有没有办法如何在sphinx文档中自动显示变量var1和var2及其init-values?
class MyClass:
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 * 2
self.var2 = par2 * 2
def method(self):
pass
Run Code Online (Sandbox Code Playgroud) 当我使用狮身人面像车博士来记录一类,为属性的值总是报道,(因为它说,它应该在这里,在#437),但始终是"=无"
Attribute = None
Some Documentation
Run Code Online (Sandbox Code Playgroud)
我把它包括在内
.. autoclass:: core.SomeClass
:members:
Run Code Online (Sandbox Code Playgroud)
我的代码看起来像
class SomeClass(object):
def __init__(self):
self.attribute = "value" #: Some Documentation
Run Code Online (Sandbox Code Playgroud)
有没有办法让"=无"报告真正的价值,或让它消失?
我有带有对象属性的Python类,它们只被声明为运行构造函数的一部分,如下所示:
class Foo(object):
def __init__(self, base):
self.basepath = base
temp = []
for run in os.listdir(self.basepath):
if self.foo(run):
temp.append(run)
self.availableruns = tuple(sorted(temp))
Run Code Online (Sandbox Code Playgroud)
如果我现在使用help(Foo)或尝试Foo在Sphinx中记录,则不显示self.basepath和self.availableruns属性.这对我们API的用户来说是一个问题.
我已经尝试寻找一种标准方法来确保解析器可以找到这些"动态声明"的属性(最好是docstring'd),但到目前为止还没有运气.有什么建议?谢谢.