1

一些 Python 模块（如math和sys）的 pydoc 文档有一个“模块文档”部分，其中包含指向一些 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 构建的……任何帮助将不胜感激！

4

2 回答 2

3

查看模块的代码后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”部分。

于 2010-06-24T12:43:15.757 回答
0

模块文档可能是模块的文档字符串。这是出现在模块顶部的纯文本（或重组文本）字符串。这是一个例子。

"""
Module documentation.
"""

def bar():
    print "HEllo"

这适用于纯 Python 模块。

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

于 2010-06-20T09:29:38.897 回答