You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

117 lines
3.8 KiB

8 years ago
  1. ============
  2. Base Jsonify
  3. ============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/10.0/base_jsonify
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-10-0/server-tools-10-0-base_jsonify
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/10.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds a 'jsonify' method to every model of the ORM.
  25. It works on the current recordset and requires a single argument 'parser'
  26. that specify the field to extract.
  27. Example of parser:
  28. .. code-block:: python
  29. parser = [
  30. 'name',
  31. 'number',
  32. 'create_date',
  33. ('partner_id', ['id', 'display_name', 'ref'])
  34. ('line_id', ['id', ('product_id', ['name']), 'price_unit'])
  35. ]
  36. In order to be consitent with the odoo api the jsonify method always
  37. return a list of object even if there is only one element in input
  38. By default the key into the json is the name of the field extracted
  39. from the model. If you need to specify an alternate name to use as key, you
  40. can define your mapping as follow into the parser definition:
  41. .. code-block:: python
  42. parser = [
  43. 'field_name:json_key'
  44. ]
  45. .. code-block:: python
  46. parser = [
  47. 'name',
  48. 'number',
  49. 'create_date:creationDate',
  50. ('partner_id:partners', ['id', 'display_name', 'ref'])
  51. ('line_id:lines', ['id', ('product_id', ['name']), 'price_unit'])
  52. ]
  53. Also the module provide a method "get_json_parser" on the ir.exports object
  54. that generate a parser from an ir.exports configuration
  55. **Table of contents**
  56. .. contents::
  57. :local:
  58. Bug Tracker
  59. ===========
  60. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  61. In case of trouble, please check there if your issue has already been reported.
  62. If you spotted it first, help us smashing it by providing a detailed and welcomed
  63. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_jsonify%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  64. Do not contact contributors directly about support or help with technical issues.
  65. Credits
  66. =======
  67. Authors
  68. ~~~~~~~
  69. * Akretion
  70. Contributors
  71. ~~~~~~~~~~~~
  72. * BEAU Sébastien <sebastien.beau@akretion.com>
  73. * Raphaël Reverdy <raphael.reverdy@akretion.com>
  74. * Laurent Mignon <laurent.mignon@acsone.eu>
  75. Maintainers
  76. ~~~~~~~~~~~
  77. This module is maintained by the OCA.
  78. .. image:: https://odoo-community.org/logo.png
  79. :alt: Odoo Community Association
  80. :target: https://odoo-community.org
  81. OCA, or the Odoo Community Association, is a nonprofit organization whose
  82. mission is to support the collaborative development of Odoo features and
  83. promote its widespread use.
  84. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/10.0/base_jsonify>`_ project on GitHub.
  85. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.