Repolode
Enviar
mkdocstrings

mkdocstrings/griffe

Herramienta de Python que extrae la estructura y las firmas de un paquete para generar documentación de API o detectar cambios incompatibles.

Ver en GitHubSitio web
Estrellas
704
Forks
81
Issues abiertos
41
Último commit
hace 15 días

¿Qué es?

Griffe carga paquetes de Python y crea una representación estructurada de sus módulos, clases, funciones y firmas, sin ejecutar el código. El resultado se puede serializar a JSON o recorrer desde Python, lo que lo convierte en una fuente de datos útil para generadores de documentación.

La interfaz de línea de comandos ofrece dos comandos principales. `griffe dump` exporta la API de uno o más paquetes como JSON, mientras que `griffe check` compara el código actual con una versión anterior e informa de cambios incompatibles, como modificaciones en los tipos de parámetros. Puede cargar una referencia de comparación desde una referencia de git o desde una versión publicada en PyPI, y es compatible con los layouts `src`.

Griffe se puede instalar con pip o uv. Su API de Python ofrece `load`, `load_git` y `find_breaking_changes` para automatizar comprobaciones o crear herramientas personalizadas.

Funciones clave

  • 01Extrae estáticamente la estructura y las firmas de paquetes de Python.
  • 02Exporta la API como JSON con `griffe dump`.
  • 03Detecta cambios incompatibles con `griffe check`, también al comparar referencias de git.
  • 04Permite comparar con versiones descargadas de PyPI mediante el extra pypi.
  • 05Ofrece una API de Python para cargar paquetes y encontrar cambios incompatibles.

Casos de uso

  • Generar documentación de referencia de la API de una biblioteca de Python.
  • Detectar cambios involuntarios en las firmas en CI antes de una versión.
  • Comparar una nueva versión con la versión anterior publicada en PyPI.
  • Crear herramientas personalizadas que inspeccionen la API pública de una base de código.

Inicio rápido

  1. 1

    Instala Griffe con pip

    pip install griffe
  2. 2

    Vuelca la API de un paquete en formato JSON

    griffe dump httpx fastapi
  3. 3

    Comprueba si un paquete contiene cambios incompatibles en la API

    griffe check mypackage --verbose

Antes de usarlo

  • Para comprobar paquetes de PyPI, se necesita el extra opcional pypi.

Temas

#python#api-documentation#breaking-changes#static-analysis#developer-tools#docs#api#mkdocstrings-collector#parser#signature

Preguntas frecuentes

¿Qué es griffe?
Herramienta de Python que extrae la estructura y las firmas de un paquete para generar documentación de API o detectar cambios incompatibles. Griffe carga paquetes de Python y crea una representación estructurada de sus módulos, clases, funciones y firmas, sin ejecutar el código. El resultado se puede serializar a JSON o recorrer desde Python, lo que lo convierte en una fuente de datos útil para generadores de documentación.
¿griffe es gratuito? ¿Qué licencia tiene?
griffe es open source bajo la licencia ISC. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿griffe sigue mantenido?
Mantenimiento activo. El último commit de griffe fue el 23 oct 2026.
¿Para qué puedo usar griffe?
Generar documentación de referencia de la API de una biblioteca de Python. Detectar cambios involuntarios en las firmas en CI antes de una versión. Comparar una nueva versión con la versión anterior publicada en PyPI. Crear herramientas personalizadas que inspeccionen la API pública de una base de código.
¿Cómo se instala griffe?
Instala Griffe con pip: pip install griffe Vuelca la API de un paquete en formato JSON: griffe dump httpx fastapi Comprueba si un paquete contiene cambios incompatibles en la API: griffe check mypackage --verbose
¿Dónde consigo griffe?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/mkdocstrings/griffe

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

Proyectos relacionados