Python Sphinx自动摘要：成员函数的自动列表 [英] Python Sphinx Autosummary: Automated listing of member functions

问题描述

如何告诉自动汇总扩展不仅要列出单个类，还要列出所有类的成员？

如果我使用：

.. autosummary::

    MyClass

在生成的html文件中，将只有一个简短摘要，如下所示：

MyClass(var1，var2，...)我的Custom类可以做一些奇特的事情...

我真正想要的是：

MyClass(var1，var2，...)我的Custom类可以做一些奇特的事情...

MyClass.doA(var1，var2，...)A做得很好

MyClass.doB(var1，var2，...)B做得更好吗

我必须如何配置自动汇总指令才能实现这一点(除了在自动汇总指令中自己繁琐地命名所有函数之外)？ 谢谢！

推荐答案

您可以像下面这样扩展Autosumary指令，并这样调用它：

.. autoclass:: your.fully.qualified.path.to.the.Class
   :members:
   :undoc-members:

    .. rubric:: Methods

    .. autoautosummary:: your.fully.qualified.path.to.the.Class
        :methods:

    .. rubric:: Attributes

    .. autoautosummary:: your.fully.qualified.path.to.the.Class
        :attributes:

Code(在conf.py中)：

from sphinx.ext.autosummary import Autosummary
from sphinx.ext.autosummary import get_documenter
from docutils.parsers.rst import directives
from sphinx.util.inspect import safe_getattr
import re

class AutoAutoSummary(Autosummary):

    option_spec = {
        'methods': directives.unchanged,
        'attributes': directives.unchanged
    }

    required_arguments = 1

    @staticmethod
    def get_members(obj, typ, include_public=None):
        if not include_public:
            include_public = []
        items = []
        for name in dir(obj):
            try:
                documenter = get_documenter(safe_getattr(obj, name), obj)
            except AttributeError:
                continue
            if documenter.objtype == typ:
                items.append(name)
        public = [x for x in items if x in include_public or not x.startswith('_')]
        return public, items

    def run(self):
        clazz = str(self.arguments[0])
        try:
            (module_name, class_name) = clazz.rsplit('.', 1)
            m = __import__(module_name, globals(), locals(), [class_name])
            c = getattr(m, class_name)
            if 'methods' in self.options:
                _, methods = self.get_members(c, 'method', ['__init__'])

                self.content = ["~%s.%s" % (clazz, method) for method in methods if not method.startswith('_')]
            if 'attributes' in self.options:
                _, attribs = self.get_members(c, 'attribute')
                self.content = ["~%s.%s" % (clazz, attrib) for attrib in attribs if not attrib.startswith('_')]
        finally:
            return super(AutoAutoSummary, self).run()

def setup(app):
    app.add_directive('autoautosummary', AutoAutoSummary)

这篇关于Python Sphinx自动摘要：成员函数的自动列表的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！