Vamos cobrir as regras mais importantes e frequentemente usadas da PEP 8:

1. Indentação:

   • Use 4 espaços por nível de indentação.
   • NUNCA use tabulações (tabs) para indentação em código Python. Configure seu editor para converter Tab para 4 espaços.

   # Correto
   def minha_funcao():
       print("Hello")
       if True:
           print("World")
   
   # Incorreto
   def minha_funcao():
     print("Hello") # Apenas 2 espaços
   def minha_funcao():
   	print("Hello") # Usando tab
   
   

2. Linhas em Branco:

   • Duas linhas em branco para separar funções e classes de nível superior.
   • Uma linha em branco para separar métodos dentro de uma classe.
   • Use linhas em branco para organizar blocos lógicos de código e melhorar a legibilidade.

   class MinhaClasse:
       def __init__(self):
           pass# Uma linha em branco antes do próximo método
   
       def meu_metodo(self):
           pass 
   
   def minha_outra_funcao(): # Duas linhas em branco antes de uma nova função
       pass
   
   

3. Tamanho Máximo da Linha:

   • Limite todas as linhas a um máximo de 79 caracteres. Para docstrings e comentários, o limite é 72 caracteres.
   • Como quebrar linhas longas:
     • Use parênteses (), colchetes [] ou chaves {}.
     • Use a barra invertida \\ (mas evite, se possível, pois pode ser frágil).

   # Correto (quebra de linha implícita dentro de parênteses)
   minha_variavel_longa = (primeiro_item + segundo_item +
                           terceiro_item + quarto_item)
   
   # Incorreto (linha muito longa)
   #minha_variavel_longa = primeiro_item + segundo_item + terceiro_item + quarto_item + quinto_item
   
   

4. Nomenclatura:

   • Módulos e Pacotes: Nomes curtos, em minúsculas, com palavras separadas por _ (snake_case).
     • meu_modulo.py, utilitarios
   • Classes: CamelCase (palavras unidas, primeira letra de cada palavra maiúscula).
     • MinhaClasse, UsuarioModelo
   • Funções e Variáveis: snake_case (minúsculas, palavras separadas por _).
     • minha_funcao, nome_usuario, total_vendas
   • Constantes: Todas maiúsculas, com palavras separadas por _.
     • MAX_CONEXOES, PI
   • Variáveis/Métodos "Privados" (convenção): Comece com um underscore _ (ex: _minha_variavel_interna). Isso não impede o acesso, mas sinaliza que é para uso interno.
   • Variáveis/Métodos "Fortemente Privados" (name mangling): Comece com dois underscores __ (ex: __minha_variavel_muito_privada). Python renomeia isso para evitar colisões em herança. Use com cautela.

5. Espaços em Branco:

   • Sempre coloque um espaço depois de uma vírgula ,.
   • Sempre coloque um espaço ao redor de operadores (=, +, , ==, etc.).
   • Nunca use espaços imediatamente dentro de parênteses, colchetes ou chaves.

   # Correto
   a = 1 + 2
   lista = [1, 2, 3]
   dicionario = {'chave': 'valor'}
   funcao(arg1, arg2)
   
   # Incorreto
   a=1+2
   lista = [ 1, 2, 3 ]
   dicionario = { 'chave':'valor' }
   funcao( arg1,arg2 )
   
   

6. Importações:

   • Cada importação em uma linha separada.
   • Agrupadas na ordem: bibliotecas padrão, bibliotecas de terceiros, módulos locais.
   • Cada grupo separado por uma linha em branco.
   • Ordenadas alfabeticamente dentro de cada grupo.

   import os
   import sys
   
   import requests
   from django.conf import settings
   
   from meu_app.models import Usuario
   from .utils import helper_function
   
   

7. Comentários:

   • Mantenha os comentários atualizados.
   • Use # para comentários de linha única.
   • Use docstrings (strings de múltiplas linhas logo abaixo da definição de funções, classes, módulos) para explicar o propósito e o uso.

   def calcular_area_quadrado(lado):
       """
       Calcula a área de um quadrado.
   
       Args:
           lado (float): O comprimento do lado do quadrado.
   
       Returns:
           float: A área calculada.
       """
       # Garante que o lado seja positivo antes do cálculo
       if lado <= 0:
           raise ValueError("O lado deve ser um valor positivo.")
       return lado * lado