Repolode
Enviar
mkdocstrings

mkdocstrings/griffe

Ferramenta Python que extrai a estrutura e as assinaturas de um pacote para gerar documentação de API ou detectar mudanças incompatíveis.

Ver no GitHubSite
Estrelas
704
Forks
81
Issues abertas
41
Último commit
há 14 dias

O que é?

Griffe carrega pacotes Python e cria uma representação estruturada de seus módulos, classes, funções e assinaturas sem executar o código. O resultado pode ser serializado em JSON ou percorrido pelo Python, o que torna a ferramenta útil como fonte de dados para geradores de documentação.

A interface de linha de comando oferece dois comandos principais. `griffe dump` exporta a API de um ou mais pacotes como JSON, enquanto `griffe check` compara o código atual com uma versão anterior e relata mudanças incompatíveis, como alterações nos tipos de parâmetros. É possível carregar uma versão de referência a partir de uma referência do git ou de uma versão publicada no PyPI, e a ferramenta oferece suporte a layouts `src`.

Griffe pode ser instalado com pip ou uv. Sua API Python disponibiliza `load`, `load_git` e `find_breaking_changes` para automatizar verificações ou criar ferramentas personalizadas.

Recursos principais

  • 01Extrai estaticamente a estrutura e as assinaturas de pacotes Python.
  • 02Exporta a API como JSON com `griffe dump`.
  • 03Detecta mudanças incompatíveis com `griffe check`, inclusive em comparação com referências do git.
  • 04Pode comparar com versões obtidas do PyPI usando o extra pypi.
  • 05Oferece uma API Python para carregar pacotes e encontrar mudanças incompatíveis.

Casos de uso

  • Gerar a documentação de referência da API de uma biblioteca Python.
  • Detectar mudanças indesejadas nas assinaturas durante o CI, antes de uma versão ser lançada.
  • Comparar uma nova versão com a versão anterior no PyPI.
  • Criar ferramentas personalizadas para inspecionar a API pública de uma base de código.

Início rápido

  1. 1

    Instale o Griffe com pip

    pip install griffe
  2. 2

    Exporte a API de um pacote em formato JSON

    griffe dump httpx fastapi
  3. 3

    Verifique se um pacote contém alterações incompatíveis na API

    griffe check mypackage --verbose

Antes de usar

  • Para verificar pacotes do PyPI, é necessário o extra opcional pypi.

Tópicos

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

Perguntas frequentes

O que é griffe?
Ferramenta Python que extrai a estrutura e as assinaturas de um pacote para gerar documentação de API ou detectar mudanças incompatíveis. Griffe carrega pacotes Python e cria uma representação estruturada de seus módulos, classes, funções e assinaturas sem executar o código. O resultado pode ser serializado em JSON ou percorrido pelo Python, o que torna a ferramenta útil como fonte de dados para geradores de documentação.
griffe é gratuito? Qual é a licença?
griffe é open source sob a licença ISC. Confira os termos da licença antes de usá-lo em produtos comerciais.
griffe ainda é mantido?
Manutenção ativa. O último commit de griffe foi em 23 de out. de 2026.
Para que posso usar griffe?
Gerar a documentação de referência da API de uma biblioteca Python. Detectar mudanças indesejadas nas assinaturas durante o CI, antes de uma versão ser lançada. Comparar uma nova versão com a versão anterior no PyPI. Criar ferramentas personalizadas para inspecionar a API pública de uma base de código.
Como instalar griffe?
Instale o Griffe com pip: pip install griffe Exporte a API de um pacote em formato JSON: griffe dump httpx fastapi Verifique se um pacote contém alterações incompatíveis na API: griffe check mypackage --verbose
Onde consigo griffe?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/mkdocstrings/griffe

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados