NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] developer/orm: environment documentation

Browse Source 
Move Environment explanation to the class docstring and autogenerate the
doc

Add documentation on some util methods.

closes odoo/documentation#2798

Related: odoo/odoo#102896
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit is contained in:
Victor Feyens 2022-10-10 12:39:08 +00:00
parent b7f5b3e04b
commit 7c42ab8eaf
1 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
content/developer/reference/backend/orm.rst
View File

@ -650,50 +650,46 @@ Method decorators
Environment Environment
=========== ===========
The :class:`~odoo.api.Environment` stores various contextual data used by .. currentmodule:: odoo.api
the ORM: the database cursor (for database queries), the current user
(for access rights checking) and the current context (storing arbitrary
metadata). The environment also stores caches.
All recordsets have an environment, which is immutable, can be accessed .. autoclass:: Environment
using :attr:`~odoo.models.Model.env` and gives access to:
* the current user (:attr:`~odoo.api.Environment.user`)
* the cursor (:attr:`~odoo.api.Environment.cr`)
* the superuser flag (:attr:`~odoo.api.Environment.su`)
* or the context (:attr:`~odoo.api.Environment.context`)
.. code-block:: bash .. code-block:: bash
>>> records.env >>> records.env
<Environment object ...> <Environment object ...>
>>> records.env.uid
3
>>> records.env.user >>> records.env.user
res.user(3) res.user(3)
>>> records.env.cr >>> records.env.cr
<Cursor object ...) <Cursor object ...>
When creating a recordset from an other recordset, the environment is When creating a recordset from an other recordset, the environment is
inherited. The environment can be used to get an empty recordset in an inherited. The environment can be used to get an empty recordset in an
other model, and query that model:: other model, and query that model:
.. code-block:: bash
>>> self.env['res.partner'] >>> self.env['res.partner']
res.partner() res.partner()
>>> self.env['res.partner'].search([['is_company', '=', True], ['customer', '=', True]]) >>> self.env['res.partner'].search([('is_company', '=', True), ('customer', '=', True)])
res.partner(7, 18, 12, 14, 17, 19, 8, 31, 26, 16, 13, 20, 30, 22, 29, 15, 23, 28, 74) res.partner(7, 18, 12, 14, 17, 19, 8, 31, 26, 16, 13, 20, 30, 22, 29, 15, 23, 28, 74)
.. currentmodule:: odoo.api Some lazy properties are available to access the environment (contextual) data:
.. automethod:: Environment.ref
.. autoattribute:: Environment.lang .. autoattribute:: Environment.lang
.. autoattribute:: Environment.user .. autoattribute:: Environment.user
.. autoattribute:: Environment.company .. autoattribute:: Environment.company
.. autoattribute:: Environment.companies .. autoattribute:: Environment.companies
.. TODO cr, uid but not @property or methods of Environment class... Useful environment methods
--------------------------
.. automethod:: Environment.ref
.. automethod:: Environment.is_superuser
.. automethod:: Environment.is_admin
.. automethod:: Environment.is_system
Altering the environment Altering the environment
------------------------ ------------------------