Repolode
peterjc

peterjc/flake8-black

Plugin do flake8 que executa o black em modo de verificação e reporta diferenças de formatação como violações BLK do flake8.

Estrelas
167
Forks
11
Issues abertas
3
Último commit
há 3 dias

O que é?

flake8-black é um plugin do flake8 que executa o black em modo de verificação durante a análise do flake8. Qualquer arquivo que o black reformataria é reportado como uma violação BLK100, permitindo executar as verificações de estilo do black pelo mesmo comando flake8 usado para outras regras de lint.

O plugin é útil em hooks pre-commit do git e em integração contínua, onde uma única execução do flake8 pode cobrir tanto a formatação do black quanto outras verificações. Ele lê configurações do black, como target_version, skip_string_normalization e line_length, do pyproject.toml e aceita a opção --black-config para indicar um arquivo de configuração compartilhado. Também reporta erros internos com códigos BLK9xx, como arquivos ilegíveis ou TOML inválido.

O README observa que o plugin não respeita as configurações include e exclude do black; portanto, arquivos excluídos do black também precisam ser excluídos no flake8. Recomenda-se fixar uma versão específica do black, pois atualizações do black podem introduzir novas violações BLK100.

Recursos principais

  • 01Reporta como violações BLK100 do flake8 os arquivos que o black reformataria.
  • 02Lê configurações do black, como line_length e target_version, do pyproject.toml.
  • 03Aceita a opção --black-config para indicar um arquivo de configuração compartilhado.
  • 04Reporta problemas internos, como arquivos ilegíveis ou TOML inválido, com códigos BLK9xx.
  • 05Pode ser instalado pelo PyPI ou pelo conda-forge.

Casos de uso

  • Executar verificações de estilo do black junto com outras regras do flake8 em CI.
  • Garantir uma formatação consistente por meio de um hook pre-commit do git.
  • Compartilhar uma configuração do black entre vários projetos Python.

Início rápido

  1. 1

    Instale o plugin do PyPI usando pip

    pip install flake8-black
  2. 2

    Execute o flake8 em um arquivo Python para ver os códigos BLK

    flake8 example.py

Antes de usar

  • Ele não respeita as configurações include e exclude do black, então esses arquivos precisam ser excluídos separadamente no flake8.
  • Como informado no README, as versões a partir da 0.3.7 não funcionam com o black 25.9.0. A v0.4.0, que corrigirá isso, ainda está pendente.

Em coleções

Tópicos

Perguntas frequentes

O que é flake8-black?
Plugin do flake8 que executa o black em modo de verificação e reporta diferenças de formatação como violações BLK do flake8. flake8-black é um plugin do flake8 que executa o black em modo de verificação durante a análise do flake8. Qualquer arquivo que o black reformataria é reportado como uma violação BLK100, permitindo executar as verificações de estilo do black pelo mesmo comando flake8 usado para outras regras de lint.
flake8-black é gratuito? Qual é a licença?
flake8-black é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
flake8-black ainda é mantido?
Manutenção ativa. O último commit de flake8-black foi em 3 de nov. de 2026.
Para que posso usar flake8-black?
Executar verificações de estilo do black junto com outras regras do flake8 em CI. Garantir uma formatação consistente por meio de um hook pre-commit do git. Compartilhar uma configuração do black entre vários projetos Python.
Como instalar flake8-black?
Instale o plugin do PyPI usando pip: pip install flake8-black Execute o flake8 em um arquivo Python para ver os códigos BLK: flake8 example.py
Onde consigo flake8-black?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/peterjc/flake8-black

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

Projetos relacionados