From dfcbcb02cea2b2f5c996933ea1d813e51da5f9d6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9rome=20Maes?= <jem@openerp.com>
Date: Wed, 6 Apr 2016 14:33:43 +0200
Subject: [PATCH] [IMP] doc : add python idioms and odoo specific coding
guidelines
- add python idioms
- odoo specific guidelines (for ORM, translations, ...) inspired from old guidelines v6.0
- some other best pratices
---
doc/reference/guidelines.rst | 537 ++++++++++++++++++++++++++++++++---
1 file changed, 496 insertions(+), 41 deletions(-)
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst
index ad33f2ba56d6..5ae52963b42f 100644
--- a/doc/reference/guidelines.rst
+++ b/doc/reference/guidelines.rst
@@ -6,7 +6,7 @@
Odoo Guidelines
===============
-This page introduce the new Odoo Coding Guidelines. These guidelines aim to improve the quality of the code (better readability of source, ...) and Odoo Apps. Indeed, proper code ought ease maintenance, aid debugging, lower complexity and promote reliability.
+This page introduces the new Odoo Coding Guidelines. Those aim to improve the quality of the code (e.g. better readability of source) and Odoo Apps. Indeed, proper code eases maintenance, aids debugging, lowers complexity and promotes reliability.
These guidelines should be applied to every new module, and new developpment. These guidelines will be applied to old module **only** in case of code refactoring (migration to new API, big refactoring, ...).
@@ -23,7 +23,7 @@ Module structure
Directories
-----------
-A module is organised in some important directories. These directories aim to contain the business core of the module; having a look at them should make understand the purpose of the module.
+A module is organised in important directories. Those contain the business logic; having a look at them should make understand the purpose of the module.
- *data/* : demo and data xml
- *models/* : models definition
@@ -31,10 +31,9 @@ A module is organised in some important directories. These directories aim to co
- *views/* : contains the views and templates
- *static/* : contains the web assets, separated into *css/, js/, img/, lib/, ...*
-Other directories compose the module.
+Other optional directories compose the module.
-- *data/* : contains the data (in XML form)
-- *wizard/* : regroup the transient models (formerly *osv_memory*) and their views.
+- *wizard/* : regroups the transient models (formerly *osv_memory*) and their views.
- *report/* : contains the reports (RML report **[deprecated]**, models based on SQL views (for reporting) and other complex reports). Python objects and XML views are included in this directory.
- *tests/* : contains the Python/YML tests
@@ -62,17 +61,17 @@ For instance, *sale* module introduces ``sale_order`` and
For *data*, split them by purpose : demo or data. The filename will be
the main_model name, suffixed by *_demo.xml* or *_data.xml*.
-For *controllers*, the only file should be named *main.py*. Otherwise, if you need to inherit an existing controller from another module, its name will be *<module_name>.py*. Unlike *models*, each controller should be contained in a separated file.
+For *controllers*, the only file should be named *main.py*. Otherwise, if you need to inherit an existing controller from another module, its name will be *<module_name>.py*. Unlike *models*, each controller class should be contained in a separated file.
For *static files*, since the resources can be used in different contexts (frontend, backend, both), they will be included in only one bundle. So, CSS/Less, JavaScript and XML files should be suffixed with the name of the bundle type. i.e.: *im_chat_common.css*, *im_chat_common.js* for 'assets_common' bundle, and *im_chat_backend.css*, *im_chat_backend.js* for 'assets_backend' bundle.
-For modules having only one file, the convention will be *<module_name>.ext* (i.e.: *project.js*).
-Don't link data (image, libraries) outside Odoo: don't use an
+If the module owns only one file, the convention will be *<module_name>.ext* (i.e.: *project.js*).
+Don't link data (image, libraries) outside Odoo: do not use an
URL to an image but copy it in our codebase instead.
-For *data*, split them by purpose: data or demo. The filename will be
+Regarding *data*, split them by purpose: data or demo. The filename will be
the *main_model* name, suffixed by *_data.xml* or *_demo.xml*.
-For *wizards*, the naming convention is :
+Regarding *wizards*, naming convention is :
- :file:`{<main_transient>}.py`
- :file:`{<main_transient>}_views.xml`
@@ -180,7 +179,7 @@ To declare a record in XML, the **record** notation (using *<record>*) is recomm
</field>
</record>
-Some syntax equivalences exists, and can be used:
+Odoo supports custom tags acting as syntactic sugar:
- menuitem: use it as a shortcut to declare a ``ir.ui.menu``
- workflow: the <workflow> tag sends a signal to an existing workflow.
@@ -308,7 +307,7 @@ Imports
The imports are ordered as
#. External libraries (one per line sorted and split in python stdlib)
-#. Imports of ``openerp``
+#. Imports of ``odoo``
#. Imports from Odoo modules (rarely, and only if necessary)
Inside these 3 groups, the imported lines are alphabetically sorted.
@@ -320,39 +319,480 @@ Inside these 3 groups, the imported lines are alphabetically sorted.
import re
import time
from datetime import datetime
- # 2 : imports of openerp
- import openerp
- from openerp import api, fields, models # alphabetically ordered
- from openerp.tools.safe_eval import safe_eval as eval
- from openerp.tools.translate import _
+ # 2 : imports of odoo
+ import odoo
+ from odoo import api, fields, models # alphabetically ordered
+ from odoo.tools.safe_eval import safe_eval as eval
+ from odoo.tools.translate import _
# 3 : imports from odoo modules
- from openerp.addons.website.models.website import slug
- from openerp.addons.web.controllers.main import login_redirect
+ from odoo.addons.website.models.website import slug
+ from odoo.addons.web.controllers.main import login_redirect
-Idioms
-------
+Idiomatics Python Programming
+-----------------------------
-- Prefer ``%`` over ``.format()`` (when only one variable to replace in a string), prefer ``%(varname)`` instead of position (when multiple variables are to be replaced in a string). This makes the translation easier for the translators community.
-- Avoid to create generators and decorators: only use the ones provide by the Odoo API.
-- Always favor *readability* over *conciseness* or using the language features or idioms.
-- Use list comprehension, dict comprehension, and basic manipulation using ``map``, ``filter``, ``sum``, ... They make the code easier to read.
-- The same applies for recordset methods : use ``filtered``, ``mapped``, ``sorted``, ...
- Each python file should have ``# -*- coding: utf-8 -*-`` as first line.
-- Document your code (docstring on methods, simple comments for the tricky part of the code)
-- Use meaningful variable/class/method names.
-- Every method used to compute data for a 'stat button' should use a ``read_group`` or a SQL query. This aims to improve performance (by computing data in only on query).
+- Always favor *readability* over *conciseness* or using the language features or idioms.
+- Don't use ``.clone()``
+.. code-block:: python
-Symbols
--------
+ # bad
+ new_dict = my_dict.clone()
+ new_list = old_list.clone()
+ # good
+ new_dict = dict(my_dict)
+ new_list = list(old_list)
+
+- Python dictionnary : creation and update
+
+.. code-block:: python
+
+ # -- creation empty dict
+ my_dict = {}
+ my_dict2 = dict()
+
+ # -- creation with values
+ # bad
+ my_dict = {}
+ my_dict['foo'] = 3
+ my_dict['bar'] = 4
+ # good
+ my_dict = {'foo': 3, 'bar': 4}
+
+ # -- update dict
+ # bad
+ my_dict['foo'] = 3
+ my_dict['bar'] = 4
+ my_dict['baz'] = 5
+ # good
+ my_dict.update(foo=3, bar=4, baz=5)
+ my_dict = dict(my_dict, **my_dict2)
+
+- Use meaningful variable/class/method names
+- Useless variable : Temporary variables can make the code clearer by giving
+ names to objects, but that doesn't mean you should create temporary variables
+ all the time:
+
+.. code-block:: python
+
+ # pointless
+ schema = kw['schema']
+ params = {'schema': schema}
+ # simpler
+ params = {'schema': kw['schema']}
+
+- Multiple return points are OK, when they're simpler
+
+.. code-block:: python
+
+ # a bit complex and with a redundant temp variable
+ def axes(self, axis):
+ axes = []
+ if type(axis) == type([]):
+ axes.extend(axis)
+ else:
+ axes.append(axis)
+ return axes
+
+ # clearer
+ def axes(self, axis):
+ if type(axis) == type([]):
+ return list(axis) # clone the axis
+ else:
+ return [axis] # single-element list
+
+- Know your builtins : You should at least have a basic understanding of all
+ the Python builtins (http://docs.python.org/library/functions.html)
+
+.. code-block:: python
+
+ value = my_dict.get('key', None) # very very redundant
+ value= my_dict.get('key') # good
+
+Also, ``if 'key' in my_dict`` and ``if my_dict.get('key')`` have very different
+meaning, be sure that you're using the right one.
+
+- Learn list comprehensions : Use list comprehension, dict comprehension, and
+ basic manipulation using ``map``, ``filter``, ``sum``, ... They make the code
+ easier to read.
+
+.. code-block:: python
+
+ # not very good
+ cube = []
+ for i in res:
+ cube.append((i['id'],i['name']))
+ # better
+ cube = [(i['id'], i['name']) for i in res]
+
+- Collections are booleans too : In python, many objects have "boolean-ish" value
+ when evaluated in a boolean context (such as an if). Among these are collections
+ (lists, dicts, sets, ...) which are "falsy" when empty and "truthy" when containing
+ items:
+
+.. code-block:: python
+
+ bool([]) is False
+ bool([1]) is True
+ bool([False]) is True
+
+So, you can write ``if some_collection:`` instead of ``if len(some_collection):``.
+
+
+- Iterate on iterables
+
+.. code-block:: python
+
+ # creates a temporary list and looks bar
+ for key in my_dict.keys():
+ "do something..."
+ # better
+ for key in my_dict:
+ "do something..."
+ # creates a temporary list
+ for key, value in my_dict.items():
+ "do something..."
+ # only iterates
+ for key, value in my_dict.iteritems():
+ "do something..."
+
+- Use dict.setdefault
+
+.. code-block:: python
+
+ # longer.. harder to read
+ values = {}
+ for element in iterable:
+ if element not in values:
+ values[element] = []
+ values[element].append(other_value)
+
+ # better.. use dict.setdefault method
+ values = {}
+ for element in iterable:
+ values.setdefault(element, []).append(other_value)
+
+- As a good developper, document your code (docstring on methods, simple
+ comments for tricky part of code)
+- In additions to these guidelines, you may also find the following link
+ interesting: http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html
+ (a little bit outdated, but quite relevant)
+
+Programming in Odoo
+-------------------
+
+- Avoid to create generators and decorators: only use the ones provided by
+ the Odoo API.
+- As in python, use ``filtered``, ``mapped``, ``sorted``, ... methods to
+ ease code reading and performance.
+
+
+Make your method works in batch
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+When adding a function, make sure it can process multiple records. Typically,
+such method is decorated with ``api.multi`` decorator (or takes a list of *id*,
+if written in old api). Then you will have to iterate on ``self`` to treat each
+record.
+
+.. code-block:: python
+
+ @api.multi
+ def my_method(self)
+ for record in self:
+ record.do_cool_stuff()
+
+Avoid to use ``api.one`` decorator : this will probably not do what you expected,
+and extending a such method is not as easy than a *api.multi* method, since it
+returns a list of result (ordered by recordset ids).
+
+For performance issue, when developping a 'stat button' (for instance), do not
+perform a ``search`` or a ``search_count`` in a loop in a ``api.multi`` method. It
+is recommended to use ``read_group`` method, to compute all value in only one request.
+
+.. code-block:: python
+
+ @api.multi
+ def _compute_equipment_count(self):
+ """ Count the number of equipement per category """
+ equipment_data = self.env['hr.equipment'].read_group([('category_id', 'in', self.ids)], ['category_id'], ['category_id'])
+ mapped_data = dict([(m['category_id'][0], m['category_id_count']) for m in equipment_data])
+ for category in self:
+ category.equipment_count = mapped_data.get(category.id, 0)
+
+
+Propagate the context
+~~~~~~~~~~~~~~~~~~~~~
+In new API, the context is a ``frozendict`` that cannot be modified. To call
+a method with a different context, the ``with_context`` method should be used :
+
+.. code-block:: python
+
+ records.with_context(new_context).do_stuff() # all the context is replaced
+ records.with_context(**additionnal_context).do_other_stuff() # additionnal_context values override native context ones
+
+Passing parameter in context can have dangerous side-effects. Since the values
+are propagated automatically, some behavior can appears. Calling ``create()``
+method of a model with *default_my_field* key in context will set the default
+value of *my_field* for the concerned model. But if curing this creation, other
+object (such as sale.order.line, on sale.order creation) having a field
+name *my_field*, their default value will be set too.
+
+If you need to create a key context influencing the behavior of some object,
+choice a good name, and eventually prefix it by the name of the module to
+isolate its impact. A good example are the keys of ``mail`` module :
+*mail_create_nosubscribe*, *mail_notrack*, *mail_notify_user_signature*, ...
+
+
+Do not bypass the ORM
+~~~~~~~~~~~~~~~~~~~~~
+You should never use the database cursor directly when the ORM can do the same
+thing! By doing so you are bypassing all the ORM features, possibly the
+transactions, access rights and so on.
+
+And chances are that you are also making the code harder to read and probably
+less secure.
+
+.. code-block:: python
+
+ # very very wrong
+ self.env.cr.execute('SELECT id FROM auction_lots WHERE auction_id in (' + ','.join(map(str, ids))+') AND state=%s AND obj_price > 0', ('draft',))
+ auction_lots_ids = [x[0] for x in self.env.cr.fetchall()]
+
+ # no injection, but still wrong
+ self.env.cr.execute('SELECT id FROM auction_lots WHERE auction_id in %s '\
+ 'AND state=%s AND obj_price > 0', (tuple(ids), 'draft',))
+ auction_lots_ids = [x[0] for x in self.env.cr.fetchall()]
+
+ # better
+ auction_lots_ids = self.search([('auction_id','in',ids), ('state','=','draft'), ('obj_price','>',0)])
+
+
+No SQL injections, please !
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Care must be taken not to introduce SQL injections vulnerabilities when using
+manual SQL queries. The vulnerability is present when user input is either
+incorrectly filtered or badly quoted, allowing an attacker to introduce
+undesirable clauses to a SQL query (such as circumventing filters or
+executing UPDATE or DELETE commands).
+
+The best way to be safe is to never, NEVER use Python string concatenation (+)
+or string parameters interpolation (%) to pass variables to a SQL query string.
+
+The second reason, which is almost as important, is that it is the job of the
+database abstraction layer (psycopg2) to decide how to format query parameters,
+not your job! For example psycopg2 knows that when you pass a list of values
+it needs to format them as a comma-separated list, enclosed in parentheses !
+
+.. code-block:: python
+
+ # the following is very bad:
+ # - it's a SQL injection vulnerability
+ # - it's unreadable
+ # - it's not your job to format the list of ids
+ self.env.cr.execute('SELECT distinct child_id FROM account_account_consol_rel ' +
+ 'WHERE parent_id IN ('+','.join(map(str, ids))+')')
+
+ # better
+ self.env.cr.execute('SELECT DISTINCT child_id '\
+ 'FROM account_account_consol_rel '\
+ 'WHERE parent_id IN %s',
+ (tuple(ids),))
+
+This is very important, so please be careful also when refactoring, and most
+importantly do not copy these patterns!
+
+Here is a memorable example to help you remember what the issue is about (but
+do not copy the code there). Before continuing, please be sure to read the
+online documentation of pyscopg2 to learn of to use it properly:
+
+- The problem with query parameters (http://initd.org/psycopg/docs/usage.html#the-problem-with-the-query-parameters)
+- How to pass parameters with psycopg2 (http://initd.org/psycopg/docs/usage.html#passing-parameters-to-sql-queries)
+- Advanced parameter types (http://initd.org/psycopg/docs/usage.html#adaptation-of-python-values-to-sql-types)
+
+
+Keep your methods short/simple when possible
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Functions and methods should not contain too much logic: having a lot of small
+and simple methods is more advisable than having few large and complex methods.
+A good rule of thumb is to split a method as soon as:
+- it has more than one responsibility (see http://en.wikipedia.org/wiki/Single_responsibility_principle)
+- it is too big to fit on one screen.
+
+Also, name your functions accordingly: small and properly named functions are the starting point of readable/maintainable code and tighter documentation.
+
+This recommendation is also relevant for classes, files, modules and packages. (See also http://en.wikipedia.org/wiki/Cyclomatic_complexity)
+
+
+Never commit the transaction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Odoo framework is in charge of providing the transactional context for
+all RPC calls. The principle is that a new database cursor is opened at the
+beginning of each RPC call, and committed when the call has returned, just
+before transmitting the answer to the RPC client, approximately like this:
+
+.. code-block:: python
+
+ def execute(self, db_name, uid, obj, method, *args, **kw):
+ db, pool = pooler.get_db_and_pool(db_name)
+ # create transaction cursor
+ cr = db.cursor()
+ try:
+ res = pool.execute_cr(cr, uid, obj, method, *args, **kw)
+ cr.commit() # all good, we commit
+ except Exception:
+ cr.rollback() # error, rollback everything atomically
+ raise
+ finally:
+ cr.close() # always close cursor opened manually
+ return res
+
+If any error occurs during the execution of the RPC call, the transaction is
+rolled back atomically, preserving the state of the system.
+
+Similarly, the system also provides a dedicated transaction during the execution
+of tests suites, so it can be rolled back or not depending on the server
+startup options.
+
+The consequence is that if you manually call ``cr.commit()`` anywhere there is
+a very high chance that you will break the system in various ways, because you
+will cause partial commits, and thus partial and unclean rollbacks, causing
+among others:
+
+#. inconsistent business data, usually data loss
+#. workflow desynchronization, documents stuck permanently
+#. tests that can't be rolled back cleanly, and will start polluting the
+ database, and triggering error (this is true even if no error occurs
+ during the transaction)
+
+Here is the very simple rule:
+ You should **NEVER** call ``cr.commit()`` yourself, **UNLESS** you have
+ created your own database cursor explicitly! And the situations where you
+ need to do that are exceptional!
+
+ And by the way if you did create your own cursor, then you need to handle
+ error cases and proper rollback, as well as properly close the cursor when
+ you're done with it.
+
+And contrary to popular belief, you do not even need to call ``cr.commit()``
+in the following situations:
+- in the ``_auto_init()`` method of an *models.Model* object: this is taken
+care of by the addons initialization method, or by the ORM transaction when
+creating custom models
+- in reports: the ``commit()`` is handled by the framework too, so you can
+update the database even from within a report
+- within *models.Transient* methods: these methods are called exactly like
+regular *models.Model* ones, within a transaction and with the corresponding
+``cr.commit()/rollback()`` at the end
+- etc. (see general rule above if you have in doubt!)
+
+All ``cr.commit()`` calls outside of the server framework from now on must
+have an **explicit comment** explaining why they are absolutely necessary, why
+they are indeed correct, and why they do not break the transactions. Otherwise
+they can and will be removed !
+
+
+Use translation method correctly
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Odoo uses a GetText-like method named "underscore" ``_( )`` to indicate that
+a static string used in the code needs to be translated at runtime using the
+language of the context. This pseudo-method is accessed within your code by
+importing as follows:
+
+.. code-block:: python
+
+ from odoo.tools.translate import _
+
+A few very important rules must be followed when using it, in order for it to
+work and to avoid filling the translations with useless junk.
+
+Basically, this method should only be used for static strings written manually
+in the code, it will not work to translate field values, such as Product names,
+etc. This must be done instead using the translate flag on the corresponding
+field.
+
+The rule is very simple: calls to the underscore method should always be in
+the form ``_('literal string')`` and nothing else:
+
+.. code-block:: python
+
+ # good: plain strings
+ error = _('This record is locked!')
+
+ # good: strings with formatting patterns included
+ error = _('Record %s cannot be modified!') % record
+
+ # ok too: multi-line literal strings
+ error = _("""This is a bad multiline example
+ about record %s!""") % record
+ error = _('Record %s cannot be modified' \
+ 'after being validated!') % record
+
+ # bad: tries to translate after string formatting
+ # (pay attention to brackets!)
+ # This does NOT work and messes up the translations!
+ error = _('Record %s cannot be modified!' % record)
+
+ # bad: dynamic string, string concatenation, etc are forbidden!
+ # This does NOT work and messes up the translations!
+ error = _("'" + que_rec['question'] + "' \n")
+
+ # bad: field values are automatically translated by the framework
+ # This is useless and will not work the way you think:
+ error = _("Product %s is out of stock!") % _(product.name)
+ # and the following will of course not work as already explained:
+ error = _("Product %s is out of stock!" % product.name)
+
+ # bad: field values are automatically translated by the framework
+ # This is useless and will not work the way you think:
+ error = _("Product %s is not available!") % _(product.name)
+ # and the following will of course not work as already explained:
+ error = _("Product %s is not available!" % product.name)
+
+ # Instead you can do the following and everything will be translated,
+ # including the product name if its field definition has the
+ # translate flag properly set:
+ error = _("Product %s is not available!") % product.name
+
+
+Also, keep in mind that translators will have to work with the literal values
+that are passed to the underscore function, so please try to make them easy to
+understand and keep spurious characters and formatting to a minimum. Translators
+must be aware that formatting patterns such as %s or %d, newlines, etc. need
+to be preserved, but it's important to use these in a sensible and obvious manner:
+
+.. code-block:: python
+
+ # Bad: makes the translations hard to work with
+ error = "'" + question + _("' \nPlease enter an integer value ")
+
+ # Better (pay attention to position of the brackets too!)
+ error = _("Answer to question %s is not valid.\n" \
+ "Please enter an integer value.") % question
+
+In general in Odoo, when manipulating strings, prefer ``%`` over ``.format()``
+(when only one variable to replace in a string), and prefer ``%(varname)`` instead
+of position (when multiple variables have to be replaced). This makes the
+translation easier for the community translators.
+
+
+Symbols and Conventions
+-----------------------
- Model name (using the dot notation, prefix by the module name) :
- - When defining an Odoo Model : use singular form of the name (*res.partner* and *sale.order* instead of *res.partnerS* and *saleS.orderS*)
- - When defining an Odoo Transient (wizard) : use ``<related_base_model>.<action>`` where *related_base_model* is the base model (defined in *models/*) related to the transient, and *action* is the short name of what the transient do. For instance : ``account.invoice.make``, ``project.task.delegate.batch``, ...
- - When defining *report* model (SQL views e.i.) : use ``<related_base_model>.report.<action>``, based on the Transient convention.
+ - When defining an Odoo Model : use singular form of the name (*res.partner*
+ and *sale.order* instead of *res.partnerS* and *saleS.orderS*)
+ - When defining an Odoo Transient (wizard) : use ``<related_base_model>.<action>``
+ where *related_base_model* is the base model (defined in *models/*) related
+ to the transient, and *action* is the short name of what the transient do.
+ For instance : ``account.invoice.make``, ``project.task.delegate.batch``, ...
+ - When defining *report* model (SQL views e.i.) : use
+ ``<related_base_model>.report.<action>``, based on the Transient convention.
-- Odoo Python Class : use camelcase for code in api v8 (Object-oriented style), underscore lowercase notation for old api (SQL style).
+- Odoo Python Class : use camelcase for code in api v8 (Object-oriented style),
+ underscore lowercase notation for old api (SQL style).
.. code-block:: python
@@ -366,7 +806,9 @@ Symbols
- Variable name :
- use camelcase for model variable
- use underscore lowercase notation for common variable.
- - since new API works with record or recordset instead of id list, don't suffix variable name with *_id* or *_ids* if they not contain id or list of id.
+ - since new API works with record or recordset instead of id list, don't
+ suffix variable name with *_id* or *_ids* if they not contain id or list
+ of id.
.. code-block:: python
@@ -382,7 +824,9 @@ Symbols
- Default method : the default method pattern is *_default_<field_name>*
- Onchange method : the onchange method pattern is *_onchange_<field_name>*
- Constraint method : the constraint method pattern is *_check_<constraint_name>*
- - Action method : an object action method is prefix with *action_*. Its decorator is ``@api.multi``, but since it use only one record, add ``self.ensure_one()`` at the beginning of the method.
+ - Action method : an object action method is prefix with *action_*. Its decorator is
+ ``@api.multi``, but since it use only one record, add ``self.ensure_one()``
+ at the beginning of the method.
- In a Model attribute order should be
#. Private attributes (``_name``, ``_description``, ``_inherit``, ...)
@@ -451,7 +895,10 @@ Javascript and CSS
- Use a linter (jshint, ...)
- Never add minified Javascript Libraries
- Use camelcase for class declaration
-- Unless your code is supposed to run on every page, target specific pages using the ``if_dom_contains`` function of website module. Target an element which is specific to the pages your code needs to run on using JQuery.
+- Unless your code is supposed to run on every page, target specific pages
+ using the ``if_dom_contains`` function of website module. Target an
+ element which is specific to the pages your code needs to run on
+ using JQuery.
.. code-block:: javascript
@@ -462,7 +909,11 @@ Javascript and CSS
**For CSS :**
-- Prefix all your classes with *o_<module_name>* where *module_name* is the technical name of the module ('sale', 'im_chat', ...) or the main route reserved by the module (for website module mainly, i.e. : 'o_forum' for *website_forum* module). The only exception for this rule is the webclient: it simply uses *o_* prefix.
+- Prefix all your classes with *o_<module_name>* where *module_name* is the
+ technical name of the module ('sale', 'im_chat', ...) or the main route
+ reserved by the module (for website module mainly, i.e. : 'o_forum' for
+ *website_forum* module). The only exception for this rule is the
+ webclient: it simply uses *o_* prefix.
- Avoid using id
- Use Bootstrap native classes
- Use underscore lowercase notation to name class
@@ -480,11 +931,15 @@ Prefix your commit with
- **[REF]** for refactoring
- **[ADD]** for adding new resources
- **[REM]** for removing of resources
-- **[MOV]** for moving files (Do not change content of moved file, otherwise Git will loose track, and the history will be lost !), or simply moving code from a file to another one.
+- **[MOV]** for moving files (Do not change content of moved file, otherwise
+ Git will loose track, and the history will be lost !), or simply moving code
+ from a file to another one.
- **[MERGE]** for merge commits (only for forward/back-port)
- **[CLA]** for signing the Odoo Individual Contributor License
-Then, in the message itself, specify the part of the code impacted by your changes (module name, lib, transversal object, ...) and a description of the changes.
+Then, in the message itself, specify the part of the code impacted by
+your changes (module name, lib, transversal object, ...) and a description
+of the changes.
- Always include a meaningful commit message: it should be self explanatory
(long enough) including the name of the module that has been changed and the
--
GitLab