Merge PR #551 into 17.0

Signed-off-by lmignon

Author: OCA-git-bot

graphql_base/README.rst

@@ -44,9 +44,9 @@ Usage
 
 To use this module, you need to
 
--  create your graphene schema
--  create your controller to expose your GraphQL endpoint, and
-   optionally a GraphiQL IDE.
+- create your graphene schema
+- create your controller to expose your GraphQL endpoint, and optionally
+  a GraphiQL IDE.
 
 This module does not attempt to expose the whole Odoo object model. This
 could be the purpose of another module based on this one. We believe
@@ -56,12 +56,12 @@ exposed and needs to be tested when upgrading Odoo.
 
 To start working with this module, we recommend the following approach:
 
--  Learn `GraphQL basics <https://graphql.org/learn/>`__
--  Learn `graphene <https://graphene-python.org/>`__, the python library
-   used to create GraphQL schemas and resolvers.
--  Examine the ``graphql_demo`` module in this repo, copy it, adapt the
-   controller to suit your needs (routes, authentication methods).
--  Start building your own schema and resolver.
+- Learn `GraphQL basics <https://graphql.org/learn/>`__
+- Learn `graphene <https://graphene-python.org/>`__, the python library
+  used to create GraphQL schemas and resolvers.
+- Examine the ``graphql_demo`` module in this repo, copy it, adapt the
+  controller to suit your needs (routes, authentication methods).
+- Start building your own schema and resolver.
 
 Building your schema
 --------------------
@@ -71,11 +71,11 @@ The schema can be built using native graphene types. An
 convenience. It is a graphene ``ObjectType`` with a default attribute
 resolver which:
 
--  converts False to None (except for Boolean types), to avoid Odoo's
-   weird ``False`` strings being rendered as json ``"false"``;
--  adds the user timezone to Datetime fields;
--  raises an error if an attribute is absent to avoid field name typing
-   errors.
+- converts False to None (except for Boolean types), to avoid Odoo's
+  weird ``False`` strings being rendered as json ``"false"``;
+- adds the user timezone to Datetime fields;
+- raises an error if an attribute is absent to avoid field name typing
+  errors.
 
 Creating GraphQL controllers
 ----------------------------

graphql_base/__manifest__.py

@@ -11,7 +11,7 @@
     "website": "https://github.com/OCA/rest-framework",
     "depends": ["base"],
     "data": ["views/graphiql.xml"],
-    "external_dependencies": {"python": ["graphene", "graphql_server"]},
+    "external_dependencies": {"python": ["graphene", "graphql_server==3.0.0b7"]},
     "development_status": "Production/Stable",
     "maintainers": ["sbidoul"],
     "installable": True,

graphql_base/static/description/index.html

@@ -396,8 +396,8 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>To use this module, you need to</p>
 <ul class="simple">
 <li>create your graphene schema</li>
-<li>create your controller to expose your GraphQL endpoint, and
-optionally a GraphiQL IDE.</li>
+<li>create your controller to expose your GraphQL endpoint, and optionally
+a GraphiQL IDE.</li>
 </ul>
 <p>This module does not attempt to expose the whole Odoo object model. This
 could be the purpose of another module based on this one. We believe
@@ -433,24 +433,24 @@ <h2><a class="toc-backref" href="#toc-entry-3">Creating GraphQL controllers</a><
 <tt class="docutils literal">odoo.addons.graphql_base.GraphQLControllerMixin</tt> class to help you
 build GraphQL controllers providing GraphiQL and/or GraphQL endpoints.</p>
 <pre class="code python literal-block">
-<span class="kn">from</span> <span class="nn">odoo</span> <span class="kn">import</span> <span class="n">http</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">odoo.addons.graphql_base</span> <span class="kn">import</span> <span class="n">GraphQLControllerMixin</span><span class="w">
+<span class="kn">from</span><span class="w"> </span><span class="nn">odoo</span><span class="w"> </span><span class="kn">import</span> <span class="n">http</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">odoo.addons.graphql_base</span><span class="w"> </span><span class="kn">import</span> <span class="n">GraphQLControllerMixin</span><span class="w">
 
-</span><span class="kn">from</span> <span class="nn">..schema</span> <span class="kn">import</span> <span class="n">schema</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">..schema</span><span class="w"> </span><span class="kn">import</span> <span class="n">schema</span><span class="w">
 
 
-</span><span class="k">class</span> <span class="nc">GraphQLController</span><span class="p">(</span><span class="n">http</span><span class="o">.</span><span class="n">Controller</span><span class="p">,</span> <span class="n">GraphQLControllerMixin</span><span class="p">):</span><span class="w">
+</span><span class="k">class</span><span class="w"> </span><span class="nc">GraphQLController</span><span class="p">(</span><span class="n">http</span><span class="o">.</span><span class="n">Controller</span><span class="p">,</span> <span class="n">GraphQLControllerMixin</span><span class="p">):</span><span class="w">
 
 </span>    <span class="c1"># The GraphiQL route, providing an IDE for developers</span><span class="w">
 </span>    <span class="nd">&#64;http</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/graphiql/demo&quot;</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="s2">&quot;user&quot;</span><span class="p">)</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">graphiql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">graphiql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
 </span>        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_graphiql_request</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span><span class="w">
 
 </span>    <span class="c1"># The graphql route, for applications.</span><span class="w">
 </span>    <span class="c1"># Note csrf=False: you may want to apply extra security</span><span class="w">
 </span>    <span class="c1"># (such as origin restrictions) to this route.</span><span class="w">
 </span>    <span class="nd">&#64;http</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/graphql/demo&quot;</span><span class="p">,</span> <span class="n">auth</span><span class="o">=</span><span class="s2">&quot;user&quot;</span><span class="p">,</span> <span class="n">csrf</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">graphql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">graphql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span><span class="w">
 </span>        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handle_graphql_request</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span>
 </pre>
 </div>

pydantic/README.rst

@@ -29,13 +29,13 @@ Pydantic
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
 This addon provides a utility method that can be used to map odoo record
-to a `Pydantic model <https://pydantic-docs.helpmanual.io/>`__.
+to a `Pydantic model (>= v2) <https://docs.pydantic.dev/>`__.
 
 If you need to make your Pydantic models extendable at runtime, takes a
 look at the python package
 `extendable-pydantic <https://pypi.org/project/extendable_pydantic/>`__
-and the odoo addon
-`extendable <https://github.com/acsone/odoo-addon-extendable>`__
+and the `odoo addon
+extendable <https://pypi.org/project/odoo-addon-extendable>`__
 
 **Table of contents**
 
@@ -47,36 +47,28 @@ Usage
 
 To support pydantic models that map to Odoo models, Pydantic model
 instances can be created from arbitrary odoo model instances by mapping
-fields from odoo models to fields defined by the pydantic model. To ease
-the mapping, the addon provide a utility class
-odoo.addons.pydantic.utils.GenericOdooGetter.
+fields from odoo models to fields defined by the pydantic model.
+
+To ease the mapping, the addon provide an utility class (using
+``pydantic>2.0``) ``odoo.addons.pydantic.utils.PydanticOdooBaseModel``:
 
 .. code:: python
 
-   import pydantic
-   from odoo.addons.pydantic import utils
+   from odoo.addons.pydantic.utils import PydanticOdooBaseModel
 
-   class Group(pydantic.BaseModel):
-       name: str
 
-       class Config:
-           orm_mode = True
-           getter_dict = utils.GenericOdooGetter
+   class Group(PydanticOdooBaseModel):
+       name: str
 
-   class UserInfo(pydantic.BaseModel):
+   class UserInfo(PydanticOdooBaseModel):
        name: str
        groups: List[Group] = pydantic.Field(alias="groups_id")
 
-       class Config:
-           orm_mode = True
-           getter_dict = utils.GenericOdooGetter
-
    user = self.env.user
    user_info = UserInfo.from_orm(user)
 
-See the official `Pydantic
-documentation <https://pydantic-docs.helpmanual.io/>`__ to discover all
-the available functionalities.
+See the official `Pydantic documentation <https://docs.pydantic.dev/>`__
+to discover all the available functionalities.
 
 Known issues / Roadmap
 ======================
@@ -108,8 +100,9 @@ Authors
 Contributors
 ------------
 
--  Laurent Mignon <laurent.mignon@acsone.eu>
--  Tris Doan <tridm@trobz.com>
+- Laurent Mignon <laurent.mignon@acsone.eu>
+- Tris Doan <tridm@trobz.com>
+- Pierre Verkest <pierre@verkest.fr>
 
 Maintainers
 -----------

pydantic/__manifest__.py

@@ -15,7 +15,7 @@
     "data": [],
     "demo": [],
     "external_dependencies": {
-        "python": ["pydantic", "contextvars", "typing-extensions"]
+        "python": ["pydantic>=2.0", "contextvars", "typing-extensions"]
     },
     "installable": True,
 }

pydantic/readme/CONTRIBUTORS.md

@@ -1,2 +1,3 @@
 - Laurent Mignon \<<laurent.mignon@acsone.eu>\>
 - Tris Doan \<<tridm@trobz.com>\>
+- Pierre Verkest \<<pierre@verkest.fr>\>

pydantic/readme/DESCRIPTION.md

@@ -1,8 +1,7 @@
 This addon provides a utility method that can be used to map odoo record
-to a [Pydantic model](https://pydantic-docs.helpmanual.io/).
+to a [Pydantic model (>= v2)](https://docs.pydantic.dev/).
 
 If you need to make your Pydantic models extendable at runtime, takes a
 look at the python package
 [extendable-pydantic](https://pypi.org/project/extendable_pydantic/) and
-the odoo addon
-[extendable](https://github.com/acsone/odoo-addon-extendable)
+the [odoo addon extendable](https://pypi.org/project/odoo-addon-extendable)

pydantic/readme/USAGE.md

@@ -1,32 +1,25 @@
 To support pydantic models that map to Odoo models, Pydantic model
 instances can be created from arbitrary odoo model instances by mapping
-fields from odoo models to fields defined by the pydantic model. To ease
-the mapping, the addon provide a utility class
-odoo.addons.pydantic.utils.GenericOdooGetter.
+fields from odoo models to fields defined by the pydantic model. 
+
+
+To ease the mapping, the addon provide an utility class (using `pydantic>2.0`) `odoo.addons.pydantic.utils.PydanticOdooBaseModel`:
 
 ``` python
-import pydantic
-from odoo.addons.pydantic import utils
+from odoo.addons.pydantic.utils import PydanticOdooBaseModel
 
-class Group(pydantic.BaseModel):
-    name: str
 
-    class Config:
-        orm_mode = True
-        getter_dict = utils.GenericOdooGetter
+class Group(PydanticOdooBaseModel):
+    name: str
 
-class UserInfo(pydantic.BaseModel):
+class UserInfo(PydanticOdooBaseModel):
     name: str
     groups: List[Group] = pydantic.Field(alias="groups_id")
 
-    class Config:
-        orm_mode = True
-        getter_dict = utils.GenericOdooGetter
-
 user = self.env.user
 user_info = UserInfo.from_orm(user)
 ```
 
 See the official [Pydantic
-documentation](https://pydantic-docs.helpmanual.io/) to discover all the
+documentation](https://docs.pydantic.dev/) to discover all the
 available functionalities.

pydantic/static/description/index.html

@@ -371,12 +371,12 @@ <h1 class="title">Pydantic</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" 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 image-reference" href="https://github.com/OCA/rest-framework/tree/17.0/pydantic"><img alt="OCA/rest-framework" src="https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/rest-framework-17-0/rest-framework-17-0-pydantic"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This addon provides a utility method that can be used to map odoo record
-to a <a class="reference external" href="https://pydantic-docs.helpmanual.io/">Pydantic model</a>.</p>
+to a <a class="reference external" href="https://docs.pydantic.dev/">Pydantic model (&gt;= v2)</a>.</p>
 <p>If you need to make your Pydantic models extendable at runtime, takes a
 look at the python package
 <a class="reference external" href="https://pypi.org/project/extendable_pydantic/">extendable-pydantic</a>
-and the odoo addon
-<a class="reference external" href="https://github.com/acsone/odoo-addon-extendable">extendable</a></p>
+and the <a class="reference external" href="https://pypi.org/project/odoo-addon-extendable">odoo addon
+extendable</a></p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -395,34 +395,25 @@ <h1 class="title">Pydantic</h1>
 <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>To support pydantic models that map to Odoo models, Pydantic model
 instances can be created from arbitrary odoo model instances by mapping
-fields from odoo models to fields defined by the pydantic model. To ease
-the mapping, the addon provide a utility class
-odoo.addons.pydantic.utils.GenericOdooGetter.</p>
+fields from odoo models to fields defined by the pydantic model.</p>
+<p>To ease the mapping, the addon provide an utility class (using
+<tt class="docutils literal">pydantic&gt;2.0</tt>) <tt class="docutils literal">odoo.addons.pydantic.utils.PydanticOdooBaseModel</tt>:</p>
 <pre class="code python literal-block">
-<span class="kn">import</span> <span class="nn">pydantic</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">odoo.addons.pydantic</span> <span class="kn">import</span> <span class="n">utils</span><span class="w">
+<span class="kn">from</span><span class="w"> </span><span class="nn">odoo.addons.pydantic.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">PydanticOdooBaseModel</span><span class="w">
 
-</span><span class="k">class</span> <span class="nc">Group</span><span class="p">(</span><span class="n">pydantic</span><span class="o">.</span><span class="n">BaseModel</span><span class="p">):</span><span class="w">
-</span>    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="w">
 
-</span>    <span class="k">class</span> <span class="nc">Config</span><span class="p">:</span><span class="w">
-</span>        <span class="n">orm_mode</span> <span class="o">=</span> <span class="kc">True</span><span class="w">
-</span>        <span class="n">getter_dict</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">GenericOdooGetter</span><span class="w">
+</span><span class="k">class</span><span class="w"> </span><span class="nc">Group</span><span class="p">(</span><span class="n">PydanticOdooBaseModel</span><span class="p">):</span><span class="w">
+</span>    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="w">
 
-</span><span class="k">class</span> <span class="nc">UserInfo</span><span class="p">(</span><span class="n">pydantic</span><span class="o">.</span><span class="n">BaseModel</span><span class="p">):</span><span class="w">
+</span><span class="k">class</span><span class="w"> </span><span class="nc">UserInfo</span><span class="p">(</span><span class="n">PydanticOdooBaseModel</span><span class="p">):</span><span class="w">
 </span>    <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="w">
 </span>    <span class="n">groups</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Group</span><span class="p">]</span> <span class="o">=</span> <span class="n">pydantic</span><span class="o">.</span><span class="n">Field</span><span class="p">(</span><span class="n">alias</span><span class="o">=</span><span class="s2">&quot;groups_id&quot;</span><span class="p">)</span><span class="w">
 
-</span>    <span class="k">class</span> <span class="nc">Config</span><span class="p">:</span><span class="w">
-</span>        <span class="n">orm_mode</span> <span class="o">=</span> <span class="kc">True</span><span class="w">
-</span>        <span class="n">getter_dict</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">GenericOdooGetter</span><span class="w">
-
 </span><span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">user</span><span class="w">
 </span><span class="n">user_info</span> <span class="o">=</span> <span class="n">UserInfo</span><span class="o">.</span><span class="n">from_orm</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
 </pre>
-<p>See the official <a class="reference external" href="https://pydantic-docs.helpmanual.io/">Pydantic
-documentation</a> to discover all
-the available functionalities.</p>
+<p>See the official <a class="reference external" href="https://docs.pydantic.dev/">Pydantic documentation</a>
+to discover all the available functionalities.</p>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
@@ -453,6 +444,7 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;</li>
 <li>Tris Doan &lt;<a class="reference external" href="mailto:tridm&#64;trobz.com">tridm&#64;trobz.com</a>&gt;</li>
+<li>Pierre Verkest &lt;<a class="reference external" href="mailto:pierre&#64;verkest.fr">pierre&#64;verkest.fr</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">

pydantic/tests/__init__.py

@@ -0,0 +1 @@
+from . import test_pydantic_generic_odoo_getter