[MIG] field_vector: Migration to 18.0

Author: IJOL

field_vector/README.rst

@@ -1,7 +1,3 @@
-.. image:: https://odoo-community.org/readme-banner-image
-   :target: https://odoo-community.org/get-involved?utm_source=readme
-   :alt: Odoo Community Association
-
 ============
 Field Vector
 ============
@@ -17,17 +13,17 @@ Field Vector
 .. |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/license-LGPL--3-blue.png
+.. |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%2Fserver--tools-lightgray.png?logo=github
-    :target: https://github.com/OCA/server-tools/tree/16.0/field_vector
+    :target: https://github.com/OCA/server-tools/tree/18.0/field_vector
     :alt: OCA/server-tools
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-field_vector
+    :target: https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-field_vector
     :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/server-tools&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -212,7 +208,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20field_vector%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20field_vector%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.
 
@@ -257,6 +253,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-lmignon| 
 
-This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/field_vector>`_ project on GitHub.
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.0/field_vector>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

field_vector/__manifest__.py

@@ -4,7 +4,7 @@
 {
     "name": "Field Vector",
     "summary": """New specialized field to store vector data""",
-    "version": "16.0.1.0.0",
+    "version": "18.0.1.0.0",
     "license": "LGPL-3",
     "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/server-tools",

field_vector/fields.py

@@ -24,7 +24,7 @@ class VectorValue:
     """
 
     def __init__(self, value: list | tuple | np.ndarray, dimensions=None, autopad=True):
-        if not isinstance(value, (list, tuple, np.ndarray)):
+        if not isinstance(value, list | tuple | np.ndarray):
             raise ValueError(
                 f"Invalid type '{type(value)}' for VectorValue: "
                 "Only list, tuple or np.ndarray are allowed."
@@ -124,9 +124,9 @@ class Vector(fields.Field):
 
     def __init__(
         self,
-        dimensions=fields.Default,
-        autopad=fields.Default,
-        string=fields.Default,
+        dimensions=fields.SENTINEL,
+        autopad=fields.SENTINEL,
+        string=fields.SENTINEL,
         **kwargs,
     ):
         super().__init__(
@@ -136,7 +136,7 @@ def __init__(
     def _setup_attrs(self, model_class, name):
         res = super()._setup_attrs(model_class, name)
         if (
-            self.dimensions == fields.Default
+            self.dimensions == fields.SENTINEL
             or self.dimensions is None
             or not isinstance(self.dimensions, int)
         ):
@@ -179,7 +179,7 @@ def convert_to_export(self, value: VectorValue, record):
     def convert_to_cache(self, value, record, validate=True):
         if value is None or value is False:
             return None
-        if not isinstance(value, (list, tuple, np.ndarray, VectorValue)):
+        if not isinstance(value, list | tuple | np.ndarray | VectorValue):
             raise ValueError(
                 f"Invalid type '{type(value)}' for {self.name}: "
                 "Only np.ndarray or list of floats/int are allowed."
@@ -190,14 +190,15 @@ def convert_to_cache(self, value, record, validate=True):
             value = value.pad(self.dimensions)
         if validate and value.dimensions != self.dimensions:
             raise ValueError(
-                f"Invalid vector size for {self.name}: {value.dimensions} != {self.dimensions}"
+                f"Invalid vector size for {self.name}: "
+                f"{value.dimensions} != {self.dimensions}"
             )
         return value
 
     def convert_to_record(self, value, record):
         if value is None or value is False:
             return None
-        if not isinstance(value, (list, tuple, np.ndarray, VectorValue)):
+        if not isinstance(value, list | tuple | np.ndarray | VectorValue):
             raise ValueError(
                 f"Invalid type '{type(value)}' for {self.name}: "
                 "Only np.ndarray, list of floats/int or VectorValue are allowed."

field_vector/hooks.py

@@ -5,9 +5,9 @@
 from odoo.exceptions import MissingError
 
 
-def pre_init_hook(cr):
+def pre_init_hook(env):
     """setup vector"""
-    cr.execute(
+    env.cr.execute(
         """
         SELECT
             tablename
@@ -17,24 +17,23 @@ def pre_init_hook(cr):
             tablename='spatial_ref_sys';
     """
     )
-    check = cr.fetchone()
+    check = env.cr.fetchone()
     if check:
         return {}
     try:
-        cr.execute(
+        env.cr.execute(
             """
         CREATE EXTENSION IF NOT EXISTS vector;
     """
         )
-    except Exception as exc:
-        raise MissingError(
-            _(
-                "Error, can not automatically initialize vector"
-                " support. Database user may have to be superuser and"
-                " pgvector extensions  to be installed. If you do not"
-                " want Odoo to connect with a super user you can manually"
-                " prepare your database. To dothis, open a client to your"
-                " database using a super user and run:\n"
-                "CREATE EXTENSION vector;\n"
-            )
-        ) from exc
+    except Exception:
+        import logging
+
+        _logger = logging.getLogger(__name__)
+        _logger.warning(
+            "Could not automatically initialize pgvector support. "
+            "Database user may need superuser privileges and pgvector "
+            "extension must be installed. To manually prepare your "
+            "database, run as superuser:\n"
+            "CREATE EXTENSION vector;"
+        )

field_vector/pyproject.toml

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

field_vector/static/description/index.html

@@ -3,16 +3,15 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>README.rst</title>
+<title>Field Vector</title>
 <style type="text/css">
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z 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 +274,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: gray; } /* line numbers */
+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 }
@@ -301,7 +300,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic, pre.problematic {
+span.problematic {
   color: red }
 
 span.section-subtitle {
@@ -360,21 +359,16 @@
 </style>
 </head>
 <body>
-<div class="document">
+<div class="document" id="field-vector">
+<h1 class="title">Field Vector</h1>
 
-
-<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
-<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
-</a>
-<div class="section" id="field-vector">
-<h1>Field Vector</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:9545962191ec37e88fe11fd9d6e8c01b540134dad5a6482b6a0c19110c7fd3f4
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-tools/tree/16.0/field_vector"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-field_vector"><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/server-tools&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/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/server-tools/tree/18.0/field_vector"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-field_vector"><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/server-tools&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 addon provides a new field type called “Vector” that allows you to
 store and manage vector into your Odoo database.</p>
 <p><strong>Table of contents</strong></p>
@@ -401,7 +395,7 @@ <h1>Field Vector</h1>
 </ul>
 </div>
 <div class="section" id="use-cases-context">
-<h2><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
 <p>The advent of large language models (LLMs) has highlighted the
 importance of vector representation as a powerful representation of data
 to easily determine the similarity between different pieces of
@@ -410,13 +404,13 @@ <h2><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h2>
 allows for efficient similarity comparisons.</p>
 </div>
 <div class="section" id="installation">
-<h2><a class="toc-backref" href="#toc-entry-2">Installation</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-2">Installation</a></h1>
 <p>To install this module, you need to ensure that the
 <a class="reference external" href="https://github.com/pgvector/pgvector">pgvector</a> extension is
 installed and available in your PostgreSQL instance.</p>
 </div>
 <div class="section" id="configuration">
-<h2><a class="toc-backref" href="#toc-entry-3">Configuration</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-3">Configuration</a></h1>
 <p>[ This file is not always required; it should explain <strong>how to configure
 the module before using it</strong>; it is aimed at users with administration
 privileges.</p>
@@ -431,7 +425,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Configuration</a></h2>
 </ul>
 </div>
 <div class="section" id="usage">
-<h2><a class="toc-backref" href="#toc-entry-4">Usage</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-4">Usage</a></h1>
 <blockquote>
 <div class="line-block">
 <div class="line"><strong>⚠️ Warning</strong></div>
@@ -447,7 +441,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Usage</a></h2>
 manage vector data in their Odoo database when they develop their own
 modules.</p>
 <div class="section" id="field-declaration">
-<h3><a class="toc-backref" href="#toc-entry-5">Field declaration</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-5">Field declaration</a></h2>
 <p>To declare a field of type vector, you can use the following syntax:</p>
 <pre class="code python literal-block">
 <span class="kn">from</span><span class="w"> </span><span class="nn">odoo.addons.field_vector.fields</span><span class="w"> </span><span class="kn">import</span> <span class="n">Vector</span><span class="w">
@@ -485,7 +479,7 @@ <h3><a class="toc-backref" href="#toc-entry-5">Field declaration</a></h3>
 error will be raised.</p>
 </div>
 <div class="section" id="field-usage">
-<h3><a class="toc-backref" href="#toc-entry-6">Field usage</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-6">Field usage</a></h2>
 <p>The vector field can be used like any other field in Odoo. When
 accessing the field, it will always return an
 <tt class="docutils literal">odoo.addons.field_vector.fields.VectorValue</tt> object, which is a
@@ -518,7 +512,7 @@ <h3><a class="toc-backref" href="#toc-entry-6">Field usage</a></h3>
 </pre>
 </div>
 <div class="section" id="plain-sql-queries">
-<h3><a class="toc-backref" href="#toc-entry-7">Plain SQL queries</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-7">Plain SQL queries</a></h2>
 <p>When reading the field in plain SQL queries, the field will be returned
 as a <tt class="docutils literal">VectorValue</tt> object. You can use the <tt class="docutils literal">value</tt> property to get
 the value of the vector as a numpy array.</p>
@@ -539,58 +533,55 @@ <h3><a class="toc-backref" href="#toc-entry-7">Plain SQL queries</a></h3>
 </div>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h2><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h1>
 <ul class="simple">
 <li>allows the use of specific operators into domain filters to search for
 similar vectors.</li>
 <li>dedicated widget to display the vector in a more user-friendly way.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h2><a class="toc-backref" href="#toc-entry-9">Bug Tracker</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-9">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20field_vector%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/server-tools/issues/new?body=module:%20field_vector%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">
-<h2><a class="toc-backref" href="#toc-entry-10">Credits</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-10">Credits</a></h1>
 <div class="section" id="authors">
-<h3><a class="toc-backref" href="#toc-entry-11">Authors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-11">Authors</a></h2>
 <ul class="simple">
 <li>ACSONE SA/NV</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h3><a class="toc-backref" href="#toc-entry-12">Contributors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-12">Contributors</a></h2>
 <ul class="simple">
 <li>Laurent Mignon <a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a> (<a class="reference external" href="https://www.acsone.eu">https://www.acsone.eu</a>)</li>
 </ul>
 </div>
 <div class="section" id="other-credits">
-<h3><a class="toc-backref" href="#toc-entry-13">Other credits</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-13">Other credits</a></h2>
 <p>The development of this module has been financially supported by:</p>
 <ul class="simple">
 <li><a class="reference external" href="https://www.alcyonbelux.be/">Alcyon Belux</a></li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-14">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/server-tools/tree/16.0/field_vector">OCA/server-tools</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/18.0/field_vector">OCA/server-tools</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>
-</div>
 </body>
 </html>

requirements.txt

@@ -1,6 +1,7 @@
 # generated from manifests external_dependencies
 cryptography
 dataclasses
+numpy
 odoo_test_helper
 odoorpc
 openpyxl