Skip to content

Commit 9e65ad6

Browse files
OCA-git-botOCA-git-bot
committed
[BOT] post-merge updates
1 parent a2b8a40 commit 9e65ad6

File tree

4 files changed

+84
-18
lines changed

4 files changed

+84
-18
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ addon | version | maintainers | summary
5959
[fetchmail_attach_from_folder](fetchmail_attach_from_folder/) | 16.0.1.5.0 | [![NL66278](https://github.com/NL66278.png?size=30px)](https://github.com/NL66278) | Attach mails in an IMAP folder to existing objects
6060
[html_text](html_text/) | 16.0.1.0.1 | | Generate excerpts from any HTML field
6161
[iap_alternative_provider](iap_alternative_provider/) | 16.0.1.0.0 | [![sebastienbeau](https://github.com/sebastienbeau.png?size=30px)](https://github.com/sebastienbeau) | Base module for providing alternative provider for iap apps
62-
[jsonifier](jsonifier/) | 16.0.0.0.1 | | JSON-ify data for all models
62+
[jsonifier](jsonifier/) | 16.0.0.1.0 | | JSON-ify data for all models
6363
[letsencrypt](letsencrypt/) | 16.0.1.1.1 | [![hbrunn](https://github.com/hbrunn.png?size=30px)](https://github.com/hbrunn) | Request SSL certificates from letsencrypt.org
6464
[module_analysis](module_analysis/) | 16.0.1.0.3 | [![legalsylvain](https://github.com/legalsylvain.png?size=30px)](https://github.com/legalsylvain) | Add analysis tools regarding installed modules to know which installed modules comes from Odoo Core, OCA, or are custom modules
6565
[module_auto_update](module_auto_update/) | 16.0.1.0.2 | | Automatically update Odoo modules

‎jsonifier/README.rst

+33-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ JSONifier
77
!! This file is generated by oca-gen-addon-readme !!
88
!! changes will be overwritten. !!
99
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:35c533b68310f11e30533abb554ad99c602c67aef7b9ba22b2d88822862cf1f0
10+
!! source digest: sha256:b4e38b8c4c0fb183e4fee0005cba8864f90c1da9705d957c0b2dd379a7ce6987
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
1313
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -200,6 +200,38 @@ NOTE: this module was named `base_jsonify` till version 14.0.1.5.0.
200200
.. contents::
201201
:local:
202202

203+
Usage
204+
=====
205+
206+
with_fieldname parameter
207+
==========================
208+
209+
The with_fieldname option of jsonify() method, when true, will inject on
210+
the same level of the data "_fieldname_$field" keys that will
211+
contain the field name, in the language of the current user.
212+
213+
214+
Examples of with_fieldname usage:
215+
216+
.. code-block:: python
217+
218+
# example 1
219+
parser = [('name')]
220+
a.jsonify(parser=parser)
221+
[{'name': 'SO3996'}]
222+
>>> a.jsonify(parser=parser, with_fieldname=False)
223+
[{'name': 'SO3996'}]
224+
>>> a.jsonify(parser=parser, with_fieldname=True)
225+
[{'fieldname_name': 'Order Reference', 'name': 'SO3996'}}]
226+
227+
228+
# example 2 - with a subparser-
229+
parser=['name', 'create_date', ('order_line', ['id' , 'product_uom', 'is_expense'])]
230+
>>> a.jsonify(parser=parser, with_fieldname=False)
231+
[{'name': 'SO3996', 'create_date': '2015-06-02T12:18:26.279909+00:00', 'order_line': [{'id': 16649, 'product_uom': 'stuks', 'is_expense': False}, {'id': 16651, 'product_uom': 'stuks', 'is_expense': False}, {'id': 16650, 'product_uom': 'stuks', 'is_expense': False}]}]
232+
>>> a.jsonify(parser=parser, with_fieldname=True)
233+
[{'fieldname_name': 'Order Reference', 'name': 'SO3996', 'fieldname_create_date': 'Creation Date', 'create_date': '2015-06-02T12:18:26.279909+00:00', 'fieldname_order_line': 'Order Lines', 'order_line': [{'fieldname_id': 'ID', 'id': 16649, 'fieldname_product_uom': 'Unit of Measure', 'product_uom': 'stuks', 'fieldname_is_expense': 'Is expense', 'is_expense': False}]}]
234+
203235
Bug Tracker
204236
===========
205237

‎jsonifier/__manifest__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{
77
"name": "JSONifier",
88
"summary": "JSON-ify data for all models",
9-
"version": "16.0.0.0.1",
9+
"version": "16.0.0.1.0",
1010
"category": "Uncategorized",
1111
"website": "https://github.com/OCA/server-tools",
1212
"author": "Akretion, ACSONE, Camptocamp, Odoo Community Association (OCA)",

‎jsonifier/static/description/index.html

+49-15
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88

99
/*
1010
:Author: David Goodger ([email protected])
11-
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
11+
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
1212
:Copyright: This stylesheet has been placed in the public domain.
1313
1414
Default cascading style sheet for the HTML output of Docutils.
15+
Despite the name, some widely supported CSS2 features are used.
1516
1617
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
1718
customize this style sheet.
@@ -274,7 +275,7 @@
274275
margin-left: 2em ;
275276
margin-right: 2em }
276277

277-
pre.code .ln { color: grey; } /* line numbers */
278+
pre.code .ln { color: gray; } /* line numbers */
278279
pre.code, code { background-color: #eeeeee }
279280
pre.code .comment, code .comment { color: #5C6576 }
280281
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -300,7 +301,7 @@
300301
span.pre {
301302
white-space: pre }
302303

303-
span.problematic {
304+
span.problematic, pre.problematic {
304305
color: red }
305306

306307
span.section-subtitle {
@@ -366,7 +367,7 @@ <h1 class="title">JSONifier</h1>
366367
!! This file is generated by oca-gen-addon-readme !!
367368
!! changes will be overwritten. !!
368369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
369-
!! source digest: sha256:35c533b68310f11e30533abb554ad99c602c67aef7b9ba22b2d88822862cf1f0
370+
!! source digest: sha256:b4e38b8c4c0fb183e4fee0005cba8864f90c1da9705d957c0b2dd379a7ce6987
370371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
371372
<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&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
372373
<p>This module adds a ‘jsonify’ method to every model of the ORM.
@@ -502,35 +503,66 @@ <h1 class="title">JSONifier</h1>
502503
<p><strong>Table of contents</strong></p>
503504
<div class="contents local topic" id="contents">
504505
<ul class="simple">
505-
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
506-
<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
507-
<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
508-
<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
509-
<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
506+
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
507+
<li><a class="reference internal" href="#with-fieldname-parameter" id="toc-entry-2">with_fieldname parameter</a></li>
508+
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
509+
<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
510+
<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
511+
<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
512+
<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
510513
</ul>
511514
</li>
512515
</ul>
513516
</div>
517+
<div class="section" id="usage">
518+
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
519+
</div>
520+
<div class="section" id="with-fieldname-parameter">
521+
<h1><a class="toc-backref" href="#toc-entry-2">with_fieldname parameter</a></h1>
522+
<p>The with_fieldname option of jsonify() method, when true, will inject on
523+
the same level of the data “_fieldname_$field” keys that will
524+
contain the field name, in the language of the current user.</p>
525+
<blockquote>
526+
Examples of with_fieldname usage:</blockquote>
527+
<pre class="code python literal-block">
528+
<span class="c1"># example 1</span><span class="w">
529+
</span><span class="n">parser</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'name'</span><span class="p">)]</span><span class="w">
530+
</span><span class="n">a</span><span class="o">.</span><span class="n">jsonify</span><span class="p">(</span><span class="n">parser</span><span class="o">=</span><span class="n">parser</span><span class="p">)</span><span class="w">
531+
</span><span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'SO3996'</span><span class="p">}]</span><span class="w">
532+
</span><span class="o">&gt;&gt;&gt;</span> <span class="n">a</span><span class="o">.</span><span class="n">jsonify</span><span class="p">(</span><span class="n">parser</span><span class="o">=</span><span class="n">parser</span><span class="p">,</span> <span class="n">with_fieldname</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span><span class="w">
533+
</span><span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'SO3996'</span><span class="p">}]</span><span class="w">
534+
</span><span class="o">&gt;&gt;&gt;</span> <span class="n">a</span><span class="o">.</span><span class="n">jsonify</span><span class="p">(</span><span class="n">parser</span><span class="o">=</span><span class="n">parser</span><span class="p">,</span> <span class="n">with_fieldname</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="w">
535+
</span><span class="p">[{</span><span class="s1">'fieldname_name'</span><span class="p">:</span> <span class="s1">'Order Reference'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'SO3996'</span><span class="p">}}]</span><span class="w">
536+
537+
538+
</span><span class="c1"># example 2 - with a subparser-</span><span class="w">
539+
</span><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">'create_date'</span><span class="p">,</span> <span class="p">(</span><span class="s1">'order_line'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span> <span class="p">,</span> <span class="s1">'product_uom'</span><span class="p">,</span> <span class="s1">'is_expense'</span><span class="p">])]</span><span class="w">
540+
</span><span class="o">&gt;&gt;&gt;</span> <span class="n">a</span><span class="o">.</span><span class="n">jsonify</span><span class="p">(</span><span class="n">parser</span><span class="o">=</span><span class="n">parser</span><span class="p">,</span> <span class="n">with_fieldname</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span><span class="w">
541+
</span><span class="p">[{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'SO3996'</span><span class="p">,</span> <span class="s1">'create_date'</span><span class="p">:</span> <span class="s1">'2015-06-02T12:18:26.279909+00:00'</span><span class="p">,</span> <span class="s1">'order_line'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">16649</span><span class="p">,</span> <span class="s1">'product_uom'</span><span class="p">:</span> <span class="s1">'stuks'</span><span class="p">,</span> <span class="s1">'is_expense'</span><span class="p">:</span> <span class="kc">False</span><span class="p">},</span> <span class="p">{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">16651</span><span class="p">,</span> <span class="s1">'product_uom'</span><span class="p">:</span> <span class="s1">'stuks'</span><span class="p">,</span> <span class="s1">'is_expense'</span><span class="p">:</span> <span class="kc">False</span><span class="p">},</span> <span class="p">{</span><span class="s1">'id'</span><span class="p">:</span> <span class="mi">16650</span><span class="p">,</span> <span class="s1">'product_uom'</span><span class="p">:</span> <span class="s1">'stuks'</span><span class="p">,</span> <span class="s1">'is_expense'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}]}]</span><span class="w">
542+
</span><span class="o">&gt;&gt;&gt;</span> <span class="n">a</span><span class="o">.</span><span class="n">jsonify</span><span class="p">(</span><span class="n">parser</span><span class="o">=</span><span class="n">parser</span><span class="p">,</span> <span class="n">with_fieldname</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="w">
543+
</span><span class="p">[{</span><span class="s1">'fieldname_name'</span><span class="p">:</span> <span class="s1">'Order Reference'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'SO3996'</span><span class="p">,</span> <span class="s1">'fieldname_create_date'</span><span class="p">:</span> <span class="s1">'Creation Date'</span><span class="p">,</span> <span class="s1">'create_date'</span><span class="p">:</span> <span class="s1">'2015-06-02T12:18:26.279909+00:00'</span><span class="p">,</span> <span class="s1">'fieldname_order_line'</span><span class="p">:</span> <span class="s1">'Order Lines'</span><span class="p">,</span> <span class="s1">'order_line'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'fieldname_id'</span><span class="p">:</span> <span class="s1">'ID'</span><span class="p">,</span> <span class="s1">'id'</span><span class="p">:</span> <span class="mi">16649</span><span class="p">,</span> <span class="s1">'fieldname_product_uom'</span><span class="p">:</span> <span class="s1">'Unit of Measure'</span><span class="p">,</span> <span class="s1">'product_uom'</span><span class="p">:</span> <span class="s1">'stuks'</span><span class="p">,</span> <span class="s1">'fieldname_is_expense'</span><span class="p">:</span> <span class="s1">'Is expense'</span><span class="p">,</span> <span class="s1">'is_expense'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}]}]</span>
544+
</pre>
545+
</div>
514546
<div class="section" id="bug-tracker">
515-
<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
547+
<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
516548
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
517549
In case of trouble, please check there if your issue has already been reported.
518550
If you spotted it first, help us to smash it by providing a detailed and welcomed
519551
<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>
520552
<p>Do not contact contributors directly about support or help with technical issues.</p>
521553
</div>
522554
<div class="section" id="credits">
523-
<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
555+
<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
524556
<div class="section" id="authors">
525-
<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
557+
<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
526558
<ul class="simple">
527559
<li>Akretion</li>
528560
<li>ACSONE</li>
529561
<li>Camptocamp</li>
530562
</ul>
531563
</div>
532564
<div class="section" id="contributors">
533-
<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
565+
<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
534566
<ul class="simple">
535567
<li>BEAU Sébastien &lt;<a class="reference external" href="mailto:sebastien.beau&#64;akretion.com">sebastien.beau&#64;akretion.com</a>&gt;</li>
536568
<li>Raphaël Reverdy &lt;<a class="reference external" href="mailto:raphael.reverdy&#64;akretion.com">raphael.reverdy&#64;akretion.com</a>&gt;</li>
@@ -541,9 +573,11 @@ <h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
541573
</ul>
542574
</div>
543575
<div class="section" id="maintainers">
544-
<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
576+
<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
545577
<p>This module is maintained by the OCA.</p>
546-
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
578+
<a class="reference external image-reference" href="https://odoo-community.org">
579+
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
580+
</a>
547581
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
548582
mission is to support the collaborative development of Odoo features and
549583
promote its widespread use.</p>

0 commit comments

Comments
 (0)