peak-sdk 1.6.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

peak/cli/resources/services.py

@@ -107,7 +107,7 @@ MAPPING = {
 }
 
 
-@app.command("list", short_help="List services.", options_metavar="list_services")
+@app.command("list", short_help="List services.")
 def list_services(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -155,7 +155,7 @@ def list_services(
         writer.write(response)
 
 
-@app.command(short_help="Create a new service.", options_metavar="create_service")
+@app.command(short_help="Create a new service.")
 def create(
     ctx: typer.Context,
     file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
@@ -267,7 +267,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Update an existing service.", options_metavar="update_service")
+@app.command(short_help="Update an existing service.")
 def update(
     ctx: typer.Context,
     service_id: str = _SERVICE_ID,
@@ -383,7 +383,6 @@ def update(
 
 @app.command(
     short_help="Create a new service or Update an existing service.",
-    options_metavar="create_or_update_service",
 )
 def create_or_update(
     ctx: typer.Context,
@@ -502,7 +501,7 @@ def create_or_update(
     writer.write(response)
 
 
-@app.command(short_help="Delete an existing service.", options_metavar="delete_service")
+@app.command(short_help="Delete an existing service.")
 def delete(
     ctx: typer.Context,
     service_id: str = _SERVICE_ID,
@@ -536,7 +535,7 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a service.", options_metavar="describe_service")
+@app.command(short_help="Describe details of a service.")
 def describe(
     ctx: typer.Context,
     service_id: str = _SERVICE_ID,
@@ -588,7 +587,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Test API type service", options_metavar="test_service")
+@app.command(short_help="Test API type service")
 def test(
     ctx: typer.Context,
     service_name: str = _SERVICE_NAME,

peak/cli/resources/tenants.py

@@ -32,13 +32,15 @@ app = typer.Typer(
     short_help="Create and manage Tenant Settings.",
 )
 
-_ENTITY_TYPE = typer.Option(..., help="Entity type to be used in this operation (e.g. - feed, workflow).")
+_ENTITY_TYPE = typer.Option(
+    ...,
+    help="Entity type to be used in this operation (e.g. - `workflow`, `webapp`, `api-deployment`).",
+)
 
 
 @app.command(
     "list-instance-options",
     short_help="List tenant instance options.",
-    options_metavar="list_tenant_instance_options",
 )
 def list_instance_options(
     ctx: typer.Context,

peak/cli/resources/users.py

@@ -24,7 +24,7 @@ from typing import Optional
 import typer
 from peak import Session
 from peak.cli.args import OUTPUT_TYPES, PAGING
-from peak.constants import OutputTypesNoTable
+from peak.constants import OutputTypes, OutputTypesNoTable
 from peak.output import Writer
 from peak.resources import users
 
@@ -41,7 +41,7 @@ _AUTH_TOKEN = typer.Option(
 )
 
 
-@app.command(short_help="Check user permission for a specific feature.", options_metavar="check_permission")
+@app.command(short_help="Check user permission for a specific feature.")
 def check_permission(
     ctx: typer.Context,
     feature: str = _FEATURE,
@@ -68,4 +68,4 @@ def check_permission(
 
     with writer.pager():
         response = user_client.check_permissions({feature: action})
-        writer.write(response.get(feature, False))
+        writer.write(response.get(feature, False), output_type=OutputTypes.json)

peak/cli/resources/webapps.py

@@ -84,7 +84,7 @@ MAPPING = {"imageId": "imageDetails", "versionId": "imageDetails", "instanceType
 DEPRECATION_MESSAGE = "The Web App commands are deprecated and will eventually be removed. We recommend using the Service feature which offers a more comprehensive and flexible solution for managing web applications and API deployments.\n"
 
 
-@app.command("list", short_help="List webapps.", options_metavar="list_webapps")
+@app.command("list", short_help="List webapps.")
 def list_webapps(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -138,7 +138,7 @@ def list_webapps(
         writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
-@app.command(short_help="Create a new webapp.", options_metavar="create_webapp")
+@app.command(short_help="Create a new webapp.")
 def create(
     ctx: typer.Context,
     file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
@@ -229,7 +229,7 @@ def create(
         writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
-@app.command(short_help="Update an existing webapp.", options_metavar="update_webapp")
+@app.command(short_help="Update an existing webapp.")
 def update(
     ctx: typer.Context,
     webapp_id: str = _WEBAPP_ID,
@@ -322,7 +322,7 @@ def update(
         writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
-@app.command(short_help="Create a new webapp or Update an existing webapp.", options_metavar="create_or_update_webapp")
+@app.command(short_help="Create a new webapp or Update an existing webapp.")
 def create_or_update(
     ctx: typer.Context,
     file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
@@ -415,7 +415,7 @@ def create_or_update(
     writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
-@app.command(short_help="Delete an existing webapp.", options_metavar="delete_webapp")
+@app.command(short_help="Delete an existing webapp.")
 def delete(
     ctx: typer.Context,
     webapp_id: str = _WEBAPP_ID,
@@ -457,7 +457,7 @@ def delete(
         writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
-@app.command(short_help="Describe details of a webapp.", options_metavar="describe_webapp")
+@app.command(short_help="Describe details of a webapp.")
 def describe(
     ctx: typer.Context,
     webapp_id: str = _WEBAPP_ID,

peak/cli/resources/workflows.py

@@ -93,7 +93,7 @@ _COUNT = typer.Option(
 )
 
 
-@app.command(short_help="Create a new workflow.", options_metavar="create_workflow")
+@app.command(short_help="Create a new workflow.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
@@ -119,12 +119,12 @@ 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.
+                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 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.
@@ -132,7 +132,7 @@ def create(
                 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 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.
@@ -216,7 +216,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Update an existing workflow.", options_metavar="update_workflow")
+@app.command(short_help="Update an existing workflow.")
 def update(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -243,12 +243,12 @@ 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.
+                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 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.
@@ -256,7 +256,7 @@ def update(
                 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 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.
@@ -342,7 +342,6 @@ def update(
 
 @app.command(
     short_help="Create a new workflow or Update an existing workflow.",
-    options_metavar="create_or_update_workflow",
 )
 def create_or_update(
     ctx: typer.Context,
@@ -367,12 +366,12 @@ 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.
+                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 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.
@@ -380,7 +379,7 @@ def create_or_update(
                 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 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.
@@ -464,7 +463,7 @@ def create_or_update(
         writer.write(response)
 
 
-@app.command(short_help="Update required fields of an existing workflow.", options_metavar="patch_workflow")
+@app.command(short_help="Update required fields of an existing workflow.")
 def patch(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -521,12 +520,12 @@ 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.
+                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 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.
@@ -534,7 +533,7 @@ def patch(
                 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 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.
@@ -640,7 +639,7 @@ def patch(
         writer.write(response)
 
 
-@app.command("list", short_help="List workflows.", options_metavar="list_workflows")
+@app.command("list", short_help="List workflows.")
 def list_workflows(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -690,7 +689,7 @@ def list_workflows(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a workflow.", options_metavar="describe_workflow")
+@app.command(short_help="Describe details of a workflow.")
 def describe(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -734,7 +733,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Delete a workflow.", options_metavar="delete_workflow")
+@app.command(short_help="Delete a workflow.")
 def delete(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -766,7 +765,7 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Start a workflow run.", options_metavar="execute_workflow")
+@app.command(short_help="Start a workflow run.")
 def execute(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -828,7 +827,7 @@ def execute(
         writer.write(response)
 
 
-@app.command(short_help="List all available resources.", options_metavar="list_workflow_resources")
+@app.command(short_help="List all available resources.")
 def list_resources(
     ctx: typer.Context,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
@@ -866,7 +865,7 @@ def list_resources(
         writer.write(response)
 
 
-@app.command(short_help="List default resources.", options_metavar="list_workflow_default_resources")
+@app.command(short_help="List default resources.")
 def list_default_resources(
     ctx: typer.Context,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
@@ -899,7 +898,7 @@ def list_default_resources(
         writer.write(response)
 
 
-@app.command(short_help="List executions for the given workflow.", options_metavar="list_workflow_executions")
+@app.command(short_help="List executions for the given workflow.")
 def list_executions(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -951,7 +950,7 @@ def list_executions(
         writer.write(response)
 
 
-@app.command(short_help="Get workflow execution logs.", options_metavar="get_execution_logs")
+@app.command(short_help="Get workflow execution logs.")
 def get_execution_logs(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID_OPTION,
@@ -1039,7 +1038,7 @@ def get_execution_logs(
             next_token = response.get("nextToken", None)
 
 
-@app.command(short_help="Get workflow execution details.", options_metavar="get_execution_details")
+@app.command(short_help="Get workflow execution details.")
 def get_execution_details(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID_OPTION,

peak/compression.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Compression module to create zip file to be used as artifact."""
+
 from __future__ import annotations
 
 import contextlib
@@ -26,7 +27,7 @@ import os
 import tempfile
 import zipfile
 from pathlib import Path
-from typing import Iterable, Iterator, Optional, Set
+from typing import Any, Dict, Iterable, Iterator, Optional, Set
 
 from pathspec import PathSpec
 
@@ -163,7 +164,7 @@ def _load_ignore_patterns(path_obj: Path, ignore_files: Optional[list[str]]) ->
 
 
 def print_file_tree(files: Iterable[str]) -> None:
-    """Prints list of files in tree format.
+    """Prints list of files in tree format with specific limits per level.
 
     Args:
         files (list[str]): List of file paths
@@ -171,33 +172,47 @@ def print_file_tree(files: Iterable[str]) -> None:
     writer = output.Writer(ignore_debug_mode=True)
     files_dict = _build_files_dict(files)
 
-    def _print_tree(files_dict: dict[str, dict], indent: str) -> None:  # type: ignore[type-arg]
+    limits = {1: 100, 2: 100, 3: 50}
+    default_limit = 25
+
+    def _print_tree(files_dict: Dict[str, Any], indent: str, level: int) -> None:
+        limit = limits.get(level, default_limit)
+        count = 0
+
+        for key, value in files_dict.items():
+            if isinstance(value, dict):
+                writer.write(f"{indent}{key}/")
+                new_indent = indent + ("|   " if indent else "├── ")
+                _print_tree(value, new_indent, level + 1)
+
         for key, value in files_dict.items():
-            writer.write(f"{indent}{key}")
-            if value:
-                new_indent = "|   " if indent else "├── "
-                _print_tree(value, new_indent + indent)
+            if not isinstance(value, dict):
+                if count >= limit:
+                    writer.write(f"{indent}...")
+                    break
+                writer.write(f"{indent}{key}")
+                count += 1
 
-    _print_tree(files_dict, "")
+    _print_tree(files_dict, "", 1)
 
 
-def _build_files_dict(files: Iterable[str]) -> dict[str, dict]:  # type: ignore[type-arg]
+def _build_files_dict(files: Iterable[str]) -> Dict[str, Any]:
     """Builds a nested dictionary from list of files.
 
     Args:
         files (list[str]): List of file paths to process.
 
     Returns:
-        dict[str, dict]: Nested dict file tree structure.
+        dict[str, Any]: Nested dict file tree structure.
     """
-    files_dict: dict[str, dict] = {}  # type: ignore[type-arg]
+    files_dict: Dict[str, Any] = {}
     for f in files:
         components = Path(os.path.normpath(f)).parts
         current_dir = files_dict
         for directory in components[:-1]:
-            if directory not in current_dir:
+            if directory not in current_dir or current_dir[directory] is None:
                 current_dir[directory] = {}
             current_dir = current_dir[directory]
         if components[-1] not in current_dir:
-            current_dir[components[-1]] = {}
+            current_dir[components[-1]] = None
     return files_dict

peak/exceptions.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Exceptions for the Peak API."""
+
 from __future__ import annotations
 
 from collections import defaultdict
@@ -103,6 +104,17 @@ class PayloadTooLargeException(BaseHttpException):
 
     STATUS_CODE = 413
 
+    def __init__(self, message: str = "") -> None:
+        """Throw exception with custom message.
+
+        Args:
+            message (str): Additional message to add to exception.
+        """
+        error_message: str = (
+            "Please use '--dry-run' with your command to preview the file tree and optimize the file contents."
+        )
+        super().__init__(f"{message}. {error_message}")
+
 
 class UnprocessableEntityException(BaseHttpException):
     """The server understands the request, but it was unable to process the contained instructions."""
@@ -154,7 +166,9 @@ class FileLimitExceededException(PeakBaseException):
             message (str): Additional message to add to exception.
             units (str): Units of the maximum size.
         """
-        error_message: str = f"Compressed directory size is over {max_size}{units}."
+        error_message: str = (
+            f"Compressed directory size is over {max_size}{units}. Please use '--dry-run' with your command to preview the file tree and optimize the file contents."
+        )
         super().__init__(f"{error_message} {message}")
 
 

peak/handler.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Handler for sending requests to the API."""
+
 from __future__ import annotations
 
 import contextlib
@@ -35,7 +36,7 @@ from urllib3.util import Retry
 import peak.config
 from peak.compression import compress, get_files_to_include, print_file_tree
 from peak.constants import ContentType, HttpMethods
-from peak.exceptions import BaseHttpException
+from peak.exceptions import BaseHttpException, PayloadTooLargeException
 from peak.output import Writer
 from peak.telemetry import telemetry
 from peak.validators import check_file_size
@@ -200,6 +201,9 @@ class HandlerUtils(AuthRetrySession):
         if 200 <= response.status_code < 300:  # noqa: PLR2004
             return response
 
+        if response.status_code == 413:  # noqa: PLR2004
+            raise PayloadTooLargeException(response.json().get("detail", ""))
+
         raise BaseHttpException.REGISTRY[response.status_code](response.json())
 
 

peak/helpers.py

@@ -20,10 +20,12 @@
 #
 
 """Collection of basic helper functions."""
+
 from __future__ import annotations
 
 import inspect
 import json
+import re
 from datetime import datetime, timezone
 from types import FrameType
 from typing import Any, Dict, List, Optional
@@ -205,6 +207,42 @@ def remove_none_values(data: Any) -> Dict[str, Any]:
     return data  # type: ignore[no-any-return]
 
 
+def convert_to_snake_case(s: str) -> str:
+    """Converts a given string from camelCase or TitleCase to snake case.
+
+    Args:
+        s (str): The string to be converted.
+
+    Returns:
+        str: The converted string in snake case.
+    """
+    return re.sub(r"(?<!^)(?=[A-Z])", "_", s).lower()
+
+
+def convert_keys_to_snake_case(data: Dict[str, Any], *, convert_nested: bool = False) -> Dict[str, Any]:
+    """Converts keys of a dictionary to snake case.
+
+    Args:
+        data (Dict[str, Any]): Dictionary to be converted.
+        convert_nested (bool): Whether to convert nested keys as well. Default is False.
+
+    Returns:
+        Dict[str, Any]: Dictionary with keys converted to snake case.
+    """
+
+    def convert_dict(d: Dict[str, Any]) -> Dict[str, Any]:
+        new_dict = {}
+        for k, v in d.items():
+            new_key = convert_to_snake_case(k)
+            if convert_nested and isinstance(v, dict):
+                new_dict[new_key] = convert_dict(v)
+            else:
+                new_dict[new_key] = v
+        return new_dict
+
+    return convert_dict(data)
+
+
 def format_date(timestamp: str, time_format: str = "%Y/%m/%d %H:%M:%S") -> str:
     """Format a timestamp to a given format.
 

peak/output.py

@@ -56,6 +56,7 @@ class Writer:
         self,
         data: Any,
         deprecation_message: str | None = None,
+        output_type: OutputTypes | None = None,
     ) -> None:
         """Write logs to the terminal.
 
@@ -63,27 +64,33 @@ class Writer:
             data (Any): Data to be printed on the terminal.
                 This handles dry-run, debug mode and exit code for the CLI.
             deprecation_message (str, optional): Deprecation message to be printed on the terminal.
+            output_type (OutputTypes, optional): Override for the output type set in the config.
         """
-        output_type = config.OUTPUT_TYPE
+        output_type_parsed = output_type or config.OUTPUT_TYPE
         table_params = config.TABLE_PARAMS
 
         if not config.DEBUG_MODE or self.ignore_debug_mode:
             if deprecation_message:
                 self._print_deprecation_warning(deprecation_message)
-            if output_type == OutputTypes.yaml.value:
+            if output_type_parsed == OutputTypes.yaml.value:
                 self.__yaml(data)
-            elif output_type == OutputTypes.table.value:
+            elif output_type_parsed == OutputTypes.table.value:
                 self.__table(data, table_params)
             else:
-                self.__json(data)
+                self.__json(data, output_type)
 
-    def __json(self, data: Any) -> None:
+    def __json(self, data: Any, output_type: OutputTypes | None = None) -> None:
         """Write logs to the terminal in JSON format.
 
         Args:
             data (Any): Data to be printed on the terminal.
+            output_type (OutputTypes): If passed, JSON parser would be used to print output
+                even if the data is not a dictionary.
         """
-        console.print(data)
+        if isinstance(data, dict) or output_type == OutputTypes.json:
+            console.print_json(data=data)
+        else:
+            console.print(data)
 
     def __table(self, data: dict[Any, Any], params: dict[str, Any]) -> None:
         """Write logs to the terminal in a tabular format.