Datamodel
This addon allows you to define simple data models supporting serialization/deserialization
Datamodel
This addon allows you to define simple data models supporting serialization/deserialization to/from json
Datamodels are Marshmallow models classes that can be inherited as Odoo Models.
Table of contents
Usage
To define your own datamodel you just need to create a class that inherits from odoo.addons.datamodel.core.Datamodel
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.
class Base(Datamodel): _inherit = "base" def _my_method(self): pass
Datamodels are available through the datamodels registry provided by the Odoo's environment.
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.
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 and known issues can be found on GitHub.
Bug Tracker
Bugs are tracked on GitHub 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.
Do not contact contributors directly about support or help with technical issues.
Credits
Authors
- ACSONE SA/NV
Contributors
Laurent Mignon <laurent.mignon@acsone.eu>
-
- Carlos Roca
Maintainers
This module is maintained by the OCA.
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.
Current maintainer:
This module is part of the OCA/rest-framework project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Once the user has seen at least one product this snippet will be visible.