Repolode
google

google/yapf

Formatador de código Python que reformata arquivos conforme um estilo configurável, usando o algoritmo de layout do clang-format.

Alternativa open source a:Black

Estrelas
13,986
Forks
915
Issues abertas
433
Último commit
ontem

O que é?

O YAPF formata código-fonte Python calculando o melhor layout que segue o estilo escolhido, para que os desenvolvedores gastem menos tempo ajustando manualmente indentação, espaçamento e quebras de linha. Ele se baseia no algoritmo de reformatação do clang-format e pode ser executado pela linha de comando ou usado como biblioteca por meio das funções FormatCode e FormatFile.

O estilo é definido com bases predefinidas, como pep8, google, yapf e facebook, que podem ser personalizadas com configurações de chave e valor em um arquivo .style.yapf, setup.cfg ou pyproject.toml, ou pela linha de comando. Há muitas opções individuais para configurar itens como limite de colunas, posicionamento de colchetes, divisão de operadores e espaçamento de comentários.

O YAPF pode reformatar apenas intervalos de linhas selecionados, excluir arquivos usando padrões na linha de comando ou um arquivo .yapfignore, exibir diffs e executar em paralelo em vários arquivos. O modo --diff retorna um código de saída diferente de zero quando são necessárias alterações, o que permite usá-lo como verificação em CI.

Recursos principais

  • 01Reformata arquivos Python conforme um estilo predefinido ou personalizado, como pep8 ou google.
  • 02Pode ser personalizado com dezenas de opções de estilo em arquivos de configuração ou pela linha de comando.
  • 03Formata apenas os intervalos de linhas especificados em um arquivo.
  • 04Aceita padrões de exclusão pela linha de comando ou por .yapfignore / pyproject.toml.
  • 05Oferece um modo diff que retorna um código de saída diferente de zero quando são necessárias alterações de formatação, adequado para verificações em CI.
  • 06Pode ser usado como ferramenta de linha de comando ou biblioteca Python.

Casos de uso

  • Impor um estilo de código consistente em uma equipe ou repositório Python.
  • Adicionar uma verificação de formatação a um pipeline de CI usando o modo diff.
  • Formatar apenas as linhas alteradas por um patch ou edição, em uma integração com editor.
  • Automatizar a limpeza de estilo em scripts que geram ou transformam código Python.

Início rápido

  1. 1

    Instale o YAPF pelo PyPI

    pip install yapf
  2. 2

    Execute o yapf nos seus arquivos Python usando opções como --diff ou --in-place

Antes de usar

  • O README descreve o YAPF como beta, e as versões podem mudar com frequência.
  • Alguns recursos mais recentes do Python, como a sintaxe de parâmetros de tipo da PEP 695 e a formalização de f-strings da PEP 701, ainda não são compatíveis.

Em coleções

Tópicos

Perguntas frequentes

O que é yapf?
Formatador de código Python que reformata arquivos conforme um estilo configurável, usando o algoritmo de layout do clang-format. O YAPF formata código-fonte Python calculando o melhor layout que segue o estilo escolhido, para que os desenvolvedores gastem menos tempo ajustando manualmente indentação, espaçamento e quebras de linha. Ele se baseia no algoritmo de reformatação do clang-format e pode ser executado pela linha de comando ou usado como biblioteca por meio das funções FormatCode e FormatFile.
yapf é gratuito? Qual é a licença?
yapf é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
yapf ainda é mantido?
Manutenção ativa. O último commit de yapf foi em 6 de nov. de 2026.
Para que posso usar yapf?
Impor um estilo de código consistente em uma equipe ou repositório Python. Adicionar uma verificação de formatação a um pipeline de CI usando o modo diff. Formatar apenas as linhas alteradas por um patch ou edição, em uma integração com editor. Automatizar a limpeza de estilo em scripts que geram ou transformam código Python.
Como instalar yapf?
Instale o YAPF pelo PyPI: pip install yapf Execute o yapf nos seus arquivos Python usando opções como --diff ou --in-place
Onde consigo yapf?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/google/yapf

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

Projetos relacionados