Skip to main content

Add capabilities to register and use decoupled components, as an alternative to model classes

Project description

Odoo Community Association

Components

Production/Stable License: LGPL-3 OCA/connector Translate me on Weblate Try me on Runboat

This module implements a component system and is a base block for the Connector Framework. It can be used without using the full Connector though.

Documentation: http://odoo-connector.com/

You may also want to check the Introduction to Odoo Components by @guewen.

Table of contents

Usage

As a developer, you have access to a component system. You can find the documentation in the code or on http://odoo-connector.com

In a nutshell, you can create components:

from odoo.addons.component.core import Component

class MagentoPartnerAdapter(Component):
    _name = 'magento.partner.adapter'
    _inherit = 'magento.adapter'

    _usage = 'backend.adapter'
    _collection = 'magento.backend'
    _apply_on = ['res.partner']

And later, find the component you need at runtime (dynamic dispatch at component level):

def run(self, external_id):
    backend_adapter = self.component(usage='backend.adapter')
    external_data = backend_adapter.read(external_id)

In order for tests using components to work, you will need to use the base class provided by `odoo.addons.component.tests.common`:

  • TransactionComponentCase

There are also some specific base classes for testing the component registry, using the ComponentRegistryCase as a base class. See the docstrings in tests/common.py.

Changelog

16.0.1.0.0 (2022-10-04)

  • [MIGRATION] from 15.0

15.0.1.0.0 (2021-11-25)

  • [MIGRATION] from 14.0

14.0.1.0.0 (2020-10-22)

  • [MIGRATION] from 13.0

13.0.1.0.0 (2019-10-23)

  • [MIGRATION] from 12.0

12.0.1.0.0 (2018-10-02)

  • [MIGRATION] from 11.0 branched at rev. 324e006

Bug Tracker

Bugs are tracked on GitHub 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.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Camptocamp

Contributors

Other credits

The migration of this module from 17.0 to 18.0 was financially supported by Camptocamp.

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainer:

guewen

This module is part of the OCA/connector project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_addon_component-18.0.1.0.3-py3-none-any.whl (59.8 kB view details)

Uploaded Python 3

File details

Details for the file odoo_addon_component-18.0.1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_component-18.0.1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c5c140c4534cb902041d4b14e90ac968838ce37bec2945aeab651256256abd10
MD5 81ea5705e036a18bcdacfed8c3fc10d9
BLAKE2b-256 ce1958a0308bad8c47522c5921d931167c723183cd78ab3a84bc2f354f65d273

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page