Search 1.9 billion lines of Odoo code on GitHub
component
<h1 class="title">Components</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/connector/tree/15.0/component"><img alt="OCA/connector" src="https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/connector-15-0/connector-15-0-component"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/102/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>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.</p>
<p>Documentation: <a class="reference external" href="http://odoo-connector.com/">http://odoo-connector.com/</a></p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id5">Usage</a></li>
<li><a class="reference internal" href="#changelog" id="id6">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id7">15.0.1.0.0 (2021-11-25)</a></li>
<li><a class="reference internal" href="#id2" id="id8">14.0.1.0.0 (2020-10-22)</a></li>
<li><a class="reference internal" href="#id3" id="id9">13.0.1.0.0 (2019-10-23)</a></li>
<li><a class="reference internal" href="#id4" id="id10">12.0.1.0.0 (2018-10-02)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id11">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id12">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id13">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id14">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id15">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id5">Usage</a></h2>
<p>As a developer, you have access to a component system. You can find the
documentation in the code or on <a class="reference external" href="http://odoo-connector.com">http://odoo-connector.com</a></p>
<p>In a nutshell, you can create components:</p>
<pre>
<code>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']</code>
</pre>
<p>And later, find the component you need at runtime (dynamic dispatch at
component level):</p>
<pre>
<code>def run(self, external_id):
backend_adapter = self.component(usage='backend.adapter')
external_data = backend_adapter.read(external_id)</code>
</pre>
<p>In order for tests using components to work, you will need to use the base
class provided by <cite>odoo.addons.component.tests.common</cite>:</p>
<ul class="simple">
<li><cite>TransactionComponentCase</cite></li>
</ul>
<p>There are also some specific base classes for testing the component registry,
using the ComponentRegistryCase as a base class. See the docstrings in
<cite>tests/common.py</cite>.</p>
<a name="changelog"></a>
<h2><a class="toc-backref" href="#id6">Changelog</a></h2>
<a name="id1"></a>
<h3><a class="toc-backref" href="#id7">15.0.1.0.0 (2021-11-25)</a></h3>
<ul class="simple">
<li>[MIGRATION] from 14.0</li>
</ul>
<a name="id2"></a>
<h3><a class="toc-backref" href="#id8">14.0.1.0.0 (2020-10-22)</a></h3>
<ul class="simple">
<li>[MIGRATION] from 13.0</li>
</ul>
<a name="id3"></a>
<h3><a class="toc-backref" href="#id9">13.0.1.0.0 (2019-10-23)</a></h3>
<ul class="simple">
<li>[MIGRATION] from 12.0</li>
</ul>
<a name="id4"></a>
<h3><a class="toc-backref" href="#id10">12.0.1.0.0 (2018-10-02)</a></h3>
<ul class="simple">
<li>[MIGRATION] from 11.0 branched at rev. 324e006</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id11">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/connector/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/connector/issues/new?body=module:%20component%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id12">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id13">Authors</a></h3>
<ul class="simple">
<li>Camptocamp</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id14">Contributors</a></h3>
<ul class="simple">
<li>Guewen Baconnier <<a class="reference external" href="mailto:guewen.baconnier@camptocamp.com">guewen.baconnier@camptocamp.com</a>></li>
<li>Laurent Mignon <<a class="reference external" href="mailto:laurent.mignon@acsone.eu">laurent.mignon@acsone.eu</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id15">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/guewen"><img alt="guewen" src="https://github.com/guewen.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/connector/tree/15.0/component">OCA/connector</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>