<h1 class="title">Base Jsonify</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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/base_jsonify"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-base_jsonify"><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/149/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module adds a 'jsonify' method to every model of the ORM. It works on the current recordset and requires a single argument 'parser' that specify the field to extract.</p> <p>Example of a simple parser:</p> <pre> <code lang="python">parser = [ 'name', 'number', 'create_date', ('partner_id', ['id', 'display_name', 'ref']) ('line_id', ['id', ('product_id', ['name']), 'price_unit']) ]</code> </pre> <p>In order to be consistent with the odoo api the jsonify method always return a list of object even if there is only one element in the recordset.</p> <p>By default the key into the json is the name of the field extracted from the model. If you need to specify an alternate name to use as key, you can define your mapping as follow into the parser definition:</p> <pre> <code lang="python">parser = [ 'field_name:json_key' ]</code> </pre> <pre> <code lang="python">parser = [ 'name', 'number', 'create_date:creationDate', ('partner_id:partners', ['id', 'display_name', 'ref']) ('line_id:lines', ['id', ('product_id', ['name']), 'price_unit']) ]</code> </pre> <p>If you need to parse the value of a field in a custom way, you can pass a callable or the name of a method on the model:</p> <pre> <code lang="python">parser = [ ('name', &quot;jsonify_name&quot;) # method name ('number', lambda rec, field_name: rec[field_name] * 2)) # callable ]</code> </pre> <p>Also the module provide a method &quot;get_json_parser&quot; on the ir.exports object that generate a parser from an ir.exports configuration.</p> <p>Further features are available for advanced uses. It defines a simple &quot;resolver&quot; model that has a &quot;python_code&quot; field and an eval function so that arbitrary functions can be configured to transform fields, or process the resulting dictionary. It is also to specify a lang to extract the translation of any given field.</p> <p>To use these features, a full parser follows the following structure:</p> <pre> <code lang="python">parser = { &quot;resolver&quot;: 3, &quot;language_agnostic&quot;: True, &quot;langs&quot;: { False: [ {'name': 'description'}, {'name': 'number', 'resolver': 5}, ({'name': 'partner_id', 'alias': 'partners'}, [{'name': 'display_name'}]) ], 'fr_FR': [ {'name': 'description', 'alias': 'descriptions_fr'}, ({'name': 'partner_id', 'alias': 'partners'}, [{'name': 'description', 'alias': 'description_fr'}]) ], } }</code> </pre> <p>Note that a resolver can be passed either as a recordset or as an id, so as to be fully serializable. A slightly simpler version in case the translation of fields is not needed, but other features like custom resolvers are:</p> <pre> <code lang="python">parser = { &quot;resolver&quot;: 3, &quot;language_agnostic&quot;: True, &quot;fields&quot;: [ {'name': 'description'}, {'name': 'number', 'resolver': 5}, ({'name': 'partner_id', 'alias': 'partners'}, [{'name': 'display_name'}]), ], }</code> </pre> <p>A simple parser is simply translated into a full parser at export.</p> <p>If the global resolver is given, then the json_dict goes through:</p> <pre> <code lang="python">resolver.eval(dict, record)</code> </pre> <p>Which allows to add external data from the context or transform the dictionary if necessary. Similarly if given for a field the resolver evaluates the result.</p> <p>It is possible for an alias to end with a '*': in that case the result it put into a list.</p> <pre> <code lang="python">parser = { &quot;langs&quot;: { False: [ {'name': 'name'}, {'name': 'field_1', 'alias': 'customTags*'}, {'name': 'field_2', 'alias': 'customTags*'}, ] } }</code> </pre> <p>Would result in the following json structure:</p> <pre> <code lang="python">{ 'name': 'record_name', 'customTags': ['field_1_value', 'field_2_value'], }</code> </pre> <p>The intended use-case is to be compatible with APIs that require all translated parameters to be exported simultaneously, and ask for custom properties to be put in a sub-dictionary. Since it is often the case that some of these requirements are optional, new requirements could be met without needing to add field or change any code.</p> <p>Note that the export values with the simple parser depends on the record's lang; this is in contrast with full parsers which are designed to be language agnostic.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id2">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id3">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li> </ul> </li> </ul> </div> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id1">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20base_jsonify%0Aversion:%2013.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="#id2">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id3">Authors</a></h3> <ul class="simple"> <li>Akretion</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id4">Contributors</a></h3> <ul class="simple"> <li>BEAU Sébastien &lt;<a class="reference external" href="mailto:sebastien.beau&#64;akretion.com">sebastien.beau&#64;akretion.com</a>&gt;</li> <li>Raphaël Reverdy &lt;<a class="reference external" href="mailto:raphael.reverdy&#64;akretion.com">raphael.reverdy&#64;akretion.com</a>&gt;</li> <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;</li> <li>Nans Lefebvre &lt;<a class="reference external" href="mailto:nans.lefebvre&#64;acsone.eu">nans.lefebvre&#64;acsone.eu</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id5">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>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/13.0/base_jsonify">OCA/server-tools</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>