Estilo é tudo, há quem diga… e não vale apenas para roupas.
Quando o assunto é programação, não vale somente “resolver um problema”. Você tem que resolver com estilo.
Em outras palavras, o código tem que fazer mais do que realizar uma determinada tarefa. Ele tem que ser enxuto e legível para outros programadores (e, mesmo, você) lerem e entenderem o que cada linha ou bloco de código faz.
O aplicativo pep8 leva o nome do guia de estilos PEP 8 do Python.
Pode ser usado para verificar se seus scripts estão dentro dos parâmetros da convenção de estilização do código Python.
Se não estiver instalado, use o pip para fazer a instalação dele:
pip3 install pep8
Depois de instalado, já é possível executá-lo em relação a qualquer um de seus scripts:
Veja a saída dele:
pep8 example-serialgrades.py
example-serialgrades.py:4:11: E201 whitespace after '('
example-serialgrades.py:4:51: E202 whitespace before ')'
example-serialgrades.py:7:14: E225 missing whitespace around operator
example-serialgrades.py:7:28: E201 whitespace after '('
example-serialgrades.py:7:35: E202 whitespace before ')'
example-serialgrades.py:10:32: E201 whitespace after '('
example-serialgrades.py:10:46: E202 whitespace before ')'
No caso acima, não há erros que impeçam a execução do script. O pep8 sequer tem a função de debugar código Python.
Veja o que é informado na primeira linha da saída do comando:
example-serialgrades.py— o nome do arquivo analisado.4:11— a linha (4) e a coluna (11) onde foi encontrada uma inconsistência.E201 whitespace after '('— o código da inconsistência e uma breve explicação que – neste caso – corresponde a um espaço vazio após o uso do parêntese.
Mesmo não tendo fluência em inglês, é possível entender “mais ou menos” o que está havendo, linha a linha.
neste Neste caso, volte ao arquivo e edite-o de acordo com os parâmetros pedidos pelo PEP 8.
Quando o seu código estiver bom, o pep8 não irá retornar qualquer aviso.
Se você não tem grandes dificuldades com a língua inglesa, pode experimentar (no Linux) a seguinte linha de comando:
pep8 --show-source --show-pep8 editor.py | less
Com as opções ‘–show-source’ e ‘–show-pep8’, serão exibidas as linhas de código com “problemas”, junto com uma explicação didática para ajudar a melhorar suas práticas de programação.