PEP 8 - Guia de estilo para código Python

Miojo

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: 65.532 ]

Por: Artur Gaspar em 20/04/2010

6 0

Denuncie Favoritos Indicar Impressora

Tamanho da linha e linhas em branco

Tamanho da linha

Limite todas as linhas a 79 caracteres.

Ainda há muitos dispositivos que são limitados a 80 caracteres; mais, limitando o tamanho a 80 caracteres possibilita várias janelas lado-a-lado. O wrapping nesses dispositivos atrapalha a visualização do código. Portanto, por favor, limite todas as linhas a 79 caracteres. Para longos blocos de texto (docstrings ou comentários), limitar a 72 caracteres é recomendado.

A melhor maneira de acondicionar linhas longas é a continuação implícita entre parênteses, colchetes e chaves. Se for necessário, você pode colocar parênteses em volta da expressão, mas há casos onde a barra invertida (\) é melhor. E certifique-se de uma indentação correta na linha seguinte. O melhor lugar para quebra de linha em um operador binário é depois, não antes dele. Exemplo:

# Visualizado melhor com fonte monoespaçada
class Rectangle(Blob):
    def __init__(self, width, height,
                color='black', emphasis=None, highlight=0):
        if width == 0 and height == 0 and \
           color == 'red' and emphasis == 'strong' or \
           highlight > 100:
            raise ValueError("sorry, you lose")
        if width == 0 and height == 0 and (color == 'red' or
                                           emphasis is None):
            raise ValueError("I don't think so -- values are %s, %s" %
                             (width, height))
        Blob.__init__(self, width, height,
                      color, emphasis, highlight)

Linhas em branco

Separe funções de nível superior e definições de classe, com duas linhas em branco;
Definições de método dentro de uma classe são separadas por uma linha em branco;
Linhas em branco extras podem ser utilizados (com moderação) para separar grupos de funções. As linhas em branco podem ser omitidas entre um grupo de one-liners relacionado (por exemplo, um conjunto de implementações dummy);
Use linhas em branco em funções, com moderação, para indicar seções lógicas;
Python aceita o Ctrl-L (i.e. ^ L) for feed espaço em branco e muitas ferramentas tratam esses caracteres como separadores de página, assim você pode usá-los para separar páginas das seções relacionadas com o arquivo.

Página anterior 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

Scikit Learn: Projetando o futuro de suas APIs e aplicativos usando machine learning

Desenvolvendo aplicações GUI simples em Python & Glade (PyGTK) com banco de dados SQLite

Qu1cksc0pe - All-in-One Static Malware Analysis Tool

Como isolar seus projetos Python com virtualenv (ambiente virtual)

Integração do ChatGPT em uma API Python

Comentários