peak-sdk 1.11.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

peak/cli/press/apps/deployments.py

@@ -66,10 +66,13 @@ def create(
             imageUrl (string | required: false): URL of the image to be associated with the app deployment.
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of parameters for the block. Here the key is the name of the block.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -348,10 +351,13 @@ def create_revision(
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
       body (map):
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of blocks within the app, for which to provide parameters. Must be a valid block name.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the app spec.
         revision (map | required: false):

peak/cli/press/apps/specs.py

@@ -76,6 +76,16 @@ def create(
               release (map):
                 version (string): A valid semantic release version of the block spec.
               autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
+      parameters (map | required: false):
+        <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
+            name (string): Name of the parameter.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b
@@ -332,6 +342,16 @@ def create_release(
               release (map):
                 version (string): A valid semantic release version of the block spec.
               autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
+      parameters (map | required: false):
+        <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
+            name (string): Name of the parameter.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b

peak/cli/press/blocks/deployments.py

@@ -75,8 +75,8 @@ def create(
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -362,8 +362,8 @@ def create_revision(
     ```yaml
       body (map):
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the block spec.
         revision (map | required: false):
@@ -550,8 +550,7 @@ def patch_parameters(
     \b
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
-    body (map):
-        <key> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
     ```
 
     \b

peak/cli/press/blocks/specs.py

@@ -330,6 +330,7 @@ def create(
                 env (map | required: false): Key-Value pair where key is the name of the env.
                 secrets (list(str) | required: false): List of secret names to be passed.
             sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            scaleToZero (boolean | required: false): Enable scale to zero for the service. Only applicable for web-app type services. Default value is false. Enabling Scale to zero ensures that the resources hosting your app are scaled down when ideal over a period of time. The resources will scale back up automatically on next launch.
             entrypoint (string | required: false): Entry point for the service.
             healthCheckURL (string | required: false): URL to check the health of the service.
             minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
@@ -748,6 +749,7 @@ def create_release(
                 env (map | required: false): Key-Value pair where key is the name of the env.
                 secrets (list(str) | required: false): List of secret names to be passed.
             sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            scaleToZero (boolean | required: false): Enable scale to zero for the service. Only applicable for web-app type services. Default value is false. Enabling Scale to zero ensures that the resources hosting your app are scaled down when ideal over a period of time. The resources will scale back up automatically on next launch.
             entrypoint (string | required: false): Entry point for the service.
             healthCheckURL (string | required: false): URL to check the health of the service.
             minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.

peak/cli/press/deployments.py

@@ -23,9 +23,9 @@
 from typing import List, Optional
 
 import typer
-from peak.cli import args
-from peak.cli.args import OUTPUT_TYPES, PAGING
-from peak.constants import OutputTypes
+from peak.cli import args, helpers
+from peak.cli.args import DRY_RUN, GENERATE_YAML, OUTPUT_TYPES, PAGING
+from peak.constants import OutputTypes, OutputTypesNoTable
 from peak.output import Writer
 from peak.press.deployments import Deployment
 from rich.console import Console
@@ -36,6 +36,8 @@ app = typer.Typer(
 )
 console = Console()
 
+_DEPLOYMENT_ID = typer.Argument(..., help="ID of the Block deployment to be used in this operation")
+
 
 @app.command("list", short_help="List App and Block deployments.")
 def list_deployments(
@@ -123,3 +125,47 @@ def execute_resources(
     with writer.pager():
         response = deployment_client.execute_resources(deployment_id)
         writer.write(response)
+
+
+@app.command(short_help="Update the parameters for a deployment at run time.")
+def patch_parameters(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+    generate: Optional[bool] = GENERATE_YAML,  # noqa: ARG001
+) -> None:
+    """***Update*** the parameters for a deployment at run time.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak deployments patch-parameters <deployment-id> /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {...}
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v1_deployments__deploymentId__parameters_run)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    deployments_client: Deployment = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, deployments_client.patch_parameters)
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployments_client.patch_parameters(deployment_id, **body)
+        writer.write(response)

peak/cli/resources/services.py

@@ -79,6 +79,11 @@ SESSION_STICKINESS = typer.Option(
     help="Enable session stickiness for the service. Not required for API type services.",
 )
 
+SCALE_TO_ZERO = typer.Option(
+    None,
+    help="Enable scale to zero for the service. Only applicable for web-app type services.",
+)
+
 _ENVS = typer.Option(None, help="List of plain text environment variables in the format arg1=value1.")
 
 _SECRETS = typer.Option(None, help="List of secret names to be passed as environment variables.")
@@ -168,6 +173,7 @@ def create(
     version_id: int = VERSION_ID,
     instance_type_id: int = INSTANCE_TYPE_ID,
     session_stickiness: bool = SESSION_STICKINESS,
+    scale_to_zero: bool = SCALE_TO_ZERO,
     service_type: Optional[str] = _SERVICE_TYPE,
     env: Optional[List[str]] = _ENVS,
     secrets: Optional[List[str]] = _SECRETS,
@@ -198,6 +204,7 @@ def create(
             env (map | required: false): Key-Value pair where key is the name of the env.
             secrets (list(str) | required: false): List of secret names to be passed.
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
+        scaleToZero (boolean | required: false): Enable scale to zero for the service. Only applicable for web-app type services. Default value is false. Enabling Scale to zero ensures that the resources hosting your app are scaled down when ideal over a period of time. The resources will scale back up automatically on next launch.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
         minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
@@ -212,7 +219,7 @@ def create(
     \b
     📝 ***Example usage without yaml:***
     ```bash
-    peak services create --name <name> --title <title> --description <description> --service-type web-app --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --session-stickiness
+    peak services create --name <name> --title <title> --description <description> --service-type web-app --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --scale-to-zero
     ```
 
     \b
@@ -236,6 +243,7 @@ def create(
         version_id,
         instance_type_id,
         session_stickiness,
+        scale_to_zero,
         service_type,
         env,
         secrets,
@@ -280,6 +288,7 @@ def update(
     version_id: int = VERSION_ID,
     instance_type_id: int = INSTANCE_TYPE_ID,
     session_stickiness: bool = SESSION_STICKINESS,
+    scale_to_zero: bool = SCALE_TO_ZERO,
     env: Optional[List[str]] = _ENVS,
     secrets: Optional[List[str]] = _SECRETS,
     entrypoint: Optional[str] = _ENTRYPOINT,
@@ -294,7 +303,7 @@ def update(
 
     \b
     When updating the service, it will trigger a redeployment only under specific conditions.
-    Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, env, secrets or sessionStickiness.
+    Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, env, secrets, scaleToZero or sessionStickiness.
     However, only modifying the title or description will not trigger a redeployment.
 
     With the help of this operation, we can just update the required fields (except name and serviceType) and keep the rest of the fields as it is.
@@ -314,6 +323,7 @@ def update(
             env (map | required: false): Key-Value pair where key is the name of the env.
             secrets (list(str) | required: false): List of secret names to be passed.
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
+        scaleToZero (boolean | required: false): Enable scale to zero for the service. Only applicable for web-app type services. Default value is false. Enabling Scale to zero ensures that the resources hosting your app are scaled down when ideal over a period of time. The resources will scale back up automatically on next launch.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
         minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
@@ -328,7 +338,7 @@ def update(
      \b
     📝 ***Example usage without yaml:***
     ```bash
-    peak services update <service-id> --title <title> --description <description> --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --session-stickiness
+    peak services update <service-id> --title <title> --description <description> --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --scale-to-zero
     ```
 
     \b
@@ -351,6 +361,7 @@ def update(
         version_id,
         instance_type_id,
         session_stickiness,
+        scale_to_zero,
         env,
         secrets,
         entrypoint,
@@ -396,6 +407,7 @@ def create_or_update(
     version_id: int = VERSION_ID,
     instance_type_id: int = INSTANCE_TYPE_ID,
     session_stickiness: bool = SESSION_STICKINESS,
+    scale_to_zero: bool = SCALE_TO_ZERO,
     service_type: Optional[str] = _SERVICE_TYPE,
     env: Optional[List[str]] = _ENVS,
     secrets: Optional[List[str]] = _SECRETS,
@@ -411,7 +423,7 @@ def create_or_update(
 
     \b
     When updating the service, it will trigger a redeployment only under specific conditions.
-    Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, env, secrets or sessionStickiness.
+    Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, env, secrets, scaleToZero or sessionStickiness.
     However, only modifying the title or description will not trigger a redeployment.
 
     \b
@@ -431,6 +443,7 @@ def create_or_update(
             env (map | required: false): Key-Value pair where key is the name of the env.
             secrets (list(str) | required: false): List of secret names to be passed.
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
+        scaleToZero (boolean | required: false): Enable scale to zero for the service. Only applicable for web-app type services. Default value is false. Enabling Scale to zero ensures that the resources hosting your app are scaled down when ideal over a period of time. The resources will scale back up automatically on next launch.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
         minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
@@ -445,7 +458,7 @@ def create_or_update(
     \b
     📝 ***Example usage without yaml:***
     ```bash
-    peak services create-or-update --name <name> --title <title> --description <description> --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --session-stickiness
+    peak services create-or-update --name <name> --title <title> --description <description> --image-id <image-id> --version-id <version-id> --instance-type-id <instance-type-id> --scale-to-zero
     ```
 
     \b
@@ -471,6 +484,7 @@ def create_or_update(
         version_id,
         instance_type_id,
         session_stickiness,
+        scale_to_zero,
         service_type,
         env,
         secrets,
@@ -566,6 +580,7 @@ def describe(
             "instanceTypeId": 1
         },
         "sessionStickiness": false,
+        "scaleToZero": false,
         "createdAt": "2020-01-01T18:00:00.000Z",
         "createdBy": "someone@peak.ai",
         "updatedAt": "2020-01-01T18:00:00.000Z",

peak/handler.py

@@ -95,19 +95,20 @@ class _CombinedMeta(HandlerRegistryMeta, ABCMeta):
 
 
 class AuthRetrySession(requests.Session):
-    """Session with extra sugar attached."""
+    """Session with retries."""
 
-    # used in testing, so we can modify the backoff_factor etc. to speed up the tests
     _DEFAULT_RETRY_CONFIG: ClassVar[Dict[str, Any]] = {
         "backoff_factor": 2,
-        "total": 5,
-        "status_forcelist": [500, 502, 503, 504],
+        "total": 3,
+        "status_forcelist": [429, 500, 502, 503, 504],
+        "allowed_methods": ["GET", "POST", "PUT", "DELETE", "PATCH"],
     }
 
     def _add_retries(self, retry_config: Optional[Dict[str, Any]] = None) -> None:
         if retry_config is None:
             retry_config = self._DEFAULT_RETRY_CONFIG
         adapter = HTTPAdapter(max_retries=Retry(**retry_config))
+        self.mount("http://", adapter=adapter)
         self.mount("https://", adapter=adapter)
 
 
@@ -204,7 +205,11 @@ class HandlerUtils(AuthRetrySession):
         if response.status_code == 413:  # noqa: PLR2004
             raise PayloadTooLargeException(response.json().get("detail", ""))
 
-        raise BaseHttpException.REGISTRY[response.status_code](response.json())
+        error_response = response.text
+        with contextlib.suppress(Exception):
+            error_response = response.json()
+
+        raise BaseHttpException.REGISTRY[response.status_code](error_response)
 
 
 class BaseHandler(ABC, HandlerUtils, metaclass=_CombinedMeta):
@@ -261,9 +266,11 @@ class MultipartFormDataHandler(BaseHandler):
         Returns:
             requests.Response: response of the request
         """
+        self._add_retries()
+
         with self.make_artifact(path, self.parse_args(body or {}), ignore_files) as monitor:
             headers = {**headers, "Content-Type": monitor.content_type}
-            response: Any = getattr(requests, method.value)(url, data=monitor, headers=headers, **request_kwargs)
+            response: Any = getattr(self, method.value)(url, data=monitor, headers=headers, **request_kwargs)
         return self.handle_response(response)
 
 
@@ -299,8 +306,10 @@ class ApplicationJsonHandler(BaseHandler):
         Returns:
             requests.Response: response of the request.
         """
+        self._add_retries()
+
         headers = {**headers, "Content-Type": self.CONTENT_TYPE.value}
-        response: Any = getattr(requests, method.value)(
+        response: Any = getattr(self, method.value)(
             url,
             params=self.parse_args(params or {}),
             json=body,

peak/metrics/__init__.py

@@ -0,0 +1,26 @@
+#
+# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# #
+# # Licensed under the Apache License, Version 2.0 (the "License"). You
+# # may not use this file except in compliance with the License. A copy of
+# # the License is located at:
+# #
+# # https://github.com/PeakBI/peak-sdk/blob/main/LICENSE
+# #
+# # or in the "license" file accompanying this file. This file is
+# # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# # ANY KIND, either express or implied. See the License for the specific
+# # language governing permissions and limitations under the License.
+# #
+# # This file is part of the peak-sdk.
+# # see (https://github.com/PeakBI/peak-sdk)
+# #
+# # You should have received a copy of the APACHE LICENSE, VERSION 2.0
+# # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
+#
+"""This exports the `metrics` module from the `peak` package."""
+
+from peak.metrics import metrics
+from peak.metrics.metrics import Metric, get_client
+
+__all__ = ["metrics", "Metric", "get_client"]