From 9e5f121d5b10a8ecdc3c4e1f1bdca3c1482a2b52 Mon Sep 17 00:00:00 2001 From: "Laurent Mignon (ACSONE)" Date: Sat, 6 Nov 2021 16:41:30 +0100 Subject: [PATCH 01/26] [ADD] pydantic: allows pydantic usage into Odoo and withon base_rest --- base_rest_pydantic/README.rst | 111 +++++ base_rest_pydantic/__init__.py | 1 + base_rest_pydantic/__manifest__.py | 21 + .../i18n/base_rest_datamodel.pot | 26 + base_rest_pydantic/readme/CONTRIBUTORS.rst | 1 + base_rest_pydantic/readme/DESCRIPTION.rst | 2 + base_rest_pydantic/readme/USAGE.rst | 33 ++ base_rest_pydantic/restapi.py | 195 ++++++++ .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 455 ++++++++++++++++++ base_rest_pydantic/tests/__init__.py | 2 + base_rest_pydantic/tests/test_from_params.py | 46 ++ base_rest_pydantic/tests/test_response.py | 42 ++ 13 files changed, 935 insertions(+) create mode 100644 base_rest_pydantic/README.rst create mode 100644 base_rest_pydantic/__init__.py create mode 100644 base_rest_pydantic/__manifest__.py create mode 100644 base_rest_pydantic/i18n/base_rest_datamodel.pot create mode 100644 base_rest_pydantic/readme/CONTRIBUTORS.rst create mode 100644 base_rest_pydantic/readme/DESCRIPTION.rst create mode 100644 base_rest_pydantic/readme/USAGE.rst create mode 100644 base_rest_pydantic/restapi.py create mode 100644 base_rest_pydantic/static/description/icon.png create mode 100644 base_rest_pydantic/static/description/index.html create mode 100644 base_rest_pydantic/tests/__init__.py create mode 100644 base_rest_pydantic/tests/test_from_params.py create mode 100644 base_rest_pydantic/tests/test_response.py diff --git a/base_rest_pydantic/README.rst b/base_rest_pydantic/README.rst new file mode 100644 index 000000000..cb7b63867 --- /dev/null +++ b/base_rest_pydantic/README.rst @@ -0,0 +1,111 @@ +=================== +Base Rest Datamodel +=================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/14.0/base_rest_pydantic + :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-14-0/rest-framework-14-0-base_rest_pydantic + :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/14.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This addon allows you to use Pydantic objects as params and/or response with your +REST API methods. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To use Pydantic instances as request and/or response of a REST service endpoint +you must: + +* Define your Pydantic classes; +* Provides the information required to the ``odoo.addons.base_rest.restapi.method`` decorator; + + +.. code-block:: python + + + from odoo.addons.base_rest import restapi + from odoo.addons.component.core import Component + from odoo.addons.pydantic.models import BaseModel + + class PingMessage(BaseModel): + message: str + + + class PingService(Component): + _inherit = 'base.rest.service' + _name = 'ping.service' + _usage = 'ping' + _collection = 'my_module.services' + + + @restapi.method( + [(["/pong"], "GET")], + input_param=restapi.PydanticModel(PingMessage), + output_param=restapi.PydanticModel(PingMessage), + auth="public", + ) + def pong(self, ping_message): + return PingMessage(message = "Received: " + ping_message.message) + +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 smashing 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 + +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. + +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. diff --git a/base_rest_pydantic/__init__.py b/base_rest_pydantic/__init__.py new file mode 100644 index 000000000..0d7891f8a --- /dev/null +++ b/base_rest_pydantic/__init__.py @@ -0,0 +1 @@ +from . import restapi diff --git a/base_rest_pydantic/__manifest__.py b/base_rest_pydantic/__manifest__.py new file mode 100644 index 000000000..b061642ac --- /dev/null +++ b/base_rest_pydantic/__manifest__.py @@ -0,0 +1,21 @@ +# Copyright 2021 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html) + +{ + "name": "Base Rest Datamodel", + "summary": """ + Pydantic binding for base_rest""", + "version": "14.0.4.1.0", + "license": "LGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/rest-framework", + "depends": ["base_rest"], + "data": [], + "demo": [], + "installable": True, + "external_dependencies": { + "python": [ + "pydantic", + ] + }, +} diff --git a/base_rest_pydantic/i18n/base_rest_datamodel.pot b/base_rest_pydantic/i18n/base_rest_datamodel.pot new file mode 100644 index 000000000..7dc461d5e --- /dev/null +++ b/base_rest_pydantic/i18n/base_rest_datamodel.pot @@ -0,0 +1,26 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_rest_datamodel +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.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: base_rest_datamodel +#: code:addons/base_rest_datamodel/restapi.py:0 +#, python-format +msgid "BadRequest %s" +msgstr "" + +#. module: base_rest_datamodel +#: code:addons/base_rest_datamodel/restapi.py:0 +#, python-format +msgid "Invalid Response %s" +msgstr "" diff --git a/base_rest_pydantic/readme/CONTRIBUTORS.rst b/base_rest_pydantic/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..172b2d223 --- /dev/null +++ b/base_rest_pydantic/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Laurent Mignon diff --git a/base_rest_pydantic/readme/DESCRIPTION.rst b/base_rest_pydantic/readme/DESCRIPTION.rst new file mode 100644 index 000000000..a5311dcef --- /dev/null +++ b/base_rest_pydantic/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This addon allows you to use Pydantic objects as params and/or response with your +REST API methods. diff --git a/base_rest_pydantic/readme/USAGE.rst b/base_rest_pydantic/readme/USAGE.rst new file mode 100644 index 000000000..47d6506a0 --- /dev/null +++ b/base_rest_pydantic/readme/USAGE.rst @@ -0,0 +1,33 @@ +To use Pydantic instances as request and/or response of a REST service endpoint +you must: + +* Define your Pydantic classes; +* Provides the information required to the ``odoo.addons.base_rest.restapi.method`` decorator; + + +.. code-block:: python + + + from odoo.addons.base_rest import restapi + from odoo.addons.component.core import Component + from odoo.addons.pydantic.models import BaseModel + + class PingMessage(BaseModel): + message: str + + + class PingService(Component): + _inherit = 'base.rest.service' + _name = 'ping.service' + _usage = 'ping' + _collection = 'my_module.services' + + + @restapi.method( + [(["/pong"], "GET")], + input_param=restapi.PydanticModel(PingMessage), + output_param=restapi.PydanticModel(PingMessage), + auth="public", + ) + def pong(self, ping_message): + return PingMessage(message = "Received: " + ping_message.message) diff --git a/base_rest_pydantic/restapi.py b/base_rest_pydantic/restapi.py new file mode 100644 index 000000000..7e49f004d --- /dev/null +++ b/base_rest_pydantic/restapi.py @@ -0,0 +1,195 @@ +# Copyright 2021 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo import _ +from odoo.exceptions import UserError + +from odoo.addons.base_rest import restapi + +from pydantic import BaseModel, ValidationError, validate_model + + +def replace_ref_in_schema(item, original_schema): + if isinstance(item, list): + return [replace_ref_in_schema(i, original_schema) for i in item] + elif isinstance(item, dict): + if list(item.keys()) == ["$ref"]: + schema = item["$ref"].split("/")[-1] + return {"$ref": f"#/components/schemas/{schema}"} + else: + return { + key: replace_ref_in_schema(i, original_schema) + for key, i in item.items() + } + else: + return item + + +class PydanticModel(restapi.RestMethodParam): + def __init__(self, cls: BaseModel): + """ + :param name: The pydantic model name + """ + if not issubclass(cls, BaseModel): + raise TypeError( + f"{cls} is not a subclass of odoo.addons.pydantic.models.BaseModel" + ) + self._model_cls = cls + + def from_params(self, service, params): + try: + return self._model_cls(**params) + except ValidationError as ve: + raise UserError(_("BadRequest %s") % ve.json(indent=0)) + + def to_response(self, service, result): + # do we really need to validate the instance???? + json_dict = result.dict() + to_validate = ( + json_dict if not result.__config__.orm_mode else result.dict(by_alias=True) + ) + *_, validation_error = validate_model(self._model_cls, to_validate) + if validation_error: + raise SystemError(_("Invalid Response %s") % validation_error) + return json_dict + + def to_openapi_query_parameters(self, servic, spec): + json_schema = self._model_cls.schema() + parameters = [] + for prop, spec in list(json_schema["properties"].items()): + params = { + "name": prop, + "in": "query", + "required": prop in json_schema.get("required", []), + "allowEmptyValue": spec.get("nullable", False), + "default": spec.get("default"), + } + if spec.get("schema"): + params["schema"] = spec.get("schema") + else: + params["schema"] = {"type": spec["type"]} + if spec.get("items"): + params["schema"]["items"] = spec.get("items") + if "enum" in spec: + params["schema"]["enum"] = spec["enum"] + + parameters.append(params) + + if spec["type"] == "array": + # To correctly handle array into the url query string, + # the name must ends with [] + params["name"] = params["name"] + "[]" + + return parameters + + # TODO, we should probably get the spec as parameters. That should + # allows to add the definition of a schema only once into the specs + # and use a reference to the schema into the parameters + def to_openapi_requestbody(self, service, spec): + return {"content": {"application/json": {"schema": self.to_json_schema(spec)}}} + + def to_openapi_responses(self, service, spec): + return { + "200": { + "content": {"application/json": {"schema": self.to_json_schema(spec)}} + } + } + + def to_json_schema(self, spec): + schema = self._model_cls.schema() + schema_name = schema["title"] + if schema_name not in spec.components.schemas: + definitions = schema.get("definitions", {}) + for name, sch in definitions.items(): + if name in spec.components.schemas: + continue + sch = replace_ref_in_schema(sch, sch) + spec.components.schema(name, sch) + schema = replace_ref_in_schema(schema, schema) + spec.components.schema(schema_name, schema) + return {"$ref": f"#/components/schemas/{schema_name}"} + + +class PydanticModelList(PydanticModel): + def __init__( + self, + cls: BaseModel, + min_items: int = None, + max_items: int = None, + unique_items: bool = None, + ): + """ + :param name: The pydantic model name + :param min_items: A list instance is valid against "min_items" if its + size is greater than, or equal to, min_items. + The value MUST be a non-negative integer. + :param max_items: A list instance is valid against "max_items" if its + size is less than, or equal to, max_items. + The value MUST be a non-negative integer. + :param unique_items: Used to document that the list should only + contain unique items. + (Not enforced at validation time) + """ + super().__init__(cls=cls) + self._min_items = min_items + self._max_items = max_items + self._unique_items = unique_items + + def from_params(self, service, params): + self._do_validate(params, "input") + return [super(PydanticModelList, self).from_params(param) for param in params] + + def to_response(self, service, result): + self._do_validate(result, "output") + return [ + super(PydanticModelList, self).to_response(service=service, result=r) + for r in result + ] + + def to_openapi_query_parameters(self, service, spec): + raise NotImplementedError("List are not (?yet?) supported as query paramters") + + def _do_validate(self, values, direction): + ExceptionClass = UserError if direction == "input" else SystemError + if self._min_items is not None and len(values) < self._min_items: + raise ExceptionClass( + _( + "BadRequest: Not enough items in the list (%s < %s)" + % (len(values), self._min_items) + ) + ) + if self._max_items is not None and len(values) > self._max_items: + raise ExceptionClass( + _( + "BadRequest: Too many items in the list (%s > %s)" + % (len(values), self._max_items) + ) + ) + + # TODO, we should probably get the spec as parameters. That should + # allows to add the definition of a schema only once into the specs + # and use a reference to the schema into the parameters + def to_openapi_requestbody(self, service, spec): + return {"content": {"application/json": {"schema": self.to_json_schema(spec)}}} + + def to_openapi_responses(self, service, spec): + return { + "200": { + "content": {"application/json": {"schema": self.to_json_schema(spec)}} + } + } + + def to_json_schema(self, spec): + json_schema = super().to_json_schema(spec) + json_schema = {"type": "array", "items": json_schema} + if self._min_items is not None: + json_schema["minItems"] = self._min_items + if self._max_items is not None: + json_schema["maxItems"] = self._max_items + if self._unique_items is not None: + json_schema["uniqueItems"] = self._unique_items + return json_schema + + +restapi.PydanticModel = PydanticModel +restapi.PydanticModelList = PydanticModelList diff --git a/base_rest_pydantic/static/description/icon.png b/base_rest_pydantic/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/base_rest_pydantic/static/description/index.html b/base_rest_pydantic/static/description/index.html new file mode 100644 index 000000000..b42fa6eb4 --- /dev/null +++ b/base_rest_pydantic/static/description/index.html @@ -0,0 +1,455 @@ + + + + + + +Base Rest Datamodel + + + +
+

Base Rest Datamodel

+ + +

Beta License: LGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runbot

+

This addon allows you to use Pydantic objects as params and/or response with your +REST API methods.

+

Table of contents

+ +
+

Usage

+

To use Pydantic instances as request and/or response of a REST service endpoint +you must:

+
    +
  • Define your Pydantic classes;
    • +
  • Provides the information required to the odoo.addons.base_rest.restapi.method decorator;
    • +
+
+from odoo.addons.base_rest import restapi
+from odoo.addons.component.core import Component
+from odoo.addons.pydantic.models import BaseModel
+
+class PingMessage(BaseModel):
+    message: str
+
+
+class PingService(Component):
+    _inherit = 'base.rest.service'
+    _name = 'ping.service'
+    _usage = 'ping'
+    _collection = 'my_module.services'
+
+
+    @restapi.method(
+        [(["/pong"], "GET")],
+        input_param=restapi.PydanticModel(PingMessage),
+        output_param=restapi.PydanticModel(PingMessage),
+        auth="public",
+    )
+    def pong(self, ping_message):
+        return PingMessage(message = "Received: " + ping_message.message)
+
+
+
+

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 smashing 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

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

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.

+
+
+
+ + diff --git a/base_rest_pydantic/tests/__init__.py b/base_rest_pydantic/tests/__init__.py new file mode 100644 index 000000000..07ef555a4 --- /dev/null +++ b/base_rest_pydantic/tests/__init__.py @@ -0,0 +1,2 @@ +from . import test_response +from . import test_from_params diff --git a/base_rest_pydantic/tests/test_from_params.py b/base_rest_pydantic/tests/test_from_params.py new file mode 100644 index 000000000..052ea3d33 --- /dev/null +++ b/base_rest_pydantic/tests/test_from_params.py @@ -0,0 +1,46 @@ +# Copyright 2021 Wakari SRL +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +from typing import Type + +import mock + +from odoo.exceptions import UserError +from odoo.tests.common import SavepointCase + +from pydantic import BaseModel + +from .. import restapi + + +class TestPydantic(SavepointCase): + def setUp(self): + super(TestPydantic, self).setUp() + + class Model1(BaseModel): + name: str + description: str = None + + self.Model1: BaseModel = Model1 + + def _from_params(self, pydantic_cls: Type[BaseModel], params: dict, **kwargs): + restapi_pydantic = restapi.PydanticModel(pydantic_cls, **kwargs) + mock_service = mock.Mock() + mock_service.env = self.env + return restapi_pydantic.from_params(mock_service, params) + + def test_from_params(self): + params = {"name": "Instance Name", "description": "Instance Description"} + instance = self._from_params(self.Model1, params) + self.assertEqual(instance.name, params["name"]) + self.assertEqual(instance.description, params["description"]) + + def test_from_params_missing_optional_field(self): + params = {"name": "Instance Name"} + instance = self._from_params(self.Model1, params) + self.assertEqual(instance.name, params["name"]) + self.assertIsNone(instance.description) + + def test_from_params_missing_required_field(self): + msg = r"value_error.missing" + with self.assertRaisesRegex(UserError, msg): + self._from_params(self.Model1, {"description": "Instance Description"}) diff --git a/base_rest_pydantic/tests/test_response.py b/base_rest_pydantic/tests/test_response.py new file mode 100644 index 000000000..83a1297a4 --- /dev/null +++ b/base_rest_pydantic/tests/test_response.py @@ -0,0 +1,42 @@ +# Copyright 2021 Wakari SRL +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +from typing import List + +import mock + +from odoo.tests.common import SavepointCase + +from pydantic import BaseModel + +from .. import restapi + + +class TestPydantic(SavepointCase): + def _to_response(self, instance: BaseModel): + restapi_pydantic = restapi.PydanticModel(instance.__class__) + mock_service = mock.Mock() + mock_service.env = self.env + return restapi_pydantic.to_response(mock_service, instance) + + def _to_response_list(self, instance: List[BaseModel]): + restapi_pydantic = restapi.PydanticModelList(instance[0].__class__) + mock_service = mock.Mock() + mock_service.env = self.env + return restapi_pydantic.to_response(mock_service, instance) + + def test_to_response(self): + class Model1(BaseModel): + name: str + + instance = Model1(name="Instance 1") + res = self._to_response(instance) + self.assertEqual(res["name"], instance.name) + + def test_to_response_list(self): + class Model1(BaseModel): + name: str + + instances = (Model1(name="Instance 1"), Model1(name="Instance 2")) + res = self._to_response_list(instances) + self.assertEqual(len(res), 2) + self.assertSetEqual({r["name"] for r in res}, {"Instance 1", "Instance 2"}) From 8ff890609d4117346293a481f56d25c534f7c5a7 Mon Sep 17 00:00:00 2001 From: oca-travis Date: Tue, 14 Jun 2022 08:47:51 +0000 Subject: [PATCH 02/26] [UPD] Update base_rest_pydantic.pot --- .../i18n/base_rest_pydantic.pot | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 base_rest_pydantic/i18n/base_rest_pydantic.pot diff --git a/base_rest_pydantic/i18n/base_rest_pydantic.pot b/base_rest_pydantic/i18n/base_rest_pydantic.pot new file mode 100644 index 000000000..958d379a5 --- /dev/null +++ b/base_rest_pydantic/i18n/base_rest_pydantic.pot @@ -0,0 +1,38 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * base_rest_pydantic +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.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: base_rest_pydantic +#: code:addons/base_rest_pydantic/restapi.py:0 +#, python-format +msgid "BadRequest %s" +msgstr "" + +#. module: base_rest_pydantic +#: code:addons/base_rest_pydantic/restapi.py:0 +#, python-format +msgid "BadRequest: Not enough items in the list (%s < %s)" +msgstr "" + +#. module: base_rest_pydantic +#: code:addons/base_rest_pydantic/restapi.py:0 +#, python-format +msgid "BadRequest: Too many items in the list (%s > %s)" +msgstr "" + +#. module: base_rest_pydantic +#: code:addons/base_rest_pydantic/restapi.py:0 +#, python-format +msgid "Invalid Response %s" +msgstr "" From 2ed64506fe55aa8cdc1db16516ad6a9bf01ccaf5 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 14 Jun 2022 08:51:41 +0000 Subject: [PATCH 03/26] [UPD] README.rst --- base_rest_pydantic/static/description/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/base_rest_pydantic/static/description/index.html b/base_rest_pydantic/static/description/index.html index b42fa6eb4..032d1ef2a 100644 --- a/base_rest_pydantic/static/description/index.html +++ b/base_rest_pydantic/static/description/index.html @@ -3,7 +3,7 @@ - + Base Rest Datamodel