[python] Sphinx의 autodoc을 사용하여 클래스의 __init __ (self) 메서드를 문서화하는 방법은 무엇입니까?

지난 몇 년 동안 저는 , 및 autodoc-skip-member같은 메서드를 원했기 때문에 관련없는 다양한 Python 프로젝트에 대해 여러 가지 콜백 변형을 작성했습니다.__init__()__enter__()__exit__() API 문서에 표시했습니다 (결국 이러한 “특수 메소드”는 API의 일부이며 더 나은 위치 특수 메서드의 독 스트링 내부보다 문서화).

최근에 저는 최고의 구현을 가져와 제 Python 프로젝트 중 하나의 일부로 만들었습니다 ( 여기에 문서가 있습니다 ). 구현은 기본적으로 다음과 같습니다.

import types

def setup(app):
    """Enable Sphinx customizations."""
    enable_special_methods(app)


def enable_special_methods(app):
    """
    Enable documenting "special methods" using the autodoc_ extension.

    :param app: The Sphinx application object.

    This function connects the :func:`special_methods_callback()` function to
    ``autodoc-skip-member`` events.

    .. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
    """
    app.connect('autodoc-skip-member', special_methods_callback)


def special_methods_callback(app, what, name, obj, skip, options):
    """
    Enable documenting "special methods" using the autodoc_ extension.

    Refer to :func:`enable_special_methods()` to enable the use of this
    function (you probably don't want to call
    :func:`special_methods_callback()` directly).

    This function implements a callback for ``autodoc-skip-member`` events to
    include documented "special methods" (method names with two leading and two
    trailing underscores) in your documentation. The result is similar to the
    use of the ``special-members`` flag with one big difference: Special
    methods are included but other types of members are ignored. This means
    that attributes like ``__weakref__`` will always be ignored (this was my
    main annoyance with the ``special-members`` flag).

    The parameters expected by this function are those defined for Sphinx event
    callback functions (i.e. I'm not going to document them here :-).
    """
    if getattr(obj, '__doc__', None) and isinstance(obj, (types.FunctionType, types.MethodType)):
        return False
    else:
        return skip

예, 논리보다 더 많은 문서가 있습니다. :-). 옵션을 autodoc-skip-member사용하는 것보다 이와 같은 콜백 을 정의 할 때의 이점 special-members(나에게)은 special-members옵션이 __weakref__노이즈를 고려하고 전혀 유용하지 않은 (모든 새로운 스타일의 클래스, AFAIK에서 사용 가능) 과 같은 속성의 문서화도 가능하게 한다는 것입니다. 콜백 접근 방식은이를 방지합니다 (함수 / 메소드에서만 작동하고 다른 속성을 무시하기 때문).

답변

autodoc_default_options = {
    'members': True,
    'member-order': 'bysource',
    'special-members': '__init__',
    'undoc-members': True,
    'exclude-members': '__weakref__'
}

import inspect

def skip_init_without_args(app, what, name, obj, would_skip, options):
    if name == '__init__':
        func = getattr(obj, '__init__')
        spec = inspect.getfullargspec(func)
        return not spec.args and not spec.varargs and not spec.varkw and not spec.kwonlyargs
    return would_skip

def setup(app):
    app.connect("autodoc-skip-member", skip_init_without_args)