[18.0][MIG] extendable_fastapi

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 exclude: |
   (?x)
   # NOT INSTALLABLE ADDONS
-  ^extendable/|
+  ^extendable_fastapi/|
   # END NOT INSTALLABLE ADDONS
   # Files and folders generated by bots, to avoid loops
   ^setup/|/static/description/index\.html$|

extendable/tests/common.py

@@ -3,7 +3,6 @@
 
 from contextlib import contextmanager
 
-import odoo
 from odoo import SUPERUSER_ID, api
 from odoo.modules.registry import Registry
 from odoo.tests import common

extendable_fastapi/README.rst

@@ -0,0 +1,119 @@
+==================
+Extendable Fastapi
+==================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:4e4f5d96294f860ce7f0c4e023431f8ed9ca011c318b5ba4a3cfcd15c31eac1a
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/18.0/extendable_fastapi
+    :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-extendable_fastapi
+    :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
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This addon is a technical addon used to allows the use of
+`extendable <https://pypi.org/project/extendable/>`__ classes in the
+implementation of your fastapi endpoint handlers. It also allows you to
+use
+`extendable_pydantic <https://pypi.org/project/extendable_pydantic/>`__
+models when defining your endpoint handlers request and response models.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Changelog
+=========
+
+16.0.2.1.1 (2023-11-07)
+-----------------------
+
+**Bugfixes**
+
+-  Fix registry corruption when running tests difined in a class
+   inheriting of the *FastAPITransactionCase* class if an error occurs
+   in the *setUpClass* after the call to super().
+   (`#392 <https://github.com/OCA/rest-framework/issues/392>`__)
+
+16.0.2.1.0 (2023-10-13)
+-----------------------
+
+**Features**
+
+-  
+
+   -  New base schemas: *PagedCollection*. This schema is used to define
+      the the structure of a paged collection of resources. This schema
+      is similar to the ones defined in the Odoo's **fastapi** addon but
+      works as/with extendable models.
+   -  The *StrictExtendableBaseModel* has been moved to the
+      *extendable_pydantic* python lib. You should consider to import it
+      from there.
+      (`#380 <https://github.com/OCA/rest-framework/issues/380>`__)
+
+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:%20extendable_fastapi%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.
+
+Credits
+=======
+
+Authors
+-------
+
+* ACSONE SA/NV
+
+Contributors
+------------
+
+-  Laurent Mignon <laurent.mignon@acsone.eu> (https://acsone.eu)
+-  Marie Lejeune <marie.lejeune@acsone.eu> (https://acsone.eu)
+
+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.
+
+.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px
+    :target: https://github.com/lmignon
+    :alt: lmignon
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-lmignon| 
+
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/18.0/extendable_fastapi>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

extendable_fastapi/__init__.py

@@ -0,0 +1,2 @@
+from . import fastapi_dispatcher
+from .schemas import StrictExtendableBaseModel

extendable_fastapi/__manifest__.py

@@ -0,0 +1,23 @@
+# Copyright 2023 ACSONE SA/NV
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
+
+{
+    "name": "Extendable Fastapi",
+    "summary": """
+        Allows the use of extendable into fastapi apps""",
+    "version": "18.0.1.0.0",
+    "license": "LGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "maintainers": ["lmignon"],
+    "website": "https://github.com/OCA/rest-framework",
+    "depends": ["fastapi", "extendable"],
+    "data": [],
+    "demo": [],
+    "external_dependencies": {
+        "python": [
+            "pydantic>=2.0.0",
+            "extendable-pydantic>=1.2.0",
+        ],
+    },
+    "installable": True,
+}

extendable_fastapi/fastapi_dispatcher.py

@@ -0,0 +1,30 @@
+# Copyright 2023 ACSONE SA/NV
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/LGPL).
+
+from contextlib import contextmanager
+
+from odoo.addons.extendable.registry import _extendable_registries_database
+from odoo.addons.fastapi.fastapi_dispatcher import (
+    FastApiDispatcher as BaseFastApiDispatcher,
+)
+
+from extendable import context
+
+
+class FastApiDispatcher(BaseFastApiDispatcher):
+    routing_type = "fastapi"
+
+    def dispatch(self, endpoint, args):
+        with self._manage_extendable_context():
+            return super().dispatch(endpoint, args)
+
+    @contextmanager
+    def _manage_extendable_context(self):
+        env = self.request.env
+        registry = _extendable_registries_database.get(env.cr.dbname, {})
+        token = context.extendable_registry.set(registry)
+        try:
+            response = yield
+        finally:
+            context.extendable_registry.reset(token)
+        return response

extendable_fastapi/i18n/extendable_fastapi.pot

@@ -0,0 +1,13 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.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"

extendable_fastapi/models/__init__.py

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

extendable_fastapi/models/fastapi_endpoint_demo.py

@@ -0,0 +1,19 @@
+# Copyright 2023 ACSONE SA/NV
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import models
+
+from fastapi import APIRouter
+
+from ..tests.routers import demo_pydantic_router
+
+
+class FastapiEndpoint(models.Model):
+    _inherit = "fastapi.endpoint"
+
+    def _get_fastapi_routers(self) -> list[APIRouter]:
+        # Add router defined for tests to the demo app
+        routers = super()._get_fastapi_routers()
+        if self.app == "demo":
+            routers.append(demo_pydantic_router)
+        return routers

extendable_fastapi/pyproject.toml

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

extendable_fastapi/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- Laurent Mignon \<<laurent.mignon@acsone.eu>\> (<https://acsone.eu>)
+- Marie Lejeune \<<marie.lejeune@acsone.eu>\> (<https://acsone.eu>)

extendable_fastapi/readme/DESCRIPTION.md

@@ -0,0 +1,5 @@
+This addon is a technical addon used to allows the use of
+[extendable](https://pypi.org/project/extendable/) classes in the
+implementation of your fastapi endpoint handlers. It also allows you to
+use [extendable_pydantic](https://pypi.org/project/extendable_pydantic/)
+models when defining your endpoint handlers request and response models.

extendable_fastapi/readme/HISTORY.md

@@ -0,0 +1,21 @@
+## 16.0.2.1.1 (2023-11-07)
+
+**Bugfixes**
+
+- Fix registry corruption when running tests difined in a class
+  inheriting of the *FastAPITransactionCase* class if an error occurs in
+  the *setUpClass* after the call to super().
+  ([\#392](https://github.com/OCA/rest-framework/issues/392))
+
+## 16.0.2.1.0 (2023-10-13)
+
+**Features**
+
+- - New base schemas: *PagedCollection*. This schema is used to define
+    the the structure of a paged collection of resources. This schema is
+    similar to the ones defined in the Odoo's **fastapi** addon but
+    works as/with extendable models.
+  - The *StrictExtendableBaseModel* has been moved to the
+    *extendable_pydantic* python lib. You should consider to import it
+    from there.
+    ([\#380](https://github.com/OCA/rest-framework/issues/380))

extendable_fastapi/schemas.py

@@ -0,0 +1,19 @@
+from typing import Annotated, Generic, TypeVar
+
+from extendable_pydantic import StrictExtendableBaseModel
+
+from pydantic import Field
+
+T = TypeVar("T")
+
+
+class PagedCollection(StrictExtendableBaseModel, Generic[T]):
+    """A paged collection of items"""
+
+    # This is a generic model. The type of the items is defined by the generic type T.
+    # It provides you a common way to return a paged collection of items of
+    # extendable models. It's based on the StrictExtendableBaseModel to ensure
+    # a strict validation when used within the odoo fastapi framework.
+
+    count: Annotated[int, Field(..., description="The count of items into the system")]
+    items: list[T]