Commit Graph
69 Commits
Author SHA1 Message Date
Adrian Torres ece40d83fb [FIX] doc: warn about pitfalls of inverse batching
This commit updates the documentation surrounding compute and inverse
methods for fields, explicitly warning API consumers that grouping
multiple compute fields under a single inverse method is error-prone and
could not work at all (it can still work under specific conditions but
henceforth it shall be considered bad practice).

This case was found at https://github.com/odoo/enterprise/pull/13815/commits/a651413df915f166697d26a83084582207405858

closes odoo/odoo#60115

X-original-commit: 1d21924c1da0bed59cd105a3d9bf9b60fa2d7bc4
Signed-off-by: Raphael Collet (rco) <rco@openerp.com>
Signed-off-by: Adrian Torres (adt) <adt@odoo.com>
2020-10-15 15:05:00 +00:00
Victor FeyensandRaf Geens c4442e8341 [IMP] doc: related fields do not support chained x2m dependencies
The behavior isn't exactly undefined: it will appear to work if the
relation refers to only 1 instance. If there are multiple it will give
results for 1 instance and ignore the others. This behavior should not
be relied upon, hence I'm documenting it as undefined. I confirmed this
with mat from the ORM team.

Even better would be to raise an error or warning if `related` is used
in this context.

closes odoo/odoo#57270

closes odoo/odoo#57815

X-original-commit: 6ae421f551ee36afa836494bc8563fc9276ab31e
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: Raf Geens <raf@odoo.com>
2020-09-16 10:21:36 +00:00
Xavier Morel 48335c04bf [IMP] core: orm doc
* fix link from backend tutorial to log_access section
* flesh out log access documentation
* add documentation for log_access itself & improve doc for a few
  other model-level attributes
2020-07-28 13:03:12 +00:00
Victor Feyens c69a092b98 [IMP] doc: _inherits usage warnings
The delegation inheritance is very useful in some cases,
but its usage shouldn't be encouraged.

Furthermore, chained _inherits may result in unexpected
behavior/results,
and really shouldn't be used.

closes odoo/odoo#54864

X-original-commit: 4a06a4c79e962906832f98147fe87a2c19efaa75
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-07-23 16:18:11 +00:00
c5d3a109f5 [REF] ir.autovacuum: declarative garbage collector registration
The ir.autovacuum model purpose is to run several garbage collecting
operations like removing files from the filestore when no attachment
references them anymore.

The precedent strategy to register new garbage collection tasks was to
override the `power_on` method and to imperatively execute a vacuum
cleaning method on a given model. All calls were executed in a single
SQL transaction without any error handling, meaning a single fail during
any call resulted in a complete failure of the entire vacuum cleaning
chain.

We introduce a new `@autovacuum` api decorator, its purpose it to
register garbage collecting methods that will be safely executed in
their own transaction by the vacuum cleaner. In order to ensure this
new strategy is used, we deprecate `power_on` extensions.

By the way, garbage-collecting methods can be quite heavy and we don't
want users to directly call them. We now ensure they are private.

closes odoo/odoo#47842

Task: 2154079
Signed-off-by: Raphael Collet (rco) <rco@openerp.com>
Co-authored-by: Raphael Collet <rco@odoo.com>
Co-authored-by: Olivier Dony <odo@odoo.com>
2020-05-19 13:38:19 +00:00
Victor Feyens 57eb964182 [IMP] base: document all field types.
closes odoo/odoo#49135

X-original-commit: cc653d3f1a49e2b7b2cc0ec833097bd7cf3528a1
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2020-04-07 12:11:57 +00:00
Victor Feyens 3e9b73b1ee [IMP] doc: document the api.model decorator
X-original-commit: efa3a148cb178693b73af054cd6e19870d068454
2020-02-07 14:00:12 +00:00
Victor Feyens 59a7738be2 [IMP] doc: orm page missing information + UI
* Some fields types were missing
* Add information on multi-record field access
* UI finetuning
2020-02-05 14:00:15 +00:00
Victor FeyensandAntoine Vandevenne 5a1d603c5f [ADD] doc: multi-company howtos
closes odoo/odoo#41038

X-original-commit: eaabad20516a73a97b23343a22357659c29945f7
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2019-11-28 10:16:48 +00:00
Victor Feyens 0bfb695b4f [ADD] ORM: with_company 2019-11-12 16:23:33 +00:00
Victor Feyens ae4855fa1e [IMP] base, doc: orm page refactoring.
closes odoo/odoo#39725

X-original-commit: 7ce7c58592c7c7202a37c73767c477be5a835752
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2019-11-04 11:16:12 +00:00
Victor Feyens 09221fe246 [FIX] doc: fix some sphinx warnings.
closes odoo/odoo#38170

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2019-10-08 09:36:59 +00:00
Florent de Labarre 7e6e9df12f [IMP] doc: add missing attributes
Add documentation about model attributes
_parent_name
_date_name
_fold_name
_translate

Forward port of #32559 to 13.0

closes odoo/odoo#37840

Signed-off-by: Nicolas Martinelli (nim) <nim@odoo.com>
2019-10-03 07:33:17 +00:00
Christophe Simonis 5a273e74f0 [MERGE] forward port branch saas-12.4 up to fe59754c52
closes odoo/odoo#36721

Signed-off-by: Christophe Simonis <chs@odoo.com>
2019-09-13 13:32:51 +00:00
Christophe Simonis 545e6d2034 [MERGE] forward port branch 12.0 up to 52f6e38cea 2019-08-30 17:20:28 +02:00
Florent de Labarre 71570e49ab [FIX] doc: add parent_of operator
closes odoo/odoo#32558

Signed-off-by: vfe <Feyensv@users.noreply.github.com>
2019-08-28 08:46:15 +00:00
Simon Lejeune 504b5fe5a9 [ADD] fields, models: company consistency check
Assigning `check_company=True` to a field will
- set a default domain filtering the companies
- allow to call `_check_company` on the records to ensure the domain is
  respected

Setting `_check_company_auto = True` on a model will ensure
`_check_company` is called at create and write, enforcing the multi
company domain.

Joint work with Raphael Collet <rco@odoo.com>

task-1985992
2019-09-03 15:03:45 +00:00
mreficent 64773140b0 [IMP] doc: remove calls to @api.guess and @api.noguess
Those two decorators are removed/deprecated since recent commits but
some references remained in the documentation.

api.guess and api.noguess is deprecated and removed since c552fb7a61

closes odoo/odoo#35332

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2019-08-01 13:16:37 +00:00
Yenthe666 ce00210b61 [IMP] doc: remove calls to @api.multi and @api.one
Those two decorators are removed/deprecated since recent commits but some references remained in the documentation.

api.multi is deprecated since https://github.com/odoo/odoo/commit/cc62447a44c2cf4e2edaf8a1f6d94520e799ddd9
api.one was removed with https://github.com/odoo/odoo/commit/407f1f6cdb87a59bbad9f853078d7345cdf9f60c

closes odoo/odoo#35261

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2019-07-30 15:39:19 +00:00
Xavier Morel 38b919251e [REM] doc: autodoc of removed api.* decorators
* @one was removed in 407f1f6cdb
* @v7 and @v8 were removed in c552fb7a61
* @multi was removed in a8767716cf
2019-07-30 09:29:28 +00:00
Adrian Torres 4b38cc6590 [REM] *: calls to @api.multi
Multi is the default api for methods, it is not necessary to explicitly
decorate methods with it, adds clutter and most people use it because
they see that the rest of the code uses it.

Done with `find . -type f -name '*.py' | xargs sed -i '/@api.multi/d'`
2019-07-17 14:13:12 +02:00
Raphael Collet c552fb7a61 [IMP] api: remove deprecated decorators 2019-07-08 13:51:35 +00:00
Christophe Simonis 7a0243ec15 [MERGE] forward port branch 12.0 up to b3052b690f 2018-11-23 12:11:32 +01:00
Olivier Dony 7765689f63 [DOC] orm: fix a typo in parent_path doc 2018-11-18 02:59:53 +01:00
Olivier Dony 6d2b055d5e [DOC] orm: update doc for parent_path field
As of 12.0, the `parent_left` and `parent_right` special fields previously
used to store the tree structure have been replaced with a single
`parent_path` field. See also PR #22558.
2018-11-18 02:55:52 +01:00
Christophe Simonis b106b7ce0b [MERGE] forward port branch 12.0 up to dd70c68426 2018-11-06 16:40:07 +01:00
Bruno Paulino 9e7d6a3e7e [IMP] doc: add a more meaningful example
update Model Inheritance Delegation docs with a more meaningful example
2018-10-30 16:09:21 +00:00
Christophe Simonis 5e055a2afd [MERGE] forward port branch saas-11.4 up to f6ca72b3ce 2018-11-02 10:52:55 +01:00
Christophe Simonis 58525e29d8 [MERGE] forward port branch saas-15 up to bff43f0aa1 2018-10-24 16:14:52 +02:00
Martin Trigaux d5cc05c994 [FIX] doc: correct reference to the line in the file
Introduced at 94e82753ac
2018-10-23 16:17:58 +02:00
Christophe Simonis 68d36512ef [MERGE] forward port branch saas-11.4 up to d78f23df84 2018-09-07 20:20:45 +02:00
Jesús Alan Ramos Rodríguez 5b13a45fb8 [FIX] doc: Change name of method in documentation
invalidate_all no longer exists

Closes #26613
2018-09-04 17:04:33 +02:00
Xavier Morel 0e307f8280 [FIX] doc building and warnings
doc:

* fix incorrect doc comments (documenting params which don't exist)
* correctly quote non-refs
* fix role label syntax (backticks must be escaped)
* add newline to fix warning

JS doc parser:

* fix handling of already-resolved objects
* fix handling of non-string properties (e.g. foo[0] at module toplevel)
* don't blow up if subject of .include call can't be resolved (just ignore)

Others:

* add translator support for ``problematic`` node (apparently used for
  some refs by recent Sphinx)
2018-08-27 12:55:21 +02:00
Raphael Collet c36fc4a435 [FIX] doc: API of create 2018-08-27 11:18:33 +02:00
Raphael Collet 960360afe4 [REF] *: use native date/datetime for Date/Datetime fields
From this commit onwards, Date fields will return datetime.date objects and Datetime fields will return datetime.datetime objects, this implies a number of things that are clearly explained both in the ORM API for master.

This commit also introduces a number of helper functions for dates and datetimes that are exposed in tools.date_utils and fields.Date[time], explained in the documentation as well.

Task-ID: 47189
2018-08-06 14:37:19 +02:00
Christophe Simonis 4715d7e35a [MERGE] forward port branch saas-15 up to 0d55241185 2018-03-19 19:29:58 +01:00
Jerther 0ee76b664c [IMP] doc: add a tip to create a model without any table
As explained in #17386, _auto=False on a model is used for report where the
table is explicitely created in init method.
To create a model without any table, AbstractModel should be used.

Closes #19448
2018-03-16 12:57:16 +01:00
Ryan Cole ca83d3c1ac [IMP] doc: add details of o2m and m2m limitations 2018-03-16 09:04:31 +01:00
Olivier Dony 464fe4a185 [FIX] doc: clarify: record[field] is valid/recommended 2017-07-06 15:58:47 +02:00
Martin Trigaux c060e90d81 [FIX] doc: correctly link doc and test lines
The test is surprisingly formated but it is to be able to extract the relevant
lines in the documentation
2017-06-16 15:14:27 +02:00
Christophe Simonis 387b2acfcb [MERGE] forward port branch saas-11 up to 1730dca101 2017-02-23 19:40:03 +01:00
Christophe Simonis ac11bfd927 [MERGE] forward port branch 9.0 up to a7531810f3 2017-02-17 11:42:12 +01:00
Martin Trigaux a7531810f3 [IMP] doc: more explicit section name
A section for uncategorised methods.

Fixes https://twitter.com/mannequin/status/832360802422312962
2017-02-17 11:10:14 +01:00
Martin Trigaux 9528024536 [FIX] doc: building correctly autoclass references 2016-10-11 12:09:27 +02:00
Christophe Simonis 6854887ade [MERGE] forward port branch saas-10 up to 477482e 2016-09-22 13:41:33 +02:00
Christophe Simonis 78f6117db0 [MERGE] forward port branch saas-6 up to 6a67e5c 2016-09-22 12:52:35 +02:00
xmo-odoo 9c78ba1f75 [IMP] document subset/superset operations 2016-09-15 17:05:10 +02:00
Christophe Simonis c88c70e900 [MERGE] forward port of branch saas-10 up to d73f0d8 2016-06-21 13:58:24 +02:00
Christophe Simonis e37ba61832 [MERGE] forward port of branch saas-6 up to b87a93a 2016-06-20 14:20:03 +02:00
Nick-OpusVL bdf93910c3 [FIX] doc: 'Searching' instead of 'Research'
The word 'Research' isn't usually used in this context.  'Searching' is better.
Closes #11517
2016-06-17 09:40:46 +02:00