python - subclases - ¿Cómo mostrar atributos de instancia en el documento de la esfinge?

subclases python

Question

¿Hay alguna manera de mostrar automáticamente las variables var1 y var2 y sus valores de inicio en la documentación de la esfinge?

class myClass():
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method():
pass

Answer 1

Sus variables son variables de instancia, no variables de clase.

Sin adjuntar una cadena de documentación (o un #: "comentario de documento") a las variables, no se documentarán. Podrías hacer lo siguiente:

class MyClass(object):
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 #: initial value: par1
self.var2 = par2 #: initial value: par2
def method(self):
pass

Pero preferiría incluir documentación variable utilizando campos de información :

class MyClass(object):
"""
Description for class
:ivar var1: initial value: par1
:ivar var2: initial value: par2
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method(self):
pass

Ver también:

• http://www.sphinx-doc.org/ext/autodoc.html#directive-autoattribute
• ¿Cómo puedo hacer que los atributos del objeto de documento Python / Sphinx se declaren solo en __init__?
• Problemas con autodoc y atributos de instancia explícitamente especificados