Como utilizar o PEP 8 para escrever código facilmente?
[
Como Escrever Código Python Bonito de Acordo com o PEP 8
PEP 8 é um documento que fornece diretrizes e melhores práticas sobre como escrever código Python. Foi escrito em 2001 por Guido van Rossum, Barry Warsaw e Alyssa Coghlan. O principal objetivo do PEP 8 é melhorar a legibilidade e a consistência do código Python.
Ao final deste tutorial, você será capaz de:
- Escrever código Python que segue o PEP 8
- Entender a razão por trás das diretrizes estabelecidas no PEP 8
- Configurar seu ambiente de desenvolvimento para que você possa começar a escrever código Python de acordo com o PEP 8
PEP significa Python Enhancement Proposal e existem muitos PEPs. Estes documentos descrevem principalmente novos recursos propostos para a linguagem Python, mas alguns PEPs também se concentram em design e estilo e têm como objetivo servir como um recurso para a comunidade. O PEP 8 é um desses PEPs focados em estilo.
Neste tutorial, você vai abordar as diretrizes principais estabelecidas no PEP 8. Você vai explorar tópicos de programação do básico ao intermediário. Você pode aprender sobre tópicos mais avançados lendo a documentação completa do PEP 8.
Por que precisamos do PEP 8
”A legibilidade conta.”
- O Zen do Python
Como Guido van Rossum disse, “O código é lido muito mais vezes do que é escrito.” Você pode gastar alguns minutos, ou um dia inteiro, escrevendo um trecho de código para processar autenticação de usuário. Depois de escrevê-lo, você nunca mais o escreverá novamente.
Mas certamente você terá que lê-lo novamente. Aquele trecho de código pode fazer parte de um projeto em que está trabalhando. Toda vez que você voltar para aquele arquivo, terá que lembrar o que aquele código faz e por que você o escreveu, então a clareza é fundamental.
Convenções de Nomenclatura
Uma das principais seções do PEP 8 aborda as convenções de nomenclatura, que se referem às regras de como nomear variáveis, funções, classes e outros elementos em Python.
Estilos de Nomenclatura
Existem diferentes estilos de nomenclatura que podem ser usados ao escrever código Python, mas o mais comum é o snake_case, onde todas as letras minúsculas são usadas, separando as palavras com um underscore _.
Além disso, o PEP 8 recomenda usar nomes descritivos para variáveis, funções e classes, de modo que seja fácil entender o propósito e o funcionamento desses elementos apenas ao ler os nomes.
Como Escolher Nomes
Ao escolher nomes para variáveis, funções e classes em Python, é importante seguir algumas diretrizes:
- Use nomes significativos e descritivos que indiquem claramente o propósito do elemento.
- Evite nomes genéricos, como
dataoutemp, que podem causar confusão. - Se possível, use nomes pronunciáveis para facilitar a leitura e compreensão do código.
- Evite nomes muito longos e complexos, que podem dificultar a leitura do código.
Layout do Código
Outro aspecto abordado pelo PEP 8 é o layout do código, que se refere à formatação e à organização visual do código Python. Seguir as diretrizes de layout do PEP 8 pode tornar o código mais legível e fácil de entender.
Linhas em Branco
O PEP 8 recomenda o uso de linhas em branco para separar logicamente partes do código Python. Por exemplo, é comum usar linhas em branco para separar classes, funções e blocos de código dentro de uma função.
Comprimento Máximo da Linha e Quebra de Linha
O PEP 8 estabelece um limite de 79 caracteres para o comprimento máximo de uma linha de código. Quando uma linha de código excede esse limite, é recomendado quebrar a linha em várias linhas menores para melhor legibilidade.
Indentação
A indentação correta é crucial em Python, pois ela define a estrutura e a hierarquia do código. O PEP 8 fornece diretrizes claras para a indentação correta do código Python.
Tabs versus Espaços
O PEP 8 recomenda o uso de espaços em branco em vez de tabulações para indentar o código Python. Recomenda-se usar quatro espaços para cada nível de indentação.
Indentação Após Quebra de Linha
O PEP 8 também aborda a indentação correta após uma quebra de linha em operações longas ou quando se deseja continuar uma linha anterior em uma nova linha.
Onde Colocar o Fechamento de Chaves
O PEP 8 recomenda colocar o fechamento de chaves em uma nova linha após o código que as abre, a menos que a abertura e o fechamento possam ficar na mesma linha sem que isso comprometa a legibilidade do código.
Comentários
Comentários são partes do código Python que são ignoradas pelo interpretador. Eles são usados para fornecer explicações, esclarecimentos ou documentação sobre o código. O PEP 8 fornece diretrizes sobre como usar comentários em seu código Python.
Comentários de Bloco
Os comentários de bloco são usados para fornecer explicações ou esclarecimentos sobre blocos de código maiores. Eles devem ser escritos em linhas separadas e começar com # seguido de um espaço em branco.
Comentários em Linha
Os comentários em linha são usados para fornecer explicações ou esclarecimentos sobre uma única linha de código. Eles devem ser escritos na mesma linha de código, após um ou dois espaços em branco.
Strings de Documentação
As strings de documentação, ou docstrings, são usadas para documentar classes, funções e métodos em Python. Elas devem ser escritas logo após a definição do elemento e detalhar o propósito e o funcionamento do elemento.
Espaços em Branco em Expressões e Declarações
O uso adequado de espaços em branco em expressões e declarações pode melhorar a legibilidade do código Python. O PEP 8 fornece diretrizes sobre como usar espaços em branco nessas situações.
Espaços ao Redor de Operadores Binários
O PEP 8 recomenda o uso de um espaço em branco antes e depois de operadores binários, como +, -, *, /, etc. Isso melhora a legibilidade do código.
Quando Evitar Adicionar Espaços em Branco
Existem algumas situações em que é recomendado não adicionar espaços em branco em torno de elementos, como parênteses em expressões matemáticas, os dois pontos após uma declaração if, for, while, etc.
Recomendações de Programação
O PEP 8 também inclui algumas recomendações gerais sobre como escrever código Python de maneira mais eficiente e legível. Essas recomendações incluem:
- Evitar linhas em branco extras no final do arquivo.
- Evitar a repetição desnecessária de código.
- Usar a técnica de early exits para diminuir a complexidade de um código.
- Manter o código simples e conciso.
Quando Ignorar o PEP 8
Embora o PEP 8 seja um guia útil para escrever código Python legível, há momentos em que é necessário ignorar algumas de suas diretrizes. Por exemplo, quando se está trabalhando em um projeto com um guia de estilo diferente, ou quando a aderência estrita ao PEP 8 prejudicaria a legibilidade do código existente.
Dicas e Truques para Garantir que seu Código Esteja em Conformidade com o PEP 8
Existem algumas ferramentas e técnicas que podem ajudar a garantir que seu código Python esteja em conformidade com o PEP 8. Estas incluem:
- Linters (Verificadores de Código): são ferramentas que verificam automaticamente o código Python em busca de erros de estilo e conformidade com o PEP 8.
- Autoformatadores: são ferramentas que reformatam automaticamente o código Python para seguir as diretrizes do PEP 8.
- Ferramentas Combinadas: algumas ferramentas combinam as funcionalidades de linters e autoformatadores, oferecendo uma solução abrangente para garantir a conformidade com o PEP 8.
Conclusão
O PEP 8 é um recurso valioso para os desenvolvedores Python que desejam escrever código bonito e legível. Seguir as diretrizes do PEP 8 pode tornar seu código mais fácil de entender e colaborar com outros desenvolvedores. No entanto, lembre-se de que o PEP 8 é um guia, e não uma regra rígida. Em alguns casos, pode ser necessário adaptar as diretrizes para atender às necessidades específicas de um projeto. No geral, a legibilidade e a consistência devem ser priorizadas ao escrever código Python.
