带有toctree的sphinx autosummary还列出导入的成员

Question

使用Python和Sphinx软件生成autosummary文档。它工作得很好，但是生成的.rst文件还列出了导入的函数和类，这不是我想要的行为。在

例如，带有docstring的包“packageex”：

"""
Package Example (:mod:`packageex`)
==================================

.. currentmodule:: packageex
.. autosummary::
   :toctree:

   module0
   module1
"""

会产生一个文件packageex.module0.rst与

^{pr2}$

有没有办法只列出模块中定义的函数和类（而不是导入的函数和类）？在

在autodoc（http://sphinx-doc.org/latest/ext/autodoc.html）的doc中，有“在设置了members选项的automodule指令中，只有__module__属性等于给automodule的模块名称的模块成员将被记录。这是为了防止记录导入的类或函数。如果要阻止此行为并记录所有可用成员，请设置“导入成员”选项。注意，导入模块中的属性不会被记录，因为属性文档是通过解析当前模块的源文件发现的？在

Answer 1

正如mzjn所提到的，这似乎是一个已知的扩展autosummary的奇怪行为。为了得到想要的行为（即防止列出导入的对象），我刚刚修改了函数get_members（l.166斯芬克斯外景自动摘要.generate）这样：

def get_members(obj, typ, include_public=[], imported=False):
    items = []
    for name in dir(obj):
        try:
            obj_name = safe_getattr(obj, name)
            documenter = get_documenter(obj_name, obj)
        except AttributeError:
            continue
        if documenter.objtype == typ:
            try:
                cond = (
                    imported or 
                    obj_name.__module__ == obj.__name__
                    )
            except AttributeError:
                cond = True
            if cond:
                items.append(name)
    public = [x for x in items
              if x in include_public or not x.startswith('_')]
    return public, items