重写Sphinx autodoc"Alias of"用于导入私有类？

Question

我有一个Python包,我试图用sphinx-autodoc记录.我的python包有一个__init__.py文件,它从子模块中导出一个类,使其可以在包级别访问.

from a.b.c.d import _Foo as Foo

__all__ = ["Foo"]

如果我这样做,我的(html)文档如下:

abc包

子模块

abcd模块

[在abcd模块中剪切不相关公共类的文档]

模块内容

c模块.

abc Foo

_Foo的别名

_Foo因为它是abcd子模块中的私有类,所以(正确地)没有文档,因此不是非常有用.

我可以在my中添加以下内容,以conf.py确保记录模块中的私有类定义.

def skip(app, what, name, obj, skip, options):
    if name == "_Foo":
        return False
    return skip

其他替代方案,但不是我尝试过的好东西:

1. 重命名a.b.c.d._Foo为a.b.c.d.Foo(然后更新导入到from a.b.c.d import Foo) - 但后来我将类记录两次,一次在abcd模块标题下,再一次在Module内容标题下.
2. 重命名a.b.c.d.Foo到a.b.c.d.MyFoo,然后导入(from a.b.c.d import MyFoo as Foo)导致MyFoo被记录,并且Foo被列为一个别名MyFoo.

---

理想情况下,我希望私有定义保持未记录,但要将导入到包中的版本完整记录.有谁知道我怎么做到这一点？

Answer 1

Sphinx 使用类的__name__和__module__成员以及__module__类所有者的成员来确定它是别名还是真实的东西。通过显式设置这些成员，您可以欺骗 Sphinx 认为您导入的类是真正的类。

from a.b.c.d import _Foo as Foo
Foo.__module__ = __name__
Foo.__name__ = 'Foo'