fastapi-rtk 2.1.4__tar.gz → 2.1.5__tar.gz

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.1.4
+Version: 2.1.5
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.1.5/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.1.5"

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/base_api.py

@@ -21,11 +21,10 @@ class BaseApi:
     """
     Base API class for FastAPI.
 
-    Provides a foundation for exposing API routes with integrated permission and authentication support.
-    Handles route registration, permission management, and toolkit integration, allowing you to build
-    secure and extensible APIs.
+    Exposes API routes with integrated permission and authentication support,
+    handling route registration, permission management, and toolkit integration.
 
-    See [FastAPI path]("https://fastapi.tiangolo.com/tutorial/path-params/") and [FastAPI query]("https://fastapi.tiangolo.com/tutorial/query-params/") for more details on how to use path and query parameters in your API endpoints.
+    See [FastAPI path]("https://fastapi.tiangolo.com/tutorial/path-params/") and [FastAPI query]("https://fastapi.tiangolo.com/tutorial/query-params/") for details on path and query parameters in your API endpoints.
 
     Usage:
 
@@ -130,17 +129,13 @@ class BaseApi:
 
     async def on_startup(self):
         """
-        Method to run on startup.
-
-        This will be called by `FastAPIReactToolkit` when the application starts.
+        Called by `FastAPIReactToolkit` when the application starts.
         """
         pass
 
     async def on_shutdown(self):
         """
-        Method to run on shutdown.
-
-        This will be called by `FastAPIReactToolkit` when the application shuts down.
+        Called by `FastAPIReactToolkit` when the application shuts down.
         """
         pass
 

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/__init__.py

@@ -100,9 +100,9 @@ class ModelRestApi(
     """
     Base API class for FastAPI with built-in RESTful endpoints for common data operations.
 
-    This class automatically delivers standard routes for CRUD (Create, Read, Update, Delete),
+    Delivers standard routes for CRUD (Create, Read, Update, Delete),
     file and image management, data download, bulk operations, filtering, and pagination.
-    Each route is extensible with corresponding pre- and post-processing methods, allowing for custom logic
+    Each route is extensible with pre- and post-processing methods for custom logic
     before and after the main operation.
 
     Usage:
@@ -170,11 +170,11 @@ class ModelRestApi(
         ]
     )
     """
-    The list of routes to expose. available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
+    The list of routes to expose. Available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
     """
     exclude_routes: typing.List[AVAILABLE_ROUTES] = lazy(lambda: [])
     """
-    The list of routes to exclude. available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
+    The list of routes to exclude. Available routes: `info`, `download`, `bulk`, `get_list`, `get`, `post`, `put`, `delete`.
     """
     protected_routes: typing.List[AVAILABLE_ROUTES] = lazy(
         lambda self: [x for x in self.routes if x not in self.exclude_protected_routes]
@@ -475,7 +475,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the list endpoint. If not provided, Defaults to "List {ModelName}".
+    The title for the list endpoint. If not provided, defaults to "List {ModelName}".
     """
     show_title = lazy(
         lambda self: translate(
@@ -484,7 +484,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the show endpoint. If not provided, Defaults to "Show {ModelName}".
+    The title for the show endpoint. If not provided, defaults to "Show {ModelName}".
     """
     add_title = lazy(
         lambda self: translate(
@@ -493,7 +493,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the add endpoint. If not provided, Defaults to "Add {ModelName}".
+    The title for the add endpoint. If not provided, defaults to "Add {ModelName}".
     """
     edit_title = lazy(
         lambda self: translate(
@@ -502,7 +502,7 @@ class ModelRestApi(
         cache=False,
     )
     """
-    The title for the edit endpoint. If not provided, Defaults to "Edit {ModelName}".
+    The title for the edit endpoint. If not provided, defaults to "Edit {ModelName}".
     """
 
     """
@@ -617,7 +617,7 @@ class ModelRestApi(
 
     extra_list_fetch_columns = lazy(lambda: list[str]())
     """
-    The list of columns to be fetch from the database alongside the `list_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
+    The list of columns to be fetched from the database alongside the `list_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
     """
     list_select_columns = lazy(
         lambda self: self.list_columns + self.extra_list_fetch_columns
@@ -629,7 +629,7 @@ class ModelRestApi(
     """
     extra_show_fetch_columns = lazy(lambda: list[str]())
     """
-    The list of columns to be fetch from the database alongside the `show_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
+    The list of columns to be fetched from the database alongside the `show_columns`. Useful if you don't want some columns to be shown but still want to fetch them.
     """
     show_select_columns = lazy(
         lambda self: self.show_columns + self.extra_show_fetch_columns

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_add_mixin.py

@@ -134,8 +134,7 @@ class AddMixin:
         self, item: Model, params: PARAM_BODY_SESSION
     ) -> None | Model | typing.Any:
         """
-        Post-process the item after adding it to the database.
-        But before sending the response.
+        Post-process the item after adding it to the database, before sending the response.
 
         - When a `Model` is returned, it will replace the current `item`.
         - When any other value is returned, it is assumed to be a response to be returned directly.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_bulk_mixin.py

@@ -79,8 +79,7 @@ class BulkMixin:
         session: SQLASession,
     ) -> Response:
         """
-        Bulk handler for the API.
-        To be implemented by the subclass.
+        Bulk handler for the API, to be implemented by the subclass.
 
         Example:
         ```python

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_columns.py

@@ -127,7 +127,7 @@ class ColumnsMixin:
     ):
         """
         Handle the schema extra fields for the API.
-        This will transform the fields into a dictionary with the field name as the key and the field type as the value if the field is not a tuple.
+        Transforms non-tuple fields into a dictionary mapping field name to field type.
 
         Args:
             schema_extra_fields (dict[str, type | tuple[type, pydantic.fields.FieldInfo]]): The schema extra fields to handle.
@@ -183,7 +183,7 @@ class ColumnsMixin:
         name: str | None = None,
     ):
         """
-        Create a request schema based on the provided `schema` parameter. Useful for creating request schemas for add and edit endpoints, as it will transform the relation columns into the appropriate schema.
+        Create a request schema from `schema` for add and edit endpoints, transforming relation columns into the appropriate schema.
 
         Args:
             schema (typing.Type[BaseModel]): The base schema to create the request schema from.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_delete_mixin.py

@@ -61,7 +61,6 @@ class DeleteMixin:
 
         Args:
             id (str): The id of the item.
-            query (QueryManager): The query manager object.
             session (SQLASession): A database scoped session.
 
         Returns:

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_download_mixin.py

@@ -73,7 +73,7 @@ class DownloadMixin:
         Downloads a file in a headless mode.
 
         Args:
-            body (QueryBody): The query body.
+            q (QuerySchema): The query schema.
             session (SQLASession): A database scoped session.
             export_mode (ExportMode): The export mode. Can be "simplified" or "detailed". Defaults to "simplified".
             delimiter (str): The delimiter for the CSV file. Defaults to ",".
@@ -193,11 +193,10 @@ class DownloadMixin:
         quotechar: str = '"',
     ):
         """
-        Import data from CSV format. This will parse the CSV data and resolve any relationships.
+        Import data from CSV format, parsing it and resolving any relationships.
 
         Args:
             data (str | bytes): The CSV data to import.
-            query (QueryManager): The query manager object.
             session (SQLASession): The session object for the database connection.
             delimiter (str, optional): Delimiter for the CSV file. Defaults to ",".
             quotechar (str): Quote character for the CSV file. Defaults to '"'.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_edit_mixin.py

@@ -68,7 +68,7 @@ class EditMixin:
         session: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Updates an item in a headless mode.
+        Updates an item in headless mode.
 
         Args:
             id (str): The id of the item.
@@ -76,7 +76,7 @@ class EditMixin:
             session (SQLASession): A database scoped session.
 
         Returns:
-            add_return_schema: The add return schema.
+            edit_return_schema: The edit return schema.
 
         ### Note:
             If you are overriding this method, make sure to copy all the decorators too.
@@ -159,7 +159,7 @@ class EditMixin:
         Args:
             item (Model): The item that will be updated in the database.
             data (dict[str, typing.Any]): The data to merge with the item.
-            params (PARAM_BODY_QUERY_SESSION): Additional data passed to the handler.
+            params (PARAM_BODY_SESSION): Additional data passed to the handler.
         """
         pass
 
@@ -182,8 +182,7 @@ class EditMixin:
         self, item: Model, params: PARAM_BODY_SESSION
     ) -> None | Model | typing.Any:
         """
-        Post-process the item after updating it in the database.
-        But before sending the response.
+        Post-process the item after updating it in the database, before sending the response.
 
         - When a `Model` is returned, it will replace the current `item`.
         - When any other value is returned, it is assumed to be a response to be returned directly.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_file_mixin.py

@@ -27,9 +27,9 @@ class FileMixin:
 
     def image(self):
         """
-        Image endpoint for the API. Used to retrieve the image from the application.
+        Image endpoint for the API.
 
-        This endpoint is only available if the model has image columns.
+        Only available if the model has image columns.
         """
         if not self.datamodel.get_image_column_list():
             return
@@ -50,9 +50,9 @@ class FileMixin:
 
     def file(self):
         """
-        File endpoint for the API. Used to retrieve the file from the application.
+        File endpoint for the API.
 
-        This endpoint is only available if the model has file columns.
+        Only available if the model has file columns.
         """
         if not self.datamodel.get_file_column_list():
             return
@@ -73,7 +73,7 @@ class FileMixin:
 
     async def image_headless(self, filename: str):
         """
-        Retrieves an image based on the filename.
+        Retrieves an image by filename.
         """
         async with AsyncTaskRunner():
             pre_image = await smart_run(self.pre_image, filename)
@@ -91,7 +91,7 @@ class FileMixin:
 
     async def file_headless(self, filename: str):
         """
-        Retrieves a file based on the filename.
+        Retrieves a file by filename.
         """
         async with AsyncTaskRunner():
             pre_file = await smart_run(self.pre_file, filename)

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_info_mixin.py

@@ -100,7 +100,7 @@ class InfoMixin:
         session_count: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Retrieves information in a headless mode.
+        Retrieves information in headless mode.
 
         Args:
             permissions (typing.List[str]): A list of permissions.
@@ -151,7 +151,7 @@ class InfoMixin:
         session_count: SQLASession,
     ):
         """
-        Generates the information schema for the API based on the given permissions and database session.
+        Generates the information schema for the API.
 
         Args:
             permissions (typing.List[str]): The list of permissions for the API.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_list_mixin.py

@@ -54,7 +54,7 @@ class ListMixin:
         ] = SelfDepends().get_q_and_session_count_factory,
     ):
         """
-        Retrieves all items in a headless mode.
+        Retrieves all items in headless mode.
 
         Args:
             session (SQLASession): A database scoped session.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_show_mixin.py

@@ -61,7 +61,7 @@ class ShowMixin:
         session: SQLASession = SelfDepends().datamodel.get_session_factory,
     ):
         """
-        Retrieves a single item in a headless mode.
+        Retrieves a single item in headless mode.
 
         Args:
             id (str): The id of the item.

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/api/model_rest_api/_upload_mixin.py

@@ -2,9 +2,9 @@
 Upload route mixin for ``ModelRestApi``.
 
 The ``upload`` registration and ``upload_headless`` implementation are
-disabled (commented out) until further notice. The mixin is wired into
-``ModelRestApi`` so the route can be re-enabled by uncommenting the
-blocks below without further plumbing.
+disabled (commented out) until further notice. The mixin stays wired into
+``ModelRestApi`` so the route can be re-enabled by uncommenting the blocks
+below.
 """
 
 

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/apis/license.py

@@ -16,7 +16,7 @@ from ..utils import lazy, prettify_dict
 
 
 class LicenseParserError(Exception):
-    """Custom exception for license parser errors."""
+    """Raised on license parsing failures."""
 
     def __init__(
         self, data: typing.Any, message: str = "Error processing license data"

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/auth/auth.py

@@ -90,7 +90,6 @@ class Authenticator(BaseAuthenticator):
         :param optional: If `True`, `None` is returned if there is no authenticated user
         or if it doesn't pass the other requirements.
         Otherwise, throw `401 Unauthorized`. Defaults to `False`.
-        Otherwise, an exception is raised. Defaults to `False`.
         :param active: If `True`, throw `401 Unauthorized` if
         the authenticated user is inactive. Defaults to `False`.
         :param verified: If `True`, throw `401 Unauthorized` if
@@ -103,7 +102,7 @@ class Authenticator(BaseAuthenticator):
         Useful if you want to dynamically enable some authentication backends
         based on external logic, like a configuration in database.
         By default, all specified authentication backends are enabled.
-        Please not however that every backends will appear in the OpenAPI documentation,
+        Please note however that every backend will appear in the OpenAPI documentation,
         as FastAPI resolves it statically.
         """
         signature = self._get_dependency_signature(get_enabled_backends)
@@ -127,9 +126,7 @@ class Authenticator(BaseAuthenticator):
         self, get_enabled_backends: Optional[EnabledBackendsDependency] = None
     ):
         """
-        Custom logic to determine enabled authentication backends. This is useful to separately retrieve the enabled backends without performing authentication.
-
-        Return a dependency callable to retrieve parameters of enabled authentication backends.
+        Return a dependency callable that retrieves the enabled authentication backends without performing authentication.
 
         Args:
             get_enabled_backends (Optional[EnabledBackendsDependency], optional): Optional dependency callable returning a list of enabled authentication backends.
@@ -162,7 +159,7 @@ class Authenticator(BaseAuthenticator):
         strategy_params: tuple[tuple, dict[str, typing.Any]] | None = None,
     ):
         """
-        Custom logic to perform authentication. This is useful if you want to perform authentication without using it as a dependency, such as in a custom route or in the startup event.
+        Perform authentication without using it as a dependency, such as in a custom route or in the startup event.
 
         `strategy_params` is usually generated from the `get_enabled_backends` dependency.
 
@@ -280,9 +277,7 @@ class AuthConfigurator:
     @property
     def user_manager(self):
         """
-        Get the user manager.
-
-        if the user manager is not set, it will default to the UserManager class.
+        Get the user manager. Defaults to the `UserManager` class if not set.
 
         Returns:
             The user manager.
@@ -294,9 +289,7 @@ class AuthConfigurator:
     @user_manager.setter
     def user_manager(self, value: Type[UserManager]):
         """
-        Set the user manager.
-
-        Use this to use a custom user manager.
+        Set a custom user manager.
 
         Args:
             value (Type[UserManager]): The user manager value.
@@ -306,9 +299,7 @@ class AuthConfigurator:
     @property
     def cookie_transport(self):
         """
-        Get the cookie transport.
-
-        if the cookie transport is not set, it will default to the cookie_transport global variable.
+        Get the cookie transport. Built from `cookie_config` if not set.
 
         Returns:
             The cookie transport.
@@ -322,9 +313,7 @@ class AuthConfigurator:
     @cookie_transport.setter
     def cookie_transport(self, value: CookieTransport):
         """
-        Set the cookie transport.
-
-        Use this to use a custom cookie transport.
+        Set a custom cookie transport.
 
         Args:
             value (CookieTransport): The cookie transport value.
@@ -339,9 +328,7 @@ class AuthConfigurator:
     @property
     def bearer_transport(self):
         """
-        Get the bearer transport.
-
-        if the bearer transport is not set, it will default to the bearer_transport global variable.
+        Get the bearer transport. Built from `bearer_config` if not set.
 
         Returns:
             The bearer transport.
@@ -355,9 +342,7 @@ class AuthConfigurator:
     @bearer_transport.setter
     def bearer_transport(self, value: BearerTransport):
         """
-        Set the bearer transport.
-
-        Use this to use a custom bearer transport.
+        Set a custom bearer transport.
 
         Args:
             value (BearerTransport): The bearer transport value.
@@ -372,9 +357,7 @@ class AuthConfigurator:
     @property
     def cookie_backend(self):
         """
-        Get the cookie backend.
-
-        if the cookie backend is not set, it will default to the cookie_backend global variable.
+        Get the cookie backend. Built from the cookie transport and strategy if not set.
 
         Returns:
             The cookie backend.
@@ -390,9 +373,7 @@ class AuthConfigurator:
     @cookie_backend.setter
     def cookie_backend(self, value: AuthenticationBackend):
         """
-        Set the cookie backend.
-
-        Use this to use a custom cookie backend.
+        Set a custom cookie backend.
 
         Args:
             value (AuthenticationBackend): The cookie backend value.
@@ -407,9 +388,7 @@ class AuthConfigurator:
     @property
     def bearer_backend(self):
         """
-        Get the bearer backend.
-
-        if the bearer backend is not set, it will default to the bearer_backend global variable.
+        Get the bearer backend. Built from the bearer transport and strategy if not set.
 
         Returns:
             The bearer backend.
@@ -425,9 +404,7 @@ class AuthConfigurator:
     @bearer_backend.setter
     def bearer_backend(self, value: AuthenticationBackend):
         """
-        Set the bearer backend.
-
-        Use this to use a custom bearer backend.
+        Set a custom bearer backend.
 
         Args:
             value (AuthenticationBackend): The bearer backend value.
@@ -442,9 +419,7 @@ class AuthConfigurator:
     @property
     def authenticator(self):
         """
-        Get the authenticator.
-
-        if the authenticator is not set, it will default to the authenticator global variable.
+        Get the authenticator. Built from the cookie and bearer backends if not set.
 
         Returns:
             The authenticator.
@@ -458,9 +433,7 @@ class AuthConfigurator:
     @authenticator.setter
     def authenticator(self, value: Authenticator):
         """
-        Set the authenticator.
-
-        Use this to use a custom authenticator.
+        Set a custom authenticator.
 
         Args:
             value (Authenticator): The authenticator value.
@@ -475,9 +448,7 @@ class AuthConfigurator:
     @property
     def fastapi_users(self):
         """
-        Get the FastAPIUsers instance.
-
-        if the FastAPIUsers instance is not set, it will default to the fastapi_users global variable.
+        Get the FastAPIUsers instance. Built from the user manager and backends if not set.
 
         Returns:
             The FastAPIUsers instance.
@@ -493,9 +464,7 @@ class AuthConfigurator:
     @fastapi_users.setter
     def fastapi_users(self, value: FastAPIUsers):
         """
-        Set the FastAPIUsers instance.
-
-        Use this to use a custom FastAPIUsers instance.
+        Set a custom FastAPIUsers instance.
 
         Args:
             value (FastAPIUsers): The FastAPIUsers instance value.
@@ -507,9 +476,7 @@ class AuthConfigurator:
     @property
     def strategy_backend(self):
         """
-        Get the strategy backend generator.
-
-        if the strategy backend generator is not set, it will default to the get_jwt_strategy_generator function.
+        Get the strategy backend generator. Defaults to `get_jwt_strategy_generator` if not set.
 
         Returns:
             The strategy backend generator.
@@ -525,9 +492,7 @@ class AuthConfigurator:
         | Literal["JWT", "DB"],
     ):
         """
-        Set the strategy backend generator.
-
-        Use this to use a custom strategy backend generator, such as where the token is stored in the database.
+        Set a custom strategy backend generator, such as one where the token is stored in the database.
 
         Args:
             value (Callable[[StrategyConfig], Callable[[], Strategy]] | str): The strategy backend generator value or the name of the strategy generator function.
@@ -577,12 +542,10 @@ class AuthConfigurator:
 
     def auth_config(self):
         """
-        Generates a dictionary with keys as uppercase attribute names and values as original attribute names
-        from the Auth class annotations.
+        Map each `Auth` annotation name to its uppercased form.
 
         Returns:
-            dict: A dictionary where each key is an uppercase attribute name from the Auth class annotations,
-                  and each value is the original attribute name.
+            dict: Uppercase attribute name -> original attribute name, from the `Auth` class annotations.
         """
         return {k.upper(): k for k in Auth.__annotations__.keys()}
 

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/auth/ldap.py

@@ -1,19 +1,13 @@
 """
 LDAP helpers for :class:`UserManager`.
 
-Extracted from ``manager.py`` so the user-lifecycle code stays focused on
-register / authenticate / update flows and the LDAP search + role
-reconciliation lives next to the rest of the auth machinery in
-``fastapi_rtk.auth``.
-
-``ldap3_search`` does the LDAP query against an already-bound connection;
+``ldap3_search`` runs the LDAP query against an already-bound connection;
 ``ldap3_calculate_user`` applies ``AUTH_ROLES_MAPPING`` and
 ``AUTH_USER_REGISTRATION_ROLE`` to a freshly authenticated user.
 
-Both functions take the bound :class:`UserManager` as an argument when they
-need to call back into the manager (instead of being methods on it) so the
-LDAP flow can be tested as plain functions without spinning up a full
-manager.
+Both take the bound :class:`UserManager` as an argument rather than being
+methods on it, so the LDAP flow can be tested as plain functions without a
+full manager.
 """
 
 import typing
@@ -41,22 +35,18 @@ def ldap3_search(conn, username: str):
     """
     import ldap3.utils.conv
 
-    # Configuration check remains good practice
     assert Setting.AUTH_LDAP_SEARCH
 
-    # 1. Filter Construction (with security improvement)
-    # ldap3 provides a utility to escape special characters to prevent LDAP injection
+    # Escape special characters to prevent LDAP injection
     safe_username = ldap3.utils.conv.escape_filter_chars(username)
 
     base_filter = f"({Setting.AUTH_LDAP_UID_FIELD}={safe_username})"
     if Setting.AUTH_LDAP_SEARCH_FILTER:
-        # Combine the custom filter with the UID search
         filter_str = f"(&{Setting.AUTH_LDAP_SEARCH_FILTER}{base_filter})"
     else:
         filter_str = base_filter
 
-    # 2. Attribute List Construction
-    # Using a set to prevent duplicates if config fields overlap
+    # Set prevents duplicates if config fields overlap
     attributes_to_fetch = {
         Setting.AUTH_LDAP_FIRSTNAME_FIELD,
         Setting.AUTH_LDAP_LASTNAME_FIELD,
@@ -72,8 +62,6 @@ def ldap3_search(conn, username: str):
         Setting.AUTH_LDAP_SEARCH,
     )
 
-    # 3. The Search Method
-    # The search operation is a method of the connection object
     conn.search(
         Setting.AUTH_LDAP_SEARCH,
         filter_str,
@@ -82,24 +70,17 @@ def ldap3_search(conn, username: str):
     )
     logger.debug("LDAP search returned: %s", conn.entries)
 
-    # 4. Result Processing
-    # Results are stored in the conn.entries property
     if len(conn.entries) > 1:
         logger.error("LDAP search for '%s' returned multiple results.", username)
         return None, None
 
     if conn.entries:
-        # Get the first (and only) entry
         user_entry = conn.entries[0]
-
-        # Extract DN and attributes
         user_dn = user_entry.entry_dn
-        # .entry_attributes_as_dict provides a simple dict format
         user_attributes = user_entry.entry_attributes_as_dict
 
         return user_dn, user_attributes
     else:
-        # No results found
         return None, None
 
 

{fastapi_rtk-2.1.4 → fastapi_rtk-2.1.5}/fastapi_rtk/auth/password_helpers/fab.py

@@ -10,7 +10,7 @@ __all__ = ["FABPasswordHelper"]
 
 class FABPasswordHelper(PasswordHelper):
     """
-    Helper class for old version of password-related operations in the FAB React Toolkit.
+    Password helper for legacy FAB-hashed passwords.
 
     Args:
         password_hash (Optional[PasswordHash]): An optional `PasswordHash` object to use for password hashing.