Estilo de código

Por favor siga esses padrões quando estiver escrevendo código para inclusão no Django.

Estilo Python

  • Por favor adapte-se ao estilo de identação ditado no arquivo .editorconfig. Nós recomendamos usar o editor de textos com suporte a EditorConfig para evitar problemas com identação e espaços em branco. Os arquivos Python usam 4 espaços para identação e os arquivos HTML usam 2 espaços.

  • Exceto quando indicado explicitamente, sempre siga a PEP 8.

    Utilize o flake8 para procurar por problemas nesta área. Note que o nosso arquivo de setup.cfg contém alguns arquivos excluídos (modulos depreciados que nós não nos importamos em limpar e algum código de terceiros que o Django oferece) assim como alguns erros excluídos que nós não consideramos como violações graves. Lembre-se de que a PEP 8 é apenas um guia, então tenha como objetivo principal o respeito ao estilo do código ao seu redor.

    Uma exceção a PEP 8 são nossas regras sobre o comprimento das linhas. Não limite linhas de código para 79 caracteres se isso significar deixar o código mais feio ou mais difícil de ler. Nós permitimos até 119 caracteres já que esse é o limite do revisor de código do GitHub; qualquer coisa mais longa que isso requer rolagem horizontal o que faz a revisão mais difícil. Essa verificação está incluída quando você roda o flake8. Documentação, comentários, e docstrings devem estar envolvidas em até 79 caracteres, mesmo que a PEP 8 sugira somente 72.

  • Utilize quatro espaços para identação.

  • Use four space hanging indentation rather than vertical alignment:

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

    Instead of:

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

    This makes better use of space and avoids having to realign strings if the length of the first line changes.

  • Use single quotes for strings, or a double quote if the the string contains a single quote. Don’t waste time doing unrelated refactoring of existing code to conform to this style.

  • Avoid use of “we” in comments, e.g. “Loop over” rather than “We loop over”.

  • Use underscores, not camelCase, for variable, function and method names (i.e. poll.get_unique_voters(), not poll.getUniqueVoters()).

  • Utilize IniciaisMaiúsculas para nomes de classes (ou para funções factory que retornem classes).

  • In docstrings, follow the style of existing docstrings and PEP 257.

  • In tests, use assertRaisesMessage() instead of assertRaises() so you can check the exception message. Use assertRaisesRegex() only if you need regular expression matching.

  • In test docstrings, state the expected behavior that each test demonstrates. Don’t include preambles such as “Tests that” or “Ensures that”.

    Reserve ticket references for obscure issues where the ticket has additional details that can’t be easily described in docstrings or comments. Include the ticket number at the end of a sentence like this:

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

Imports

  • Utilize isort para automatizar a ordenação dos imports usando as regras abaixo.

    Início Rápido:

    $ pip install isort
$ isort -rc .

    Isso roda o isort recursivamente do seu diretório atual, modificando quaisquer arquivos que não estejam de acordo com as orientações gerais. Se você precisa ter imports fora de ordem (para evitar um import circular, por exemplo) use um comentário como esse:

    import module  # isort:skip

  • Coloque os imports nesses grupos: future, bibliotecas padrão, bibliotecas de terceiros, outros componentes Django, componentes Django locais, try/excepts. Ordene as linhas em cada grupo por ordem alfabética pelo nome completo do módulo. Coloque todos os comandos do tipo import module antes de comandos do tipo from module import objects em cada uma das seções. Utilize absolute imports para outros componentes Django e local imports para componentes locais.

  • Em cada linha, deixe os itens em ordem alfabética colocando itens nomeados com IniciaisMaiúsculas agrupados antes dos itens nomeados com somente com minúsculas.

  • Quebre linhas longas usando parênteses e identando as linhas de continuação com 4 espaços. Inclua uma vírgula depois do último import e coloque o parênteses de fechamento em sua própria linha.

    Utilize uma única linha em branco entre o último import e qualquer código a nível de módulo, e utilize duas linhas em branco acima da primeira função ou classe.

    Por exemplo (os comentários existem somente para propósitos de explicação):

    django/contrib/admin/example.py
    # future
from __future__ import unicode_literals

# standard library
import json
from itertools import chain

# third-party
import bcrypt

# Django
from django.http import Http404
from django.http.response import (
    Http404, HttpResponse, HttpResponseNotAllowed, StreamingHttpResponse,
    cookie,
)

# local Django
from .models import LogEntry

# try/except
try:
    import yaml
except ImportError:
    yaml = None

CONSTANT = 'foo'


class Example:
    # ...

  • Utilize import de conveniência quando possível. Por exemplo, faça isso:

    from django.views import View

    ao invés de:

    from django.views.generic.base import View

Estilo dos templates

  • No código de templates Django, coloque um (e somente um) espaço entre as chaves e o conteúdo da tag.

    Faça isso:

    {{ foo }}

    Não faça isso:

    {{foo}}

Estilo de uma View

  • Nas views do Django, o primeiro parâmetro na função de uma view deve ser chamado request.

    Faça isso:

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

    Não faça isso:

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

Estilo de um Model

  • Os nomes dos campos devem ser todos minúsculos, usando underscores ao invés de camelCase.

    Faça isso:

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

    Não faça isso:

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

  • A classe Meta deve aparecer depois que os campos são declarados, com uma única linha em branco separando os campos da definição da classe.

    Faça isso:

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

    class Meta:
        verbose_name_plural = 'people'

    Não faça isso:

    class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)
    class Meta:
        verbose_name_plural = 'people'

    Não faça isso também:

    class Person(models.Model):
    class Meta:
        verbose_name_plural = 'people'

    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

  • A ordem dos modelos internos das classes e dos métodos padrão devem ser como a seguir (tendo em mente que eles não são todos obrigatórios):

    • Todos os campos do banco de dados
    • Atributos customizados do manager
    • classe Meta
    • def __str__()
    • def save()
    • def get_absolute_url()
    • Quaisquer métodos customizados.

  • Se choices está definido para um dado campo de um modelo, defina cada choice com uma tupla de tuplas, sendo que o nome da tupla deve ser escrito inteiramente em maiúsculas e a tupla deve ser um atributo de classe do modelo. Exemplo:

    class MyModel(models.Model):
    DIRECTION_UP = 'U'
    DIRECTION_DOWN = 'D'
    DIRECTION_CHOICES = (
        (DIRECTION_UP, 'Up'),
        (DIRECTION_DOWN, 'Down'),
    )

Utilização do django.conf.settings

Em geral os módulos não devem utilizar em seu topo configurações armazenadas em django.conf.settings (quando queremos que alguma configuração só seja interpretada quando o módulo é importado, por exemplo). A motivação para isso é a seguinte:

A configuração manual dos settings (não confiar na variável de ambiente DJANGO_SETTINGS_MODULE, por exemplo) é permitida e possível conforme segue:

from django.conf import settings

settings.configure({}, SOME_SETTING='foo')

Porém, se qualquer configuração é acessada antes da linha settings.configure, isso não irá funcionar (internamente, settings é um LazyObject que, caso não tenha sido configurado antes, se configura sozinho e automaticamente quando o settings é acessado).

Então, se existir um módulo contendo código como o descrito a seguir:

from django.conf import settings
from django.urls import get_callable

default_foo_view = get_callable(settings.FOO_VIEW)

A importação desse módulo fará com que o objeto settings seja configurado. Isso significa que a abilidade de importar módulos no topo por terceiros é incompatível com a abilidade de configurar o objeto settings manualmente, ou faz com que ela seja extremamente difícil em algumas circunstâncias.

Ao invés do código acima, um nível de laziness ou indireção deve ser usado, tais como django.utils.functional.LazyObject, django.utils.functional.lazy() ou lambda.

Variados

  • Marque todas as strings para internacionalização; veja a documentação i18n para mais detalhes.
  • Remova comandos `import` que não são mais usados quando você mudar o código. O flake8 irá identificar esses imports para você. Se um import não utilizado precisa permanecer para compatibilidade com versões anteriores, marque o seu final com # NOQA para silenciar o warning do flake8.
  • Remova sistematicamente todos os espaços em branco no final do seu código já que eles adicionam bytes desnecessários, adicionanm poluição visual aos patches e também podem eventualmente ocasionar conflitos de merge. Algumas IDEs podem ser configuradas para automaticamente removê-los e a maioria das ferramentas de versionamento de código podem ser configuradas para exibi-los na geração dos diffs.
  • Por favor não coloque o seu nome no código que você está contribuindo. Nossa política é de manter os nomes de quem contribui no arquivo AUTHORS distribuído com o Django – e não espalhado por todo o código do projeto. Sinta-se à vontade para incluir uma mudança no arquivo AUTHORS no seu patch se você fez mais do que uma mudança trivial.

Estilo JavaScript

Para detalhes sobre o estilo de código JavaScript adotado no Django, veja JavaScript.

Back to Top