Repolode
psf

psf/black

Black é um formatador determinístico e opinativo de código Python que reescreve arquivos no lugar e gera diffs mínimos.

Estrelas
41,948
Forks
2,940
Issues abertas
298
Último commit
há 12 horas

O que é?

Black é um formatador opinativo de código Python. Ele reformata arquivos inteiros no lugar, com um conjunto deliberadamente pequeno de opções de estilo, para que o código tenha a mesma aparência em diferentes projetos e se evitem discussões sobre formatação. O projeto foi desenvolvido para gerar os menores diffs possíveis, mantendo as revisões de código focadas no conteúdo.

Black requer Python 3.10 ou mais recente e pode ser instalado com pip. Também formata Jupyter Notebooks quando instalado com o extra jupyter, e há executáveis independentes disponíveis para quem não quer instalar Python. A configuração é lida de pyproject.toml, incluindo padrões de inclusão e exclusão, embora os padrões sejam pensados para funcionar sem alterações.

Como medida de segurança, Black verifica se o código reformatado continua gerando uma AST equivalente à original; a flag --fast ignora essa verificação. O projeto documenta seu estilo de código e uma política de estabilidade que limita mudanças de estilo a correções de bugs e ao suporte a novas sintaxes do Python.

Recursos principais

  • 01Reformata arquivos Python no lugar com um conjunto pequeno e fixo de opções de estilo.
  • 02Gera diffs mínimos para manter as revisões de código focadas.
  • 03Por padrão, verifica se o código formatado é equivalente ao original em termos de AST.
  • 04Formata Jupyter Notebooks quando instalado com o extra jupyter.
  • 05Lê as configurações do projeto em pyproject.toml.

Casos de uso

  • Aplicar um estilo de código consistente em uma equipe ou repositório Python.
  • Executar automaticamente como hook de pre-commit ou no CI para verificar a formatação.
  • Formatar código Python em Jupyter Notebooks junto com arquivos de código-fonte convencionais.

Início rápido

  1. 1

    Instale o Black com pip

    pip install black
  2. 2

    Formate um arquivo ou diretório

    black {source_file_or_directory}

Antes de usar

  • Requer Python 3.10 ou superior para ser executado.

Tópicos

Perguntas frequentes

O que é black?
Black é um formatador determinístico e opinativo de código Python que reescreve arquivos no lugar e gera diffs mínimos. Black é um formatador opinativo de código Python. Ele reformata arquivos inteiros no lugar, com um conjunto deliberadamente pequeno de opções de estilo, para que o código tenha a mesma aparência em diferentes projetos e se evitem discussões sobre formatação. O projeto foi desenvolvido para gerar os menores diffs possíveis, mantendo as revisões de código focadas no conteúdo.
black é gratuito? Qual é a licença?
black é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
black ainda é mantido?
Manutenção ativa. O último commit de black foi em 19 de out. de 2026.
Para que posso usar black?
Aplicar um estilo de código consistente em uma equipe ou repositório Python. Executar automaticamente como hook de pre-commit ou no CI para verificar a formatação. Formatar código Python em Jupyter Notebooks junto com arquivos de código-fonte convencionais.
Como instalar black?
Instale o Black com pip: pip install black Formate um arquivo ou diretório: black {source_file_or_directory}
Onde consigo black?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/psf/black

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

Projetos relacionados