Styleguide¶

Imports¶

Like in Python import conventions in Translate styleguide, but imports should be grouped in the following order:

1. __future__ library imports
2. Python standard library imports
3. Third party libraries imports (Including Translate Toolkit ones)
4. Django imports
5. Django external apps imports
6. Other Pootle apps imports
7. Current package (or app) imports, using explicit relative imports (See PEP 328)

Check Python import conventions in Translate styleguide for other conventions that the imports must follow.

import re
import sys.path as sys_path
import time
from datetime import timedelta
from os import path

from lxml.html import fromstring
from translate.storage import versioncontrol

from django.contrib.sites.models import Site
from django.db import models
from django.db.models import Q
from django.db.models.signals import post_save

from tastypie.models import ApiKey

from pootle_language.models import Language
from pootle_translationproject.models import TranslationProject

from .forms import GoalForm
from .models import Tag

Order in models¶

Model’s inner classes and methods should keep the following order:

• Database fields
• Non database fields
• Default objects manager
• Custom manager attributes (i.e. other managers)
• class Meta
• def natural_key() (Because it is tightly related to model fields)
• Properties
• Any method decorated with @classmethod
• def __unicode__()
• def __str__()
• Any other method starting with __ (for example __init__())
• def save()
• def delete()
• def get_absolute_url()
• def get_translate_url()
• Any custom methods

Fields in models and forms¶

• If the field declaration fits in one line:
  • Put all the options on that line,
  • Don’t put a comma after the last option,
  • The parenthesis that closes the field declaration goes just after the last option.
• If the field declaration spans to several lines:
  • Each option goes on its own line (including the first one),
  • The options are indented 4 spaces,
  • The last option must have a comma after it,
  • The closing parenthesis in the field declaration goes on its own line, aligned with the first line in the field declaration.

class SampleForm(forms.Form):
    # Field declaration that spans to several lines.
    language = forms.ChoiceField(
        label=_('Interface Language'),
        initial="",
        required=False,
        widget=forms.Select(attrs={
            'class': 'js-select2 select2-language',
        }),
        help_text=_('Default language for using on the user interface.'),
    )
    # One line field declaration.
    project = forms.ModelChoiceField(Project, required=True)

URL patterns¶

When writing the URL patterns:

• URL patterns can be grouped by putting a blank line between the groups.
• On each URL pattern:
  • Specify the URL pattern using the url() function, not a tuple.
  • Each parameter must go on its own line in all cases, indenting them one level to allow easily seeing the different URL patterns.
  • In URLs:
    • Use hyphens, never underscores.
    • To split long URLs use implicit string continuation. Note that URLs are raw strings.
• URL pattern names must be named like pootle-{app}-{view} (except in some specific cases):
  • {app} is the app name, which sometimes can be shortened, e.g. using tp to avoid the longish translationproject. The chosen app name must be used consistently across all the URL patterns for the app.
  • {view} is a unique string which might consist on several words, separated with hyphens, that might not match the name of the view that is handled by the URL pattern.
  • The exceptions to this naming convention are:
    • URL patterns for AJAX views must be named like pootle-xhr-{view}.
    • URL patterns in pootle_app app must be named like:
      • pootle_app admin URLs must be named like pootle-admin-{view}
      • Other pootle_app URLs must be named like pootle-{view}.

urlpatterns = patterns('pootle_project.views',
    # Listing of all projects.
    url(r'^$',
        'projects_index'),

    # Whatever URLs.
    url(r'^incredibly-stupid/randomly-long-url-with-hyphens-that-is-split-'
        r'and-continued-on-next-line.html$',
        'whatever',
        name='pootle-project-whatever'),

    # Admin URLs.
    url(r'^(?P<project_code>[^/]*)/admin.html$',
        'project_admin'),
    url(r'^(?P<project_code>[^/]*)/permissions.html$',
        'project_admin_permissions',
        name='pootle-project-admin-permissions'),
)

Variables naming¶

In order to have a more consistent code the use of specific names for some heavily used variables is encouraged:

• ctx: Name for the dictionary with the context passed to a template for rendering. Also known as context, template variables or template vars.

  # Good.
  ctx = {
      'language': language,
  }
  
  
  # Bad.
  context = {
    ...
  
  templatevars = {
    ...
  
  template_vars = {
    ...
  

Settings naming¶

Pootle specific settings must be named like POOTLE_*, for example: POOTLE_ENABLE_API, POOTLE_VCS_DIRECTORY or POOTLE_MARKUP_FILTER