草庐IT

docstring

全部标签

python - 如何以编程方式设置文档字符串?

我有一个返回函数的包装函数。有没有办法以编程方式设置返回函数的文档字符串?如果我可以写信给__doc__我会做以下事情:defwrapper(a):defadd_something(b):returna+badd_something.__doc__='Adds'+str(a)+'to`b`'returnadd_something那我就可以了>>>add_three=wrapper(3)>>>add_three.__doc__'Adds3to`b`但是,由于__doc__是只读的,我不能这样做。正确的方法是什么?编辑:好的,我想保持简单,但这当然不是我真正想要做的。尽管一般__doc__

python - 如何以编程方式设置文档字符串?

我有一个返回函数的包装函数。有没有办法以编程方式设置返回函数的文档字符串?如果我可以写信给__doc__我会做以下事情:defwrapper(a):defadd_something(b):returna+badd_something.__doc__='Adds'+str(a)+'to`b`'returnadd_something那我就可以了>>>add_three=wrapper(3)>>>add_three.__doc__'Adds3to`b`但是,由于__doc__是只读的,我不能这样做。正确的方法是什么?编辑:好的,我想保持简单,但这当然不是我真正想要做的。尽管一般__doc__

python - Python 3 脚本中的 print(__doc__)

我不知道print(__doc__)在脚本开头做了什么,例如inthisScikitexample.我一直在google中寻找Python文档字符串,似乎__doc__可以在函数中提供一些文档。但我看不到__doc__在脚本中间做了什么。 最佳答案 itseems__doc__isusefultoprovidesomedocumentationin,say,functions这是真的。除了功能之外,还可以在模块中提供文档。因此,如果您有一个名为mymodule.py的文件,如下所示:"""Thisisthemoduledocstri

python - Python 3 脚本中的 print(__doc__)

我不知道print(__doc__)在脚本开头做了什么,例如inthisScikitexample.我一直在google中寻找Python文档字符串,似乎__doc__可以在函数中提供一些文档。但我看不到__doc__在脚本中间做了什么。 最佳答案 itseems__doc__isusefultoprovidesomedocumentationin,say,functions这是真的。除了功能之外,还可以在模块中提供文档。因此,如果您有一个名为mymodule.py的文件,如下所示:"""Thisisthemoduledocstri

Python 装饰器处理文档字符串

我在使用带有装饰器的文档字符串时遇到问题。举个例子:defdecorator(f):def_decorator():print'decoratoractive'f()return_decorator@decoratordeffoo():'''themagicfoofunction'''print'thisisfunctionfoo'help(foo)现在帮助没有按预期向我显示foo的文档字符串,它显示:Helponfunction_decoratorinmodule__main__:_decorator()没有装饰器,帮助是正确的:Helponfunctionfooinmodule__

Python 装饰器处理文档字符串

我在使用带有装饰器的文档字符串时遇到问题。举个例子:defdecorator(f):def_decorator():print'decoratoractive'f()return_decorator@decoratordeffoo():'''themagicfoofunction'''print'thisisfunctionfoo'help(foo)现在帮助没有按预期向我显示foo的文档字符串,它显示:Helponfunction_decoratorinmodule__main__:_decorator()没有装饰器,帮助是正确的:Helponfunctionfooinmodule__

python - 对于 Python 文档,reStructuredText 有什么真正的替代品吗?

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题,以便用事实和引用来回答它。关闭4年前。Improvethisquestion我很快就开始了一个开源Python项目,我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用带有autodoc的reStructuredText和Sphinx,因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx自动构建一个API文档我。问题在于它使用的reStructuredText语法——我认为它在渲染之前完全不可读。例如

python - 对于 Python 文档,reStructuredText 有什么真正的替代品吗?

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题,以便用事实和引用来回答它。关闭4年前。Improvethisquestion我很快就开始了一个开源Python项目,我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用带有autodoc的reStructuredText和Sphinx,因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx自动构建一个API文档我。问题在于它使用的reStructuredText语法——我认为它在渲染之前完全不可读。例如

python - 如何从函数本身内部打印python函数的Docstring?

我想从函数内部打印python函数的文档字符串。例如。defmy_function(self):"""Docstringformyfunction."""#printtheDocstringhere.目前我是在定义my_function之后直接执行此操作的。printmy_function.__doc__但宁愿让函数自己做。我尝试在my_function中调用printself.__doc__printself.my_function.__doc__和printthis.__doc__但这不起作用. 最佳答案 defmy_func(

python - 如何从函数本身内部打印python函数的Docstring?

我想从函数内部打印python函数的文档字符串。例如。defmy_function(self):"""Docstringformyfunction."""#printtheDocstringhere.目前我是在定义my_function之后直接执行此操作的。printmy_function.__doc__但宁愿让函数自己做。我尝试在my_function中调用printself.__doc__printself.my_function.__doc__和printthis.__doc__但这不起作用. 最佳答案 defmy_func(