{ "info": { "author": "Akretion, Odoo Community Association (OCA)", "author_email": "support@odoo-community.org", "bugtrack_url": null, "classifiers": [ "Framework :: Odoo", "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python" ], "description": "============\nBase Jsonify\n============\n\n.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github\n :target: https://github.com/OCA/server-tools/tree/13.0/base_jsonify\n :alt: OCA/server-tools\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-base_jsonify\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png\n :target: https://runbot.odoo-community.org/runbot/149/13.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nThis module adds a 'jsonify' method to every model of the ORM.\nIt works on the current recordset and requires a single argument 'parser'\nthat specify the field to extract.\n\nExample of a simple parser:\n\n\n.. code-block:: python\n\n parser = [\n 'name',\n 'number',\n 'create_date',\n ('partner_id', ['id', 'display_name', 'ref'])\n ('line_id', ['id', ('product_id', ['name']), 'price_unit'])\n ]\n\nIn order to be consistent with the odoo api the jsonify method always\nreturn a list of object even if there is only one element in the recordset.\n\nBy default the key into the json is the name of the field extracted\nfrom the model. If you need to specify an alternate name to use as key, you\ncan define your mapping as follow into the parser definition:\n\n.. code-block:: python\n\n parser = [\n 'field_name:json_key'\n ]\n\n.. code-block:: python\n\n\n parser = [\n 'name',\n 'number',\n 'create_date:creationDate',\n ('partner_id:partners', ['id', 'display_name', 'ref'])\n ('line_id:lines', ['id', ('product_id', ['name']), 'price_unit'])\n ]\n\nIf you need to parse the value of a field in a custom way,\nyou can pass a callable or the name of a method on the model:\n\n.. code-block:: python\n\n parser = [\n ('name', \"jsonify_name\") # method name\n ('number', lambda rec, field_name: rec[field_name] * 2)) # callable\n ]\n\nAlso the module provide a method \"get_json_parser\" on the ir.exports object\nthat generate a parser from an ir.exports configuration.\n\nFurther features are available for advanced uses.\nIt defines a simple \"resolver\" model that has a \"python_code\" field and a resolve\nfunction so that arbitrary functions can be configured to transform fields,\nor process the resulting dictionary.\nIt is also to specify a lang to extract the translation of any given field.\n\nTo use these features, a full parser follows the following structure:\n\n.. code-block:: python\n\n parser = {\n \"resolver\": 3,\n \"language_agnostic\": True,\n \"langs\": {\n False: [\n {'name': 'description'},\n {'name': 'number', 'resolver': 5},\n ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'display_name'}])\n ],\n 'fr_FR': [\n {'name': 'description', 'target': 'descriptions_fr'},\n ({'name': 'partner_id', 'target': 'partner'}, [{'name': 'description', 'target': 'description_fr'}])\n ],\n }\n }\n\n\nOne would get the a result having this structure (note that the translated fields are merged in the same dictionary):\n\n.. code-block:: python\n\n exported_json == {\n \"description\": \"English description\",\n \"description_fr\": \"French description, voil\u00e0\",\n \"number\": 42,\n \"partner\": {\n \"display_name\": \"partner name\",\n \"description_fr\": \"French description of that partner\",\n },\n }\n\n\nNote that a resolver can be passed either as a recordset or as an id, so as to be fully serializable.\nA slightly simpler version in case the translation of fields is not needed,\nbut other features like custom resolvers are:\n\n.. code-block:: python\n\n parser = {\n \"resolver\": 3,\n \"fields\": [\n {'name': 'description'},\n {'name': 'number', 'resolver': 5},\n ({'name': 'partner_id', 'target': 'partners'}, [{'name': 'display_name'}]),\n ],\n }\n\n\nBy passing the `fields` key instead of `langs`, we have essentially the same behaviour as simple parsers,\nwith the added benefit of being able to use resolvers.\n\nStandard use-cases of resolvers are:\n- give field-specific defaults (e.g. `\"\"` instead of `None`)\n- cast a field type (e.g. `int()`)\n- alias a particular field for a specific export\n- ...\n\nA simple parser is simply translated into a full parser at export.\n\nIf the global resolver is given, then the json_dict goes through:\n\n.. code-block:: python\n\n resolver.resolve(dict, record)\n\nWhich allows to add external data from the context or transform the dictionary\nif necessary. Similarly if given for a field the resolver evaluates the result.\n\nIt is possible for a target to have a marshaller by ending the target with '=list':\nin that case the result is put into a list.\n\n.. code-block:: python\n\n parser = {\n fields: [\n {'name': 'name'},\n {'name': 'field_1', 'target': 'customTags=list'},\n {'name': 'field_2', 'target': 'customTags=list'},\n ]\n }\n\n\nWould result in the following json structure:\n\n.. code-block:: python\n\n {\n 'name': 'record_name',\n 'customTags': ['field_1_value', 'field_2_value'],\n }\n\nThe intended use-case is to be compatible with APIs that require all translated\nparameters to be exported simultaneously, and ask for custom properties to be\nput in a sub-dictionary.\nSince it is often the case that some of these requirements are optional,\nnew requirements could be met without needing to add field or change any code.\n\nNote that the export values with the simple parser depends on the record's lang;\nthis is in contrast with full parsers which are designed to be language agnostic.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues `_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed\n`feedback `_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Akretion\n\nContributors\n~~~~~~~~~~~~\n\n* BEAU S\u00e9bastien \n* Rapha\u00ebl Reverdy \n* Laurent Mignon \n* Nans Lefebvre \n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/server-tools `_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/OCA/server-tools", "keywords": "", "license": "AGPL-3", "maintainer": "", "maintainer_email": "", "name": "odoo13-addon-base-jsonify", "package_url": "https://pypi.org/project/odoo13-addon-base-jsonify/", "platform": "", "project_url": "https://pypi.org/project/odoo13-addon-base-jsonify/", "project_urls": { "Homepage": "https://github.com/OCA/server-tools" }, "release_url": "https://pypi.org/project/odoo13-addon-base-jsonify/13.0.3.2.0/", "requires_dist": [ "odoo (<13.1dev,>=13.0a)" ], "requires_python": ">=3.5", "summary": "Base module that provide the jsonify method on all models", "version": "13.0.3.2.0", "yanked": false, "yanked_reason": null }, "last_serial": 11688662, "releases": { "13.0.1.0.1": [ { "comment_text": "", "digests": { "md5": "fdbe375ae6b2c67eb5fca6f979d3e981", "sha256": "20865a599cf4ef8238147fdd7076ff7021622b420c3bea3df190838d0cd02de5" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "fdbe375ae6b2c67eb5fca6f979d3e981", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29613, "upload_time": "2019-10-31T05:41:56", "upload_time_iso_8601": "2019-10-31T05:41:56.076886Z", "url": "https://files.pythonhosted.org/packages/f3/2f/4388effb746582add15a7d317168987cac8a4e9e867e84d09351c317053f/odoo13_addon_base_jsonify-13.0.1.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.2": [ { "comment_text": "", "digests": { "md5": "107f2767dad9fcce09cfa6c2e5280e99", "sha256": "0d6a5c0db5a43a9b596f3d316acb2a0ba6f95a117acd1049192ae44482b4568b" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "107f2767dad9fcce09cfa6c2e5280e99", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29878, "upload_time": "2019-11-03T05:41:29", "upload_time_iso_8601": "2019-11-03T05:41:29.132994Z", "url": "https://files.pythonhosted.org/packages/72/76/28944f90c661bd2aebf7d8a010dd28c397bb42efb49d7bae4a41794b67e6/odoo13_addon_base_jsonify-13.0.1.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.2.dev3": [ { "comment_text": "", "digests": { "md5": "c95451b0c0f2386c0a4c43e2feb3f447", "sha256": "96eda1277af958426ee8fe604e7d93631ebd2616e117e8bbaa01e746be846d3d" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.0.2.dev3-py3-none-any.whl", "has_sig": false, "md5_digest": "c95451b0c0f2386c0a4c43e2feb3f447", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29925, "upload_time": "2019-11-02T05:41:05", "upload_time_iso_8601": "2019-11-02T05:41:05.386868Z", "url": "https://files.pythonhosted.org/packages/e4/5a/227441973ec4f6535e2762ebacc66b94ce7360b61ae050b05a7a075665f1/odoo13_addon_base_jsonify-13.0.1.0.2.dev3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.3.dev1": [ { "comment_text": "", "digests": { "md5": "d5282e3ad1e78c758e5ed28e580db928", "sha256": "665b42bd45c829723823824dbaf2a5590cd05697224f554043f254b2fef5b150" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.0.3.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5282e3ad1e78c758e5ed28e580db928", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29916, "upload_time": "2019-12-25T05:42:27", "upload_time_iso_8601": "2019-12-25T05:42:27.075150Z", "url": "https://files.pythonhosted.org/packages/1d/59/d6ca158629641e9f64ddde35fe8b12e0d343ad82f84a70fa6ad20a246116/odoo13_addon_base_jsonify-13.0.1.0.3.dev1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.0.3.dev2": [ { "comment_text": "", "digests": { "md5": "a9fda08f5e9792722752b1e51f6c1536", "sha256": "57bdbdda475f72d51972a0e15148cc021cdb1bc854520147c72fc089327c7d33" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.0.3.dev2-py3-none-any.whl", "has_sig": false, "md5_digest": "a9fda08f5e9792722752b1e51f6c1536", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 29917, "upload_time": "2020-03-16T05:43:34", "upload_time_iso_8601": "2020-03-16T05:43:34.645225Z", "url": "https://files.pythonhosted.org/packages/b7/d3/ffb330fe5df815b9e1e1b397834af0641083f9fa0bf3dcb2dac2d17a9564/odoo13_addon_base_jsonify-13.0.1.0.3.dev2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.1.0": [ { "comment_text": "", "digests": { "md5": "5392fcc65eb864fbf0d2b9c6c19b9f72", "sha256": "0516f371a86f5d3e19bcbb9e3f63455a56ebf74b97607ede2c092468b60d264b" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "5392fcc65eb864fbf0d2b9c6c19b9f72", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 30850, "upload_time": "2020-06-05T04:43:55", "upload_time_iso_8601": "2020-06-05T04:43:55.837955Z", "url": "https://files.pythonhosted.org/packages/65/dd/440c5d36aeb8c039573790fcde3e45c4758c5f6190edc7a3ef93f751e69c/odoo13_addon_base_jsonify-13.0.1.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.1.1.dev1": [ { "comment_text": "", "digests": { "md5": "c77437f2d641a7c0fcd9fc960c72495e", "sha256": "85e5a27a1077fd48bc93b4b6ecebfb04c5d951e4faac169f3ab0eaaf3a4f23bf" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.1.1.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "c77437f2d641a7c0fcd9fc960c72495e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 30921, "upload_time": "2020-06-06T04:44:28", "upload_time_iso_8601": "2020-06-06T04:44:28.706696Z", "url": "https://files.pythonhosted.org/packages/1f/52/edfa999fc04d44b48789270d240a741dc9711146e32ad32489546c4db3a1/odoo13_addon_base_jsonify-13.0.1.1.1.dev1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.2.0": [ { "comment_text": "", "digests": { "md5": "d93feee5232e1f5b384f92b858b4a30b", "sha256": "376a9dd04541bac2b22de04af4cb9d84da546157cd0d7951f1db35a817d93e14" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d93feee5232e1f5b384f92b858b4a30b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 30915, "upload_time": "2020-09-25T04:48:46", "upload_time_iso_8601": "2020-09-25T04:48:46.842361Z", "url": "https://files.pythonhosted.org/packages/4a/eb/1bb881a1c91a3bd9eef4006a41a48c1db29682128017357efc6c8ac8e486/odoo13_addon_base_jsonify-13.0.1.2.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.3.0": [ { "comment_text": "", "digests": { "md5": "53b0371fd008c36d8ea18c2a30d741e4", "sha256": "d16b245bce5db1a0617e3732e8994453f27c473b2bb381d89f05567e8303dad8" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "53b0371fd008c36d8ea18c2a30d741e4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 31121, "upload_time": "2020-09-25T04:48:49", "upload_time_iso_8601": "2020-09-25T04:48:49.053755Z", "url": "https://files.pythonhosted.org/packages/64/ae/ed8511301824a260aecae9186d5c23236629ffd9b08fb7d498fc9f06afef/odoo13_addon_base_jsonify-13.0.1.3.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.3.1": [ { "comment_text": "", "digests": { "md5": "ce4643889d001c87d00ab4524c46b65d", "sha256": "01edf6733f92443c9dcedf3004a528528b57f7f198db586e1671d55cfe2cba5b" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ce4643889d001c87d00ab4524c46b65d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 31177, "upload_time": "2020-11-20T05:52:09", "upload_time_iso_8601": "2020-11-20T05:52:09.960686Z", "url": "https://files.pythonhosted.org/packages/c0/56/6bd04cf15efd1b57998630e6d9e390773b4ff7c7c1bc2fee3d0ab388ecc8/odoo13_addon_base_jsonify-13.0.1.3.1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.1.3.2.dev1": [ { "comment_text": "", "digests": { "md5": "26c3add742a736e1a2ced4d63b326d2c", "sha256": "c05d35896cdfc9c8cb93341a4d1e67f81bfdaab68f41d46b4b127cd57036aba9" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.1.3.2.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "26c3add742a736e1a2ced4d63b326d2c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 31219, "upload_time": "2020-11-23T05:53:21", "upload_time_iso_8601": "2020-11-23T05:53:21.541335Z", "url": "https://files.pythonhosted.org/packages/65/34/303d10e0976e4cb72566bd37882abf81e857c791e366d4212369eccffd49/odoo13_addon_base_jsonify-13.0.1.3.2.dev1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.3.0.0": [ { "comment_text": "", "digests": { "md5": "340f15d226ca6c8a747058168691985e", "sha256": "ca1e1f205ef80947e2d4f3720cec17e24f9732a6d9ad49a4bc5fbba181599791" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "340f15d226ca6c8a747058168691985e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 43193, "upload_time": "2021-01-22T05:49:04", "upload_time_iso_8601": "2021-01-22T05:49:04.664752Z", "url": "https://files.pythonhosted.org/packages/50/a4/af5a32d9c086585fd80b6b5eb7e98fc26283b095cf969a84fa657cca4dd8/odoo13_addon_base_jsonify-13.0.3.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.3.0.1.dev1": [ { "comment_text": "", "digests": { "md5": "9aea7345dd1790637d30279ae82e4a67", "sha256": "b973d8ea1711bca5ea137a85417addfe26aa4fe842db8ce16d8de29ec092d0e3" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.3.0.1.dev1-py3-none-any.whl", "has_sig": false, "md5_digest": "9aea7345dd1790637d30279ae82e4a67", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 43863, "upload_time": "2021-01-22T05:49:07", "upload_time_iso_8601": "2021-01-22T05:49:07.150590Z", "url": "https://files.pythonhosted.org/packages/ba/e9/5930d43afd57bc797dc0aa221b3b6e04fcc81dcc933b776a34031f9310d8/odoo13_addon_base_jsonify-13.0.3.0.1.dev1-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.3.1.0": [ { "comment_text": "", "digests": { "md5": "8bc536b5af3841f910a381f400880ecd", "sha256": "74081e11a2af6653e65ca2c0d0595a0e9e9525eda19b9f0dd515fb68fe3c9851" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.3.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8bc536b5af3841f910a381f400880ecd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 43906, "upload_time": "2021-02-06T05:49:32", "upload_time_iso_8601": "2021-02-06T05:49:32.427459Z", "url": "https://files.pythonhosted.org/packages/70/c8/99cd20d6cc30d385c9b89f8248951dcd01ba2c021573c95f0111607709f3/odoo13_addon_base_jsonify-13.0.3.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "13.0.3.2.0": [ { "comment_text": "", "digests": { "md5": "db5250e44ce0ffc6fedd44faef0e8d95", "sha256": "2711106aa90841ac0c45941eb1a1a34d3e64fa96dc68e25c88670bb9376f8901" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.3.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "db5250e44ce0ffc6fedd44faef0e8d95", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44125, "upload_time": "2021-10-11T14:53:49", "upload_time_iso_8601": "2021-10-11T14:53:49.470952Z", "url": "https://files.pythonhosted.org/packages/5d/da/33d7fa1a75850e275e43f7ec49de0a8cb16e12570a46c56c6878dffbdb90/odoo13_addon_base_jsonify-13.0.3.2.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "db5250e44ce0ffc6fedd44faef0e8d95", "sha256": "2711106aa90841ac0c45941eb1a1a34d3e64fa96dc68e25c88670bb9376f8901" }, "downloads": -1, "filename": "odoo13_addon_base_jsonify-13.0.3.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "db5250e44ce0ffc6fedd44faef0e8d95", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 44125, "upload_time": "2021-10-11T14:53:49", "upload_time_iso_8601": "2021-10-11T14:53:49.470952Z", "url": "https://files.pythonhosted.org/packages/5d/da/33d7fa1a75850e275e43f7ec49de0a8cb16e12570a46c56c6878dffbdb90/odoo13_addon_base_jsonify-13.0.3.2.0-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }