Texto de: Lucas Galdino

Introdução

No mundo Python, é comum ouvirmos falar sobre alguma "Python Enhancement Proposal", ou PEP. As PEPs são documentos que descrevem propostas de melhorias para o Python e uma das PEPs mais famosas é a PEP8.

As diretrizes desse documento abrangem várias áreas, como convenções de nomenclatura para variáveis, funções e classes, estilo de indentação, espaçamento, comentários e outras práticas recomendadas para tornar o código Python mais legível e fácil de manter. Basicamente, esse documento é um guia de estilo para a linguagem.

Seguir as diretrizes do PEP 8 não é obrigatório, mas é amplamente recomendado pela comunidade Python, pois ajuda a garantir que o código seja compreensível por outros desenvolvedores e promove a consistência em projetos compartilhados. Existem até ferramentas de verificação de código que podem ajudar a automatizar a conformidade com o PEP 8 durante o desenvolvimento.

Outros PEPs

Existem várias PEPs que abordam uma ampla gama de tópicos relacionados ao desenvolvimento e ao ecossistema Python. Alguns exemplos de PEPs além do PEP 8 incluem:

1. PEP 20 (The Zen of Python): Esta PEP descreve os princípios orientadores e filosofia do Python. É uma coleção de princípios que ajudam a orientar o design da linguagem e a cultura da comunidade Python.
2. PEP 257 (Docstring Conventions): Esta PEP descreve convenções para escrever docstrings em Python, ou seja, strings de documentação que explicam o propósito e a funcionalidade de funções, métodos, módulos ou classes.
3. PEP 484 (Type Hints): Este PEP introduziu a capacidade de adicionar dicas de tipo opcional ao Python 3.5 e posterior, permitindo aos desenvolvedores especificar tipos de dados esperados e retornados por funções e métodos.
4. PEP 333 (Python Web Server Gateway Interface v1.0): Este PEP especifica uma interface padrão entre aplicativos web escritos em Python e servidores web, permitindo a interoperabilidade entre diferentes servidores e frameworks web.
5. PEP 572 (Assignment Expressions): Este PEP introduziu a sintaxe de expressões de atribuição (também conhecida como "walrus operator") em Python 3.8, permitindo atribuições dentro de expressões.

Existem muitas outras PEPs, cada uma abordando diferentes aspectos da linguagem Python, desde mudanças na sintaxe até melhorias na biblioteca padrão e no ecossistema de desenvolvimento. No site oficial podemos ver as diversas outras PEPs existentes.

Exemplos

Agora alguns exemplos de como se utilizar do PEP8 dentro do código em Python:

Limitação do Comprimento da Linha:

# Mantenha as linhas de código abaixo de 79 caracteres de comprimento
long_string = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."

Linhas em Branco:

# Use linhas em branco para separar definições de funções e classes
class MyClass:
    def __init__(self):
        pass

def my_function():
    pass

Comentários:

# Use comentários para explicar o código quando necessário
x = 42

def calculate_total(x, y):
    """
    Função para calcular o total de dois números.
    :param x: O primeiro número.
    :param y: O segundo número.
    :return: A soma dos dois números.
    """
    return x + y

Indentação e Espaçamento:

# Use 4 espaços para a indentação
if x < 5:
    print("Menor que 5")

# Use espaços consistentes ao redor de operadores
y = x * 2 + 5

Convenções de Nomenclatura:

# Variáveis e funções devem usar snake_case
my_variable = 42
def my_function():
    pass

# Classes devem usar CapWords (PascalCase)
class MyClass:
    def __init__(self):
        pass

Seguir estas diretrizes ajuda a tornar o código mais legível e fácil de entender para outros desenvolvedores, promovendo consistência em todo o código Python.

Estes são apenas alguns exemplos mais comuns, mas se você quiser pode acessar a lista completa de regras do PEP8 clicando aqui.

Conclusão

Apesar de não ser obrigatório, o uso do PEP8 é importante e efetivo dentro do seu código Python. Deixar seu código mais legível e segundo os padrões utilizados pela comunidade em geral pode ser benéfico de diversas formas.