Repolode
Enviar
PyCQA

PyCQA/docformatter

Herramienta de línea de comandos para Python que reformatea automáticamente los docstrings según las convenciones de PEP 257.

Ver en GitHubSitio web
Estrellas
600
Forks
98
Issues abiertos
22
Último commit
hace 4 días

¿Qué es?

docformatter es una herramienta de línea de comandos para Python que reescribe los docstrings para que sigan un subconjunto de las convenciones de PEP 257. Normaliza el estilo de las comillas, coloca las comillas de cierre en una línea propia en los docstrings multilínea, separa el resumen de la descripción con una línea en blanco y elimina la indentación sobrante y los espacios en blanco al final de las líneas.

Se puede ejecutar para modificar archivos individuales directamente o aplicarse a todo un proyecto, y ofrece un modo compatible con black mediante la opción --black. También da formato a las listas de campos escritas con los estilos de Epytext o Sphinx. La configuración se puede leer desde pyproject.toml, que usa la biblioteca estándar tomllib en Python 3.11 y versiones posteriores.

Es útil para quienes buscan mantener docstrings coherentes en todo el código sin tener que editarlos uno por uno, especialmente si se ejecuta como parte de un paso de lint o pre-commit.

Funciones clave

  • 01Reformatea los docstrings para seguir las reglas de PEP 257 sobre comillas y estructura.
  • 02Admite una salida compatible con black mediante la opción --black.
  • 03Da formato a las listas de campos de estilo Epytext y Sphinx.
  • 04Puede modificar archivos directamente con --in-place.
  • 05Lee la configuración desde pyproject.toml.

Casos de uso

  • Unificar el formato de los docstrings en un proyecto de Python.
  • Aplicar automáticamente un formato coherente a los docstrings mediante un hook de pre-commit o una comprobación de CI.
  • Limpiar código heredado con comillas e indentación inconsistentes en los docstrings.

Inicio rápido

  1. 1

    Instala docformatter desde PyPI con pip

    pip install --upgrade docformatter
  2. 2

    Formatea los docstrings de un archivo directamente

    docformatter --in-place example.py

En colecciones

Linters y formateadores de código

Temas

#python#docstring#formatter#pep-257#code-style#linting#autoformat

Preguntas frecuentes

¿Qué es docformatter?
Herramienta de línea de comandos para Python que reformatea automáticamente los docstrings según las convenciones de PEP 257. docformatter es una herramienta de línea de comandos para Python que reescribe los docstrings para que sigan un subconjunto de las convenciones de PEP 257. Normaliza el estilo de las comillas, coloca las comillas de cierre en una línea propia en los docstrings multilínea, separa el resumen de la descripción con una línea en blanco y elimina la indentación sobrante y los espacios en blanco al final de las líneas.
¿docformatter es gratuito? ¿Qué licencia tiene?
docformatter es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿docformatter sigue mantenido?
Mantenimiento activo. El último commit de docformatter fue el 3 nov 2026.
¿Para qué puedo usar docformatter?
Unificar el formato de los docstrings en un proyecto de Python. Aplicar automáticamente un formato coherente a los docstrings mediante un hook de pre-commit o una comprobación de CI. Limpiar código heredado con comillas e indentación inconsistentes en los docstrings.
¿Cómo se instala docformatter?
Instala docformatter desde PyPI con pip: pip install --upgrade docformatter Formatea los docstrings de un archivo directamente: docformatter --in-place example.py
¿Dónde consigo docformatter?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/PyCQA/docformatter

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados