=================
Components Events
=================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:de1e8576f3deb72993535826d37a69c1b899bd9102f87eb6f8ac5190d5e93944
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
: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/14.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-14-0/connector-14-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=14.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.
Documentation: http://odoo-connector.com/
.. _Observer pattern: https://en.wikipedia.org/wiki/Observer_pattern
**Table of contents**
.. contents::
:local:
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::
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)``
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
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:%2014.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 <guewen.baconnier@camptocamp.com>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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/14.0/component_event>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/connector",
"name": "odoo14-addon-component-event",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Camptocamp,Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "=================\nComponents Events\n=================\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:de1e8576f3deb72993535826d37a69c1b899bd9102f87eb6f8ac5190d5e93944\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github\n :target: https://github.com/OCA/connector/tree/14.0/component_event\n :alt: OCA/connector\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/connector-14-0/connector-14-0-component_event\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/connector&target_branch=14.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module implements an event system (`Observer pattern`_) and is a\nbase block for the Connector Framework. It can be used without\nusing the full Connector though. It is built upon the ``component`` module.\n\nDocumentation: http://odoo-connector.com/\n\n.. _Observer pattern: https://en.wikipedia.org/wiki/Observer_pattern\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nAs a developer, you have access to a events system. You can find the\ndocumentation in the code or on http://odoo-connector.com\n\nIn a nutshell, you can create trigger events::\n\n class Base(models.AbstractModel):\n _inherit = 'base'\n\n @api.model\n def create(self, vals):\n record = super(Base, self).create(vals)\n self._event('on_record_create').notify(record, fields=vals.keys())\n return record\n\nAnd subscribe listeners to the events::\n\n from odoo.addons.component.core import Component\n from odoo.addons.component_event import skip_if\n\n class MagentoListener(Component):\n _name = 'magento.event.listener'\n _inherit = 'base.connector.listener'\n\n @skip_if(lambda self, record, **kwargs: self.no_connector_export(record))\n def on_record_create(self, record, fields=None):\n \"\"\" Called when a record is created \"\"\"\n record.with_delay().export_record(fields=fields)\n\n\nThis module triggers 3 events:\n\n* ``on_record_create(record, fields=None)``\n* ``on_record_write(record, fields=None)``\n* ``on_record_unlink(record)``\n\nChangelog\n=========\n\n.. [ The change log. The goal of this file is to help readers\n understand changes between version. The primary audience is\n end users and integrators. Purely technical changes such as\n code refactoring must not be mentioned here.\n\n This file may contain ONE level of section titles, underlined\n with the ~ (tilde) character. Other section markers are\n forbidden and will likely break the structure of the README.rst\n or other documents where this fragment is included. ]\n\nNext\n~~~~\n\n12.0.1.0.0 (2018-11-26)\n~~~~~~~~~~~~~~~~~~~~~~~\n\n* [MIGRATION] from 12.0 branched at rev. 324e006\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/connector/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/connector/issues/new?body=module:%20component_event%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Camptocamp\n\nContributors\n~~~~~~~~~~~~\n\n* Guewen Baconnier <guewen.baconnier@camptocamp.com>\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/connector <https://github.com/OCA/connector/tree/14.0/component_event>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "Components Events",
"version": "14.0.1.0.4",
"project_urls": {
"Homepage": "https://github.com/OCA/connector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a89523714ca125bdc4510c5ccf5d35a8d36196d73ec5f0e17a5de3aa9517b64",
"md5": "4f718435dd4058880b48b60e60c5d3ae",
"sha256": "e62b9867ec23077ec371d513a6095193a8a704581711b4af3ea805a0227240cc"
},
"downloads": -1,
"filename": "odoo14_addon_component_event-14.0.1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f718435dd4058880b48b60e60c5d3ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35594,
"upload_time": "2024-09-03T07:40:38",
"upload_time_iso_8601": "2024-09-03T07:40:38.014759Z",
"url": "https://files.pythonhosted.org/packages/0a/89/523714ca125bdc4510c5ccf5d35a8d36196d73ec5f0e17a5de3aa9517b64/odoo14_addon_component_event-14.0.1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 07:40:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cachetools",
"specs": []
}
],
"lcname": "odoo14-addon-component-event"
}
JSON
