PEP 8 - Guia de estilo para código Python

Este artigo é uma tradução/adaptação da PEP 8 - Style Guide for Python Code, de Guido van Rossum e Barry Warsaw, que mostra as convenções para escrever código Python.

[ Hits: 49.010 ]

Por: Artur Gaspar em 20/04/2010


Introdução



Para ver o documento original (em inglês), acesse: http://www.python.org/dev/peps/pep-0008/

Este documento fornece as convenções de estilo para o código Python, incluindo a biblioteca padrão na distribuição Python principal.

Para informações sobre as convenções para C no CPython (a implementação padrão), consulte a PEP 7. Esta PEP pode ainda estar incompleta (na verdade, ela pode nunca ser terminada).

Uma das ideias-chave de Guido é que o código é lido com muito mais frequência do que é escrito. As orientações fornecidas aqui são destinadas a melhorar a legibilidade do código e torná-lo coerente em todo o amplo espectro de código Python. Como diz a PEP 20 (The Zen of Python), "Readability counts" (legibilidade conta).

Um guia de estilo fala sobre de coerência. Coerência com este guia de estilo é importantes. Coerência dentro de um projeto é mais importante. Coerência dentro de um módulo ou função é ainda mais importante.

Mas o mais importante: saber quando ser inconsistente - às vezes o guia de estilo simplesmente não se aplica a algum caso.

Quando em dúvida, use o bom senso. Veja outros exemplos e decida o que fica melhor. E não hesite em perguntar!

Dois bons motivos para quebrar uma regra:
  1. Quando a aplicação da regra tornaria o código menos legível
  2. Para ser coerente com código que também quebra-o (talvez por razões históricas) - embora esta seja também uma oportunidade para limpar a bagunça de alguém.

Tabs ou espaços?

Nunca misture tabs e espaços.

Para indentação, use 4 espaços.

Para projetos mais antigos que você não queira bagunçar, use uma tab, que é equivalente a 8 espaços.

A indentação mais popular no Python são os espaços. A segunda mais popular são as tabs. Código que usa as duas indentações deve ser convertido para espaços apenas. Quando invocado com a opção -t, o interpretador mostra avisos com uso de tabs e espaços no mesmo código. Quando é invocado com -tt, os avisos se tornam erros. Essas opções são altamente recomendadas.

Para novos projetos, use espaços. Há vários editores com ferramentas para facilitar isso.

    Próxima página

Páginas do artigo
   1. Introdução
   2. Tamanho da linha e linhas em branco
   3. Codificação e importações
   4. Espaços em branco
   5. Comentários e docstrings
   6. Escrituração de versão e convenções de nomenclatura
   7. Recomendações de programação
   8. PEP 20 - The Zen of Python - de Tim Peters
Outros artigos deste autor

Instalando e configurando o VirtualBox

Leitura recomendada

Python - Uma linguagem orientada a objetos

Como criar um bot para curtir e comentar perfis do Instagram

ISO8583py - Utilizando Python para o tratamento de mensagens ISO8583

Sockets em Python

Python + ADB

  
Comentários
[1] Comentário enviado por removido em 20/04/2010 - 12:00h

Muito bom.


Contribuir com comentário




Patrocínio

Site hospedado pelo provedor RedeHost.
Linux banner
Linux banner
Linux banner

Artigos

Dicas

Tópicos

Top 10 do mês

Scripts