Data	Versão	Alteração	Autor
23/08/2018	0.1	Criação do documento	Gabriel Ziegler
23/08/2018	0.2	Adição do conteúdo do estilo	Gabriel Ziegler
25/08/2018	0.3	Adição de exemplos de código python	Gabriel Ziegler

Folha de estilo do Django

Python Style

A folha de estilo da linguagem segue as especificações da PEP 8

• snake_case, não camelCase

Use:

class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

Não use:

class Person(models.Model):
    FirstName = models.CharField(max_length=20)
    Last_Name = models.CharField(max_length=40)

• Identação com 4 espaços

• Identação com 4 espaços para argumentos em mais de uma linha:

Use:

raise AttributeError(
    'Here is a multine error message '
    'shortened for clarity.'
)

Não use:

raise AttributeError('Here is a multine error message '
                     'shortened for clarity.')

• Aspas simples para strings

• Docstrings de funções seguem a PEP 257

def test_foo():
    """
    A test docstring looks like this (#123456).
    """
    ...

• A classe Meta deve aparecer sempre depois da definição dos atributos da classe separado por apenas UMA linha.

class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

    class Meta:
        verbose_name_plural = 'people'

• Template: no Django, o código da template deve ser separado por um espaço separando das chaves.

Use:

{{ foo }}

Não use:

{{foo}}

• View: o primeiro parâmetro de uma View deve ser chamado request

def my_view(request, foo):
    # ...