Article image
Paloma Falchi
Paloma Falchi05/06/2024 07:14
Compartilhe

Você sabe o que é PEP 8? - Guia para um Código Limpo e Eficiente

  • #Python

Python é popular por sua simplicidade e legibilidade. A PEP 8, um dos documentos chave da comunidade Python, fornece diretrizes de estilo que ajudam a manter a uniformidade do código, melhorando a estética, a eficiência no desenvolvimento e a colaboração entre desenvolvedores.

Mas você já ouviu falar em PEP 8?

A PEP 8 cobre diversos aspectos da escrita de código Python, complementados por outras boas práticas essenciais para a criação de código de alta qualidade

  • Indentação
  • Use quatro espaços por nível de indentação.
  • Não misture espaços com tabulações.
  • Comprimento das Linhas
  • Limite as linhas a 79 caracteres.
  • Quebra de Linhas
  • Use quebras de linha para expressões longas, com operadores no início da nova linha.
  • Espaços em Branco
  • Evite espaços desnecessários.
  • Use espaços em torno de operadores de atribuição e comparativos, mas não dentro de expressões entre parênteses.
  • Comentários
  • Use comentários para explicar o código.
  • Comentários de linha única devem começar com um espaço após o #.
  • Nomes de Variáveis e Funções
  • Use snake_case para nomes de variáveis e funções.
  • Use CamelCase para nomes de classes.
  • Importações
  • Coloque todas as importações no topo do arquivo.
  • Use uma importação por linha.

Conclusão

Seguir a PEP 8 e adotar boas práticas são essenciais para escrever código Python de alta qualidade. Essas práticas facilitam a leitura, manutenção e colaboração, resultando em software mais robusto e sustentável.

Referências

  1. PEP 8 – Style Guide for Python Code
  2. Python Software Foundation
  3. Google Python Style Guide
  4. Effective Python: 59 Specific Ways to Write Better Python
  5. Flake8 Documentation
Compartilhe
Comentários (1)
Jairo Junior
Jairo Junior - 05/06/2024 11:56

Tema importante!


Contribuo, informando sobre o porque não devemos misturar espaços com tabulações, para que tenhamos clareza, primeiro que são primeiros conceitos diferentes, exemplo de espaço;


" ",


Agora exemplo de tabulação


"\t".


Mas porque não devemos misturar espaços com tabulações?


Para obter Consistência, pois misturar espaços e tabulações pode levar a inconsistências na exibição do código, pois diferentes editores e visualizadores de código podem interpretar as tabulações de maneira diferente.


Por si só isso já evita muitos bugs!


Para evitar erros de sintaxe, pois em python, a indentação define blocos de código, e misturar espaços e tabulações pode resultar em erros de indentação difíceis de depurar, já que o Python trata espaços e tabulações de forma diferente ao analisar o código.


Vale a pena contruir códigos sobre a premissão do PEP8.


Continue a contribuir com esse tópico, para que tenhamos referência extendida para consulta.