[UPD] README.rst
OCA-git-bot
chien
parent
739f68b033
commit
c888c09d99
|
|
@ -2,10 +2,13 @@
|
|||
JSONifier
|
||||
=========
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:c2bfb7648f5bdbd7dfc39ce9e3a2169fa7ba35f0d5467e289da141c53a7deded
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
|
|
@ -19,9 +22,9 @@ JSONifier
|
|||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-jsonifier
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/149/16.0
|
||||
:alt: Try me on Runbot
|
||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
|
|
@ -202,7 +205,7 @@ Bug Tracker
|
|||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20jsonifier%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
|
|
|||
|
|
@ -3,18 +3,18 @@
|
|||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>JSONifier</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
|
|
@ -366,20 +366,22 @@ ul.auto-toc {
|
|||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:c2bfb7648f5bdbd7dfc39ce9e3a2169fa7ba35f0d5467e289da141c53a7deded
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<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/server-tools/tree/16.0/jsonifier"><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-16-0/server-tools-16-0-jsonifier"><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/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/server-tools/tree/16.0/jsonifier"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-jsonifier"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-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 class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span><span class="p">,</span>
|
||||
<span class="s1">'number'</span><span class="p">,</span>
|
||||
<span class="s1">'create_date'</span><span class="p">,</span>
|
||||
<span class="p">(</span><span class="s1">'partner_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'display_name'</span><span class="p">,</span> <span class="s1">'ref'</span><span class="p">])</span>
|
||||
<span class="p">(</span><span class="s1">'line_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="p">(</span><span class="s1">'product_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">]),</span> <span class="s1">'price_unit'</span><span class="p">])</span>
|
||||
<span class="p">]</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="s1">'name'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s1">'number'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s1">'create_date'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'partner_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'display_name'</span><span class="p">,</span> <span class="s1">'ref'</span><span class="p">])</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'line_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="p">(</span><span class="s1">'product_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">]),</span> <span class="s1">'price_unit'</span><span class="p">])</span><span class="w">
|
||||
</span><span class="p">]</span>
|
||||
</pre>
|
||||
<p>In order to be consistent with the Odoo API the jsonify method always
|
||||
returns a list of objects even if there is only one element in the recordset.</p>
|
||||
|
|
@ -387,26 +389,26 @@ returns a list of objects even if there is only one element in the recordset.</p
|
|||
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 class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'field_name:json_key'</span>
|
||||
<span class="p">]</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="s1">'field_name:json_key'</span><span class="w">
|
||||
</span><span class="p">]</span>
|
||||
</pre>
|
||||
<pre class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span><span class="p">,</span>
|
||||
<span class="s1">'number'</span><span class="p">,</span>
|
||||
<span class="s1">'create_date:creationDate'</span><span class="p">,</span>
|
||||
<span class="p">(</span><span class="s1">'partner_id:partners'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'display_name'</span><span class="p">,</span> <span class="s1">'ref'</span><span class="p">])</span>
|
||||
<span class="p">(</span><span class="s1">'line_id:lines'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="p">(</span><span class="s1">'product_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">]),</span> <span class="s1">'price_unit'</span><span class="p">])</span>
|
||||
<span class="p">]</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="s1">'name'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s1">'number'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s1">'create_date:creationDate'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'partner_id:partners'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'display_name'</span><span class="p">,</span> <span class="s1">'ref'</span><span class="p">])</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'line_id:lines'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span><span class="p">,</span> <span class="p">(</span><span class="s1">'product_id'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'name'</span><span class="p">]),</span> <span class="s1">'price_unit'</span><span class="p">])</span><span class="w">
|
||||
</span><span class="p">]</span>
|
||||
</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 class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s2">"jsonify_name"</span><span class="p">)</span> <span class="c1"># method name</span>
|
||||
<span class="p">(</span><span class="s1">'number'</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">rec</span><span class="p">,</span> <span class="n">field_name</span><span class="p">:</span> <span class="n">rec</span><span class="p">[</span><span class="n">field_name</span><span class="p">]</span> <span class="o">*</span> <span class="mi">2</span><span class="p">))</span> <span class="c1"># callable</span>
|
||||
<span class="p">]</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s2">"jsonify_name"</span><span class="p">)</span> <span class="c1"># method name</span><span class="w">
|
||||
</span> <span class="p">(</span><span class="s1">'number'</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">rec</span><span class="p">,</span> <span class="n">field_name</span><span class="p">:</span> <span class="n">rec</span><span class="p">[</span><span class="n">field_name</span><span class="p">]</span> <span class="o">*</span> <span class="mi">2</span><span class="p">))</span> <span class="c1"># callable</span><span class="w">
|
||||
</span><span class="p">]</span>
|
||||
</pre>
|
||||
<p>Also the module provide a method “get_json_parser” on the ir.exports object
|
||||
that generate a parser from an ir.exports configuration.</p>
|
||||
|
|
@ -417,46 +419,46 @@ 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 class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"resolver"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||||
<span class="s2">"language_agnostic"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||||
<span class="s2">"langs"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="kc">False</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'number'</span><span class="p">,</span> <span class="s1">'resolver'</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span>
|
||||
<span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partner'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'display_name'</span><span class="p">}])</span>
|
||||
<span class="p">],</span>
|
||||
<span class="s1">'fr_FR'</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'descriptions_fr'</span><span class="p">},</span>
|
||||
<span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partner'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'description_fr'</span><span class="p">}])</span>
|
||||
<span class="p">],</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="s2">"resolver"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"language_agnostic"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"langs"</span><span class="p">:</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="kc">False</span><span class="p">:</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'number'</span><span class="p">,</span> <span class="s1">'resolver'</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partner'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'display_name'</span><span class="p">}])</span><span class="w">
|
||||
</span> <span class="p">],</span><span class="w">
|
||||
</span> <span class="s1">'fr_FR'</span><span class="p">:</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'descriptions_fr'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partner'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'description_fr'</span><span class="p">}])</span><span class="w">
|
||||
</span> <span class="p">],</span><span class="w">
|
||||
</span> <span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span>
|
||||
</pre>
|
||||
<p>One would get a result having this structure (note that the translated fields are merged in the same dictionary):</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="n">exported_json</span> <span class="o">==</span> <span class="p">{</span>
|
||||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"English description"</span><span class="p">,</span>
|
||||
<span class="s2">"description_fr"</span><span class="p">:</span> <span class="s2">"French description, voilà"</span><span class="p">,</span>
|
||||
<span class="s2">"number"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span>
|
||||
<span class="s2">"partner"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="s2">"display_name"</span><span class="p">:</span> <span class="s2">"partner name"</span><span class="p">,</span>
|
||||
<span class="s2">"description_fr"</span><span class="p">:</span> <span class="s2">"French description of that partner"</span><span class="p">,</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">}</span>
|
||||
<span class="n">exported_json</span> <span class="o">==</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"English description"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"description_fr"</span><span class="p">:</span> <span class="s2">"French description, voilà"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"number"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"partner"</span><span class="p">:</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="s2">"display_name"</span><span class="p">:</span> <span class="s2">"partner name"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"description_fr"</span><span class="p">:</span> <span class="s2">"French description of that partner"</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="p">},</span><span class="w">
|
||||
</span><span class="p">}</span>
|
||||
</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 class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"resolver"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||||
<span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'number'</span><span class="p">,</span> <span class="s1">'resolver'</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span>
|
||||
<span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partners'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'display_name'</span><span class="p">}]),</span>
|
||||
<span class="p">],</span>
|
||||
<span class="p">}</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="s2">"resolver"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'description'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'number'</span><span class="p">,</span> <span class="s1">'resolver'</span><span class="p">:</span> <span class="mi">5</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">({</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'partner_id'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'partners'</span><span class="p">},</span> <span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'display_name'</span><span class="p">}]),</span><span class="w">
|
||||
</span> <span class="p">],</span><span class="w">
|
||||
</span><span class="p">}</span>
|
||||
</pre>
|
||||
<p>By passing the <cite>fields</cite> key instead of <cite>langs</cite>, we have essentially the same behaviour as simple parsers,
|
||||
with the added benefit of being able to use resolvers.</p>
|
||||
|
|
@ -475,20 +477,20 @@ if necessary. Similarly if given for a field the resolver evaluates the result.<
|
|||
<p>It is possible for a target to have a marshaller by ending the target with ‘=list’:
|
||||
in that case the result is put into a list.</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="n">fields</span><span class="p">:</span> <span class="p">[</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'name'</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'field_1'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'customTags=list'</span><span class="p">},</span>
|
||||
<span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'field_2'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'customTags=list'</span><span class="p">},</span>
|
||||
<span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
<span class="n">parser</span> <span class="o">=</span> <span class="p">{</span><span class="w">
|
||||
</span> <span class="n">fields</span><span class="p">:</span> <span class="p">[</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'name'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'field_1'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'customTags=list'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'field_2'</span><span class="p">,</span> <span class="s1">'target'</span><span class="p">:</span> <span class="s1">'customTags=list'</span><span class="p">},</span><span class="w">
|
||||
</span> <span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span>
|
||||
</pre>
|
||||
<p>Would result in the following JSON structure:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="p">{</span>
|
||||
<span class="s1">'name'</span><span class="p">:</span> <span class="s1">'record_name'</span><span class="p">,</span>
|
||||
<span class="s1">'customTags'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'field_1_value'</span><span class="p">,</span> <span class="s1">'field_2_value'</span><span class="p">],</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">{</span><span class="w">
|
||||
</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'record_name'</span><span class="p">,</span><span class="w">
|
||||
</span> <span class="s1">'customTags'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'field_1_value'</span><span class="p">,</span> <span class="s1">'field_2_value'</span><span class="p">],</span><span class="w">
|
||||
</span><span class="p">}</span>
|
||||
</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
|
||||
|
|
@ -501,27 +503,27 @@ this is in contrast with full parsers which are designed to be language agnostic
|
|||
<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>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
|
||||
<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
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20jsonifier%0Aversion:%2016.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>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id2">Credits</a></h1>
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id3">Authors</a></h2>
|
||||
<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Akretion</li>
|
||||
<li>ACSONE</li>
|
||||
|
|
@ -529,7 +531,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
|
|||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
|
||||
<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>BEAU Sébastien <<a class="reference external" href="mailto:sebastien.beau@akretion.com">sebastien.beau@akretion.com</a>></li>
|
||||
<li>Raphaël Reverdy <<a class="reference external" href="mailto:raphael.reverdy@akretion.com">raphael.reverdy@akretion.com</a>></li>
|
||||
|
|
@ -540,7 +542,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
|
|||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
|
||||
<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></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
|
||||
|
|
|
|||
Loading…
Reference in New Issue