pep8
Indentação
Use 4 espaços por nível de indentação.
Continuações de linha devem se alinhar com o parêntese ou usando um nível extra de indentação.
# Alinhado com o parêntese de abertura
foo = long_function_name(var_one, var_two,
var_three, var_four)
# Mais indentação para distinguir isso do restante.
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one)
Tamanho máximo da linha
- Limite todas as linhas a um máximo de 79 caracteres para código e 72 caracteres para comentários.
Importações
- As importações devem ser feitas em linhas separadas.
# Correto
import os
import sys
# Errado
import sys, os
# É aceitável dizer isso
from subprocess import Popen, PIPE
- As importações são sempre colocadas no topo do arquivo, logo depois de quaisquer comentários ou docstrings e antes de constantes globais e variáveis.
Espaços em branco em Expressões e Instruções
Evite espaços em branco extras em situações como estas:
# Correto
spam(ham[1], {eggs: 2})
# Errado
spam( ham[ 1 ], { eggs: 2 } )
Coloque um espaço em branco antes e depois dos operadores:
# Correto
x = 1
y = x + 1
# Errado
x=1
y = x+1
Convenções de Nomenclatura
- Nomes de Funções e Variáveis: Deve-se usar letras minúsculas e underscores para separar palavras (
lower_case_with_underscores). - Nomes de Classes e Exceções: Use a convenção CapWords, onde a primeira letra de cada palavra é maiúscula (
CapWords). - Constantes: Utilize letras maiúsculas e underscores para separar palavras (
ALL_CAPS). - Métodos de Instância: Use
selfcomo o nome do primeiro argumento para métodos de instância. - Métodos de Classe: Use
clscomo o nome do primeiro argumento para métodos de classe.
Comentários
- Os comentários devem ser frases completas e devem ser usados para esclarecer o código e não são óbvios.
- Use comentários em linha com moderação e evite-os se o código já é claro.
Formatação de Docstrings
- Use “”” para strings de documentação (docstrings).
- Escreva docstrings para módulos, classes, métodos e funções públicas.
- As docstrings devem começar com uma linha que resume brevemente a funcionalidade e terminar com uma descrição mais detalhada.
Acordos de Codificação
- Não use codificações, a menos que seja necessário. O Python 3.x padrão para UTF-8, e o Python 2.x padrão para ASCII.
- Não coloque
from __future__ importem novos módulos. - Não use espaços em torno do sinal de igualdade quando usado para indicar um argumento de palavra-chave ou um valor de parâmetro padrão.
Seguir o PEP 8 pode melhorar significativamente a legibilidade e a qualidade do seu código Python, tornando-o mais fácil de entender e manter tanto para você quanto para outros desenvolvedores.
Se você quiser saber mais veja a documentação oficial do python, clicando aqui!
