Repolode
Enviar
PyCQA

PyCQA/docformatter

Ferramenta de linha de comando para Python que reformata docstrings automaticamente de acordo com as convenções da PEP 257.

Ver no GitHubSite
Estrelas
600
Forks
98
Issues abertas
22
Último commit
há 4 dias

O que é?

docformatter é uma ferramenta de linha de comando para Python que reescreve docstrings para que sigam um subconjunto das convenções da PEP 257. Ela padroniza o estilo das aspas, coloca as aspas de fechamento em uma linha própria nas docstrings multilinha, separa o resumo da descrição com uma linha em branco e remove recuos indesejados e espaços em branco no fim das linhas.

A ferramenta pode ser executada diretamente nos arquivos ou em todo o projeto, e oferece um modo compatível com black por meio da opção --black. Também formata listas de campos nos estilos Epytext ou Sphinx. As configurações podem ser lidas de pyproject.toml, usando a biblioteca padrão tomllib no Python 3.11 ou posterior.

É útil para quem quer manter docstrings consistentes em toda a base de código sem editar cada uma manualmente, especialmente quando a ferramenta é executada como parte de uma etapa de lint ou pre-commit.

Recursos principais

  • 01Reformata docstrings seguindo as regras de aspas e formatação da PEP 257.
  • 02Oferece saída compatível com black por meio da opção --black.
  • 03Formata listas de campos nos estilos Epytext e Sphinx.
  • 04Pode editar arquivos diretamente com --in-place.
  • 05Lê configurações de pyproject.toml.

Casos de uso

  • Padronizar a formatação de docstrings em um projeto Python.
  • Garantir automaticamente a consistência das docstrings em um hook de pre-commit ou em uma verificação de CI.
  • Limpar código legado com aspas e recuos inconsistentes nas docstrings.

Início rápido

  1. 1

    Instale o docformatter do PyPI com pip

    pip install --upgrade docformatter
  2. 2

    Formate os docstrings de um arquivo diretamente

    docformatter --in-place example.py

Em coleções

Linters e formatadores de código

Tópicos

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

Perguntas frequentes

O que é docformatter?
Ferramenta de linha de comando para Python que reformata docstrings automaticamente de acordo com as convenções da PEP 257. docformatter é uma ferramenta de linha de comando para Python que reescreve docstrings para que sigam um subconjunto das convenções da PEP 257. Ela padroniza o estilo das aspas, coloca as aspas de fechamento em uma linha própria nas docstrings multilinha, separa o resumo da descrição com uma linha em branco e remove recuos indesejados e espaços em branco no fim das linhas.
docformatter é gratuito? Qual é a licença?
docformatter é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
docformatter ainda é mantido?
Manutenção ativa. O último commit de docformatter foi em 3 de nov. de 2026.
Para que posso usar docformatter?
Padronizar a formatação de docstrings em um projeto Python. Garantir automaticamente a consistência das docstrings em um hook de pre-commit ou em uma verificação de CI. Limpar código legado com aspas e recuos inconsistentes nas docstrings.
Como instalar docformatter?
Instale o docformatter do PyPI com pip: pip install --upgrade docformatter Formate os docstrings de um arquivo diretamente: docformatter --in-place example.py
Onde consigo docformatter?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/PyCQA/docformatter

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

Projetos relacionados