-
-
Notifications
You must be signed in to change notification settings - Fork 439
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[IMP] component_event: black, isort, prettier
- Loading branch information
1 parent
7aab12a
commit d945973
Showing
13 changed files
with
99 additions
and
124 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 |
|---|---|---|
|
|
@@ -17,25 +17,24 @@ Components Events | |
| :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html | ||
| :alt: License: LGPL-3 | ||
| .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github | ||
| :target: https://github.com/OCA/connector/tree/16.0/component_event | ||
| :target: https://github.com/OCA/connector/tree/17.0/component_event | ||
| :alt: OCA/connector | ||
| .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png | ||
| :target: https://translation.odoo-community.org/projects/connector-16-0/connector-16-0-component_event | ||
| :target: https://translation.odoo-community.org/projects/connector-17-0/connector-17-0-component_event | ||
| :alt: Translate me on Weblate | ||
| .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/connector&target_branch=16.0 | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/connector&target_branch=17.0 | ||
| :alt: Try me on Runboat | ||
|
|
||
| |badge1| |badge2| |badge3| |badge4| |badge5| | ||
|
|
||
| This module implements an event system (`Observer pattern`_) and is a | ||
| base block for the Connector Framework. It can be used without | ||
| using the full Connector though. It is built upon the ``component`` module. | ||
| This module implements an event system (`Observer | ||
| pattern <https://en.wikipedia.org/wiki/Observer_pattern>`__) and is a | ||
| base block for the Connector Framework. It can be used without using the | ||
| full Connector though. It is built upon the ``component`` module. | ||
|
|
||
| Documentation: http://odoo-connector.com/ | ||
|
|
||
| .. _Observer pattern: https://en.wikipedia.org/wiki/Observer_pattern | ||
|
|
||
| **Table of contents** | ||
|
|
||
| .. contents:: | ||
|
|
@@ -47,84 +46,77 @@ Usage | |
| As a developer, you have access to a events system. You can find the | ||
| documentation in the code or on http://odoo-connector.com | ||
|
|
||
| In a nutshell, you can create trigger events:: | ||
| In a nutshell, you can create trigger events: | ||
|
|
||
| :: | ||
|
|
||
| class Base(models.AbstractModel): | ||
| _inherit = 'base' | ||
| class Base(models.AbstractModel): | ||
| _inherit = 'base' | ||
|
|
||
| @api.model | ||
| def create(self, vals): | ||
| record = super(Base, self).create(vals) | ||
| self._event('on_record_create').notify(record, fields=vals.keys()) | ||
| return record | ||
| @api.model | ||
| def create(self, vals): | ||
| record = super(Base, self).create(vals) | ||
| self._event('on_record_create').notify(record, fields=vals.keys()) | ||
| return record | ||
|
|
||
| And subscribe listeners to the events:: | ||
| And subscribe listeners to the events: | ||
|
|
||
| from odoo.addons.component.core import Component | ||
| from odoo.addons.component_event import skip_if | ||
| :: | ||
|
|
||
| class MagentoListener(Component): | ||
| _name = 'magento.event.listener' | ||
| _inherit = 'base.connector.listener' | ||
| from odoo.addons.component.core import Component | ||
| from odoo.addons.component_event import skip_if | ||
|
|
||
| @skip_if(lambda self, record, **kwargs: self.no_connector_export(record)) | ||
| def on_record_create(self, record, fields=None): | ||
| """ Called when a record is created """ | ||
| record.with_delay().export_record(fields=fields) | ||
| class MagentoListener(Component): | ||
| _name = 'magento.event.listener' | ||
| _inherit = 'base.connector.listener' | ||
|
|
||
| @skip_if(lambda self, record, **kwargs: self.no_connector_export(record)) | ||
| def on_record_create(self, record, fields=None): | ||
| """ Called when a record is created """ | ||
| record.with_delay().export_record(fields=fields) | ||
|
|
||
| This module triggers 3 events: | ||
|
|
||
| * ``on_record_create(record, fields=None)`` | ||
| * ``on_record_write(record, fields=None)`` | ||
| * ``on_record_unlink(record)`` | ||
| - ``on_record_create(record, fields=None)`` | ||
| - ``on_record_write(record, fields=None)`` | ||
| - ``on_record_unlink(record)`` | ||
|
|
||
| Changelog | ||
| ========= | ||
|
|
||
| .. [ The change log. The goal of this file is to help readers | ||
| understand changes between version. The primary audience is | ||
| end users and integrators. Purely technical changes such as | ||
| code refactoring must not be mentioned here. | ||
| This file may contain ONE level of section titles, underlined | ||
| with the ~ (tilde) character. Other section markers are | ||
| forbidden and will likely break the structure of the README.rst | ||
| or other documents where this fragment is included. ] | ||
| Next | ||
| ~~~~ | ||
| ---- | ||
|
|
||
| 12.0.1.0.0 (2018-11-26) | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
| ----------------------- | ||
|
|
||
| * [MIGRATION] from 12.0 branched at rev. 324e006 | ||
| - [MIGRATION] from 12.0 branched at rev. 324e006 | ||
|
|
||
| Bug Tracker | ||
| =========== | ||
|
|
||
| Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector/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 a detailed and welcomed | ||
| `feedback <https://github.com/OCA/connector/issues/new?body=module:%20component_event%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
| `feedback <https://github.com/OCA/connector/issues/new?body=module:%20component_event%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
|
|
||
| Do not contact contributors directly about support or help with technical issues. | ||
|
|
||
| Credits | ||
| ======= | ||
|
|
||
| Authors | ||
| ~~~~~~~ | ||
| ------- | ||
|
|
||
| * Camptocamp | ||
|
|
||
| Contributors | ||
| ~~~~~~~~~~~~ | ||
| ------------ | ||
|
|
||
| * Guewen Baconnier <[email protected]> | ||
| - Guewen Baconnier <[email protected]> | ||
|
|
||
| Maintainers | ||
| ~~~~~~~~~~~ | ||
| ----------- | ||
|
|
||
| This module is maintained by the OCA. | ||
|
|
||
|
|
@@ -136,6 +128,6 @@ 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. | ||
|
|
||
| This module is part of the `OCA/connector <https://github.com/OCA/connector/tree/16.0/component_event>`_ project on GitHub. | ||
| This module is part of the `OCA/connector <https://github.com/OCA/connector/tree/17.0/component_event>`_ project on GitHub. | ||
|
|
||
| You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. | ||
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
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 @@ | ||
| [build-system] | ||
| requires = ["whool"] | ||
| build-backend = "whool.buildapi" |
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 @@ | ||
| - Guewen Baconnier \<<[email protected]>\> |
This file was deleted.
Oops, something went wrong.
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,6 @@ | ||
| This module implements an event system ([Observer | ||
| pattern](https://en.wikipedia.org/wiki/Observer_pattern)) and is a base | ||
| block for the Connector Framework. It can be used without using the full | ||
| Connector though. It is built upon the `component` module. | ||
|
|
||
| Documentation: <http://odoo-connector.com/> |
This file was deleted.
Oops, something went wrong.
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,5 @@ | ||
| ## Next | ||
|
|
||
| ## 12.0.1.0.0 (2018-11-26) | ||
|
|
||
| - \[MIGRATION\] from 12.0 branched at rev. 324e006 |
This file was deleted.
Oops, something went wrong.
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,33 @@ | ||
| As a developer, you have access to a events system. You can find the | ||
| documentation in the code or on <http://odoo-connector.com> | ||
|
|
||
| In a nutshell, you can create trigger events: | ||
|
|
||
| class Base(models.AbstractModel): | ||
| _inherit = 'base' | ||
|
|
||
| @api.model | ||
| def create(self, vals): | ||
| record = super(Base, self).create(vals) | ||
| self._event('on_record_create').notify(record, fields=vals.keys()) | ||
| return record | ||
|
|
||
| And subscribe listeners to the events: | ||
|
|
||
| from odoo.addons.component.core import Component | ||
| from odoo.addons.component_event import skip_if | ||
|
|
||
| class MagentoListener(Component): | ||
| _name = 'magento.event.listener' | ||
| _inherit = 'base.connector.listener' | ||
|
|
||
| @skip_if(lambda self, record, **kwargs: self.no_connector_export(record)) | ||
| def on_record_create(self, record, fields=None): | ||
| """ Called when a record is created """ | ||
| record.with_delay().export_record(fields=fields) | ||
|
|
||
| This module triggers 3 events: | ||
|
|
||
| - `on_record_create(record, fields=None)` | ||
| - `on_record_write(record, fields=None)` | ||
| - `on_record_unlink(record)` |
This file was deleted.
Oops, something went wrong.
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
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,2 @@ | ||
| # generated from manifests external_dependencies | ||
| cachetools |