O documento discute as diretrizes de estilo de codificação Python definidas no PEP 8. Ele cobre tópicos como formatação de código, espaçamento, comentários, docstrings e nomenclatura. O objetivo é promover consistência e legibilidade no código Python.
4. Espaços em expressões e instruções
if x == 4 : print x , y ; >> if x == 4: print x, y;
spam( ham[ 1 ], { eggs: 2 } ) >> spam(ham[1], {eggs: 2})
spam (1) >> spam(1)
dict ['key'] = list [index] >> dict['key'] = list[index]
x = 1
y = 2
long_variable = 3
x = 1
y = 2
long_variable = 3
5. Comentários
Comentários que contradizem o código são piores do que
nenhum comentário
Escrevam seus comentários em inglês, a menos que você
tenha 120% de certeza de que o código jamais será lido por
pessoas que não falam sua língua
Não comente o óbvio
x = x + 1 # Increment x
x = x + 1 # Compensate for border
não faça isso ->
isso é mais útil ->
6. Docstrings
Escreva docstrings para todo módulo, função,
classe e método público
"""Return a foobang
Optional plotz says to frobnicate
the bizbaz first.
"""
7. Nomes e Identificadores
CapWords: nome de classes
nome_funcao: nome de função
__dois_underscores_no_início: atributo privado da classe
__dois_underscores_no_início_e_no_fim__: atributos ou objetos especiais
CONSTANTES: