=========
Datamodel
=========
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:5411d4f742eb933a4d05f5f6e1784a7ddc042e7f22b1c08d535e225c306a6955
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/licence-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%2Frest--framework-lightgray.png?logo=github
:target: https://github.com/OCA/rest-framework/tree/16.0/datamodel
:alt: OCA/rest-framework
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-datamodel
: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/rest-framework&target_branch=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This addon allows you to define simple data models supporting serialization/deserialization
to/from json
Datamodels are `Marshmallow models <https://github.com/sv-tools/marshmallow-objects>`_ classes that can be inherited as Odoo
Models.
**Table of contents**
.. contents::
:local:
Usage
=====
To define your own datamodel you just need to create a class that inherits from
``odoo.addons.datamodel.core.Datamodel``
.. code-block:: python
from marshmallow import fields
from odoo.addons.base_rest import restapi
from odoo.addons.component.core import Component
from odoo.addons.datamodel.core import Datamodel
class PartnerShortInfo(Datamodel):
_name = "partner.short.info"
id = fields.Integer(required=True, allow_none=False)
name = fields.String(required=True, allow_none=False)
class PartnerInfo(Datamodel):
_name = "partner.info"
_inherit = "partner.short.info"
street = fields.String(required=True, allow_none=False)
street2 = fields.String(required=False, allow_none=True)
zip_code = fields.String(required=True, allow_none=False)
city = fields.String(required=True, allow_none=False)
phone = fields.String(required=False, allow_none=True)
is_componay = fields.Boolean(required=False, allow_none=False)
As for odoo models, you can extend the `base` datamodel by inheriting of `base`.
.. code-block:: python
class Base(Datamodel):
_inherit = "base"
def _my_method(self):
pass
Datamodels are available through the `datamodels` registry provided by the Odoo's environment.
.. code-block:: python
class ResPartner(Model):
_inherit = "res.partner"
def _to_partner_info(self):
PartnerInfo = self.env.datamodels["partner.info"]
partner_info = PartnerInfo(partial=True)
partner_info.id = partner.id
partner_info.name = partner.name
partner_info.street = partner.street
partner_info.street2 = partner.street2
partner_info.zip_code = partner.zip
partner_info.city = partner.city
partner_info.phone = partner.phone
partner_info.is_company = partner.is_company
return partner_info
The Odoo's environment is also available into the datamodel instance.
.. code-block:: python
class MyDataModel(Datamodel):
_name = "my.data.model"
def _my_method(self):
partners = self.env["res.partner"].search([])
.. warning::
The `env` property into a Datamodel instance is mutable. IOW, you can't rely
on information (context, user) provided by the environment. The `env` property
is a helper property that give you access to the odoo's registry and must
be use with caution.
Known issues / Roadmap
======================
The `roadmap <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+label%3Adatamodel>`_
and `known issues <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adatamodel>`_ can
be found on GitHub.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/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/rest-framework/issues/new?body=module:%20datamodel%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.
Credits
=======
Authors
~~~~~~~
* ACSONE SA/NV
Contributors
~~~~~~~~~~~~
* Laurent Mignon <laurent.mignon@acsone.eu>
* `Tecnativa <https://www.tecnativa.com>`_:
* Carlos Roca
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.
.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px
:target: https://github.com/lmignon
:alt: lmignon
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-lmignon|
This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/datamodel>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/rest-framework",
"name": "odoo-addon-datamodel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "ACSONE SA/NV, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": "=========\nDatamodel\n=========\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:5411d4f742eb933a4d05f5f6e1784a7ddc042e7f22b1c08d535e225c306a6955\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-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github\n :target: https://github.com/OCA/rest-framework/tree/16.0/datamodel\n :alt: OCA/rest-framework\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/rest-framework-16-0/rest-framework-16-0-datamodel\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=16.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis addon allows you to define simple data models supporting serialization/deserialization\nto/from json\n\nDatamodels are `Marshmallow models <https://github.com/sv-tools/marshmallow-objects>`_ classes that can be inherited as Odoo\nModels.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nTo define your own datamodel you just need to create a class that inherits from\n``odoo.addons.datamodel.core.Datamodel``\n\n.. code-block:: python\n\n from marshmallow import fields\n\n from odoo.addons.base_rest import restapi\n from odoo.addons.component.core import Component\n from odoo.addons.datamodel.core import Datamodel\n\n\n class PartnerShortInfo(Datamodel):\n _name = \"partner.short.info\"\n\n id = fields.Integer(required=True, allow_none=False)\n name = fields.String(required=True, allow_none=False)\n\n class PartnerInfo(Datamodel):\n _name = \"partner.info\"\n _inherit = \"partner.short.info\"\n\n street = fields.String(required=True, allow_none=False)\n street2 = fields.String(required=False, allow_none=True)\n zip_code = fields.String(required=True, allow_none=False)\n city = fields.String(required=True, allow_none=False)\n phone = fields.String(required=False, allow_none=True)\n is_componay = fields.Boolean(required=False, allow_none=False)\n\n\nAs for odoo models, you can extend the `base` datamodel by inheriting of `base`.\n\n.. code-block:: python\n\n class Base(Datamodel):\n _inherit = \"base\"\n\n def _my_method(self):\n pass\n\nDatamodels are available through the `datamodels` registry provided by the Odoo's environment.\n\n.. code-block:: python\n\n class ResPartner(Model):\n _inherit = \"res.partner\"\n\n def _to_partner_info(self):\n PartnerInfo = self.env.datamodels[\"partner.info\"]\n partner_info = PartnerInfo(partial=True)\n partner_info.id = partner.id\n partner_info.name = partner.name\n partner_info.street = partner.street\n partner_info.street2 = partner.street2\n partner_info.zip_code = partner.zip\n partner_info.city = partner.city\n partner_info.phone = partner.phone\n partner_info.is_company = partner.is_company\n return partner_info\n\nThe Odoo's environment is also available into the datamodel instance.\n\n.. code-block:: python\n\n class MyDataModel(Datamodel):\n _name = \"my.data.model\"\n\n def _my_method(self):\n partners = self.env[\"res.partner\"].search([])\n\n.. warning::\n\n The `env` property into a Datamodel instance is mutable. IOW, you can't rely\n on information (context, user) provided by the environment. The `env` property\n is a helper property that give you access to the odoo's registry and must\n be use with caution.\n\nKnown issues / Roadmap\n======================\n\nThe `roadmap <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement+label%3Adatamodel>`_\nand `known issues <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adatamodel>`_ can\nbe found on GitHub.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/rest-framework/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20datamodel%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* ACSONE SA/NV\n\nContributors\n~~~~~~~~~~~~\n\n* Laurent Mignon <laurent.mignon@acsone.eu>\n* `Tecnativa <https://www.tecnativa.com>`_:\n\n * Carlos Roca\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\n.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px\n :target: https://github.com/lmignon\n :alt: lmignon\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-lmignon| \n\nThis module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/16.0/datamodel>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "This addon allows you to define simple data models supporting serialization/deserialization",
"version": "16.0.1.0.1",
"project_urls": {
"Homepage": "https://github.com/OCA/rest-framework"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dcc6231c1d60a655d5f88d43143399e2f80584d9c28789f9a86e21450f32ff7",
"md5": "f8bda27d0ccff575bc0bff9dee824a22",
"sha256": "861e472855ed3cfda0b4c2abe34269a7683587fea90ff2ad43d060dceb7c5f1a"
},
"downloads": -1,
"filename": "odoo_addon_datamodel-16.0.1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8bda27d0ccff575bc0bff9dee824a22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 37467,
"upload_time": "2023-10-28T13:05:06",
"upload_time_iso_8601": "2023-10-28T13:05:06.227682Z",
"url": "https://files.pythonhosted.org/packages/8d/cc/6231c1d60a655d5f88d43143399e2f80584d9c28789f9a86e21450f32ff7/odoo_addon_datamodel-16.0.1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-28 13:05:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "rest-framework",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "a2wsgi",
"specs": []
},
{
"name": "apispec",
"specs": []
},
{
"name": "apispec",
"specs": [
[
">=",
"4.0.0"
]
]
},
{
"name": "cerberus",
"specs": []
},
{
"name": "contextvars",
"specs": []
},
{
"name": "extendable-pydantic",
"specs": []
},
{
"name": "extendable-pydantic",
"specs": [
[
">=",
"1.2.0"
]
]
},
{
"name": "extendable",
"specs": [
[
">=",
"0.0.4"
]
]
},
{
"name": "fastapi",
"specs": []
},
{
"name": "graphene",
"specs": []
},
{
"name": "graphql_server",
"specs": []
},
{
"name": "jsondiff",
"specs": []
},
{
"name": "marshmallow",
"specs": []
},
{
"name": "marshmallow-objects",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "parse-accept-language",
"specs": []
},
{
"name": "pydantic",
"specs": []
},
{
"name": "pydantic",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "pyquerystring",
"specs": []
},
{
"name": "python-multipart",
"specs": []
},
{
"name": "typing-extensions",
"specs": []
},
{
"name": "ujson",
"specs": []
}
],
"lcname": "odoo-addon-datamodel"
}
JSON
