peak-sdk 1.5.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

peak/cli/resources/workflows.py

@@ -82,6 +82,16 @@ _CLEAR_IMAGE_CACHE = typer.Option(None, help="Whether to clear image cache on wo
 
 _STEP_NAMES = typer.Option(None, help="List of step names to be updated.")
 
+_EXECUTION_STATUS = typer.Option(
+    None,
+    help="List of workflow execution statuses. Valid values are `Success`, `Running`, `Stopped`, `Stopping` and `Failed`.",
+)
+
+_COUNT = typer.Option(
+    None,
+    help="Number of workflow executions required in the provided time range or 90 days. If not provided, all executions are returned.",
+)
+
 
 @app.command(short_help="Create a new workflow.", options_metavar="create_workflow")
 def create(
@@ -109,13 +119,25 @@ def create(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
-                runtimeExceeded (int | required: false): The runtime after which event is called.
-              user (string | required: false): User to be notified.
-              webhook (map | required: false):
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              user (string): User to be notified.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              webhook (map):
                 name (string): Name of the webhook.
                 url (string): URL of the webhook.
                 payload (string): Webhook payload.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              email (map):
+                name (string): Name of the email watcher.
+                recipients (map):
+                    to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
         retryOptions (map | required: false): # Workflow level retry options which will be applied to all steps.
             duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
             exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
@@ -221,13 +243,25 @@ def update(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
-                runtimeExceeded (int | required: false): The runtime after which event is called.
-              user (string | required: false): User to be notified.
-              webhook (map | required: false):
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              user (string): User to be notified.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              webhook (map):
                 name (string): Name of the webhook.
                 url (string): URL of the webhook.
                 payload (string): Webhook payload.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              email (map):
+                name (string): Name of the email watcher.
+                recipients (map):
+                    to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
         retryOptions (map | required: false): # Workflow level retry options which will be applied to all steps.
             duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
             exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
@@ -333,13 +367,25 @@ def create_or_update(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
-                runtimeExceeded (int | required: false): The runtime after which event is called.
-              user (string | required: false): User to be notified.
-              webhook (map | required: false):
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              user (string): User to be notified.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              webhook (map):
                 name (string): Name of the webhook.
                 url (string): URL of the webhook.
                 payload (string): Webhook payload.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              email (map):
+                name (string): Name of the email watcher.
+                recipients (map):
+                    to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
         retryOptions (map | required: false): # Workflow level retry options which will be applied to all steps.
             duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
             exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
@@ -475,13 +521,25 @@ def patch(
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
-                fail (boolean | required: false): Whether to call event on success.
-                runtimeExceeded (int | required: false): The runtime after which event is called.
-              user (string | required: false): User to be notified.
-              webhook (map | required: false):
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              user (string): User to be notified.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              webhook (map):
                 name (string): Name of the webhook.
                 url (string): URL of the webhook.
                 payload (string): Webhook payload.
+            - events (map):
+                success (boolean | required: false): Whether to call event on success.
+                fail (boolean | required: false): Whether to call event on failure.
+                runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+              email (map):
+                name (string): Name of the email watcher.
+                recipients (map):
+                    to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
         retryOptions (map | required: false): # Workflow level retry options which will be applied to all steps.
             duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
             exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
@@ -599,7 +657,7 @@ def list_workflows(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak workflows list --page-size 10 --page-number 1 --workflow_status "Draft" --last_execution_status "Success" --last_modified_by "abc@peak.ai" --name "test"
+    peak workflows list --page-size 10 --page-number 1 --workflow-status "Draft" --last-execution-status "Success" --last-modified-by "abc@peak.ai" --name "test"
     ```
 
     \b
@@ -847,6 +905,8 @@ def list_executions(
     workflow_id: int = _WORKFLOW_ID,
     date_from: Optional[str] = args.DATE_FROM,
     date_to: Optional[str] = args.DATE_TO,
+    status: Optional[List[str]] = _EXECUTION_STATUS,
+    count: Optional[int] = _COUNT,
     page_size: Optional[int] = args.PAGE_SIZE,
     page_number: Optional[int] = args.PAGE_NUMBER,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
@@ -857,7 +917,7 @@ def list_executions(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak workflows list-executions 9999 --page-size 10 --page-number 1
+    peak workflows list-executions 9999 --page-size 10 --page-number 1 --status "Running" --status "Failed"
     ```
 
     \b
@@ -882,6 +942,8 @@ def list_executions(
             workflow_id=workflow_id,
             date_from=date_from,
             date_to=date_to,
+            status=parse_list_of_strings(status),
+            count=count,
             page_size=page_size,
             page_number=page_number,
             return_iterator=False,
@@ -974,7 +1036,7 @@ def get_execution_logs(
                 writer.write(response)
                 break
 
-            next_token = response["nextToken"] if "nextToken" in response else None
+            next_token = response.get("nextToken", None)
 
 
 @app.command(short_help="Get workflow execution details.", options_metavar="get_execution_details")

peak/cli/ruff.toml

@@ -1,11 +1,13 @@
 extend = '../../pyproject.toml'
 src = ["."]
-ignore = [
+lint.ignore = [
   "UP007", # typer is not PEP-585 and PEP-604 compliant
   "D208",
   "FBT001",
   "FBT002",
   "FBT003",
-  "RSE102"
+  "RSE102",
+  "FA100"
+  # TODO: remove this once we are supporting > 3.10 properly
 ]
-unfixable = []
+lint.unfixable = []

peak/compression.py

@@ -65,7 +65,7 @@ def compress(path: str, ignore_files: Optional[list[str]] = None) -> Iterator[te
                     raise exceptions.FileLimitExceededException(constants.MAX_ARTIFACT_SIZE_MB)
 
             # include directories as API backend need directories explicitly included
-            relative_root_path = Path(".")
+            relative_root_path = Path()
             if relative_root_path in parent_directories:
                 parent_directories.remove(relative_root_path)
             for directory in parent_directories:
@@ -192,7 +192,7 @@ def _build_files_dict(files: Iterable[str]) -> dict[str, dict]:  # type: ignore[
     """
     files_dict: dict[str, dict] = {}  # type: ignore[type-arg]
     for f in files:
-        components = os.path.normpath(f).split(os.sep)
+        components = Path(os.path.normpath(f)).parts
         current_dir = files_dict
         for directory in components[:-1]:
             if directory not in current_dir:

peak/exceptions.py

@@ -29,13 +29,11 @@ from typing import Any, ClassVar, Dict, List, Optional, Tuple, Type
 class PeakBaseException(Exception):
     """Base exception class for the Peak SDK."""
 
-    ...
-
 
 class HttpExceptionsRegistryMeta(type):
     """Registry metaclass."""
 
-    REGISTRY: Dict[int, Any] = defaultdict(lambda: Exception)
+    REGISTRY: ClassVar[Dict[int, Any]] = defaultdict(lambda: Exception)
 
     def __new__(
         cls: "Type[HttpExceptionsRegistryMeta]",
@@ -58,7 +56,7 @@ class HttpExceptionsRegistryMeta(type):
             HttpExceptionsRegistryMeta: the child class itself, forward annotated for type checking
         """
         new_cls: "HttpExceptionsRegistryMeta" = type.__new__(cls, name, bases, attrs)
-        status_code: Optional[int] = attrs.get("STATUS_CODE", None)
+        status_code: Optional[int] = attrs.get("STATUS_CODE")
         if status_code:
             cls.REGISTRY[status_code] = new_cls
         return new_cls
@@ -148,11 +146,11 @@ class MissingEnvironmentVariableException(PeakBaseException):
 class FileLimitExceededException(PeakBaseException):
     """Limits on the file are exceeded."""
 
-    def __init__(self, max_size: int | float, *, message: str = "", units: str = "MB") -> None:
+    def __init__(self, max_size: float, *, message: str = "", units: str = "MB") -> None:
         """Throw exception with custom message.
 
         Args:
-            max_size (int): Maximum size of the file.
+            max_size (float): Maximum size of the file.
             message (str): Additional message to add to exception.
             units (str): Units of the maximum size.
         """

peak/handler.py

@@ -51,7 +51,7 @@ writer = Writer(ignore_debug_mode=True)
 class HandlerRegistryMeta(type):
     """Metaclass for registering all types of Handler classes."""
 
-    REGISTRY: Dict[ContentType, BaseHandler] = {}
+    REGISTRY: ClassVar[Dict[ContentType, BaseHandler]] = {}
 
     def __new__(
         cls: "Type[HandlerRegistryMeta]",
@@ -79,7 +79,7 @@ class HandlerRegistryMeta(type):
         error_invalid_content_type: str = f"Invalid content type for {name} handler"
         new_cls: "HandlerRegistryMeta" = type.__new__(cls, name, bases, attrs)
 
-        content_type: Optional[ContentType] = attrs.get("CONTENT_TYPE", None)
+        content_type: Optional[ContentType] = attrs.get("CONTENT_TYPE")
         try:
             if content_type and ContentType(content_type):
                 cls.REGISTRY[content_type] = new_cls()
@@ -92,14 +92,12 @@ class HandlerRegistryMeta(type):
 class _CombinedMeta(HandlerRegistryMeta, ABCMeta):
     """Utility class for combining multiple meta-classes."""
 
-    ...
-
 
 class AuthRetrySession(requests.Session):
     """Session with extra sugar attached."""
 
     # used in testing, so we can modify the backoff_factor etc. to speed up the tests
-    _DEFAULT_RETRY_CONFIG: Dict[str, Any] = {
+    _DEFAULT_RETRY_CONFIG: ClassVar[Dict[str, Any]] = {
         "backoff_factor": 2,
         "total": 5,
         "status_forcelist": [500, 502, 503, 504],

peak/helpers.py

@@ -44,7 +44,7 @@ def parse_body_for_multipart_request(body: Dict[str, Any]) -> Dict[str, str]:
     Returns:
         Dict[str, str]: the parsed object
     """
-    return {key: (value if type(value) == str else json.dumps(value)) for (key, value) in body.items()}
+    return {key: (value if isinstance(value, str) else json.dumps(value)) for (key, value) in body.items()}
 
 
 def remove_keys(body: Dict[str, Any], keys: List[str]) -> Dict[str, Any]:
@@ -76,8 +76,7 @@ def get_base_domain(stage: str, subdomain: Optional[str] = "service") -> str:
         stage = "dev"
 
     domain: str = f"https://{subdomain}.{stage}.peak.ai"
-    domain = domain.replace("..", ".")  # for prod domain
-    return domain
+    return domain.replace("..", ".")  # for prod domain
 
 
 def parse_list_of_strings(param: List[str] | None) -> List[str] | None:
@@ -113,7 +112,7 @@ def snake_case_to_lower_camel_case(snake_case_string: str) -> str:
 
 
 def variables_to_dict(*args: Any, frame: FrameType | None = None) -> Dict[str, str]:
-    """Converts arbitary variables to a dictonary.
+    """Converts arbitrary variables to a dictionary.
 
     Args:
         args (str|int): tuple of string|int variables
@@ -143,11 +142,11 @@ def combine_dictionaries(
     dict2: Dict[str, Any],
     nested_keys_to_skip: Optional[List[str]] = [],  # noqa: B006
 ) -> Dict[str, Any]:
-    """Combines two dictonaries. Values for second dictonary have higer precedence.
+    """Combines two dictionaries. Values for second dictionary have higher precedence.
 
     Args:
         dict1 (Dict[str, Any]): dictionary 1
-        dict2 (Dict[str, Any]): dictonary 2
+        dict2 (Dict[str, Any]): dictionary 2
         nested_keys_to_skip (List[str] | None): Keys for which nested combining is not required.
 
     Returns:
@@ -158,7 +157,7 @@ def combine_dictionaries(
 
     combined_dict = dict(dict1)
     for key in dict2:
-        if key in combined_dict and type(combined_dict[key]) is dict and key not in (nested_keys_to_skip or []):
+        if key in combined_dict and isinstance(combined_dict[key], dict) and key not in (nested_keys_to_skip or []):
             combined_dict[key] = combine_dictionaries(combined_dict[key], dict2[key])
         else:
             combined_dict[key] = dict2[key]
@@ -178,12 +177,12 @@ def map_user_options(
         dict_type_keys (List[str]): List of keys which have json type values
 
     Returns:
-        Dict[str, str]: Mappe dictionary
+        Dict[str, str]: Mapped dictionary
     """
     result: Dict[str, Any] = {}
     for key in user_options:
         if key in mapping:
-            nested_dict = result[mapping[key]] if mapping[key] in result else {}
+            nested_dict = result.get(mapping[key], {})
             nested_dict[key] = json.loads(user_options[key]) if key in dict_type_keys else user_options[key]
             result[mapping[key]] = nested_dict
         else:

peak/output.py

@@ -105,7 +105,7 @@ class Writer:
         title = params["title"]
 
         if "subheader_key" in params and params["subheader_key"] in data:
-            subheader_title = "Total" if "subheader_title" not in params else params["subheader_title"]
+            subheader_title = params.get("subheader_title", "Total")
             title = f'{title} ({subheader_title} = {data[params["subheader_key"]]})'
 
         table = Table(
@@ -135,7 +135,7 @@ class Writer:
                 elif "parser" in key_details[1]:
                     v = key_details[1]["parser"](v)
 
-                if isinstance(v, (dict, list)):  # noqa: UP038
+                if isinstance(v, (dict, list)):
                     parsed_value = json_highlighter(Text(json.dumps(v, indent=2), overflow="fold"))
                 else:
                     parsed_value = Text(str(v), overflow="fold")

peak/press/apps.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Apps client module."""
+
 from __future__ import annotations
 
 import json
@@ -48,8 +49,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_specs(
@@ -64,8 +64,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_specs(
         self,
@@ -153,7 +152,8 @@ class App(BaseClient):
 
         All App Specs must have unique names within a tenant.
         An App Spec must now be made up of already existing block specs.
-        Spec details (specId and release) needs to be added in the spec body inside `config` key.
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
 
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs_>`__
@@ -198,7 +198,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ]
                 }
@@ -321,6 +322,9 @@ class App(BaseClient):
     def create_spec_release(self, spec_id: str, body: Dict[str, Any]) -> Dict[str, str]:
         """Publish a new release to an existing App spec.
 
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
+
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs__specId__releases>`__
 
@@ -340,7 +344,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ],
                     "release": {
@@ -440,8 +445,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_spec_releases(
@@ -452,8 +456,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_spec_releases(
         self,
@@ -595,8 +598,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_deployments(
@@ -608,8 +610,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_deployments(
         self,
@@ -844,8 +845,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_deployment_revisions(
@@ -857,8 +857,7 @@ class App(BaseClient):
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_deployment_revisions(
         self,