[MIG] search_engine_serializer_pydantic

Author: paradoxxxzero

.pre-commit-config.yaml

@@ -5,7 +5,6 @@ exclude: |
   ^connector_elasticsearch/|
   ^connector_search_engine_serializer_ir_export/|
   ^search_engine_image_thumbnail/|
-  ^search_engine_serializer_pydantic/|
   # END NOT INSTALLABLE ADDONS
   # Files and folders generated by bots, to avoid loops
   ^setup/|/static/description/index\.html$|

requirements.txt

@@ -3,3 +3,4 @@ requests
 typesense>=1.1.0
 typing-extensions
 unidecode
+pydantic

search_engine_serializer_pydantic/README.rst

@@ -17,13 +17,13 @@ Search Engine Serilizer Pydantic
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github
-    :target: https://github.com/OCA/search-engine/tree/16.0/search_engine_serializer_pydantic
+    :target: https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic
     :alt: OCA/search-engine
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/search-engine-16-0/search-engine-16-0-search_engine_serializer_pydantic
+    :target: https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-search_engine_serializer_pydantic
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -99,16 +99,16 @@ Example:
 Known issues / Roadmap
 ======================
 
--  Add dedicated widget to display in a user friendly way the json
-   schema generated by the serializer on the index form.
+- Add dedicated widget to display in a user friendly way the json schema
+  generated by the serializer on the index form.
 
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/search-engine/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/search-engine/issues/new?body=module:%20search_engine_serializer_pydantic%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/search-engine/issues/new?body=module:%20search_engine_serializer_pydantic%0Aversion:%2018.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.
 
@@ -123,14 +123,14 @@ Authors
 Contributors
 ------------
 
--  Laurent Mignon laurent.mignon@acsone.eu (https://www.acsone.eu/)
+- Laurent Mignon laurent.mignon@acsone.eu (https://www.acsone.eu/)
 
 Other credits
 -------------
 
 The development of this module has been financially supported by:
 
--  (ALCYON Belux)[https://www.alcyonbelux.be/fr/]
+- (ALCYON Belux)[https://www.alcyonbelux.be/fr/]
 
 Maintainers
 -----------
@@ -153,6 +153,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-lmignon| 
 
-This module is part of the `OCA/search-engine <https://github.com/OCA/search-engine/tree/16.0/search_engine_serializer_pydantic>`_ project on GitHub.
+This module is part of the `OCA/search-engine <https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

search_engine_serializer_pydantic/__manifest__.py

@@ -3,9 +3,8 @@
 
 {
     "name": "Search Engine Serilizer Pydantic",
-    "summary": """
-        Defines base class for pydantic baser serializer""",
-    "version": "16.0.1.0.0",
+    "summary": "Defines base class for pydantic baser serializer",
+    "version": "18.0.1.0.0",
     "license": "AGPL-3",
     "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
     "maintainers": ["lmignon"],
@@ -17,11 +16,10 @@
     "data": [
         "views/se_index.xml",
     ],
-    "demo": [],
     "external_dependencies": {
         "python": [
             "pydantic",
         ],
     },
-    "installable": False,
+    "installable": True,
 }

search_engine_serializer_pydantic/models/se_index.py

@@ -2,7 +2,6 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
 import json
-from typing import Type
 
 from pydantic import BaseModel
 
@@ -12,7 +11,6 @@
 
 
 class SeIndex(models.Model):
-
     _inherit = "se.index"
 
     is_pydantic_serializer = fields.Boolean(
@@ -47,7 +45,7 @@ def _compute_record_json_schema(self):
                 rec.record_json_schema = None
                 rec.record_json_schema_str = ""
             else:
-                model: Type[BaseModel] = rec.model_serializer.get_model_class()
+                model: type[BaseModel] = rec.model_serializer.get_model_class()
                 rec.record_json_schema = model.model_json_schema()
                 rec.record_json_schema_str = json.dumps(
                     rec.record_json_schema, indent=2

search_engine_serializer_pydantic/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

search_engine_serializer_pydantic/static/description/index.html

@@ -1,4 +1,3 @@
-<?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>
@@ -9,10 +8,11 @@
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -275,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* 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 }
@@ -301,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -369,7 +369,7 @@ <h1 class="title">Search Engine Serilizer Pydantic</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:c1ccbbd934bcc84a6ba68660b56e79a875d6da98da0bea29e68ce453e054aae0
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/search-engine/tree/16.0/search_engine_serializer_pydantic"><img alt="OCA/search-engine" src="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/search-engine-16-0/search-engine-16-0-search_engine_serializer_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/search-engine&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic"><img alt="OCA/search-engine" src="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-search_engine_serializer_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/search-engine&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module is a technical module that define a new abstract class named
 <tt class="docutils literal">PydandicModelSerializer</tt> that inherit from
 <tt class="docutils literal">odoo.addons.connector_search_engine.tools.serializer.ModelSerializer</tt></p>
@@ -413,46 +413,46 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 provided by this module.</p>
 <p>Example:</p>
 <pre class="code python literal-block">
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Type</span><span class="w">
-</span><span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span><span class="w">
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Type</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModel</span><span class="w">
 
-</span><span class="kn">from</span> <span class="nn">odoo.addons.search_engine_serialize_pydantic.tools.serializer</span> <span class="kn">import</span> <span class="p">(</span><span class="w">
+</span><span class="kn">from</span><span class="w"> </span><span class="nn">odoo.addons.search_engine_serialize_pydantic.tools.serializer</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span><span class="w">
 </span>    <span class="n">PydanticModelSerializer</span><span class="p">,</span><span class="w">
 </span><span class="p">)</span><span class="w">
 
 
-</span><span class="k">class</span> <span class="nc">MyModel</span><span class="p">(</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">MyModel</span><span class="p">(</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="n">description</span><span class="p">:</span> <span class="nb">str</span><span class="w">
 
-</span>    <span class="k">def</span> <span class="nf">record_to_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">:</span> <span class="n">Model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">record_to_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">:</span> <span class="n">Model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span><span class="w">
 </span>        <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="w">
 </span>            <span class="n">name</span><span class="o">=</span><span class="n">record</span><span class="o">.</span><span class="n">name</span><span class="p">,</span><span class="w">
 </span>            <span class="n">description</span><span class="o">=</span><span class="n">record</span><span class="o">.</span><span class="n">description</span><span class="p">,</span><span class="w">
 </span>        <span class="p">)</span><span class="w">
 
-</span><span class="k">class</span> <span class="nc">MyModelSerializer</span><span class="p">(</span><span class="n">PydanticModelSerializer</span><span class="p">):</span><span class="w">
-</span>    <span class="k">def</span> <span class="nf">get_model_class</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Type</span><span class="p">[</span><span class="n">MyModel</span><span class="p">]:</span><span class="w">
+</span><span class="k">class</span><span class="w"> </span><span class="nc">MyModelSerializer</span><span class="p">(</span><span class="n">PydanticModelSerializer</span><span class="p">):</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">get_model_class</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Type</span><span class="p">[</span><span class="n">MyModel</span><span class="p">]:</span><span class="w">
 </span>        <span class="k">return</span> <span class="n">MyModel</span><span class="w">
 
-</span>    <span class="k">def</span> <span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">:</span> <span class="n">Model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span><span class="w">
+</span>    <span class="k">def</span><span class="w"> </span><span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">:</span> <span class="n">Model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span><span class="w">
 </span>        <span class="n">model</span><span class="p">:</span> <span class="n">MyModel</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_model_class</span><span class="p">()</span><span class="o">.</span><span class="n">record_to_model</span><span class="p">(</span><span class="n">record</span><span class="p">)</span><span class="w">
 </span>        <span class="k">return</span> <span class="n">model</span><span class="o">.</span><span class="n">model_dump</span><span class="p">()</span>
 </pre>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
 <ul class="simple">
-<li>Add dedicated widget to display in a user friendly way the json
-schema generated by the serializer on the index form.</li>
+<li>Add dedicated widget to display in a user friendly way the json schema
+generated by the serializer on the index form.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/search-engine/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 to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/search-engine/issues/new?body=module:%20search_engine_serializer_pydantic%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/search-engine/issues/new?body=module:%20search_engine_serializer_pydantic%0Aversion:%2018.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">
@@ -479,13 +479,15 @@ <h2><a class="toc-backref" href="#toc-entry-8">Other credits</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-9">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>
+<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 image-reference" href="https://github.com/lmignon"><img alt="lmignon" src="https://github.com/lmignon.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/search-engine/tree/16.0/search_engine_serializer_pydantic">OCA/search-engine</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/search-engine/tree/18.0/search_engine_serializer_pydantic">OCA/search-engine</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>

search_engine_serializer_pydantic/tools/serializer.py

@@ -2,7 +2,6 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
 from abc import abstractmethod
-from typing import Type
 
 from pydantic import BaseModel
 
@@ -11,6 +10,6 @@
 
 class PydanticModelSerializer(ModelSerializer):
     @abstractmethod
-    def get_model_class(self) -> Type[BaseModel]:
+    def get_model_class(self) -> type[BaseModel]:
         """Return the pydantic model class."""
         ...

search_engine_serializer_pydantic/views/se_index.xml

@@ -2,27 +2,20 @@
 <!-- Copyright 2023 ACSONE SA/NV
      License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). -->
 <odoo>
-
     <record model="ir.ui.view" id="se_index_form_view">
         <field name="name">se.index.form</field>
         <field name="model">se.index</field>
         <field name="inherit_id" ref="connector_search_engine.se_index_form_view" />
         <field name="arch" type="xml">
-            <field name="name" position="after">
-                <field name="is_pydantic_serializer" invisible="1" />
-            </field>
             <group name="config" position="after">
                 <group
                     name="se_index_pydantic"
                     string="Pydantic"
-                    attrs="{'invisible': [('is_pydantic_serializer', '=', False)]}"
+                    invisible="not is_pydantic_serializer"
                 >
                     <field name="record_json_schema_str" widget="ace" />
                 </group>
             </group>
         </field>
     </record>
-
-
-
 </odoo>