Padrões de nomeação de variáveis, de acordo com a PEP 8

Seguir padrões de código é crucial porque melhora a legibilidade e a manutenção do código, facilita a colaboração entre desenvolvedores e reduz a probabilidade de erros. Padrões consistentes ajudam a garantir que o código seja compreensível e previsível, permitindo que outros programadores entendam rapidamente o trabalho e contribuam de forma eficaz. Além disso, um código bem estruturado e padronizado facilita a identificação e correção de problemas, tornando o processo de desenvolvimento mais eficiente e menos propenso a bugs.

As PEP são recomendações oficiais da python.org para padronização e estilo de código. Na dúvida de como seu código deve ser escrito, siga sempre as PEPs. A PEP 8 especificamente traz orientações gerais a respeito de estilo de código Python:

Ler a PEP 8 →

Segue um excerto desse documento que fala sobre convenção de nomes de variáveis:

“Function names should be lowercase, with words separated by underscores as necessary to improve readability.

Variable names follow the same convention as function names.”

Esse trecho fala sobre o “snake_case”, um formato de nome de variável com todas as letras minúsculas e separadas por underscores.

Utilize sempre o snake_case para suas variáveis, e tente sempre dar nomes descritivos a elas. Por exemplo:

user_age = 25
file_path = "/path/to/file.txt"
is_valid = True
student_name = "Alice"

Já as classes devem seguir um outro padrão:

”Class names should normally use the CapWords convention.”

Essa convenção é também conhecida como PascalCase, na qual as palavras são capitalizadas (primeira letra maiúscula) e não há espaços nem underscores separando-as. Por exemplo:

class CustomerOrderHistory:
    def __init__(self, customer_id, order_list):
        self.customer_id = customer_id
        self.order_list = order_list

Por fim, as constantes também seguem uma padronização. No Python, constantes são valores que nunca mais serão alterados após sua definição. A convenção é usar nomes em maiúsculas para indicar que um valor é constante. Exemplo:

PI = 3.14

def area_circle(radius):
    return PI * (radius ** 2)