Attribut als Funktion dokumentieren?

02/10/2009 - 10:34 von Ole Streicher | Report spam
Hallo,

als Ergebnis zu der hier parallel laufenden Diskussion zum asynchronen
Updaten tritt jetzt ein neues Problem auf: ich habe ein Attribut,
welches eigentlich eine (extern aufrufbare) Funktion ist und welches ich
auch gerne als solche dokumentieren möchte. Mit epydoc sieht die
Dokumentation so aus:

from other_posting import DoAsync

class MyClass(object):
'''Ipsis at urbi...

:ivar update: call this when the object should be updated.
:type update: argument-less function
'''
def __init__(self):
self.update = DoAsync(self._do_update)

def _do_update(self):
...

Das führt jedoch dazu, dass self.update nicht unter den Funktionen,
sondern unter den Attributen gelistet wird. Auch mit dem normalen pydoc
hat "self.update" keinen passenden Docstring. Wie bekomme ich da einen
unter?

Viele Grüße

Ole
 

Lesen sie die antworten

#1 Thomas Rachel
02/10/2009 - 12:52 | Warnen spam
Ole Streicher schrieb:

from other_posting import DoAsync

class MyClass(object):
'''Ipsis at urbi...

:ivar update: call this when the object should be updated.
:type update: argument-less function
'''
def __init__(self):
self.update = DoAsync(self._do_update)

def _do_update(self):
...



Das schreit zwar nach einem Decorator, aber damit kriegt man das Problem
leider auch nicht in den Griff...

Evtl. so:

class MyClass(object):
'''Ipsis at urbi...

:ivar update: call this when the object should be updated.
:type update: argument-less function
'''
def __init__(self):
self._update = DoAsync(self._do_update)

def update(self):
return self._update()

def _do_update(self):
...


Thomas

Ähnliche fragen