Domine a escrita de Códigos Python com PEP8 e suas bibliotecas

PEP 8: O Manual de Estilo Simplificado para Python

Pense em estar se divertindo com um conjunto de peças de montar. Você as arruma de forma que fiquem agradáveis e compreensíveis, não é mesmo? Pois bem, o PEP 8 é como um guia dessas regras para estruturar o seu código Python.

O que é o PEP 8 (Proposta de Aprimoramento Python)?

PEP é um acrônimo para: "Proposta de Aprimoramento Python" e seu número de identificação é o 8, apenas para referência. PEP 8 é um guia que fornece orientações para a escrita de códigos em Python de maneira clara e compreensível obedecendo uma convenção de escrita de código, com a intenção de manter o código consistente e legível.

Por que é importante?

Vamos fazer uma analogia onde você é o dono de um quarto de brinquedos, e quando você os organiza consegue entender onde coloca cada tipo de brinquedo, em qual prateleira estão os carros, em qual gaveta estão os lápis de cor, em qual armário estão os jogos de tabuleiro. Porém sem a devida identificação correta, somente você saberá onde estão as coisas dentro de seu deste quarto, sendo muito mais trabalhoso para uma pessoa conseguir encontrar os itens dentro deste quarto. Se ele estivesse organizado com os itens em ordem alfabética, com as nomenclaturas corretas e descritivas, não precisaria abrir as gavetas e armários uma um para verificar se o item procurado esta em seu interior. Poupando tempo e localizando o item mais facilmente se fosse de um mesmo padrão.

É nesse ponto que o PEP 8 entra em ação. Nos códigos Python ele serve como um guia de escrita dos códigos, declaração de nomes das variáveis, classes, objetos e assim por diante. Para melhor entender e localizar os itens dentro do seu código.

O que o PEP 8 nos ensina?

• Nomenclatura importante: Da mesma forma que você dá nomes aos seus objetos de diversão, o PEP 8 orienta a dar nomes significativos às nossas variáveis e funções.

 # Correto
nome = "João"
idade = 25
total_vendas = 1000

# Incorreto
n = "João"
i = 25
x = 1000

• Estabelece orientações sobre a utilização adequada de espaços e tabulações a fim de otimizar a organização do código. É similar a organizar sua escrivaninha para que todos os itens se encaixem perfeitamente.

# Correto
def minha_funcao():
  if x == 5:
      print("x é igual a 5")

# Incorreto
def minha_funcao():
if x == 5:
  print("x é igual a 5")

• Frases breves facilitam a leitura, não é mesmo? Assim como o PEP 8 recomenda que mantenhamos nossas linhas de código com um tamanho adequado para facilitar a compreensão.

# Correto
resultado = (variavel1 + variavel2 +
           variavel3 + variavel3 +
           variavel4 + variavel5 +
           variavel6 + variavel7)

# Incorreto
resultado = (variavel1 + variavel2 + variavel3 + variavel4 + variavel5 + variavel6 + variavel7)

• Comentários úteis são importantes, pois ajudam a melhorar a compreensão do código. Seguir as diretrizes do PEP 8 nos auxilia a criar comentários explicativos e que realmente acrescentam valor ao código.

# Correto
# Calcula a média de uma lista de números
def calcular_media(lista):
  total = sum(lista)
  return total / len(lista)

# Incorreto
# Função
def media(lista):
  # Soma
  total = sum(lista)
  # Média
  return total / len(lista)

• Coerência: Você aprecia quando todas as suas peças de Lego possuem dimensões iguais? Da mesma maneira, o PEP 8 nos pede para sermos consistentes em como escrevemos nosso código.

 # Correto
valor_total = 1000
taxa_de_desconto = 0.1

# Incorreto
ValorTotal = 1000
Taxa_de_Desconto = 0.1

Existem Bibliotecas que nos auxiliam para aplicarmos o PEP 8 ao nosso código, que automatizam e tronam nossos códigos mais legíveis e dentro dos padrões do mercado sem muito esforço:

Flake8:

• É um instrumento que examina seu código para garantir sua conformidade com o PEP 8 e outras normas de estilo. Ele examina seu código para encontrar questões importantes , como problemas de estilo ou erros de sintaxe. Combinando diversas ferramentas, como PyFlakes ,PyFlakes, PyCodestyle (o antigo Pep8) e McCabe, Estilo PyCodeFlake8 fornece uma análise de seu código.

pip install flake8

flake8 meu_codigo.py

Black:

• O Black é um instrumento de formatação de código que, de acordo com conforme diretrizes do PEP 8, reformata seu código de forma automática. Isso significa que ele aplica um estilo consistente e predefinido ao seu código sem exigir configuração adicional . O Black tem a capacidade de ser integrado ao seu fluxo de trabalho, formatando o código de forma automaticamente cada vez que você salva ou envia para controle de versão.

pip install black

black meu_codigo.py

ISort:

• ISort é uma ferramenta de classificação de importações que é organizada de forma consistente e legível como atualmente no topo de seus arquivos. Além das convenções do PEP 8, ele se reorganiza especificamente, agrupando em documentários e garantindo que sejam ordenadas alfabeticamente, visando manter a ordem e a legibilidade do seu código, o ISort pode ser benéfico para identificar e navegar pelas dependências do projeto.

pip install isort

isort meu_codigo.py

Essas ferramentas são amplamente utilizadas por toda a comunidade Python e podem ser integradas aos processos de desenvolvimento de softwares para garantir que o código esteja formatado, legível e compatível com as diretrizes do PEP8.

Isso ajudará a manter um estilo profissional e consistente em todos os projetos de desenvolvimento para garantir que o código esteja bem formatado, legível e em conformidade com as diretrizes PEP 8.

Vamos Disseminar os Conhecimentos e Transbordar Tudo o que Aprendemos!

Segue o Link do meu GitHub: https://github.com/Carlos-CGS

Segue o Link do meu LinkedIn: https://www.linkedin.com/in/carlos-cgs/

Referencias / Documentação: https://peps.python.org/pep-0008/