使用“from x import *”记录文件

Question

sphinx 的 .. automodule:: 和其他自动功能可以用于记录包含 from x import * 语句的模块，而不包含来自导入模块的所有文档吗？

编辑： 根据 mzjn 的观点，只要导入方法的 __module__ 属性与模块名称不同，就不应该记录它们。然而，对于我的一些模块来说，它们是。

我的 MLE 只是一个文件 test_doc.py 文件，其中包含以下行：

from pylab import *

和文档：

.. automodule:: agpy.test_doc
    :members:

如果我在 test_doc.py 中包含此行：

print "beta.__module__:",beta.__module__

我会得到预期结果：

beta.__module__: None

Any知道发生了什么事吗？我可能把 conf.py 搞砸了吗？

编辑：根据 mzjn 的答案，一种解决方法是更改​​具有 __module__==None 的函数的 __module__ 属性：

import pylab
from pylab import *
for k,v in pylab.__dict__.iteritems():  
    if hasattr(v,'__module__'):
        if v.__module__ is None:
            locals()[k].__module__ = 'pylab'

Answer 1

是的，那应该有效。来自文档：

在设置了 Members 选项的 automodule 指令中，只有 __module__ 属性等于给定 automodule 的模块名称的模块成员才会被记录。这是为了防止记录导入的类或函数。

---

更新：

问题似乎是许多 pylab 成员的 __module__ 属性为 None （C/Cython 模块中定义的成员 mtrand，据我所知）。

mtrand 模块是 NumPy 的一部分。在幕后，pylab.beta（以及其他几个函数）是numpy.random.mtrand.RandomState。我可以按如下方式重现文档问题：

使用此源代码 (pylabtest.py)

from pylab import beta

def mzjn(x):
    """mzjn docstring"""
    return x

和此源文档 (pylabtest.rst)，

Pylab test
==========

.. automodule:: pylabtest
    :members:

pylabtest.html 中的 Sphinx 输出包括 beta 和 mzjn.

但如果

beta.__module__ = "pylab"

添加到 pylabtest.py，则仅记录 mzjn 。