Estilo de código
El proyecto Tryton recomienda firmemente el siguiente estilo de código:
Python
El estilo de código, en general, sigue PEP 8 y PEP 257:
- Usa 4 espacios para la indentación.
- Evita el uso de from M import *.
- Si tienes dudas sobre la conformidad, usa flake8 to check the code (with option ignore=E123,E124,E126,E128,E741,W503) y isort to check the imports (with the parameters -m VERTICAL_GRID -p trytond).
- Saltos de línea:
- Usa 4 espacios por par de corchetes.
- Prefiere paréntesis en lugar de barra invertida.
- Prefiere dividir líneas después del paréntesis de apertura.
- Usa comillas dobles para cadenas que son lenguaje natural, comillas simples para cadenas similares a símbolos y triples comillas dobles para docstrings multilínea.
XML
- Usa 4 espacios para la indentación.
- Sin limitación de 80 columnas.
- Etiqueta de apertura en una sola línea o un atributo por línea.
Mejores prácticas
Estas mejores prácticas ayudan a mantener el código consistente:
- Usa docstrings y comentarios en tu código.
- Never pass keyword arguments as positional arguments when calling a method.
- In the very beginning (right under the doc-string) of a method definition, define all pool objects that will be used (pool.get(...)).
Nomenclatura de módulos, clases y variables
- Un nombre debe ser tan descriptivo y corto como sea posible.
- Evita duplicar nombres innecesariamente.
- La estructura de nombres de un modelo o módulo debe seguir estas reglas:
- La primera parte del nombre es la función general del módulo o modelo,
- after this come the less general parts of the name (i.e. the more specific name parts) for the module or model
- Si tienes dudas sobre el nombre, pregunta primero en el #tryton channel
- Para módulos y nombres de métodos, usa un guion bajo para separar las partes del nombre.
- Para nombrar clases usa CamelCase.