En los últimos años, he escrito varias variantes de autodoc-skip-member
devoluciones de llamada para varios proyectos de Python no relacionados porque quería métodos como __init__()
, __enter__()
y __exit__()
que aparecieran en la documentación de mi API (después de todo, estos "métodos especiales" son parte de la API y qué mejor lugar para documentarlos que dentro de la cadena de documentos del método especial).
Recientemente tomé la mejor implementación y la hice parte de uno de mis proyectos de Python ( aquí está la documentación ). La implementación básicamente se reduce a esto:
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
Sí, hay más documentación que lógica :-). La ventaja de definir una autodoc-skip-member
devolución de llamada como esta sobre el uso de la special-members
opción (para mí) es que la special-members
opción también habilita la documentación de propiedades como __weakref__
(disponible en todas las clases de estilo nuevo, AFAIK) que considero ruido y no son útiles en absoluto. El enfoque de devolución de llamada evita esto (porque solo funciona en funciones / métodos e ignora otros atributos).
"both" Both the class’ and the __init__ method’s docstring are concatenated and inserted.
-> Por lo tanto, no debería ser solo el__init__(self)
, sino también el docstring de la clase si lo tiene. ¿Puede proporcionar un caso de prueba porque si es así, se siente como un error, verdad?