[19.0] [MIG] jsonifier

jsonifier/README.rst

@@ -0,0 +1,288 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+=========
+JSONifier
+=========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:cbf418975463b6a5ff3ae89fdd5b77a2f9c2ad8c23f82869ce51846f94bff7ce
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/19.0/jsonifier
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-19-0/server-tools-19-0-jsonifier
+    :alt: Translate me on Weblate
+.. |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=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+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.
+
+Example of a simple parser:
+
+.. code:: python
+
+   parser = [
+       'name',
+       'number',
+       'create_date',
+       ('partner_id', ['id', 'display_name', 'ref'])
+       ('line_id', ['id', ('product_id', ['name']), 'price_unit'])
+   ]
+
+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.
+
+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:
+
+.. code:: python
+
+   parser = [
+       'field_name:json_key'
+   ]
+
+.. code:: python
+
+   parser = [
+       'name',
+       'number',
+       'create_date:creationDate',
+       ('partner_id:partners', ['id', 'display_name', 'ref'])
+       ('line_id:lines', ['id', ('product_id', ['name']), 'price_unit'])
+   ]
+
+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:
+
+.. code:: python
+
+   parser = [
+       ('name', "jsonify_name")  # method name
+       ('number', lambda rec, field_name: rec[field_name] * 2))  # callable
+   ]
+
+Also the module provide a method "get_json_parser" on the ir.exports
+object that generate a parser from an ir.exports configuration.
+
+Further features are available for advanced uses. It defines a simple
+"resolver" model that has a "python_code" field and a resolve 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.
+
+To use these features, a full parser follows the following structure:
+
+.. code:: python
+
+   parser = {
+       "resolver": 3,
+       "language_agnostic": True,
+       "langs": {
+           False: [
+               {'name': 'description'},
+               {'name': 'number', 'resolver': 5},
+               ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'display_name'}])
+           ],
+           'fr_FR': [
+               {'name': 'description', 'target': 'descriptions_fr'},
+               ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'description', 'target': 'description_fr'}])
+           ],
+       }
+   }
+
+One would get a result having this structure (note that the translated
+fields are merged in the same dictionary):
+
+.. code:: python
+
+   exported_json == {
+       "description": "English description",
+       "description_fr": "French description, voilà",
+       "number": 42,
+       "partner": {
+           "display_name": "partner name",
+           "description_fr": "French description of that partner",
+       },
+   }
+
+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:
+
+.. code:: python
+
+   parser = {
+       "resolver": 3,
+       "fields": [
+               {'name': 'description'},
+               {'name': 'number', 'resolver': 5},
+               ({'name': 'partner_id', 'target': 'partners'}, [{'name': 'display_name'}]),
+       ],
+   }
+
+By passing the fields key instead of langs, we have essentially the same
+behaviour as simple parsers, with the added benefit of being able to use
+resolvers.
+
+Standard use-cases of resolvers are: - give field-specific defaults
+(e.g. "" instead of None) - cast a field type (e.g. int()) - alias a
+particular field for a specific export - ...
+
+A simple parser is simply translated into a full parser at export.
+
+If the global resolver is given, then the json_dict goes through:
+
+.. code:: python
+
+   resolver.resolve(dict, record)
+
+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.
+
+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.
+
+.. code:: python
+
+   parser = {
+       fields: [
+           {'name': 'name'},
+           {'name': 'field_1', 'target': 'customTags=list'},
+           {'name': 'field_2', 'target': 'customTags=list'},
+       ]
+   }
+
+Would result in the following JSON structure:
+
+.. code:: python
+
+   {
+       'name': 'record_name',
+       'customTags': ['field_1_value', 'field_2_value'],
+   }
+
+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.
+
+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.
+
+NOTE: this module was named base_jsonify till version 14.0.1.5.0.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+with_fieldname parameter
+------------------------
+
+The with_fieldname option of jsonify() method, when true, will inject on
+the same level of the data "\_fieldname\_$field" keys that will contain
+the field name, in the language of the current user.
+
+   Examples of with_fieldname usage:
+
+.. code:: python
+
+   # example 1
+   parser = [('name')]
+   a.jsonify(parser=parser)
+   [{'name': 'SO3996'}]
+   >>> a.jsonify(parser=parser, with_fieldname=False)
+   [{'name': 'SO3996'}]
+   >>> a.jsonify(parser=parser, with_fieldname=True)
+   [{'fieldname_name': 'Order Reference', 'name': 'SO3996'}}]
+
+
+   # example 2 - with a subparser-
+   parser=['name', 'create_date', ('order_line', ['id' , 'product_uom', 'is_expense'])]
+   >>> a.jsonify(parser=parser, with_fieldname=False)
+   [{'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}]}]
+   >>> a.jsonify(parser=parser, with_fieldname=True)
+   [{'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}]}]
+
+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 to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20jsonifier%0Aversion:%2019.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.
+
+Credits
+=======
+
+Authors
+-------
+
+* Akretion
+* ACSONE
+* Camptocamp
+
+Contributors
+------------
+
+- BEAU Sébastien <[email protected]>
+- Raphaël Reverdy <[email protected]>
+- Laurent Mignon <[email protected]>
+- Nans Lefebvre <[email protected]>
+- Simone Orsi <[email protected]>
+- Iván Todorovich <[email protected]>
+- Nguyen Minh Chien <[email protected]>
+- Thien Vo <[email protected]>
+
+Other credits
+-------------
+
+The migration of this module from 17.0 to 18.0 was financially supported
+by Camptocamp.
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/19.0/jsonifier>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

jsonifier/__init__.py

@@ -0,0 +1 @@
+from . import models

jsonifier/__manifest__.py

@@ -0,0 +1,26 @@
+# Copyright 2017-2018 Akretion (http://www.akretion.com)
+# Sébastien BEAU <[email protected]>
+# Raphaël Reverdy <[email protected]>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+
+{
+    "name": "JSONifier",
+    "summary": "JSON-ify data for all models",
+    "version": "19.0.0.1.0",
+    "category": "Uncategorized",
+    "website": "https://github.com/OCA/server-tools",
+    "author": "Akretion, ACSONE, Camptocamp, Odoo Community Association (OCA)",
+    "license": "LGPL-3",
+    "installable": True,
+    "depends": ["base"],
+    "data": [
+        "security/ir.model.access.csv",
+        "views/ir_exports_view.xml",
+        "views/ir_exports_resolver_view.xml",
+    ],
+    "demo": [
+        "demo/resolver_demo.xml",
+        "demo/export_demo.xml",
+        "demo/ir.exports.line.csv",
+    ],
+}

jsonifier/demo/export_demo.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <record id="ir_exp_partner" model="ir.exports">
+        <field name="name">Partner Export</field>
+        <field name="resource">res.partner</field>
+    </record>
+</odoo>

jsonifier/demo/ir.exports.line.csv

@@ -0,0 +1,16 @@
+id,export_id/id,name
+name,ir_exp_partner,name
+active,ir_exp_partner,active
+partner_latitude,ir_exp_partner,partner_latitude
+color,ir_exp_partner,color
+category_id_name,ir_exp_partner,category_id/name
+country_id_name,ir_exp_partner,country_id/name
+country_id_code,ir_exp_partner,country_id/code
+child_ids_name,ir_exp_partner,child_ids/name
+child_ids_id,ir_exp_partner,child_ids/id
+child_ids_email,ir_exp_partner,child_ids/email
+child_ids_country_id_name,ir_exp_partner,child_ids/country_id/name
+child_ids_country_id_code,ir_exp_partner,child_ids/country_id/code
+child_ids_child_ids_name,ir_exp_partner,child_ids/child_ids/name
+lang,ir_exp_partner,lang
+comment,ir_exp_partner,comment

jsonifier/demo/resolver_demo.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <record id="ir_exports_resolver_dict" model="ir.exports.resolver">
+        <field name="name">ExtraData dictionary (number/text)</field>
+        <field name="python_code">
+is_number = field_type in ('integer', 'float')
+ftype = "NUMBER" if is_number else "TEXT"
+value = value if is_number else str(value)
+result = {"Key": name, "Value": value, "Type": ftype, "IsPublic": True}
+        </field>
+    </record>
+</odoo>

jsonifier/exceptions.py

@@ -0,0 +1,7 @@
+# Copyright 2022 Camptocamp SA (http://www.camptocamp.com)
+# Simone Orsi <[email protected]>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+
+
+class SwallableException(Exception):
+    """An exception that can be safely skipped."""