Search 1.9 billion lines of Odoo code on GitHub
spec_driven_model
<h1 class="title">Spec Driven Model</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.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/l10n-brazil/tree/14.0/spec_driven_model"><img alt="OCA/l10n-brazil" src="https://img.shields.io/badge/github-OCA%2Fl10n--brazil-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/l10n-brazil-14-0/l10n-brazil-14-0-spec_driven_model"><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/124/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<a name="intro"></a>
<h2>Intro</h2>
<p>This module is a databinding framework for Odoo and XML data: it allows to go from XML to Odoo objects back and forth. This module started with the <a class="reference external" href="https://www.davekuhlman.org/generateDS.html">GenerateDS</a> pure Python databinding framework and is now being migrated to xsdata. So a good starting point is to read <a class="reference external" href="https://xsdata.readthedocs.io/">the xsdata documentation here</a></p>
<p>But what if instead of only generating Python structures from XML files you could actually generate full blown Odoo objects or serialize Odoo objects back to XML? This is what this module is for!</p>
<p>First you should generate xsdata Python binding libraries you would generate for your specific XSD grammar, the Brazilian Electronic Invoicing for instance, or UBL.</p>
<p>Second you should generate Odoo abstract mixins for all these pure Python bindings. This can be achieved using <a class="reference external" href="https://github.com/akretion/xsdata-odoo">xsdata-odoo</a>. An example is OCA/l10n-brazil/l10n_br_nfe_spec for the Brazilian Electronic Invoicing.</p>
<a name="specmodel"></a>
<h2>SpecModel</h2>
<p>Now that you have generated these Odoo abstract bindings you should tell Odoo how to use them. For instance you may want that your electronic invoice abstract model matches the Odoo <cite>res.partner</cite> object. This is fairly easy, you mostly need to define an override like:</p>
<pre>
<code>from odoo.addons.spec_driven_model.models import spec_models
class ResPartner(spec_models.SpecModel):
_inherit = [
'res.partner',
'partner.binding.mixin',
]</code>
</pre>
<p>Notice you should inherit from <cite>spec_models.SpecModel</cite> and not the usual <cite>models.Model</cite>.</p>
<p><strong>Field mapping</strong>: You can then define two ways mapping between fields by overriding fields from Odoo or from the binding and using <cite>_compute=</cite> , <cite>_inverse=</cite> or simply <cite>related=</cite>.</p>
<p><strong>Relational fields</strong>: simple fields are easily mapped this way. However what about relational fields? In your XSD schema, your electronic invoice is related to the <cite>partner.binding.mixin</cite> not to an Odoo <cite>res.partner</cite>. Don't worry, when <cite>SpecModel</cite> classes are instanciated for all relational fields, we look if their comodel have been injected into some existing Odoo model and if so we remap them to the proper Odoo model.</p>
<p><strong>Field prefixes</strong>: to avoid field collision between the Odoo fields and the XSD fields, the XSD fields are prefixed with the name of the schema and a few digits representing the schema version (typically 2 digits). So if your schema get a minor version upgrade, the same fields and classes are used. For a major upgrade however new fields and classes may be used so data of several major versions could co-exist inside your Odoo database.</p>
<a name="stackedmodel"></a>
<h2>StackedModel</h2>
<p>Sadly real life XML is a bit more complex than that. Often XML structures are deeply nested just because it makes it easier for XSD schemas to validate them! for instance an electronic invoice line can be a nested structure with lots of tax details and product details. In a relational model like Odoo however you often want flatter data structures. This is where <cite>StackedModel</cite> comes to the rescue! It inherits from <cite>SpecModel</cite> and when you inherit from <cite>StackedModel</cite> you can inherit from all the generated mixins corresponding to the nested XML tags below some tag (here <cite>invoice.line.binding.mixin</cite>). All the fields corresponding to these XML tag attributes will be collected in your model and the XML parsing and serialization will happen as expected:</p>
<pre>
<code>from odoo.addons.spec_driven_model.models import spec_models
class InvoiceLine(spec_models.StackedModel):
_inherit = [
'account.move.line',
'invoice.line.binding.mixin',
]
_stacked = 'invoice.line.binding.mixin'</code>
</pre>
<p>All many2one fields that are required in the XSD (xsd_required=True) will get their model stacked automatically and recursively. You can force non required many2one fields to be stacked using the <cite>_force_stack_paths</cite> attribute. On the contrary, you can avoid some required many2one fields to be stacked using the <cite>stack_skip</cite> attribute.</p>
<a name="hooks"></a>
<h2>Hooks</h2>
<p>Because XSD schemas can define lot's of different models, spec_driven_model comes with handy hooks that will automatically make all XSD mixins turn into concrete Odoo model (eg with a table) if you didn't inject them into existing Odoo models.</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="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a></li>
</ul>
</div>
<a name="usage"></a>
<h3><a class="toc-backref" href="#id1">Usage</a></h3>
<p>See my detailed OCA Days explanations here:
<a class="reference external" href="https://www.youtube.com/watch?v=6gFOe7Wh8uA">https://www.youtube.com/watch?v=6gFOe7Wh8uA</a></p>
<p>You are also encouraged to look at the tests directory which features a full blown example from the famous PurchaseOrder.xsd from Microsoft tutorials.</p>
<a name="known-issues-roadmap"></a>
<h3><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h3>
<p>Migrate from generateDS to xsdata; see the xsdata Pull Requests in the repo.</p>
<a name="bug-tracker"></a>
<h3><a class="toc-backref" href="#id3">Bug Tracker</a></h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/l10n-brazil/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/l10n-brazil/issues/new?body=module:%20spec_driven_model%0Aversion:%2014.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>
<h3><a class="toc-backref" href="#id4">Credits</a></h3>
<a name="authors"></a>
<h2>Authors</h2>
<ul class="simple">
<li>Akretion</li>
</ul>
<a name="contributors"></a>
<h2>Contributors</h2>
<ul class="simple">
<li><a class="reference external" href="https://akretion.com/pt-BR/">AKRETION</a>:<ul>
<li>Raphaël Valyi <<a class="reference external" href="mailto:raphael.valyi@akretion.com.br">raphael.valyi@akretion.com.br</a>></li>
</ul>
</li>
<li><a class="reference external" href="https://kmee.com.br">KMEE</a>:<ul>
<li>Gabriel Cardoso de Faria <<a class="reference external" href="mailto:gabriel.cardoso@kmee.com.br">gabriel.cardoso@kmee.com.br</a>></li>
</ul>
</li>
</ul>
<a name="maintainers"></a>
<h2>Maintainers</h2>
<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/rvalyi"><img alt="rvalyi" src="https://github.com/rvalyi.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/l10n-brazil/tree/14.0/spec_driven_model">OCA/l10n-brazil</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>