Histórico de versões

Data Versão Descrição Autor(es)
09/09 0.1 Primeiras regras de estilo Yudi Yamane

Estilo e formatação

Este documento explica o estilo de código Python usado no projeto. O estilo é baseado no PEP 8 com poucas modificações que serão explicadas abaixo juntamente com outros exemplos.

Para os curiosos, a ferramenta escolhida para verificar o estilo e formatação é o autopep8. Foi escolhida por ser flexível, popular e ter a opção de realizar a formatação automaticamente.

Antes de fazer push das suas alterações execute o linter (consulte o makefile para saber o comando).

Fique atento: este documento sobre estilo de código ainda está em desenvolvimento e ainda pode mudar.

Exemplos

Nomenclatura de variáveis, funções, classes, métodos etc

A linguagem Python não tem um padrão fixo para nomenclatura de variáveis e funções. Ainda assim existem algumas diretrizes gerais que são seguidas pela comunidade e que serão adotadas nesse projeto.

Use snake_case para nomes de variáveis e funções e use CamelCase para nomes de classes.

Tabs ou espaços?

Use 4 espaços para cada nível de indentação. Configure o tab para 4 espaços no seu editor de texto.

Faça assim:

def my_func():
    if (result == IS_OK)
        return True
    return False

Não faça assim:

def my_func():
  if (result == IS_OK)
    return True
  return False

Espaços em branco em expressões

Evite espaços em branco desnecessários.

Faça assim:

func(ham[1], {eggs: 2})

Não faça assim:

func( ham [ 1 ], { eggs : 2 } )

Coloque espaços entre os operadores de menor prioridade.

Faça assim:

i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

Não faça assim:

i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

Referências