-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ADD] api_foreach: Provide api.one replacement
* Create api method to match operation of api.one, call it foreach
- Loading branch information
Showing
4 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
.. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg | ||
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html | ||
:alt: License: LGPL-3 | ||
|
||
=========== | ||
API Foreach | ||
=========== | ||
|
||
This module provides an api decorator that iterates a Recordset and returns a | ||
list of the results. This decorator is identical to the operation of the deprecated | ||
``api.one``. | ||
|
||
Known Issues / Roadmap | ||
====================== | ||
|
||
|
||
Bug Tracker | ||
=========== | ||
|
||
Bugs are tracked on `GitHub Issues | ||
<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please | ||
check there if your issue has already been reported. If you spotted it first, | ||
help us to smash it by providing detailed and welcomed feedback. | ||
|
||
|
||
Credits | ||
======= | ||
|
||
Images | ||
------ | ||
|
||
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_. | ||
|
||
Contributors | ||
------------ | ||
|
||
* Dave Lasley <[email protected]> | ||
|
||
Maintainer | ||
---------- | ||
|
||
.. image:: https://odoo-community.org/logo.png | ||
:alt: Odoo Community Association | ||
:target: https://odoo-community.org | ||
|
||
This module is maintained by the OCA. | ||
|
||
OCA, or the Odoo Community Association, is a nonprofit organization whose | ||
mission is to support the collaborative development of Odoo features and | ||
promote its widespread use. | ||
|
||
To contribute to this module, please visit https://odoo-community.org. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright 2016 LasLabs Inc. | ||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright 2016 LasLabs Inc. | ||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). | ||
{ | ||
|
||
'name': 'API Foreach', | ||
"summary": "It provides an API decorator that auto iterates recordsets.", | ||
'version': '10.0.1.0.0', | ||
'author': "LasLabs, Odoo Community Association (OCA)", | ||
'category': 'Base', | ||
'depends': [ | ||
'base', | ||
], | ||
"website": "https://laslabs.com", | ||
"license": "LGPL-3", | ||
'installable': True, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# -*- coding: utf-8 -*- | ||
# Copyright 2004-2015 Odoo S.A. | ||
# Copyright 2016 LasLabs Inc. | ||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). | ||
|
||
from odoo.api import aggregate, decorator | ||
|
||
|
||
def foreach(method): | ||
""" Decorate a record-style method where ``self`` is expected to be a | ||
singleton instance. The decorated method automatically loops on | ||
records, and makes a list with the results. In case the method is | ||
decorated with :func:`returns`, it concatenates the resulting | ||
instances. Such as | ||
method:: | ||
@api.foreach | ||
def method(self, args): | ||
return self.name | ||
may be called in both record and traditional styles, like:: | ||
# recs = model.browse(cr, uid, ids, context) | ||
names = recs.method(args) | ||
names = model.method(cr, uid, ids, args, context=context) | ||
""" | ||
def loop(method, self, *args, **kwargs): | ||
result = [method(rec, *args, **kwargs) for rec in self] | ||
return aggregate(method, result, self) | ||
|
||
wrapper = decorator(loop, method) | ||
wrapper._api = 'foreach' | ||
return wrapper |