如何将变量放入Python docstring中

Question

所以我正在尝试创建一个“动态”文档字符串，如下所示：

ANIMAL_TYPES = ["mammals", "reptiles", "other"]

def func(animalType):
""" This is a sample function.

    @param animalType: "It takes one of these animal types %s" % ANIMAL_TYPES
"""

基本上让@param animalType的文档显示ANIMAL_TYPES所拥有的内容;这样当更新此变量时，docstring将自动更新。

然而不幸的是，它似乎没有用......有谁知道是否有办法实现这一目标？

Answer 1

三引号字符串是一个大字符串。在他们内部没有任何评估。 %部分是字符串的一部分。你需要让它在实际的字符串上运行。

def func(animalType):
    """
    This is a sample function.

    @param animalType: "It takes one of these animal types %(ANIMAL_TYPES)s"
    """ % {'ANIMAL_TYPES': ANIMAL_TYPES}

不过，我不确定这是否会正常工作; docstrings有点神奇。这不起作用;在编译时评估docstring（作为函数中的第一个语句，因为它是一个字符串文字 - 一旦它得到%它不仅仅是一个字符串文字），字符串格式化在运行时发生，所以__doc__将为空：

>>> def a(): 'docstring works'
... 
>>> a.__doc__
'docstring works'
>>> def b(): "formatted docstring doesn't work %s" % ':-('
... 
>>> b.__doc__
>>> 

如果你想以这种方式工作，你需要在定义函数后执行func.__doc__ %= {'ANIMAL_TYPES': ANIMAL_TYPES}。请注意，如果你没有检查python -OO是否被定义，那么这将在__doc__上破坏，因为-OO剥离了docstrings。

>>> def c(): "formatted docstring works %s"
... 
>>> c.__doc__
"formatted docstring works %s"
>>> c.__doc__ %= 'after'
>>> c.__doc__
"formatted docstring works after"

这不是标准技术;标准技术是引用适当的常量：“采用ANIMAL_TYPES中的一种动物类型”或类似方法。

Answer 2

一种方法是使用装饰器。我不确定我对此感觉如何;我实际上搜索了这个方法的评论，并找到了this answer，它正确地指出它可以掩盖设计问题。但是你的用例乍一看对我来说似乎很合理。

无论如何，这是一种相当优雅的方式来实现您正在寻找的结果：

>>> def docstring_parameter(*sub):
...     def dec(obj):
...         obj.__doc__ = obj.__doc__.format(*sub)
...         return obj
...     return dec
... 
>>> @docstring_parameter('Ocean')
... def foo():
...     '''My Docstring Lies Over The {0}'''
...     pass
... 
>>> @docstring_parameter('Sea')
... def bar():
...     '''My Docstring Lies Over The {0}'''
...     pass
... 
>>> @docstring_parameter('Docstring', 'Me')
... def baz():
...     '''Oh Bring Back My {0} To {1}'''
...     pass
... 
>>> foo.__doc__
'My Docstring Lies Over The Ocean'
>>> bar.__doc__
'My Docstring Lies Over The Sea'
>>> foo.__doc__
'My Docstring Lies Over The Ocean'
>>> baz.__doc__
'Oh Bring Back My Docstring To Me'

Answer 3

您还可以使用.__doc__定义文档字符串

例如：

>>> def f():
      pass
>>> x = 1
>>> y = "docstring"

>>> f.__doc__ = "%s string %s" % (x, y)
>>> print(f.__doc__)
1 string docstring

Answer 4

您可以在docstring中简单地使用cross-references来引用变量。

所以：

:param animalType: It takes one of these :data:`animal types<ANIMAL_TYPES>`

在第二个：

:param choice: can be one of :attr:`MY_CONST`