如何将变量放入 Python 文档字符串

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 的任何内容；这样当更新此变量时，文档字符串将自动更新。

不幸的是，它似乎不起作用。有谁知道是否有办法实现这一目标？

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}

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

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

如果您想以这种方式工作，则需要在定义函数后执行func.__doc__ %= {'ANIMAL_TYPES': ANIMAL_TYPES}。请注意，如果您没有检查 __doc__ 是否已定义，那么这将在 python -OO 上中断，因为 -OO 会删除文档字符串。

>>> 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

您可以简单地在您的文档字符串中使用cross-references 来引用该变量。

所以：

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

第二个：

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

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

一种方法是使用装饰器。我不确定我对此有何感想；我实际上搜索了有关此方法的评论并找到了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'