howler-api 3.2.0.dev472__tar.gz → 3.2.0.dev475__tar.gz

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/PKG-INFO

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

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/cronjobs/view_cleanup.py

@@ -18,14 +18,16 @@ def execute():
 
     # Initialize datastore
     ds = datastore()
+
     # fetch the first result from user ds (needed to initialize total)
-    result = ds.user.search("*:*", rows=250, fl="*")
-    total_user_count = result["total"]
-    user_list: List[Any] = result["items"]
+    user_result = ds.user.search("*:*", rows=250, fl="*")
+    total_user_count = user_result["total"]
+    user_list: List[Any] = user_result["items"]
+
     # Do the same thing for the views
-    result = ds.view.search("*:*", rows=250)
-    total_view_count = result["total"]
-    view_list: List[Any] = result["items"]
+    view_result = ds.view.search("*:*", rows=250)
+    total_view_count = view_result["total"]
+    view_list: List[Any] = view_result["items"]
     view_ids: List[str] = []
 
     # Collect all views

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/datastore/collection.py

@@ -973,27 +973,27 @@ class ESCollection(Generic[ModelType]):
         return self.normalize(data, as_obj=as_obj)
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[True], version: Literal[True]) -> tuple[ModelType, str]: ...
+    def get_if_exists(self, key: str, as_obj: Literal[True], version: Literal[True]) -> tuple[ModelType, str]: ...
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[True], version: Literal[False]) -> ModelType: ...
+    def get_if_exists(self, key: str, as_obj: Literal[True], version: Literal[False]) -> ModelType: ...
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[True]) -> ModelType: ...
+    def get_if_exists(self, key: str, as_obj: Literal[True]) -> ModelType: ...
 
     @overload
-    def get_if_exists(self, key) -> ModelType: ...
+    def get_if_exists(self, key: str) -> ModelType: ...
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
+    def get_if_exists(self, key: str, as_obj: Literal[False], version: Literal[True]) -> tuple[dict[str, Any], str]: ...
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
+    def get_if_exists(self, key: str, as_obj: Literal[False], version: Literal[False]) -> dict[str, Any]: ...
 
     @overload
-    def get_if_exists(self, key, as_obj: Literal[False]) -> dict[str, Any]: ...
+    def get_if_exists(self, key: str, as_obj: Literal[False]) -> dict[str, Any]: ...
 
-    def get_if_exists(self, key, as_obj=True, version=False):
+    def get_if_exists(self, key: str, as_obj=True, version=False):
         """Get a document from the datastore but do not retry if not found.
 
         Use this more in caching scenarios because eventually consistent database may lead

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/datastore/migrations/fix_process.py

@@ -21,9 +21,9 @@ def migrate():
         return
 
     logger.info(f"We will delete {result['total']} hits. Continue?")
-    result = input("y/[n]")
+    prompt_result = input("y/[n]")
 
-    if result.lower() != "y":
+    if prompt_result.lower() != "y":
         logger.warning("Did not receive an OK, stopping")
         return
 

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/services/analytic_service.py

@@ -48,8 +48,8 @@ def get_analytic(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
 
 def get_analytic(
     id: str,
-    as_odm: bool = False,
-    version: bool = False,
+    as_odm=False,
+    version=False,
 ):
     """Return analytic object as either an ODM or Dict"""
     return datastore().analytic.get_if_exists(key=id, as_obj=as_odm, version=version)

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/services/dossier_service.py

@@ -72,8 +72,8 @@ def get_dossier(id: str, as_odm: Literal[False]) -> dict[str, Any]: ...
 
 def get_dossier(
     id: str,
-    as_odm: bool = False,
-    version: bool = False,
+    as_odm=False,
+    version=False,
 ):
     """Retrieve a dossier from the datastore.
 

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/services/overview_service.py

@@ -1,4 +1,4 @@
-from typing import Any, Union
+from typing import Any, Literal, overload
 
 from howler.common.loader import datastore
 from howler.common.logging import get_logger
@@ -10,9 +10,17 @@ from howler.utils.str_utils import sanitize_lucene_query
 logger = get_logger(__file__)
 
 
+@overload
 def get_matching_overviews(
-    hits: Union[list[Hit], list[dict[str, Any]]], as_odm: bool = False
-) -> Union[list[dict[str, Any]], list[Overview]]:
+    hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[False] = False
+) -> list[dict[str, Any]]: ...
+
+
+@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=False):
     """Generate a list of overviews matching a given list of analytic names from the provided hits.
 
     Args:
@@ -33,12 +41,10 @@ def get_matching_overviews(
         return []
 
     try:
-        overview_candidates = datastore().overview.search(
+        return datastore().overview.search(
             f"analytic:({' OR '.join(analytic_names)})",
             as_obj=as_odm,
         )["items"]
-
-        return overview_candidates
     except SearchException:
         logger.exception("Exception on analytic matching")
         return []

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/services/template_service.py

@@ -1,4 +1,4 @@
-from typing import Any, Literal, Optional, Union, cast, overload
+from typing import Any, Literal, cast, overload
 
 from howler.common.loader import datastore
 from howler.common.logging import get_logger
@@ -12,24 +12,24 @@ logger = get_logger(__file__)
 
 @overload
 def get_matching_templates(
-    hits: Union[list[Hit], list[dict[str, Any]]], as_odm: Literal[False] = False, uname: Optional[str] = None
+    hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[False] = False, uname: str | None = None
 ) -> list[dict[str, Any]]: ...
 
 
 @overload
 def get_matching_templates(
-    hits: Union[list[Hit], list[dict[str, Any]]], as_odm: Literal[True], uname: Optional[str] = None
+    hits: list[Hit] | list[dict[str, Any]], as_odm: Literal[True], uname: str | None = None
 ) -> list[Analytic]: ...
 
 
 def get_matching_templates(
-    hits: Union[list[Hit], list[dict[str, Any]]], as_odm: bool = False, uname: Optional[str] = None
+    hits: list[Hit] | list[dict[str, Any]], as_odm=False, uname: str | None = None
 ) -> list[dict[str, Any]] | list[Analytic]:
     """Generate a list of templates matching a given list of analytic names, and optionally a user.
 
     Args:
         hits (list[Hit] | list[dict[str, Any]]]: List of hits, each containing analytic information.
-        uname (Optional[str], optional): Username to filter templates by owner. Defaults to None.
+        uname (str | None, optional): Username to filter templates by owner. Defaults to None.
         as_odm (bool, optional): If True, return results as ODM objects. If False, return as dicts. Defaults to False.
 
     Returns:

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/howler/services/user_service.py

@@ -40,8 +40,8 @@ def get_user(id: str) -> dict[str, Any]: ...
 
 def get_user(
     id: str,
-    as_odm: bool = False,
-    version: bool = False,
+    as_odm=False,
+    version=False,
 ):
     """Return hit object as either an ODM or Dict"""
     return datastore().user.get_if_exists(key=id, as_obj=as_odm, version=version)
@@ -77,10 +77,10 @@ def convert_user(user: User) -> dict[str, Any]:
 
     user_data["apikeys"] = [
         (key, value["acl"], value["expiry_date"])
-        for key, value in datastore().user.get_if_exists(user["uname"]).apikeys.items()
+        for key, value in datastore().user.get_if_exists(user.uname).apikeys.items()
     ]
 
-    user_data["avatar"] = datastore().user_avatar.get_if_exists(user["uname"])
+    user_data["avatar"] = datastore().user_avatar.get_if_exists(user.uname)
     user_data["username"] = user_data.pop("uname")
     user_data["is_admin"] = "admin" in user_data["type"]
     user_data["roles"] = list(set(user_data.pop("type")))

{howler_api-3.2.0.dev472 → howler_api-3.2.0.dev475}/pyproject.toml

@@ -152,7 +152,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "3.2.0.dev472"
+version = "3.2.0.dev475"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",