[IMP] fastapi_auth_partner: pre-commit auto fixes

Author: paradoxxxzero

fastapi_auth_partner/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
-
 ====================
 Fastapi Auth Partner
 ====================
@@ -17,23 +13,24 @@ Fastapi Auth Partner
 .. |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-AGPL--3-blue.png
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github
-    :target: https://github.com/OCA/rest-framework/tree/16.0/fastapi_auth_partner
+    :target: https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_partner
     :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-16-0/rest-framework-16-0-fastapi_auth_partner
+    :target: https://translation.odoo-community.org/projects/rest-framework-18-0/rest-framework-18-0-fastapi_auth_partner
     :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=16.0
+    :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 module is the FastAPI implementation of `auth_partner <../auth_partner>`_ 
-it provides all the routes to manage the authentication of partners.
+This module is the FastAPI implementation of
+`auth_partner <../auth_partner>`__ it provides all the routes to manage
+the authentication of partners.
 
 **Table of contents**
 
@@ -43,45 +40,48 @@ it provides all the routes to manage the authentication of partners.
 Usage
 =====
 
-First you have to add the auth router to your FastAPI endpoint and the authentication dependency to your app dependencies:
+First you have to add the auth router to your FastAPI endpoint and the
+authentication dependency to your app dependencies:
 
-.. code-block:: python
+.. code:: python
 
-    from odoo.addons.fastapi import dependencies
-    from odoo.addons.fastapi_auth_partner.dependencies import (
-      auth_partner_authenticated_partner,
-    )
-    from odoo.addons.fastapi_auth_partner.routers.auth import auth_router
+   from odoo.addons.fastapi import dependencies
+   from odoo.addons.fastapi_auth_partner.dependencies import (
+     auth_partner_authenticated_partner,
+   )
+   from odoo.addons.fastapi_auth_partner.routers.auth import auth_router
 
-    class FastapiEndpoint(models.Model):
-        _inherit = "fastapi.endpoint"
+   class FastapiEndpoint(models.Model):
+       _inherit = "fastapi.endpoint"
 
-        def _get_fastapi_routers(self):
-          if self.app == "myapp":
-              return [
-                  auth_router,
-              ]
-          return super()._get_fastapi_routers()
+       def _get_fastapi_routers(self):
+         if self.app == "myapp":
+             return [
+                 auth_router,
+             ]
+         return super()._get_fastapi_routers()
 
-        def _get_app_dependencies_overrides(self):
-            res = super()._get_app_dependencies_overrides()
-            if self.app == "myapp":
-                res.update(
-                    {
-                        dependencies.authenticated_partner_impl: auth_partner_authenticated_partner,
-                    }
-                )
-            return res
+       def _get_app_dependencies_overrides(self):
+           res = super()._get_app_dependencies_overrides()
+           if self.app == "myapp":
+               res.update(
+                   {
+                       dependencies.authenticated_partner_impl: auth_partner_authenticated_partner,
+                   }
+               )
+           return res
 
-Next you can manage your authenticable partners and directories in the Odoo interface:
+Next you can manage your authenticable partners and directories in the
+Odoo interface:
 
 FastAPI > Authentication > Partner
 
 and
 
 FastAPI > Authentication > Directory
 
-Next you must set the directory used for the authentication in the FastAPI endpoint:
+Next you must set the directory used for the authentication in the
+FastAPI endpoint:
 
 FastAPI > FastAPI Endpoint > myapp > Directory
 
@@ -102,28 +102,28 @@ 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:%20fastapi_auth_partner%0Aversion:%2016.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:%20fastapi_auth_partner%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
-~~~~~~~
+-------
 
 * Akretion
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* `Akretion <https://www.akretion.com>`_:
+- `Akretion <https://www.akretion.com>`__:
 
-  * Sébastien Beau
-  * Florian Mounier
+  - Sébastien Beau
+  - Florian Mounier
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -135,6 +135,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/16.0/fastapi_auth_partner>`_ project on GitHub.
+This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/18.0/fastapi_auth_partner>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

fastapi_auth_partner/demo/fastapi_endpoint_demo.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <odoo>
-  <record model="fastapi.endpoint" id="fastapi_endpoint_demo">
-    <field name="name">Fastapi Auth Partner Demo Endpoint</field>
-    <field
+    <record model="fastapi.endpoint" id="fastapi_endpoint_demo">
+        <field name="name">Fastapi Auth Partner Demo Endpoint</field>
+        <field
             name="description"
         ><![CDATA[
 # A Dummy FastApi Partner Auth Demo
@@ -11,16 +11,19 @@ This demo endpoint has been created by inhering from "fastapi.endpoint", registe
 a new app into the app selection field and implementing the `_get_fastapi_routers`
 methods. See documentation to learn more about how to create a new app.
 ]]></field>
-    <field name="app">demo</field>
-    <field name="root_path">/fastapi_auth_partner_demo</field>
-    <field name="demo_auth_method">auth_partner</field>
-    <field name="user_id" ref="fastapi.my_demo_app_user" />
-    <field name="directory_id" ref="auth_partner.demo_directory" />
-    <field name="public_api_url">https://api.example.com/</field>
-    <field name="public_url">https://www.example.com/</field>
-  </record>
+        <field name="app">demo</field>
+        <field name="root_path">/fastapi_auth_partner_demo</field>
+        <field name="demo_auth_method">auth_partner</field>
+        <field name="user_id" ref="fastapi.my_demo_app_user" />
+        <field name="directory_id" ref="auth_partner.demo_directory" />
+        <field name="public_api_url">https://api.example.com/</field>
+        <field name="public_url">https://www.example.com/</field>
+    </record>
 
-  <record id="fastapi.my_demo_app_user" model="res.users">
-    <field name="groups_id" eval="[(4, ref('auth_partner.group_auth_partner_api'))]" />
-  </record>
+    <record id="fastapi.my_demo_app_user" model="res.users">
+        <field
+            name="groups_id"
+            eval="[(4, ref('auth_partner.group_auth_partner_api'))]"
+        />
+    </record>
 </odoo>

fastapi_auth_partner/dependencies.py

@@ -4,7 +4,7 @@
 
 import logging
 import sys
-from typing import Any, Dict, Union
+from typing import Any
 
 from itsdangerous import URLSafeTimedSerializer
 from starlette.status import HTTP_401_UNAUTHORIZED
@@ -20,12 +20,12 @@
 if sys.version_info >= (3, 9):
     from typing import Annotated
 else:
-    from typing_extensions import Annotated
+    from typing import Annotated
 
 _logger = logging.getLogger(__name__)
 
 
-Payload = Dict[str, Any]
+Payload = dict[str, Any]
 
 
 class AuthPartner:
@@ -41,7 +41,7 @@ def __call__(
             Depends(odoo_env),
         ],
         endpoint: Annotated[FastapiEndpoint, Depends(fastapi_endpoint)],
-        fastapi_auth_partner: Annotated[Union[str, None], Cookie()] = None,
+        fastapi_auth_partner: Annotated[str | None, Cookie()] = None,
     ) -> Partner:
         if not fastapi_auth_partner and self.allow_unauthenticated:
             return env["res.partner"].with_user(env.ref("base.public_user")).browse()

fastapi_auth_partner/models/fastapi_endpoint.py

@@ -3,7 +3,6 @@
 # @author Florian Mounier <florian.mounier@akretion.com>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
-from typing import List
 
 from odoo import fields, models
 
@@ -44,7 +43,7 @@ class FastapiEndpoint(models.Model):
         "Default to the public_api_url if not set or the odoo url if not set either."
     )
 
-    def _get_fastapi_routers(self) -> List[APIRouter]:
+    def _get_fastapi_routers(self) -> list[APIRouter]:
         routers = super()._get_fastapi_routers()
         if self.app == "demo" and self.demo_auth_method == "auth_partner":
             routers.append(auth_router)

fastapi_auth_partner/pyproject.toml

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

fastapi_auth_partner/readme/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- [Akretion](https://www.akretion.com):
+  - Sébastien Beau
+  - Florian Mounier

fastapi_auth_partner/readme/CONTRIBUTORS.rst

@@ -0,0 +1,3 @@
+This module is the FastAPI implementation of
+[auth_partner](../auth_partner) it provides all the routes to manage the
+authentication of partners.

fastapi_auth_partner/readme/DESCRIPTION.md

@@ -0,0 +1,55 @@
+First you have to add the auth router to your FastAPI endpoint and the
+authentication dependency to your app dependencies:
+
+``` python
+from odoo.addons.fastapi import dependencies
+from odoo.addons.fastapi_auth_partner.dependencies import (
+  auth_partner_authenticated_partner,
+)
+from odoo.addons.fastapi_auth_partner.routers.auth import auth_router
+
+class FastapiEndpoint(models.Model):
+    _inherit = "fastapi.endpoint"
+
+    def _get_fastapi_routers(self):
+      if self.app == "myapp":
+          return [
+              auth_router,
+          ]
+      return super()._get_fastapi_routers()
+
+    def _get_app_dependencies_overrides(self):
+        res = super()._get_app_dependencies_overrides()
+        if self.app == "myapp":
+            res.update(
+                {
+                    dependencies.authenticated_partner_impl: auth_partner_authenticated_partner,
+                }
+            )
+        return res
+```
+
+Next you can manage your authenticable partners and directories in the
+Odoo interface:
+
+FastAPI \> Authentication \> Partner
+
+and
+
+FastAPI \> Authentication \> Directory
+
+Next you must set the directory used for the authentication in the
+FastAPI endpoint:
+
+FastAPI \> FastAPI Endpoint \> myapp \> Directory
+
+Then you can use the auth router to authenticate your requests:
+
+- POST /auth/register to register a partner
+- POST /auth/login to authenticate a partner
+- POST /auth/logout to unauthenticate a partner
+- POST /auth/validate_email to validate a partner email
+- POST /auth/request_reset_password to request a password reset
+- POST /auth/set_password to set a new password
+- GET /auth/profile to get the partner profile
+- GET /auth/impersonate to impersonate a partner