Sobre o projeto
O Black é um formatador de código Python opinativo mantido pela Python Software Foundation. Seu objetivo declarado é acabar com debates sobre formatação manual, aplicando um único estilo consistente: os usuários cedem o controle sobre detalhes de formatação em troca de velocidade, determinismo e liberdade de reclamações de verificadores de estilo.
Principais características descritas no README:
- Reforma arquivos inteiros no local, ignorando a formatação anterior (com exceções pragmáticas documentadas).
- Opções de configuração deliberadamente limitadas; padrões razoáveis são enfatizados, com configurações de projeto legíveis de pyproject.toml (por exemplo, padrões de inclusão/exclusão).
- Visa produzir os menores diffs possíveis, o que o projeto afirma torna a revisão de código mais rápida.
- Inclui uma verificação de segurança de que o código reformado ainda produz um AST válido efetivamente equivalente ao original; uma flag --fast ignora essa verificação.
- Afirmar conformidade com PEP 8 e uma política de estabilidade que rege alterações de estilo.
Instalação e uso:
- Instale via pip install black; requer Python 3.10 ou mais recente.
- A formatação de Jupyter Notebook está disponível por meio do extra black[jupyter].
- Executáveis standalone compilados com PyInstaller são oferecidos nos releases do GitHub para usuários sem uma instalação de Python.
- Execute como black {source_file_or_directory} ou python -m black {source_file_or_directory}.
Ecossistema e adoção:
O README lista muitos projetos de código aberto que usam o Black, incluindo pytest, tox, Pyramid, Django, Django Channels, Hypothesis, attrs, SQLAlchemy, Poetry, aplicações do PyPA, pandas, Pillow, Twisted, LocalStack, Home Assistant, Zulip e Kedro. Também nomeia organizações como Dropbox, Lyft, Mozilla, Quora, Duolingo e Tesla como usuárias. Depoimentos são citados de desenvolvedores incluindo Mike Bayer, Hynek Schlawack, Kenneth Reitz e Carl Meyer.
O projeto é licenciado sob MIT, oferece documentação no ReadTheDocs, mantém um changelog e lista de autores em arquivos separados, e convida contribuições por meio de sua documentação de contribuição e chat no Discord. Também referencia o Código de Conduta da Comunidade Python.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.