Question

某些Python模块的pydoc文档（如math和sys）有一个“MODULE DOCS”部分，其中包含一些HTML文档的有用链接：

Help on module math:

NAME
    math

FILE
    /sw/lib/python2.6/lib-dynload/math.so

MODULE DOCS
    /sw/share/doc/python26/html/math.html

如何将这样的部分包含在您自己的模块中？

更一般地说，有没有记录pydoc识别的变量的地方？

我无法在源代码中找到它，因为math模块是我的机器（OS X）上的共享库，sys模块是用Python构建的......任何帮助都会非常感谢！

Answer 1

在查看pydoc模块的代码后，我认为“MODULE DOCS”链接仅适用于标准模块，而不适用于自定义模块。

以下是相关代码：

def getdocloc(self, object):
    """Return the location of module docs or None"""

    try:
        file = inspect.getabsfile(object)
    except TypeError:
        file = '(built-in)'

    docloc = os.environ.get("PYTHONDOCS",
                            "http://docs.python.org/library")
    basedir = os.path.join(sys.exec_prefix, "lib",
                           "python"+sys.version[0:3])
    if (isinstance(object, type(os)) and
        (object.__name__ in ('errno', 'exceptions', 'gc', 'imp',
                             'marshal', 'posix', 'signal', 'sys',
                             'thread', 'zipimport') or
         (file.startswith(basedir) and
          not file.startswith(os.path.join(basedir, 'site-packages'))))):
        if docloc.startswith("http://"):
            docloc = "%s/%s" % (docloc.rstrip("/"), object.__name__)
        else:
            docloc = os.path.join(docloc, object.__name__ + ".html")
    else:
        docloc = None
    return docloc

返回值None被解释为空的“MODULE DOCS”部分。

Answer 2

模块文档可能是docstring of the module。这是发生在模块顶部的纯文本（或restructured text）字符串。这是一个例子。

"""
Module documentation.
"""

def bar():
    print "HEllo"

这适用于纯Python模块。

对于已编译的扩展模块（如math），在初始化模块时，将模块docstring（作为Python字符串）作为第3个参数传递给Py_InitModule3。这将使字符串成为模块docstring。您可以在数学模块here的源代码中看到这一点。

如何定义用于pydoc显示的“MODULE DOCS”？

2 个答案: