单个模块/函数等有超过 1 个文档字符串吗？

Question

我正在使用 python 3.1。

是否可以为单个模块或函数创建超过 1 个文档字符串？ 我正在创建一个程序，并且打算拥有多个文档字符串，每个文档字符串都有一个类别。我打算向其他人提供该程序，以便他们可以使用它，并且为了让程序员和非程序员都轻松使用它，我在程序本身中放置了对文档字符串的引用。

更具体地说，我在程序/模块中有一个菜单作为界面，其中一个选项将允许访问模块文档字符串以获取程序文档。因此，如果可能的话，我想制作多个文档字符串来对不同类型的文档进行分类。因此，如果用户想查看文档的某些部分，会更容易。

例如。第一个文档字符串包含有关如何使用该程序的说明。第二个文档字符串包含有关程序的一部分如何工作的信息。第三个文档字符串包含有关其他部分如何工作的信息。等等，

这可能吗？如果是这样，你如何引用它们？

更新：添加了评论。

我最初的想法是实际上拥有多个文档字符串，其含义是：

def foo():
    """docstring1: blah blah blah"""
    """docstring2: blah blah blah"""
    pass # Insert code here

然后我可以使用一些代码来引用每个文档字符串。 那么，我猜这是不可能的？

Answer 1

我不建议尝试使用文档字符串做一些复杂的事情。最好保持文档字符串简单，如果您想提供一堆不同的文档选项，请执行其他操作。

如果您确实想做您所描述的事情，我建议您使用标签来分隔文档字符串中的部分。像这样：

def foo(bar, baz):
    """Function foo()

* Summary:
    Function foo() handles all your foo-ish needs.  You pass in a bar and a baz and it foos them.

* Developers:
    When you change foo(), be sure you don't add any global variables, and don't forget to run the unit tests.

* Testers:
    When you test foo, be sure to try negative values for baz.
"""
    pass # code would go here

然后您可以很容易地将字符串分割成块，并且当用户选择菜单项时，仅显示适当的块。

s = foo.__doc__  # s now refers to the docstring

lst = s.split("\n* ")
section = [section for section in lst if section.startswith("Developers")][0]
print(section) # prints the "Developers" section

这样，当您在交互式 Python shell 中工作时，您可以说“help(foo)”，然后您将看到所有文档字符串。而且，您并没有改变 Python 基本部分的基本行为，这会吓坏其他试图研究您的代码的人。

您还可以做一些更简单的事情：只需为不同目的制作一个大型的文档字符串全局字典，并从每个新事物的源代码中更新它。

文档开发人员 = {}
doc_testers = {}

def foo(bar, baz):
    """Function foo()

Function foo() handles all your foo-ish needs.  You pass in a bar and a baz and it foos them."
    pass # code goes here

doc_developers["foo"] = "When you change foo(), be sure you don't add any global variables, and don't forget to run the unit tests."

doc_testers["foo"] = "When you change foo(), be sure you don't add any global variables, and don't forget to run the unit tests."

我最不喜欢的一点是，如果您更改函数 foo 的名称，则需要在多个位置更改它：一次在实际的 def 中，一次在每个字典更新行。但你主要可以通过编写一个函数来解决这个问题：

def doc_dict = {} # this will be a dict of dicts
doc_dict["developers"] = {}
doc_dict["testers"] = {}

def doc_update(fn, d):
    name = fn.__name__
    for key, value in d.items():
        doc_dict[key][name] = value

def foo(bar, baz):
    """Function foo()

Function foo() handles all your foo-ish needs.  You pass in a bar and a baz and it foos them."
    pass # code goes here

d = { "developers": "When you change foo(), be sure you don't add any global variables, and don't forget to run the unit tests.",
"testers": " When you test foo, be sure to try negative values for baz."}

doc_update(foo, d)

可能有一种方法可以将 doc_update() 变成装饰器，但我现在没时间。

Answer 2

您需要考虑使用 装饰器 来干净地完成 ~unutbu 为函数建议的功能：为每个添加一个单独的字段。例如：

def human_desc(description):
    def add_field(function):
        function.human_desc = description
        return function
    return add_field

这就是 human_desc 实际的样子：

@human_desc('This function eggfoobars its spam.')
def eggfoobar(spam):
    "Apply egg, foo and bar to our spam metaclass object stuff."
    print spam

---

解释

As 文档解释了，这段代码相当于以下内容：

def eggfoobar(spam):
    "Apply egg, foo and bar to our spam metaclass object stuff."
    print spam
eggfoobar = human_desc('This function eggfoobars its spam.')(eggfoobar)

human_desc('This function Eggfoobars its spam.') 返回以下函数：

def add_field(function):
    function.human_desc = 'This function eggfoobars its spam.'
    return function

如您所见，human_desc 是一个函数，它为您作为参数传递的 description 值生成上述装饰器。装饰器本身是一个函数，它接受要装饰（修改）的函数并返回装饰后的函数（在本例中，即添加了一点额外的元数据）。简而言之，这相当于：

def eggfoobar(spam):
    "Apply egg, foo and bar to our spam metaclass object stuff."
    print spam
eggfoobar.human_desc = 'This function eggfoobars its spam.'

但是，语法更加清晰并且不易出错。

显然，无论哪种方式，你得到的是：

>>> print eggfoobar.human_desc
This function eggfoobars its spam.

Answer 3

您可以使用定义了 usage 和 extra 属性的类，而不是使用函数。例如，

class Foo(object):
    '''Here is the function's official docstring'''
    usage='All about the usage'
    extra='How another part works'
    def __call__(self):
        # Put the foo function code here
        pass
foo=Foo()

您可以照常调用它：foo()，
您可以获得官方文档字符串和备用文档字符串，如下所示：

print foo.__doc__
print foo.usage
print foo.extra

您还可以将额外的属性附加到普通函数（而不是像我上面那样使用类），但我认为语法有点难看：

def foo():
    pass
foo.usage='Usage string'
foo.extra='Extra string'

而且，模块是对象也。它们可以很容易地具有额外的属性：

如果您定义模块常量

USAGE='''blah blah'''
EXTRA='''meow'''

然后当您导入模块时：

import mymodule

您可以使用以下命令访问官方和备用文档字符串

mymodule.__doc__
mymodule.USAGE
mymodule.EXTRA

Answer 4

如果您想要拥有多个可能的文档字符串，您可以替换 __doc__ 属性，但请考虑使初始文档字符串对于所有类型都足够灵活。

Answer 5

模块是类/函数/模块的集合。所以它的文档字符串给出了它包含的内容的介绍。

类文档字符串告诉我们该类是关于什么的，它的方法文档字符串告诉我们这些方法是什么。一个类服务于一个目的，一个方法只做一件事情，所以它们应该有一个文档字符串。

函数只做一件事，因此一个文档就足够了。

我不明白多个文档字符串足以满足什么目的。也许你的模块很大。分为子模块，并在模块的文档字符串中提及子模块。