howler-api 4.1.0.dev1635__tar.gz → 4.1.0.dev1644__tar.gz

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-api
-Version: 4.1.0.dev1635
+Version: 4.1.0.dev1644
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/api/v1/utils/permission_helper.py

@@ -31,10 +31,12 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
         refresh => ('true' | 'false' | 'wait_for') Whether to refresh the datastore before returning.
 
         Data Block:
-        {
-            "privilege": "members",       # The permission level: 'owner', 'admins', or 'members'
-            "user_ids": ["username"]       # The users receiving the permission
-        }
+        [
+            {
+                "privilege": "members",   # The permission level: 'owner', 'admins', or 'members'
+                "user_id": "username"      # The user receiving the permission
+            }
+        ]
 
         Result Example:
         {
@@ -42,7 +44,7 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
         }
         """
         try:
-            result = permission_service.give_privilege(id, user, odm, refresh=kwargs.get("refresh"))
+            result = permission_service.give_privileges(id, user, odm, refresh=kwargs.get("refresh"))
         except VersionConflictException:
             return conflict(err="Someone has updated this item. Please try again")
         except ForbiddenException as e:
@@ -67,13 +69,21 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
         Optional Arguments:
         refresh => ('true' | 'false' | 'wait_for') Whether to refresh the datastore before returning.
 
+        Data Block:
+        [
+            {
+                "privilege": "members",   # The permission level: 'admins' or 'members'
+                "user_id": "username"      # The user losing the permission
+            }
+        ]
+
         Result Example:
         {
             ...object   # The updated action, dossier, or view
         }
         """
         try:
-            result = permission_service.remove_privilege(id, user, odm, refresh=kwargs.get("refresh"))
+            result = permission_service.remove_privileges(id, user, odm, refresh=kwargs.get("refresh"))
         except VersionConflictException:
             return conflict(err="Someone has updated this item. Please try again")
         except ForbiddenException as e:

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/datastore/collection.py

@@ -1210,13 +1210,15 @@ class ESCollection(Generic[ModelType]):
         return out
 
     @overload
-    def normalize(self: Self, data) -> ModelType | None: ...
+    def normalize(self: Self, data) -> ModelType | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def normalize(self: Self, data, as_obj: Literal[True]) -> ModelType | None: ...
+    def normalize(self: Self, data, as_obj: Literal[True]) -> ModelType | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def normalize(self: Self, data, as_obj: Literal[False]) -> dict[str, Any] | None: ...
+    def normalize(
+        self: Self, data, as_obj: Literal[False]
+    ) -> dict[str, Any] | None: ...  # codeql[py/ineffectual-statement]
 
     def normalize(self: Self, data, as_obj=True):
         """Normalize the data using the model class
@@ -1285,10 +1287,14 @@ class ESCollection(Generic[ModelType]):
         raise elasticsearch.exceptions.NotFoundError(f"Document with id {key} not found", meta, result)
 
     @overload
-    def _get(self: Self, key, retries, version: Literal[False]) -> dict[str, Any]: ...
+    def _get(
+        self: Self, key, retries, version: Literal[False]
+    ) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def _get(self: Self, key, retries, version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+    def _get(
+        self: Self, key, retries, version: Literal[True]
+    ) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
     def _get(self: Self, key, retries, version=False):
         """Versioned get-save for atomic update has two paths:
@@ -1368,25 +1374,33 @@ class ESCollection(Generic[ModelType]):
         raise DataStoreException(f"Invalid version token for {self.name}: {version!r}")
 
     @overload
-    def get(self: Self, key, as_obj: Literal[True], version: Literal[True]) -> tuple[ModelType | None, str]: ...
+    def get(
+        self: Self, key, as_obj: Literal[True], version: Literal[True]
+    ) -> tuple[ModelType | None, str]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key, as_obj: Literal[True], version: Literal[False]) -> ModelType | None: ...
+    def get(
+        self: Self, key, as_obj: Literal[True], version: Literal[False]
+    ) -> ModelType | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key, as_obj: Literal[True]) -> ModelType | None: ...
+    def get(self: Self, key, as_obj: Literal[True]) -> ModelType | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key) -> ModelType | None: ...
+    def get(self: Self, key) -> ModelType | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key, as_obj: Literal[False], version: Literal[True]) -> tuple[dict[str, Any] | None, str]: ...
+    def get(
+        self: Self, key, as_obj: Literal[False], version: Literal[True]
+    ) -> tuple[dict[str, Any] | None, str]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key, as_obj: Literal[False], version: Literal[False]) -> dict[str, Any] | None: ...
+    def get(
+        self: Self, key, as_obj: Literal[False], version: Literal[False]
+    ) -> dict[str, Any] | None: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get(self: Self, key, as_obj: Literal[False]) -> dict[str, Any] | None: ...
+    def get(self: Self, key, as_obj: Literal[False]) -> dict[str, Any] | None: ...  # codeql[py/ineffectual-statement]
 
     def get(self: Self, key, as_obj=True, version=False):
         """Get a document from the datastore, retry a few times if not found and normalize the
@@ -1407,27 +1421,35 @@ class ESCollection(Generic[ModelType]):
         return self.normalize(data, as_obj=as_obj)
 
     @overload
-    def get_if_exists(self: Self, key: str, as_obj: Literal[True], version: Literal[True]) -> tuple[ModelType, str]: ...
+    def get_if_exists(
+        self: Self, key: str, as_obj: Literal[True], version: Literal[True]
+    ) -> tuple[ModelType, str]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get_if_exists(self: Self, key: str, as_obj: Literal[True], version: Literal[False]) -> ModelType: ...
+    def get_if_exists(
+        self: Self, key: str, as_obj: Literal[True], version: Literal[False]
+    ) -> ModelType: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get_if_exists(self: Self, key: str, as_obj: Literal[True]) -> ModelType: ...
+    def get_if_exists(self: Self, key: str, as_obj: Literal[True]) -> ModelType: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get_if_exists(self: Self, key: str) -> ModelType: ...
+    def get_if_exists(self: Self, key: str) -> ModelType: ...  # codeql[py/ineffectual-statement]
 
     @overload
     def get_if_exists(
         self: Self, key: str, as_obj: Literal[False], version: Literal[True]
-    ) -> tuple[dict[str, Any], str]: ...
+    ) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get_if_exists(self: Self, key: str, as_obj: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+    def get_if_exists(
+        self: Self, key: str, as_obj: Literal[False], version: Literal[False]
+    ) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def get_if_exists(self: Self, key: str, as_obj: Literal[False]) -> dict[str, Any]: ...
+    def get_if_exists(
+        self: Self, key: str, as_obj: Literal[False]
+    ) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
     def get_if_exists(self: Self, key: str, as_obj=True, version=False):
         """Get a document from the datastore but do not retry if not found.
@@ -2095,7 +2117,7 @@ class ESCollection(Generic[ModelType]):
         script_fields: list[str] = [],
         *,
         aggregations: None = None,
-    ) -> SearchResult[ModelType]: ...
+    ) -> SearchResult[ModelType]: ...  # codeql[py/ineffectual-statement]
 
     @overload
     def search(
@@ -2114,7 +2136,7 @@ class ESCollection(Generic[ModelType]):
         script_fields: list[str] = [],
         *,
         aggregations: None = None,
-    ) -> SearchResult[dict[str, typing.Any]]: ...
+    ) -> SearchResult[dict[str, typing.Any]]: ...  # codeql[py/ineffectual-statement]
 
     @overload
     def search(
@@ -2133,7 +2155,7 @@ class ESCollection(Generic[ModelType]):
         script_fields: list[str] = [],
         *,
         aggregations: list[tuple[str, dict]],
-    ) -> AggSearchResult[ModelType]: ...
+    ) -> AggSearchResult[ModelType]: ...  # codeql[py/ineffectual-statement]
 
     @overload
     def search(
@@ -2152,7 +2174,7 @@ class ESCollection(Generic[ModelType]):
         script_fields: list[str] = [],
         *,
         aggregations: list[tuple[str, dict]],
-    ) -> AggSearchResult[dict[str, typing.Any]]: ...
+    ) -> AggSearchResult[dict[str, typing.Any]]: ...  # codeql[py/ineffectual-statement]
 
     def search(
         self: Self,
@@ -2316,7 +2338,7 @@ class ESCollection(Generic[ModelType]):
         item_buffer_size: int = 200,
         *,
         as_obj: Literal[True] = True,
-    ) -> typing.Generator[ModelType, None, None]: ...
+    ) -> typing.Generator[ModelType, None, None]: ...  # codeql[py/ineffectual-statement]
 
     @overload
     def stream_search(
@@ -2328,7 +2350,7 @@ class ESCollection(Generic[ModelType]):
         item_buffer_size: int = 200,
         *,
         as_obj: Literal[False],
-    ) -> typing.Generator[dict[str, typing.Any], None, None]: ...
+    ) -> typing.Generator[dict[str, typing.Any], None, None]: ...  # codeql[py/ineffectual-statement]
 
     def stream_search(
         self: Self,

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/odm/mixins.py

@@ -29,10 +29,14 @@ class _ObjectsDescriptor(Generic[ModelType]):
     """
 
     @overload
-    def __get__(self: Self, obj: None, objtype: type[ModelType]) -> ESCollection[ModelType]: ...
+    def __get__(
+        self: Self, obj: None, objtype: type[ModelType]
+    ) -> ESCollection[ModelType]: ...  # codeql[py/ineffectual-statement]
 
     @overload
-    def __get__(self: Self, obj: ModelType, objtype: type[ModelType]) -> ESCollection[ModelType]: ...
+    def __get__(
+        self: Self, obj: ModelType, objtype: type[ModelType]
+    ) -> ESCollection[ModelType]: ...  # codeql[py/ineffectual-statement]
 
     def __get__(self, obj: ModelType | None, objtype: type[ModelType] | None = None) -> ESCollection[ModelType]:
         """Return the ESCollection for the owner class.

howler_api-4.1.0.dev1644/howler/odm/models/permission_request.py

@@ -0,0 +1,12 @@
+from typing import Literal
+
+from howler import odm
+
+
+@odm.model(index=False, store=False, description="A permission entry for ownership permission updates")
+class PermissionRequest(odm.Model):
+    privilege: Literal["admins", "members", "owner"] = odm.Enum(
+        values=["admins", "members", "owner"],
+        description="The permission level to update",
+    )
+    user_id: str = odm.Keyword(description="The user ID to grant or revoke for the selected privilege.")

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/action_service.py

@@ -38,31 +38,37 @@ _action_queues: dict[str, NamedQueue[TriggeredAction]] = {}
 @overload
 def get_action(
     id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
-) -> tuple[Action, str]: ...
+) -> tuple[Action, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str, as_odm: Literal[True], version: Literal[False]) -> Action: ...
+def get_action(
+    id: str, as_odm: Literal[True], version: Literal[False]
+) -> Action: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str, as_odm: Literal[True]) -> Action: ...
+def get_action(id: str, as_odm: Literal[True]) -> Action: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str) -> Action: ...
+def get_action(id: str) -> Action: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+def get_action(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+def get_action(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_action(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+def get_action(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 def get_action(id: str, as_odm=False, version=False, user: User | None = None):

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/analytic_service.py

@@ -19,31 +19,39 @@ def does_analytic_exist(analytic_id: str) -> bool:
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[True], version: Literal[True]) -> tuple[Analytic, str]: ...
+def get_analytic(
+    id: str, as_odm: Literal[True], version: Literal[True]
+) -> tuple[Analytic, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[True], version: Literal[False]) -> Analytic: ...
+def get_analytic(
+    id: str, as_odm: Literal[True], version: Literal[False]
+) -> Analytic: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[True]) -> Analytic: ...
+def get_analytic(id: str, as_odm: Literal[True]) -> Analytic: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str) -> Analytic: ...
+def get_analytic(id: str) -> Analytic: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+def get_analytic(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+def get_analytic(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_analytic(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+def get_analytic(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 def get_analytic(

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/case_service.py

@@ -39,35 +39,43 @@ CREATED_CASES = Counter(f"{APP_NAME.replace('-', '_')}_created_cases_total", "Th
 @overload
 def get_case(
     id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
-) -> tuple[Case | None, str]: ...
+) -> tuple[Case | None, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[True], version: Literal[False]) -> Case | None: ...
+def get_case(
+    id: str, as_odm: Literal[True], version: Literal[False]
+) -> Case | None: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[True], version: Literal[False], user: User | None = None) -> Case | None: ...
+def get_case(
+    id: str, as_odm: Literal[True], version: Literal[False], user: User | None = None
+) -> Case | None: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[True]) -> Case | None: ...
+def get_case(id: str, as_odm: Literal[True]) -> Case | None: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str) -> Case | None: ...
+def get_case(id: str) -> Case | None: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any] | None, str]: ...
+def get_case(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any] | None, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any] | None: ...
+def get_case(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any] | None: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_case(id: str, as_odm: Literal[False]) -> dict[str, Any] | None: ...
+def get_case(id: str, as_odm: Literal[False]) -> dict[str, Any] | None: ...  # codeql[py/ineffectual-statement]
 
 
 def get_case(id: str, as_odm=False, version=False, user: User | None = None):
@@ -497,7 +505,7 @@ def append_case_item(
     item_name: str | None = None,
     *,
     user: User | None = None,
-) -> Case: ...
+) -> Case: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
@@ -510,7 +518,7 @@ def append_case_item(
     item_name: str | None = ...,
     *,
     user: User | None = None,
-) -> Case: ...
+) -> Case: ...  # codeql[py/ineffectual-statement]
 
 
 def append_case_item(  # noqa: C901

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/dossier_service.py

@@ -55,31 +55,39 @@ def exists(dossier_id: str) -> bool:
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[True], version: Literal[True]) -> tuple[Dossier, str]: ...
+def get_dossier(
+    id: str, as_odm: Literal[True], version: Literal[True]
+) -> tuple[Dossier, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[True], version: Literal[False]) -> Dossier: ...
+def get_dossier(
+    id: str, as_odm: Literal[True], version: Literal[False]
+) -> Dossier: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[True]) -> Dossier: ...
+def get_dossier(id: str, as_odm: Literal[True]) -> Dossier: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str) -> Dossier: ...
+def get_dossier(id: str) -> Dossier: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+def get_dossier(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+def get_dossier(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_dossier(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+def get_dossier(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 def get_dossier(

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/event_service.py

@@ -37,31 +37,35 @@ def exists(id: str) -> bool:
 @overload
 def get_event(
     id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
-) -> tuple[Event, str]: ...
+) -> tuple[Event, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str, as_odm: Literal[True], version: Literal[False]) -> Event: ...
+def get_event(id: str, as_odm: Literal[True], version: Literal[False]) -> Event: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str, as_odm: Literal[True]) -> Event: ...
+def get_event(id: str, as_odm: Literal[True]) -> Event: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str) -> Event: ...
+def get_event(id: str) -> Event: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+def get_event(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+def get_event(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_event(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+def get_event(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @tracer.start_as_current_span(f"{__name__}.get_event")

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/hit_service.py

@@ -361,31 +361,37 @@ def exists(id: str) -> bool:
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None) -> tuple[Hit, str]: ...
+def get_hit(
+    id: str, as_odm: Literal[True], version: Literal[True], user: User | None = None
+) -> tuple[Hit, str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[True], version: Literal[False]) -> Hit: ...
+def get_hit(id: str, as_odm: Literal[True], version: Literal[False]) -> Hit: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[True]) -> Hit: ...
+def get_hit(id: str, as_odm: Literal[True]) -> Hit: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str) -> Hit: ...
+def get_hit(id: str) -> Hit: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+def get_hit(
+    id: str, as_odm: Literal[False], version: Literal[True]
+) -> tuple[dict[str, Any], str]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+def get_hit(
+    id: str, as_odm: Literal[False], version: Literal[False]
+) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_hit(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
+def get_hit(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...  # codeql[py/ineffectual-statement]
 
 
 @tracer.start_as_current_span(f"{__name__}.get_hit")
@@ -812,7 +818,7 @@ def search(
     deep_paging_id: str | None = None,
     track_total_hits: bool = False,
     filters: list[str] | None = None,
-) -> SearchResult[Hit]: ...
+) -> SearchResult[Hit]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
@@ -827,7 +833,7 @@ def search(
     deep_paging_id: str | None = None,
     track_total_hits: bool = False,
     filters: list[str] | None = None,
-) -> SearchResult[dict[str, Any]]: ...
+) -> SearchResult[dict[str, Any]]: ...  # codeql[py/ineffectual-statement]
 
 
 @tracer.start_as_current_span(f"{__name__}.search")

{howler_api-4.1.0.dev1635 → howler_api-4.1.0.dev1644}/howler/services/overview_service.py

@@ -13,11 +13,13 @@ logger = get_logger(__file__)
 @overload
 def get_matching_overviews(
     hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[False] = False
-) -> list[dict[str, Any]]: ...
+) -> list[dict[str, Any]]: ...  # codeql[py/ineffectual-statement]
 
 
 @overload
-def get_matching_overviews(hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[True]) -> list[Overview]: ...
+def get_matching_overviews(
+    hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[True]
+) -> list[Overview]: ...  # codeql[py/ineffectual-statement]
 
 
 def get_matching_overviews(hits: list[Hit] | list[dict[str, Any]], as_odm=False):