[IMP] base_rest: pre-commit auto fixes

Author: NachoAlesLopez

.pre-commit-config.yaml

@@ -1,7 +1,6 @@
 exclude: |
   (?x)
   # NOT INSTALLABLE ADDONS
-  ^base_rest/|
   ^base_rest_auth_api_key/|
   ^base_rest_pydantic/|
   ^extendable/|

base_rest/README.rst

@@ -21,13 +21,13 @@ Base Rest
     :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/18.0/base_rest
+    :target: https://github.com/OCA/rest-framework/tree/19.0/base_rest
     :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-18-0/rest-framework-18-0-base_rest
+    :target: https://translation.odoo-community.org/projects/rest-framework-19-0/rest-framework-19-0-base_rest
     :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/rest-framework&target_branch=18.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/rest-framework&target_branch=19.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -89,8 +89,8 @@ Usage
 
 To add your own REST service you must provides at least 2 classes.
 
-- A Component providing the business logic of your service,
-- A Controller to register your service.
+-  A Component providing the business logic of your service,
+-  A Controller to register your service.
 
 The business logic of your service must be implemented into a component
 (``odoo.addons.component.core.Component``) that inherit from
@@ -99,22 +99,22 @@ The business logic of your service must be implemented into a component
 Initially, base_rest expose by default all public methods defined in a
 service. The conventions for accessing methods via HTTP were as follows:
 
-- The method ``def get(self, _id)`` if defined, is accessible via HTTP
-  GET routes ``<string:_service_name>/<int:_id>`` and
-  ``<string:_service_name>/<int:_id>/get``.
-- The method ``def search(self, **params)`` if defined, is accessible
-  via the HTTP GET routes ``<string:_service_name>/`` and
-  ``<string:_service_name>/search``.
-- The method ``def delete(self, _id)`` if defined, is accessible via the
-  HTTP DELETE route ``<string:_service_name>/<int:_id>``.
-- The ``def update(self, _id, **params)`` method, if defined, is
-  accessible via the HTTP PUT route
-  ``<string:_service_name>/<int:_id>``.
-- Other methods are only accessible via HTTP POST routes
-  ``<string:_service_name>`` or
-  ``<string:_service_name>/<string:method_name>`` or
-  ``<string:_service_name>/<int:_id>`` or
-  ``<string:_service_name>/<int:_id>/<string:method_name>``
+-  The method ``def get(self, _id)`` if defined, is accessible via HTTP
+   GET routes ``<string:_service_name>/<int:_id>`` and
+   ``<string:_service_name>/<int:_id>/get``.
+-  The method ``def search(self, **params)`` if defined, is accessible
+   via the HTTP GET routes ``<string:_service_name>/`` and
+   ``<string:_service_name>/search``.
+-  The method ``def delete(self, _id)`` if defined, is accessible via
+   the HTTP DELETE route ``<string:_service_name>/<int:_id>``.
+-  The ``def update(self, _id, **params)`` method, if defined, is
+   accessible via the HTTP PUT route
+   ``<string:_service_name>/<int:_id>``.
+-  Other methods are only accessible via HTTP POST routes
+   ``<string:_service_name>`` or
+   ``<string:_service_name>/<string:method_name>`` or
+   ``<string:_service_name>/<int:_id>`` or
+   ``<string:_service_name>/<int:_id>/<string:method_name>``
 
 .. code:: python
 
@@ -231,10 +231,10 @@ schemas <https://docs.python-cerberus.org/en/stable/>`__ and associated
 to the methods using the following naming convention. For a method
 \`my_method\`:
 
-- ``def _validator_my_method(self):`` will be called to get the schema
-  required to validate the input parameters.
-- ``def _validator_return_my_method(self):`` if defined, will be called
-  to get the schema used to validate the response.
+-  ``def _validator_my_method(self):`` will be called to get the schema
+   required to validate the input parameters.
+-  ``def _validator_return_my_method(self):`` if defined, will be called
+   to get the schema used to validate the response.
 
 In order to offer even more flexibility, a new API has been developed.
 
@@ -363,32 +363,33 @@ Changelog
 
 **Features**
 
-- Add support for oauth2 security scheme in the Swagger UI. If your
-  openapi specification contains a security scheme of type oauth2, the
-  Swagger UI will display a login button in the top right corner. In
-  order to finalize the login process, a redirect URL must be provided
-  when initializing the Swagger UI. The Swagger UI is now initialized
-  with a oauth2RedirectUrl option that references a oauth2-redirect.html
-  file provided by the swagger-ui lib and served by the current addon.
-  (`#379 <https://github.com/OCA/rest-framework/issues/379>`__)
+-  Add support for oauth2 security scheme in the Swagger UI. If your
+   openapi specification contains a security scheme of type oauth2, the
+   Swagger UI will display a login button in the top right corner. In
+   order to finalize the login process, a redirect URL must be provided
+   when initializing the Swagger UI. The Swagger UI is now initialized
+   with a oauth2RedirectUrl option that references a
+   oauth2-redirect.html file provided by the swagger-ui lib and served
+   by the current addon.
+   (`#379 <https://github.com/OCA/rest-framework/issues/379>`__)
 
 12.0.2.0.1
 ----------
 
-- validator\_...() methods can now return a cerberus ``Validator``
-  object instead of a schema dictionnary, for additional flexibility
-  (e.g. allowing validator options such as ``allow_unknown``).
+-  validator\_...() methods can now return a cerberus ``Validator``
+   object instead of a schema dictionnary, for additional flexibility
+   (e.g. allowing validator options such as ``allow_unknown``).
 
 12.0.2.0.0
 ----------
 
-- Licence changed from AGPL-3 to LGPL-3
+-  Licence changed from AGPL-3 to LGPL-3
 
 12.0.1.0.1
 ----------
 
-- Fix issue when rendering the jsonapi documentation if no documentation
-  is provided on a method part of the REST api.
+-  Fix issue when rendering the jsonapi documentation if no
+   documentation is provided on a method part of the REST api.
 
 12.0.1.0.0
 ----------
@@ -404,7 +405,7 @@ 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 to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest%0Aversion:%2019.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.
 
@@ -419,8 +420,8 @@ Authors
 Contributors
 ------------
 
-- Laurent Mignon <laurent.mignon@acsone.eu>
-- Sébastien Beau <sebastien.beau@akretion.com>
+-  Laurent Mignon <laurent.mignon@acsone.eu>
+-  Sébastien Beau <sebastien.beau@akretion.com>
 
 Maintainers
 -----------
@@ -435,6 +436,6 @@ 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 <https://github.com/OCA/rest-framework/tree/18.0/base_rest>`_ project on GitHub.
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/19.0/base_rest>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_rest/__init__.py

@@ -1,3 +1,3 @@
-from . import models
 from . import components
+from . import models
 from . import http

base_rest/__manifest__.py

@@ -6,10 +6,10 @@
     "summary": """
         Develop your own high level REST APIs for Odoo thanks to this addon.
         """,
-    "version": "18.0.1.1.1",
+    "version": "19.0.1.0.0",
     "development_status": "Beta",
     "license": "LGPL-3",
-    "author": "ACSONE SA/NV, " "Odoo Community Association (OCA)",
+    "author": "ACSONE SA/NV, Odoo Community Association (OCA)",
     "maintainers": [],
     "website": "https://github.com/OCA/rest-framework",
     "depends": ["component", "web"],
@@ -33,5 +33,5 @@
             "apispec",
         ]
     },
-    "installable": False,
+    "installable": True,
 }

base_rest/components/service.py

@@ -197,8 +197,7 @@ def _get_openapi_default_responses(self):
         return {
             "400": {"description": "One of the given parameter is not valid"},
             "401": {
-                "description": "The user is not authorized. Authentication "
-                "is required"
+                "description": "The user is not authorized. Authentication is required"
             },
             "404": {"description": "Requested resource not found"},
             "403": {

base_rest/models/rest_service_registration.py

@@ -192,7 +192,7 @@ def build_registry(self, services_registry, states=None, exclude_addons=None):
         graph = odoo.modules.graph.Graph()
         graph.add_module(self.env.cr, "base")
 
-        query = "SELECT name " "FROM ir_module_module " "WHERE state IN %s "
+        query = "SELECT name FROM ir_module_module WHERE state IN %s "
         params = [tuple(states)]
         if exclude_addons:
             query += " AND name NOT IN %s "

base_rest/restapi.py

@@ -218,13 +218,13 @@ def from_params(self, service, params):
         validator = self.get_cerberus_validator(service, "input")
         if validator.validate(params):
             return validator.document
-        raise UserError(service.env._("BadRequest %s") % validator.errors)
+        raise UserError(service.env._("BadRequest %s", validator.errors))
 
     def to_response(self, service, result):
         validator = self.get_cerberus_validator(service, "output")
         if validator.validate(result):
             return validator.document
-        raise SystemError(service.env._("Invalid Response %s") % validator.errors)
+        raise SystemError(service.env._("Invalid Response %s", validator.errors))
 
     def to_openapi_query_parameters(self, service, spec):
         json_schema = self.to_json_schema(service, spec, "input")
@@ -276,7 +276,7 @@ def get_cerberus_validator(self, service, direction):
         if isinstance(schema, dict):
             return Validator(schema, purge_unknown=True)
         raise Exception(
-            service.env._("Unable to get cerberus schema from %s") % self._schema
+            service.env._("Unable to get cerberus schema from %s", self._schema)
         )
 
     def to_json_schema(self, service, spec, direction):
@@ -412,7 +412,11 @@ def from_params(self, service, params):
                     )  # multipart ony sends its parts as string
                 except json.JSONDecodeError as error:
                     raise ValidationError(
-                        service.env._(f"{key}'s JSON content is malformed: {error}")
+                        service.env._(
+                            "%(key)s's JSON content is malformed: %(error)s",
+                            key=key,
+                            error=error,
+                        )
                     ) from error
                 param = part.from_params(service, json_param)
             params[key] = param

base_rest/static/description/index.html

@@ -374,7 +374,7 @@ <h1>Base Rest</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:198b97806a0a8c480e6c8f26f3ce3199cba9978f8d152ecf93c80091323d1805
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/rest-framework/tree/18.0/base_rest"><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-18-0/rest-framework-18-0-base_rest"><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=18.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/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/rest-framework/tree/19.0/base_rest"><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-19-0/rest-framework-19-0-base_rest"><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=19.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This addon is deprecated and not fully supported anymore from Odoo 16.
 Please migrate to the FastAPI migration module. See
 <a class="reference external" href="https://github.com/OCA/rest-framework/pull/291">https://github.com/OCA/rest-framework/pull/291</a>.</p>
@@ -454,8 +454,8 @@ <h2><a class="toc-backref" href="#toc-entry-2">Usage</a></h2>
 <li>The method <tt class="docutils literal">def search(self, **params)</tt> if defined, is accessible
 via the HTTP GET routes <tt class="docutils literal">&lt;string:_service_name&gt;/</tt> and
 <tt class="docutils literal"><span class="pre">&lt;string:_service_name&gt;/search</span></tt>.</li>
-<li>The method <tt class="docutils literal">def delete(self, _id)</tt> if defined, is accessible via the
-HTTP DELETE route <tt class="docutils literal"><span class="pre">&lt;string:_service_name&gt;/&lt;int:_id&gt;</span></tt>.</li>
+<li>The method <tt class="docutils literal">def delete(self, _id)</tt> if defined, is accessible via
+the HTTP DELETE route <tt class="docutils literal"><span class="pre">&lt;string:_service_name&gt;/&lt;int:_id&gt;</span></tt>.</li>
 <li>The <tt class="docutils literal">def update(self, _id, **params)</tt> method, if defined, is
 accessible via the HTTP PUT route
 <tt class="docutils literal"><span class="pre">&lt;string:_service_name&gt;/&lt;int:_id&gt;</span></tt>.</li>
@@ -701,8 +701,9 @@ <h3><a class="toc-backref" href="#toc-entry-5">16.0.1.0.2 (2023-10-07)</a></h3>
 Swagger UI will display a login button in the top right corner. In
 order to finalize the login process, a redirect URL must be provided
 when initializing the Swagger UI. The Swagger UI is now initialized
-with a oauth2RedirectUrl option that references a oauth2-redirect.html
-file provided by the swagger-ui lib and served by the current addon.
+with a oauth2RedirectUrl option that references a
+oauth2-redirect.html file provided by the swagger-ui lib and served
+by the current addon.
 (<a class="reference external" href="https://github.com/OCA/rest-framework/issues/379">#379</a>)</li>
 </ul>
 </div>
@@ -723,8 +724,8 @@ <h3><a class="toc-backref" href="#toc-entry-7">12.0.2.0.0</a></h3>
 <div class="section" id="section-4">
 <h3><a class="toc-backref" href="#toc-entry-8">12.0.1.0.1</a></h3>
 <ul class="simple">
-<li>Fix issue when rendering the jsonapi documentation if no documentation
-is provided on a method part of the REST api.</li>
+<li>Fix issue when rendering the jsonapi documentation if no
+documentation is provided on a method part of the REST api.</li>
 </ul>
 </div>
 <div class="section" id="section-5">
@@ -740,7 +741,7 @@ <h2><a class="toc-backref" href="#toc-entry-10">Bug Tracker</a></h2>
 <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 to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest%0Aversion:%2018.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/rest-framework/issues/new?body=module:%20base_rest%0Aversion:%2019.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">
@@ -767,7 +768,7 @@ <h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
 <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>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/18.0/base_rest">OCA/rest-framework</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/rest-framework/tree/19.0/base_rest">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>