Skip to main content

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

Project description

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

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.


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

Table of contents


As a developer, you have access to a component system. You can find the documentation in the code or on

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 =

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

  • TransactionComponentCase

  • SavepointComponentCase

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


Next (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 smashing it by providing a detailed and welcomed feedback.

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



  • Camptocamp



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:


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

You are welcome to contribute. To learn how please visit

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

odoo13_addon_component- (59.5 kB view hashes)

Uploaded Python 3

Supported by

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