mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 07:12:01 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
Ernad Husremovic
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
46
odoo-bringout-oca-rest-framework-model_serializer/README.md
Normal file
46
odoo-bringout-oca-rest-framework-model_serializer/README.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Model Serializer
|
||||
|
||||
Odoo addon: model_serializer
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-rest-framework-model_serializer
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
This addon depends on:
|
||||
- datamodel
|
||||
|
||||
## Manifest Information
|
||||
|
||||
- **Name**: Model Serializer
|
||||
- **Version**: 15.0.1.2.0
|
||||
- **Category**: N/A
|
||||
- **License**: LGPL-3
|
||||
- **Installable**: False
|
||||
|
||||
## Source
|
||||
|
||||
Based on [OCA/rest-framework](https://github.com/OCA/rest-framework) branch 16.0, addon `model_serializer`.
|
||||
|
||||
## License
|
||||
|
||||
This package maintains the original LGPL-3 license from the upstream Odoo project.
|
||||
|
||||
## Documentation
|
||||
|
||||
- Overview: doc/OVERVIEW.md
|
||||
- Architecture: doc/ARCHITECTURE.md
|
||||
- Models: doc/MODELS.md
|
||||
- Controllers: doc/CONTROLLERS.md
|
||||
- Wizards: doc/WIZARDS.md
|
||||
- Reports: doc/REPORTS.md
|
||||
- Security: doc/SECURITY.md
|
||||
- Install: doc/INSTALL.md
|
||||
- Usage: doc/USAGE.md
|
||||
- Configuration: doc/CONFIGURATION.md
|
||||
- Dependencies: doc/DEPENDENCIES.md
|
||||
- Troubleshooting: doc/TROUBLESHOOTING.md
|
||||
- FAQ: doc/FAQ.md
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
U[Users] -->|HTTP| V[Views and QWeb Templates]
|
||||
V --> C[Controllers]
|
||||
V --> W[Wizards – Transient Models]
|
||||
C --> M[Models and ORM]
|
||||
W --> M
|
||||
M --> R[Reports]
|
||||
DX[Data XML] --> M
|
||||
S[Security – ACLs and Groups] -. enforces .-> M
|
||||
|
||||
subgraph Model_serializer Module - model_serializer
|
||||
direction LR
|
||||
M:::layer
|
||||
W:::layer
|
||||
C:::layer
|
||||
V:::layer
|
||||
R:::layer
|
||||
S:::layer
|
||||
DX:::layer
|
||||
end
|
||||
|
||||
classDef layer fill:#eef8ff,stroke:#6ea8fe,stroke-width:1px
|
||||
```
|
||||
|
||||
Notes
|
||||
- Views include tree/form/kanban templates and report templates.
|
||||
- Controllers provide website/portal routes when present.
|
||||
- Wizards are UI flows implemented with `models.TransientModel`.
|
||||
- Data XML loads data/demo records; Security defines groups and access.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Configuration
|
||||
|
||||
Refer to Odoo settings for model_serializer. Configure related models, access rights, and options as needed.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Controllers
|
||||
|
||||
This module does not define custom HTTP controllers.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Dependencies
|
||||
|
||||
This addon depends on:
|
||||
|
||||
- [datamodel](../../odoo-bringout-oca-rest-framework-datamodel)
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# FAQ
|
||||
|
||||
- Q: Which Odoo version? A: 16.0 (OCA/OCB packaged).
|
||||
- Q: How to enable? A: Start server with --addon model_serializer or install in UI.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Install
|
||||
|
||||
```bash
|
||||
pip install odoo-bringout-oca-rest-framework-model_serializer"
|
||||
# or
|
||||
uv pip install odoo-bringout-oca-rest-framework-model_serializer"
|
||||
```
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Models
|
||||
|
||||
Detected core models and extensions in model_serializer.
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
```
|
||||
|
||||
Notes
|
||||
- Classes show model technical names; fields omitted for brevity.
|
||||
- Items listed under _inherit are extensions of existing models.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# Overview
|
||||
|
||||
Packaged Odoo addon: model_serializer. Provides features documented in upstream Odoo 16 under this addon.
|
||||
|
||||
- Source: OCA/OCB 16.0, addon model_serializer
|
||||
- License: LGPL-3
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Reports
|
||||
|
||||
This module does not define custom reports.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# Security
|
||||
|
||||
This module does not define custom security rules or access controls beyond Odoo defaults.
|
||||
|
||||
Default Odoo security applies:
|
||||
- Base user access through standard groups
|
||||
- Model access inherited from dependencies
|
||||
- No custom row-level security rules
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Troubleshooting
|
||||
|
||||
- Ensure Python and Odoo environment matches repo guidance.
|
||||
- Check database connectivity and logs if startup fails.
|
||||
- Validate that dependent addons listed in DEPENDENCIES.md are installed.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# Usage
|
||||
|
||||
Start Odoo including this addon (from repo root):
|
||||
|
||||
```bash
|
||||
python3 scripts/nix_odoo_web_server.py --db-name mydb --addon model_serializer
|
||||
```
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Wizards
|
||||
|
||||
This module does not include UI wizards.
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
================
|
||||
Model Serializer
|
||||
================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Alpha
|
||||
.. |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/15.0/model_serializer
|
||||
: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-15-0/rest-framework-15-0-model_serializer
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/271/15.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module takes advantage of the concepts introduced in the `datamodel` module to offer mechanisms similar to
|
||||
(a subset of) the `ModelSerializer` in Django REST Framework. That is, use the definition of the Odoo model to
|
||||
partially automate the definition of a corresponding `Datamodel` class.
|
||||
|
||||
.. IMPORTANT::
|
||||
This is an alpha version, the data model and design can change at any time without warning.
|
||||
Only for development or testing purpose, do not use in production.
|
||||
`More details on development status <https://odoo-community.org/page/development-status>`_
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
:code:`ModelSerializer` class
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The :code:`ModelSerializer` class inherits from the :code:`Datamodel` class and adds functionalities. Therefore any
|
||||
class inheriting from :code:`ModelSerializer` can be used the exact same way as any other :code:`Datamodel`.
|
||||
|
||||
Basic usage
|
||||
***********
|
||||
|
||||
Here is a basic example::
|
||||
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
|
||||
The result is equivalent to the following :code:`Datamodel` classes::
|
||||
|
||||
from marshmallow import fields
|
||||
|
||||
from odoo.addons.datamodel.core import Datamodel
|
||||
from odoo.addons.datamodel.fields import NestedModel
|
||||
|
||||
|
||||
class PartnerInfo(Datamodel):
|
||||
_name = "partner.info"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
name = fields.String(required=True, allow_none=False)
|
||||
country = NestedModel("_auto_nested_serializer.res.country")
|
||||
|
||||
|
||||
class _AutoNestedSerializerResCountry(Datamodel):
|
||||
_name = "_auto_nested_serializer.res.country"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
display_name = fields.String(dump_only=True)
|
||||
|
||||
|
||||
Overriding fields definition
|
||||
****************************
|
||||
|
||||
It is possible to override the default definition of fields as such::
|
||||
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
|
||||
country_id = NestedModel("country.info")
|
||||
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
|
||||
In this example, we override a :code:`NestedModel` but it works the same for any other field type.
|
||||
|
||||
(De)serialization
|
||||
*****************
|
||||
|
||||
:code:`ModelSerializer` does all the heavy-lifting of transforming a :code:`Datamodel` instance into the corresponding
|
||||
:code:`recordset`, and vice-versa.
|
||||
|
||||
To transform a recordset into a (list of) :code:`ModelSerializer` instance(s) (serialization), do the following::
|
||||
|
||||
partner_info = self.env.datamodels["partner.info"].from_recordset(partner)
|
||||
|
||||
This will return a single instance; if your recordset contains more than one record, you can get a list of instances
|
||||
by passing :code:`many=True` to this method.
|
||||
|
||||
|
||||
To transform a :code:`ModelSerializer` instance into a recordset (de-serialization), do the following::
|
||||
|
||||
partner = partner_info.to_recordset()
|
||||
|
||||
Unless an existing partner can be found (see below), this method **creates a new record** in the database. You can avoid
|
||||
that by passing :code:`create=False`, in which case the system will only create them in memory (:code:`NewId` recordset).
|
||||
|
||||
In order to determine if the corresponding Odoo record already exists or if a new one should be created, the system
|
||||
checks by default if the :code:`id` field of the instance corresponds to a database record. This default behavior can be
|
||||
modified like so::
|
||||
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
|
||||
def get_odoo_record(self):
|
||||
if self.code:
|
||||
return self.env[self._model].search([("code", "=", self.code)])
|
||||
return super().get_odoo_record()
|
||||
|
||||
Changelog
|
||||
=========
|
||||
|
||||
14.0.1.0.0
|
||||
~~~~~~~~~~
|
||||
|
||||
First official version.
|
||||
|
||||
15.0.1.0.0
|
||||
~~~~~~~~~~
|
||||
|
||||
Second version.
|
||||
|
||||
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 smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20model_serializer%0Aversion:%2015.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
|
||||
~~~~~~~
|
||||
|
||||
* Wakari
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* François Degrave <f.degrave@wakari.be>
|
||||
|
||||
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-fdegrave| image:: https://github.com/fdegrave.png?size=40px
|
||||
:target: https://github.com/fdegrave
|
||||
:alt: fdegrave
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-fdegrave|
|
||||
|
||||
This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/15.0/model_serializer>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
from . import builder
|
||||
from . import core
|
||||
from . import field_converter
|
||||
from . import serializers
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# Copyright 2021 Wakari SRL (http://www.wakari.be)
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
|
||||
|
||||
{
|
||||
"name": "Model Serializer",
|
||||
"summary": "Automatically translate Odoo models into Datamodels "
|
||||
"for (de)serialization",
|
||||
"version": "15.0.1.2.0",
|
||||
"development_status": "Alpha",
|
||||
"license": "LGPL-3",
|
||||
"website": "https://github.com/OCA/rest-framework",
|
||||
"author": "Wakari, Odoo Community Association (OCA)",
|
||||
"maintainers": ["fdegrave"],
|
||||
"depends": ["datamodel"],
|
||||
"external_dependencies": {
|
||||
"python": [
|
||||
"marshmallow",
|
||||
]
|
||||
},
|
||||
"data": [],
|
||||
"installable": False,
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
from odoo import models
|
||||
|
||||
from odoo.addons.datamodel.core import MetaDatamodel, _datamodel_databases
|
||||
|
||||
from .core import ModelSerializer
|
||||
|
||||
|
||||
class DatamodelBuilder(models.AbstractModel):
|
||||
_inherit = "datamodel.builder"
|
||||
|
||||
def load_datamodels(self, module, datamodels_registry=None):
|
||||
res = super().load_datamodels(module, datamodels_registry=datamodels_registry)
|
||||
datamodels_registry = (
|
||||
datamodels_registry or _datamodel_databases[self.env.cr.dbname]
|
||||
)
|
||||
for datamodel_class in MetaDatamodel._modules_datamodels[module]:
|
||||
self._extend_model_serializer(datamodel_class, datamodels_registry)
|
||||
return res
|
||||
|
||||
def _extend_model_serializer(self, datamodel_class, registry):
|
||||
"""Extend the datamodel_class with the fields declared in `_model_fields`"""
|
||||
if issubclass(datamodel_class, ModelSerializer):
|
||||
new_class = datamodel_class._extend_from_odoo_model(registry, self.env)
|
||||
new_class._build_datamodel(registry)
|
||||
|
|
@ -0,0 +1,226 @@
|
|||
from odoo import _, models
|
||||
from odoo.exceptions import ValidationError
|
||||
|
||||
from odoo.addons.datamodel.core import Datamodel, MetaDatamodel
|
||||
|
||||
from .field_converter import convert_field
|
||||
|
||||
|
||||
class class_or_instancemethod(classmethod): # pylint: disable=class-camelcase
|
||||
def __get__(self, instance, type_):
|
||||
descr_get = super().__get__ if instance is None else self.__func__.__get__
|
||||
return descr_get(instance, type_)
|
||||
|
||||
|
||||
class MetaModelSerializer(MetaDatamodel):
|
||||
def __init__(self, name, bases, attrs):
|
||||
super(MetaModelSerializer, self).__init__(name, bases, attrs)
|
||||
|
||||
|
||||
class ModelSerializer(Datamodel, metaclass=MetaModelSerializer):
|
||||
_inherit = "base"
|
||||
_register = False
|
||||
_model = None
|
||||
_model_fields = []
|
||||
|
||||
def dump(self, many=None):
|
||||
with self.__dump_mode_on__():
|
||||
dump = self.__schema__.dump(self, many=many)
|
||||
return dump
|
||||
|
||||
@classmethod
|
||||
def _check_nested_class(cls, marshmallow_field, registry):
|
||||
"""If `marshmallow_field` is a nested datamodel (relational field), we check
|
||||
if the nested datamodel class exists
|
||||
"""
|
||||
nested_name = getattr(marshmallow_field, "datamodel_name", None)
|
||||
if nested_name and nested_name not in registry:
|
||||
raise ValidationError(
|
||||
_("'{}' datamodel does not exist").format(nested_name)
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def _extend_from_odoo_model(cls, registry, env):
|
||||
"""Extend the datamodel to contain the declared Odoo model fields"""
|
||||
attrs = {
|
||||
"_inherit": cls._name,
|
||||
"_model_fields": getattr(cls, "_model_fields", []),
|
||||
"_model": getattr(cls, "_model", None),
|
||||
}
|
||||
bases = (ModelSerializer,)
|
||||
name = cls.__name__ + "Child"
|
||||
parent_class = registry[cls._name]
|
||||
has_model_fields = bool(attrs["_model_fields"])
|
||||
if getattr(parent_class, "_model_fields", None):
|
||||
has_model_fields = True
|
||||
if getattr(parent_class, "_model", None):
|
||||
if attrs["_model"] and attrs["_model"] != parent_class._model:
|
||||
raise ValidationError(
|
||||
_(
|
||||
"Error in {}: Model Serializers cannot inherit "
|
||||
"from a class having a different '_model' attribute"
|
||||
).format(cls.__name__)
|
||||
)
|
||||
attrs["_model"] = parent_class._model
|
||||
|
||||
if not (attrs["_model"] and has_model_fields):
|
||||
raise ValidationError(
|
||||
_(
|
||||
"Error in {}: Model Serializers require '_model' and "
|
||||
"'_model_fields' attributes to be defined"
|
||||
).format(cls.__name__)
|
||||
)
|
||||
|
||||
odoo_model = env[attrs["_model"]]
|
||||
for field_name in cls._model_fields:
|
||||
if not hasattr(cls, field_name):
|
||||
odoo_field = odoo_model._fields[field_name]
|
||||
marshmallow_field = convert_field(odoo_field)
|
||||
if marshmallow_field:
|
||||
attrs[field_name] = marshmallow_field
|
||||
else:
|
||||
marshmallow_field = cls.__schema_class__._declared_fields[field_name]
|
||||
cls._check_nested_class(marshmallow_field, registry)
|
||||
return MetaDatamodel(name, bases, attrs)
|
||||
|
||||
@property
|
||||
def _model_name(self):
|
||||
if self.context.get("odoo_model"):
|
||||
return self.context["odoo_model"]
|
||||
return self._model
|
||||
|
||||
@_model_name.setter
|
||||
def _model_name(self, value):
|
||||
if not self.context:
|
||||
self.context = {}
|
||||
self.context["odoo_model"] = value
|
||||
|
||||
@classmethod
|
||||
def from_recordset(cls, recordset, *, many=False):
|
||||
"""Transform a recordset into a (list of) datamodel(s)"""
|
||||
|
||||
def convert_null_value(val):
|
||||
if val:
|
||||
return val
|
||||
if val is False or isinstance(val, models.BaseModel):
|
||||
return None
|
||||
return val
|
||||
|
||||
res = []
|
||||
datamodels = recordset.env.datamodels
|
||||
recordset = recordset if many else recordset[:1]
|
||||
for record in recordset:
|
||||
instance = cls(partial=True, context={"odoo_model": record._name})
|
||||
for model_field in cls._model_fields:
|
||||
schema_field = instance.__schema__.fields[model_field]
|
||||
nested_datamodel_name = getattr(schema_field, "datamodel_name", None)
|
||||
if nested_datamodel_name:
|
||||
nested_datamodel_class = datamodels[nested_datamodel_name]
|
||||
if hasattr(nested_datamodel_class, "from_recordset"):
|
||||
setattr(
|
||||
instance,
|
||||
model_field,
|
||||
nested_datamodel_class.from_recordset(
|
||||
record[model_field], many=schema_field.many
|
||||
),
|
||||
)
|
||||
else:
|
||||
value = convert_null_value(record[model_field])
|
||||
setattr(instance, model_field, value)
|
||||
res.append(instance)
|
||||
if not many:
|
||||
return res[0] if res else None
|
||||
return res
|
||||
|
||||
def get_odoo_record(self):
|
||||
"""Get an existing record matching `self`. Meant to be overridden
|
||||
TODO: optimize this to deal with multiple instances at once
|
||||
"""
|
||||
odoo_model = self.env[self._model_name]
|
||||
if "id" in self._model_fields and getattr(self, "id", None):
|
||||
return odoo_model.browse(self.id)
|
||||
return odoo_model.browse([])
|
||||
|
||||
def _new_odoo_record(self):
|
||||
odoo_model = self.env[self._model_name]
|
||||
default_values = odoo_model.default_get(odoo_model._fields.keys())
|
||||
return odoo_model.new(default_values)
|
||||
|
||||
def _process_model_value(self, value, model_field):
|
||||
if hasattr(self, "validate_{}".format(model_field)):
|
||||
return getattr(self, "validate_{}".format(model_field))(value)
|
||||
return value
|
||||
|
||||
def _get_partial_fields(self):
|
||||
"""Return the list of fields actually used to instantiate `self`"""
|
||||
res = []
|
||||
received_keys = set(self.__schema__._declared_fields) - set(
|
||||
self.__missing_fields__
|
||||
)
|
||||
actual_field_names = {
|
||||
field.data_key: name
|
||||
for name, field in self.__schema__._declared_fields.items()
|
||||
if field.data_key
|
||||
}
|
||||
for received_key in received_keys:
|
||||
res.append(actual_field_names.get(received_key) or received_key)
|
||||
return res
|
||||
|
||||
def convert_to_values(self, model=None):
|
||||
"""Transform `self` into a dictionary to create or write an odoo record"""
|
||||
|
||||
def convert_related_values(dics):
|
||||
res = [(6, 0, [])]
|
||||
for dic in dics:
|
||||
rec_id = dic.pop("id", None)
|
||||
if rec_id:
|
||||
res[0][2].append(rec_id)
|
||||
if dic:
|
||||
res.append((1, rec_id, dic))
|
||||
else:
|
||||
res.append((4, rec_id))
|
||||
else:
|
||||
res.append((0, 0, dic))
|
||||
return res
|
||||
|
||||
model_name = model or self._model
|
||||
self._model_name = model_name
|
||||
record = self.get_odoo_record()
|
||||
values = {"id": record.id} if record else {}
|
||||
# in case of partial, not all fields are considered
|
||||
received_fields = self._get_partial_fields()
|
||||
model_fields = set(received_fields) & set(self._model_fields)
|
||||
for model_field in model_fields:
|
||||
schema_field = self.__schema__.fields[model_field]
|
||||
if schema_field.dump_only:
|
||||
continue
|
||||
value = getattr(self, model_field)
|
||||
nested_datamodel_name = getattr(schema_field, "datamodel_name", None)
|
||||
nested_datamodel = (
|
||||
self.env.datamodels[nested_datamodel_name]
|
||||
if nested_datamodel_name
|
||||
else None
|
||||
)
|
||||
if nested_datamodel and issubclass(nested_datamodel, ModelSerializer):
|
||||
odoo_field = record._fields[model_field]
|
||||
if odoo_field.type == "many2one":
|
||||
value._model_name = odoo_field.comodel_name
|
||||
value = value.to_recordset().id
|
||||
else:
|
||||
nested_values = [
|
||||
instance.convert_to_values(model=odoo_field.comodel_name)
|
||||
for instance in value
|
||||
]
|
||||
value = convert_related_values(nested_values)
|
||||
values[model_field] = self._process_model_value(value, model_field)
|
||||
return values
|
||||
|
||||
def to_recordset(self):
|
||||
"""Transform `self` into a corresponding recordset"""
|
||||
record = self.get_odoo_record()
|
||||
values = self.convert_to_values(model=self._model_name)
|
||||
if record:
|
||||
record.write(values)
|
||||
return record
|
||||
else:
|
||||
return self.env[self._model_name].create(values)
|
||||
|
|
@ -0,0 +1,131 @@
|
|||
import logging
|
||||
|
||||
from marshmallow import fields
|
||||
|
||||
from odoo import fields as odoo_fields
|
||||
|
||||
from odoo.addons.datamodel.fields import NestedModel
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
__all__ = ["convert_field"]
|
||||
|
||||
|
||||
class Binary(fields.Raw):
|
||||
def _serialize(self, value, attr, obj, **kwargs):
|
||||
res = super()._serialize(value, attr, obj, **kwargs)
|
||||
if isinstance(res, bytes):
|
||||
res = res.decode("utf-8")
|
||||
return res
|
||||
|
||||
|
||||
class FieldConverter:
|
||||
def __init__(self, odoo_field):
|
||||
self.odoo_field = odoo_field
|
||||
|
||||
def _marshmallow_field_class(self):
|
||||
pass
|
||||
|
||||
def _get_kwargs(self):
|
||||
kwargs = {
|
||||
"required": self.odoo_field.required,
|
||||
"allow_none": not self.odoo_field.required,
|
||||
}
|
||||
if self.odoo_field.readonly:
|
||||
kwargs["dump_only"] = True
|
||||
return kwargs
|
||||
|
||||
def convert_to_marshmallow(self):
|
||||
marshmallow_field_class = self._marshmallow_field_class()
|
||||
kwargs = self._get_kwargs()
|
||||
return marshmallow_field_class(**kwargs)
|
||||
|
||||
|
||||
class BooleanConverter(FieldConverter):
|
||||
def _get_kwargs(self):
|
||||
kwargs = super()._get_kwargs()
|
||||
kwargs["falsy"] = fields.Boolean.falsy.union({None})
|
||||
return kwargs
|
||||
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.Boolean
|
||||
|
||||
|
||||
class IntegerConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.Integer
|
||||
|
||||
|
||||
class FloatConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.Float
|
||||
|
||||
|
||||
class StringConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.String
|
||||
|
||||
|
||||
class DateConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.Date
|
||||
|
||||
|
||||
class DatetimeConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.DateTime
|
||||
|
||||
|
||||
class RawConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return fields.Raw
|
||||
|
||||
|
||||
class BinaryConverter(FieldConverter):
|
||||
def _marshmallow_field_class(self):
|
||||
return Binary
|
||||
|
||||
|
||||
class RelationalConverter(FieldConverter):
|
||||
def _get_kwargs(self):
|
||||
kwargs = super()._get_kwargs()
|
||||
kwargs["many"] = isinstance(
|
||||
self.odoo_field, (odoo_fields.One2many, odoo_fields.Many2many)
|
||||
)
|
||||
kwargs["nested"] = "generic.minimal.serializer"
|
||||
kwargs["metadata"] = {"odoo_model": self.odoo_field.comodel_name}
|
||||
return kwargs
|
||||
|
||||
def _marshmallow_field_class(self):
|
||||
return NestedModel
|
||||
|
||||
|
||||
FIELDS_CONV = {
|
||||
odoo_fields.Boolean: BooleanConverter,
|
||||
odoo_fields.Integer: IntegerConverter,
|
||||
odoo_fields.Id: IntegerConverter,
|
||||
odoo_fields.Float: FloatConverter,
|
||||
odoo_fields.Monetary: FloatConverter, # should we use a Decimal instead?
|
||||
odoo_fields.Char: StringConverter,
|
||||
odoo_fields.Text: StringConverter,
|
||||
odoo_fields.Html: StringConverter,
|
||||
odoo_fields.Selection: RawConverter,
|
||||
odoo_fields.Date: DateConverter,
|
||||
odoo_fields.Datetime: DatetimeConverter,
|
||||
odoo_fields.Binary: BinaryConverter,
|
||||
odoo_fields.Image: BinaryConverter,
|
||||
odoo_fields.One2many: RelationalConverter,
|
||||
odoo_fields.Many2one: RelationalConverter,
|
||||
odoo_fields.Many2many: RelationalConverter,
|
||||
}
|
||||
|
||||
|
||||
def convert_field(odoo_field):
|
||||
field_cls = type(odoo_field)
|
||||
if field_cls in FIELDS_CONV:
|
||||
return FIELDS_CONV[field_cls](odoo_field).convert_to_marshmallow()
|
||||
else:
|
||||
_logger.warning(
|
||||
"Not implemented: Odoo fields of type {} cannot be "
|
||||
"translated into Marshmallow fields".format(field_cls)
|
||||
)
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * model_serializer
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 15.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid "'{}' datamodel does not exist"
|
||||
msgstr "'{}' datamodel ne postoji"
|
||||
|
||||
#. module: model_serializer
|
||||
#: model:ir.model,name:model_serializer.model_datamodel_builder
|
||||
msgid "Datamodel Builder"
|
||||
msgstr "Graditelj datamodela"
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"Error in {}: Model Serializers cannot inherit from a class having a "
|
||||
"different '_model' attribute"
|
||||
msgstr ""
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"Error in {}: Model Serializers require '_model' and '_model_fields' "
|
||||
"attributes to be defined"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * model_serializer
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 15.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid "'{}' datamodel does not exist"
|
||||
msgstr ""
|
||||
|
||||
#. module: model_serializer
|
||||
#: model:ir.model,name:model_serializer.model_datamodel_builder
|
||||
msgid "Datamodel Builder"
|
||||
msgstr ""
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"Error in {}: Model Serializers cannot inherit from a class having a "
|
||||
"different '_model' attribute"
|
||||
msgstr ""
|
||||
|
||||
#. module: model_serializer
|
||||
#: code:addons/model_serializer/core.py:0
|
||||
#, python-format
|
||||
msgid ""
|
||||
"Error in {}: Model Serializers require '_model' and '_model_fields' "
|
||||
"attributes to be defined"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1 @@
|
|||
* François Degrave <f.degrave@wakari.be>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
This module takes advantage of the concepts introduced in the `datamodel` module to offer mechanisms similar to
|
||||
(a subset of) the `ModelSerializer` in Django REST Framework. That is, use the definition of the Odoo model to
|
||||
partially automate the definition of a corresponding `Datamodel` class.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
14.0.1.0.0
|
||||
~~~~~~~~~~
|
||||
|
||||
First official version.
|
||||
|
||||
15.0.1.0.0
|
||||
~~~~~~~~~~
|
||||
|
||||
Second version.
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
:code:`ModelSerializer` class
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The :code:`ModelSerializer` class inherits from the :code:`Datamodel` class and adds functionalities. Therefore any
|
||||
class inheriting from :code:`ModelSerializer` can be used the exact same way as any other :code:`Datamodel`.
|
||||
|
||||
Basic usage
|
||||
***********
|
||||
|
||||
Here is a basic example::
|
||||
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
|
||||
The result is equivalent to the following :code:`Datamodel` classes::
|
||||
|
||||
from marshmallow import fields
|
||||
|
||||
from odoo.addons.datamodel.core import Datamodel
|
||||
from odoo.addons.datamodel.fields import NestedModel
|
||||
|
||||
|
||||
class PartnerInfo(Datamodel):
|
||||
_name = "partner.info"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
name = fields.String(required=True, allow_none=False)
|
||||
country = NestedModel("_auto_nested_serializer.res.country")
|
||||
|
||||
|
||||
class _AutoNestedSerializerResCountry(Datamodel):
|
||||
_name = "_auto_nested_serializer.res.country"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
display_name = fields.String(dump_only=True)
|
||||
|
||||
|
||||
Overriding fields definition
|
||||
****************************
|
||||
|
||||
It is possible to override the default definition of fields as such::
|
||||
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
|
||||
country_id = NestedModel("country.info")
|
||||
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
|
||||
In this example, we override a :code:`NestedModel` but it works the same for any other field type.
|
||||
|
||||
(De)serialization
|
||||
*****************
|
||||
|
||||
:code:`ModelSerializer` does all the heavy-lifting of transforming a :code:`Datamodel` instance into the corresponding
|
||||
:code:`recordset`, and vice-versa.
|
||||
|
||||
To transform a recordset into a (list of) :code:`ModelSerializer` instance(s) (serialization), do the following::
|
||||
|
||||
partner_info = self.env.datamodels["partner.info"].from_recordset(partner)
|
||||
|
||||
This will return a single instance; if your recordset contains more than one record, you can get a list of instances
|
||||
by passing :code:`many=True` to this method.
|
||||
|
||||
|
||||
To transform a :code:`ModelSerializer` instance into a recordset (de-serialization), do the following::
|
||||
|
||||
partner = partner_info.to_recordset()
|
||||
|
||||
Unless an existing partner can be found (see below), this method **creates a new record** in the database. You can avoid
|
||||
that by passing :code:`create=False`, in which case the system will only create them in memory (:code:`NewId` recordset).
|
||||
|
||||
In order to determine if the corresponding Odoo record already exists or if a new one should be created, the system
|
||||
checks by default if the :code:`id` field of the instance corresponds to a database record. This default behavior can be
|
||||
modified like so::
|
||||
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
|
||||
def get_odoo_record(self):
|
||||
if self.code:
|
||||
return self.env[self._model].search([("code", "=", self.code)])
|
||||
return super().get_odoo_record()
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
from marshmallow import fields
|
||||
|
||||
from .core import ModelSerializer
|
||||
|
||||
|
||||
class GenericAbstractSerializer(ModelSerializer):
|
||||
_name = "generic.abstract.serializer"
|
||||
_model = "base"
|
||||
_register = False
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
if kwargs.get("_model"):
|
||||
self._model = kwargs.pop("_model")
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class GenericMinimalSerializer(GenericAbstractSerializer):
|
||||
_name = "generic.minimal.serializer"
|
||||
_model_fields = ["id", "display_name"]
|
||||
|
||||
id = fields.Integer(dump_only=True)
|
||||
display_name = fields.String(dump_only=True)
|
||||
|
||||
def to_recordset(self):
|
||||
return self.get_odoo_record()
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,547 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
|
||||
<title>Model Serializer</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="model-serializer">
|
||||
<h1 class="title">Model Serializer</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/rest-framework/tree/15.0/model_serializer"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/rest-framework-15-0/rest-framework-15-0-model_serializer"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/271/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module takes advantage of the concepts introduced in the <cite>datamodel</cite> module to offer mechanisms similar to
|
||||
(a subset of) the <cite>ModelSerializer</cite> in Django REST Framework. That is, use the definition of the Odoo model to
|
||||
partially automate the definition of a corresponding <cite>Datamodel</cite> class.</p>
|
||||
<div class="admonition important">
|
||||
<p class="first admonition-title">Important</p>
|
||||
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
|
||||
Only for development or testing purpose, do not use in production.
|
||||
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
|
||||
</div>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="id3">Usage</a><ul>
|
||||
<li><a class="reference internal" href="#modelserializer-class" id="id4"><code>ModelSerializer</code> class</a><ul>
|
||||
<li><a class="reference internal" href="#basic-usage" id="id5">Basic usage</a></li>
|
||||
<li><a class="reference internal" href="#overriding-fields-definition" id="id6">Overriding fields definition</a></li>
|
||||
<li><a class="reference internal" href="#de-serialization" id="id7">(De)serialization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#changelog" id="id8">Changelog</a><ul>
|
||||
<li><a class="reference internal" href="#id1" id="id9">14.0.1.0.0</a></li>
|
||||
<li><a class="reference internal" href="#id2" id="id10">15.0.1.0.0</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id11">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id12">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id13">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id14">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id15">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id3">Usage</a></h1>
|
||||
<div class="section" id="modelserializer-class">
|
||||
<h2><a class="toc-backref" href="#id4"><code>ModelSerializer</code> class</a></h2>
|
||||
<p>The <code>ModelSerializer</code> class inherits from the <code>Datamodel</code> class and adds functionalities. Therefore any
|
||||
class inheriting from <code>ModelSerializer</code> can be used the exact same way as any other <code>Datamodel</code>.</p>
|
||||
<div class="section" id="basic-usage">
|
||||
<h3><a class="toc-backref" href="#id5">Basic usage</a></h3>
|
||||
<p>Here is a basic example:</p>
|
||||
<pre class="literal-block">
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
</pre>
|
||||
<p>The result is equivalent to the following <code>Datamodel</code> classes:</p>
|
||||
<pre class="literal-block">
|
||||
from marshmallow import fields
|
||||
|
||||
from odoo.addons.datamodel.core import Datamodel
|
||||
from odoo.addons.datamodel.fields import NestedModel
|
||||
|
||||
|
||||
class PartnerInfo(Datamodel):
|
||||
_name = "partner.info"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
name = fields.String(required=True, allow_none=False)
|
||||
country = NestedModel("_auto_nested_serializer.res.country")
|
||||
|
||||
|
||||
class _AutoNestedSerializerResCountry(Datamodel):
|
||||
_name = "_auto_nested_serializer.res.country"
|
||||
|
||||
id = fields.Integer(required=True, allow_none=False, dump_only=True)
|
||||
display_name = fields.String(dump_only=True)
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="overriding-fields-definition">
|
||||
<h3><a class="toc-backref" href="#id6">Overriding fields definition</a></h3>
|
||||
<p>It is possible to override the default definition of fields as such:</p>
|
||||
<pre class="literal-block">
|
||||
from odoo.addons.model_serializer.core import ModelSerializer
|
||||
|
||||
class PartnerInfo(ModelSerializer):
|
||||
_name = "partner.info"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "country_id"]
|
||||
|
||||
country_id = NestedModel("country.info")
|
||||
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
</pre>
|
||||
<p>In this example, we override a <code>NestedModel</code> but it works the same for any other field type.</p>
|
||||
</div>
|
||||
<div class="section" id="de-serialization">
|
||||
<h3><a class="toc-backref" href="#id7">(De)serialization</a></h3>
|
||||
<p><code>ModelSerializer</code> does all the heavy-lifting of transforming a <code>Datamodel</code> instance into the corresponding
|
||||
<code>recordset</code>, and vice-versa.</p>
|
||||
<p>To transform a recordset into a (list of) <code>ModelSerializer</code> instance(s) (serialization), do the following:</p>
|
||||
<pre class="literal-block">
|
||||
partner_info = self.env.datamodels["partner.info"].from_recordset(partner)
|
||||
</pre>
|
||||
<p>This will return a single instance; if your recordset contains more than one record, you can get a list of instances
|
||||
by passing <code>many=True</code> to this method.</p>
|
||||
<p>To transform a <code>ModelSerializer</code> instance into a recordset (de-serialization), do the following:</p>
|
||||
<pre class="literal-block">
|
||||
partner = partner_info.to_recordset()
|
||||
</pre>
|
||||
<p>Unless an existing partner can be found (see below), this method <strong>creates a new record</strong> in the database. You can avoid
|
||||
that by passing <code>create=False</code>, in which case the system will only create them in memory (<code>NewId</code> recordset).</p>
|
||||
<p>In order to determine if the corresponding Odoo record already exists or if a new one should be created, the system
|
||||
checks by default if the <code>id</code> field of the instance corresponds to a database record. This default behavior can be
|
||||
modified like so:</p>
|
||||
<pre class="literal-block">
|
||||
class CountryInfo(ModelSerializer):
|
||||
_name = "country.info"
|
||||
_model = "res.country"
|
||||
_model_fields = ["code", "name"]
|
||||
|
||||
def get_odoo_record(self):
|
||||
if self.code:
|
||||
return self.env[self._model].search([("code", "=", self.code)])
|
||||
return super().get_odoo_record()
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="changelog">
|
||||
<h1><a class="toc-backref" href="#id8">Changelog</a></h1>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="toc-backref" href="#id9">14.0.1.0.0</a></h2>
|
||||
<p>First official version.</p>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2><a class="toc-backref" href="#id10">15.0.1.0.0</a></h2>
|
||||
<p>Second version.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id11">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/rest-framework/issues">GitHub Issues</a>.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20model_serializer%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id12">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id13">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Wakari</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id14">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>François Degrave <<a class="reference external" href="mailto:f.degrave@wakari.be">f.degrave@wakari.be</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id15">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<p>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.</p>
|
||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external" href="https://github.com/fdegrave"><img alt="fdegrave" src="https://github.com/fdegrave.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/15.0/model_serializer">OCA/rest-framework</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_model_serializer
|
||||
|
|
@ -0,0 +1,279 @@
|
|||
# Copyright 2021 Wakari SRL
|
||||
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
|
||||
from marshmallow import fields
|
||||
|
||||
from odoo import SUPERUSER_ID, fields as odoo_fields
|
||||
from odoo.exceptions import ValidationError
|
||||
|
||||
from odoo.addons.datamodel.fields import NestedModel
|
||||
from odoo.addons.datamodel.tests.common import DatamodelRegistryCase
|
||||
|
||||
from ..core import ModelSerializer
|
||||
from ..field_converter import Binary
|
||||
from ..serializers import GenericMinimalSerializer
|
||||
|
||||
|
||||
def _schema_field(model_serializer_cls, field_name):
|
||||
schema_cls = model_serializer_cls.__schema_class__
|
||||
return schema_cls._declared_fields.get(field_name)
|
||||
|
||||
|
||||
class TestModelSerializer(DatamodelRegistryCase):
|
||||
"""Test build of ModelSerializer"""
|
||||
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
self._full_build_model_serializer(GenericMinimalSerializer)
|
||||
|
||||
def _full_build_model_serializer(self, model_serializer_cls):
|
||||
model_serializer_cls._build_datamodel(self.datamodel_registry)
|
||||
new_cls = model_serializer_cls._extend_from_odoo_model(
|
||||
self.datamodel_registry, self.env
|
||||
)
|
||||
new_cls._build_datamodel(self.datamodel_registry)
|
||||
return self.env.datamodels[model_serializer_cls._name]
|
||||
|
||||
def _datamodel_instance(self, serializer_cls, values):
|
||||
datamodel_cls = self._full_build_model_serializer(serializer_cls)
|
||||
instance = datamodel_cls(partial=True)
|
||||
for key in values:
|
||||
setattr(instance, key, values[key])
|
||||
return instance
|
||||
|
||||
def test_01_required_attrs(self):
|
||||
"""Ensure that ModelSerializer has mandatory attributes"""
|
||||
msg = ".*require '_model' and '_model_fields' attributes.*"
|
||||
with self.assertRaisesRegex(ValidationError, msg):
|
||||
|
||||
class ModelSerializerBad1(ModelSerializer):
|
||||
_name = "modelserializer_no_model"
|
||||
|
||||
self._full_build_model_serializer(ModelSerializerBad1)
|
||||
|
||||
with self.assertRaisesRegex(ValidationError, msg):
|
||||
|
||||
class ModelSerializerBad2(ModelSerializer):
|
||||
_name = "modelserializer_no_model_fields"
|
||||
_model = "res.partner"
|
||||
|
||||
self._full_build_model_serializer(ModelSerializerBad2)
|
||||
|
||||
def test_02_has_field(self):
|
||||
"""Ensure that ModelSerializers have the generated fields"""
|
||||
|
||||
class ModelSerializer1(ModelSerializer):
|
||||
_name = "modelserializer1"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id"]
|
||||
|
||||
class ModelSerializer2(ModelSerializer):
|
||||
_name = "modelserializer2"
|
||||
_inherit = "modelserializer1"
|
||||
|
||||
for serializer_class in (ModelSerializer1, ModelSerializer2):
|
||||
full_cls = self._full_build_model_serializer(serializer_class)
|
||||
self.assertTrue(hasattr(full_cls, "id"))
|
||||
self.assertIsInstance(_schema_field(full_cls, "id"), fields.Integer)
|
||||
|
||||
def test_03_simple_field_converter(self):
|
||||
"""Ensure that non-relational fields are correctly converted"""
|
||||
|
||||
fields_conversion = {
|
||||
"id": (odoo_fields.Id, fields.Integer, {"dump_only": True}),
|
||||
"create_date": (odoo_fields.Datetime, fields.DateTime, {"dump_only": True}),
|
||||
"date": (
|
||||
odoo_fields.Date,
|
||||
fields.Date,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
"name": (
|
||||
odoo_fields.Char,
|
||||
fields.String,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
"comment": (
|
||||
odoo_fields.Text,
|
||||
fields.String,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
"active": (
|
||||
odoo_fields.Boolean,
|
||||
fields.Boolean,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
"partner_latitude": (
|
||||
odoo_fields.Float,
|
||||
fields.Float,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
"active_lang_count": (
|
||||
odoo_fields.Integer,
|
||||
fields.Integer,
|
||||
{"dump_only": True},
|
||||
),
|
||||
"image_1920": (
|
||||
odoo_fields.Image,
|
||||
Binary,
|
||||
{"required": False, "allow_none": True},
|
||||
),
|
||||
}
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = list(fields_conversion)
|
||||
|
||||
full_cls = self._full_build_model_serializer(PartnerSerializer)
|
||||
for field_name in fields_conversion:
|
||||
odoo_field_cls, marsh_field_cls, attrs = fields_conversion[field_name]
|
||||
this_field = _schema_field(full_cls, field_name)
|
||||
self.assertIsInstance(this_field, marsh_field_cls)
|
||||
for attr, attr_val in attrs.items():
|
||||
msg = (
|
||||
"Error when converting field {}, wrong "
|
||||
"attribute value ('{}' should be '{}')".format(
|
||||
field_name, attr, attr_val
|
||||
),
|
||||
)
|
||||
self.assertEqual(getattr(this_field, attr), attr_val, msg=msg)
|
||||
|
||||
def test_04_relational_field_converter(self):
|
||||
"""Ensure that relational fields are correctly converted"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["user_id"]
|
||||
|
||||
full_cls = self._full_build_model_serializer(PartnerSerializer)
|
||||
user_field = _schema_field(full_cls, "user_id")
|
||||
self.assertIsInstance(user_field, NestedModel)
|
||||
self.assertEqual(user_field.datamodel_name, "generic.minimal.serializer")
|
||||
self.assertFalse(user_field.many)
|
||||
|
||||
def test_05_from_recordset(self):
|
||||
"""Test `from_recordset` method with only simple fields"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name"]
|
||||
|
||||
datamodel_cls = self._full_build_model_serializer(PartnerSerializer)
|
||||
self.partner = self.env["res.partner"].create({"name": "Test Partner"})
|
||||
datamodel = datamodel_cls.from_recordset(self.partner)
|
||||
self.assertIsInstance(datamodel, datamodel_cls)
|
||||
self.assertEqual(datamodel.id, self.partner.id)
|
||||
self.assertEqual(datamodel.name, self.partner.name)
|
||||
self.assertEqual(
|
||||
set(PartnerSerializer._model_fields),
|
||||
set(datamodel.__schema__.fields.keys()),
|
||||
)
|
||||
|
||||
def test_06_from_recordset_nested(self):
|
||||
"""Test `from_recordset` method with nested fields, default nested serializer"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["user_id"]
|
||||
|
||||
datamodel_cls = self._full_build_model_serializer(PartnerSerializer)
|
||||
self.partner = self.env["res.partner"].create({"name": "Test Partner"})
|
||||
datamodel1 = datamodel_cls.from_recordset(self.partner)
|
||||
self.assertIsInstance(datamodel1, datamodel_cls)
|
||||
self.assertEqual(datamodel1.user_id, None)
|
||||
self.partner.write({"user_id": SUPERUSER_ID})
|
||||
datamodel2 = datamodel_cls.from_recordset(self.partner)
|
||||
self.assertIsInstance(datamodel2, datamodel_cls)
|
||||
self.assertEqual(datamodel2.user_id.id, SUPERUSER_ID)
|
||||
self.assertEqual(
|
||||
datamodel2.user_id.display_name, self.partner.user_id.display_name
|
||||
)
|
||||
self.assertEqual(
|
||||
set(PartnerSerializer._model_fields),
|
||||
set(datamodel2.__schema__.fields.keys()),
|
||||
)
|
||||
|
||||
def test_07_from_recordset_nested_custom(self):
|
||||
"""Test `from_recordset` method with nested fields, custom nested serializer"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["user_id"]
|
||||
|
||||
user_id = NestedModel("user_serializer")
|
||||
|
||||
class UserSerializer(ModelSerializer):
|
||||
_name = "user_serializer"
|
||||
_model = "res.users"
|
||||
_model_fields = ["login"]
|
||||
|
||||
user_dm_cls = self._full_build_model_serializer(UserSerializer)
|
||||
datamodel_cls = self._full_build_model_serializer(PartnerSerializer)
|
||||
user_field = _schema_field(datamodel_cls, "user_id")
|
||||
self.assertEqual(user_field.datamodel_name, "user_serializer")
|
||||
self.partner = self.env["res.partner"].create(
|
||||
{"name": "Test Partner", "user_id": SUPERUSER_ID}
|
||||
)
|
||||
datamodel = datamodel_cls.from_recordset(self.partner)
|
||||
self.assertIsInstance(datamodel.user_id, user_dm_cls)
|
||||
self.assertEqual(datamodel.user_id.login, self.partner.user_id.login)
|
||||
self.assertEqual(
|
||||
set(UserSerializer._model_fields),
|
||||
set(datamodel.user_id.__schema__.fields.keys()),
|
||||
)
|
||||
|
||||
def test_08_to_recordset_write(self):
|
||||
"""Test `to_recordset` method with only simple fields, existing partner"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name"]
|
||||
|
||||
self.partner = self.env["res.partner"].create({"name": "Test Partner"})
|
||||
datamodel = self._datamodel_instance(
|
||||
PartnerSerializer,
|
||||
{"id": self.partner.id, "name": self.partner.name + "New"},
|
||||
)
|
||||
new_partner = datamodel.to_recordset()
|
||||
self.assertEqual(new_partner, self.partner)
|
||||
self.assertEqual(new_partner.name, datamodel.name)
|
||||
|
||||
def test_09_to_recordset_relational_write(self):
|
||||
"""Test `to_recordset` method with relational fields, existing partner"""
|
||||
|
||||
class PartnerSerializer(ModelSerializer):
|
||||
_name = "partner_serializer"
|
||||
_model = "res.partner"
|
||||
_model_fields = ["id", "name", "child_ids"]
|
||||
|
||||
self.partner = self.env["res.partner"].create({"name": "Test Partner"})
|
||||
self.child_partner = self.env["res.partner"].create(
|
||||
{"name": "Test Child Partner"}
|
||||
)
|
||||
datamodel_child = self._datamodel_instance(
|
||||
PartnerSerializer,
|
||||
{"id": self.child_partner.id, "name": self.child_partner.name + "New"},
|
||||
)
|
||||
datamodel_child2 = self._datamodel_instance(
|
||||
PartnerSerializer,
|
||||
{"name": "Newly Created Partner"},
|
||||
)
|
||||
datamodel = self._datamodel_instance(
|
||||
PartnerSerializer,
|
||||
{
|
||||
"id": self.partner.id,
|
||||
"name": self.partner.name + "New",
|
||||
"child_ids": [datamodel_child, datamodel_child2],
|
||||
},
|
||||
)
|
||||
new_partner = datamodel.to_recordset()
|
||||
new_partner_child = new_partner.child_ids.filtered(
|
||||
lambda p: p.id == self.child_partner.id
|
||||
)
|
||||
self.assertTrue(bool(new_partner_child))
|
||||
self.assertEqual(new_partner_child.name, datamodel_child.name)
|
||||
self.assertTrue("Newly Created Partner" in new_partner.child_ids.mapped("name"))
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
[project]
|
||||
name = "odoo-bringout-oca-rest-framework-model_serializer"
|
||||
version = "16.0.0"
|
||||
description = "Model Serializer - Automatically translate Odoo models into Datamodels for (de)serialization"
|
||||
authors = [
|
||||
{ name = "Ernad Husremovic", email = "hernad@bring.out.ba" }
|
||||
]
|
||||
dependencies = [
|
||||
"odoo-bringout-oca-rest-framework-datamodel>=16.0.0",
|
||||
"requests>=2.25.1"
|
||||
]
|
||||
readme = "README.md"
|
||||
requires-python = ">= 3.11"
|
||||
classifiers = [
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Office/Business",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
homepage = "https://github.com/bringout/0"
|
||||
repository = "https://github.com/bringout/0"
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[tool.hatch.metadata]
|
||||
allow-direct-references = true
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["model_serializer"]
|
||||
|
||||
[tool.rye]
|
||||
managed = true
|
||||
dev-dependencies = [
|
||||
"pytest>=8.4.1",
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue