truefoundry 0.5.7rc1__py3-none-any.whl → 0.5.8__py3-none-any.whl

truefoundry/cli/__main__.py

@@ -71,7 +71,7 @@ def truefoundry_cli(ctx, json, debug):
     logger.add_cli_handler(level=log_level)
 
 
-def create_truefoundry_cli() -> click.MultiCommand:
+def create_truefoundry_cli() -> click.Group:
     """Generates CLI by combining all subcommands into a main CLI and returns in
 
     Returns:
@@ -105,7 +105,7 @@ def main():
     try:
         cli = create_truefoundry_cli()
     except Exception as e:
-        raise click.exceptions.UsageError(message=str(e)) from e
+        raise click.UsageError(message=str(e)) from e
     sys.exit(cli())
 
 

truefoundry/common/credential_provider.py

@@ -38,7 +38,7 @@ class EnvCredentialProvider(CredentialProvider):
             )
         self._host = resolve_tfy_host()
         self._auth_service = AuthServiceClient.from_tfy_host(tfy_host=self._host)
-        self._token: Token = Token(access_token=api_key, refresh_token=None)  # type: ignore[call-arg]
+        self._token: Token = Token(access_token=api_key, refresh_token=None)
 
     @staticmethod
     def can_provide() -> bool:

truefoundry/common/entities.py

@@ -1,5 +1,4 @@
 import time
-from enum import Enum
 from typing import Optional
 
 import jwt
@@ -8,18 +7,12 @@ from typing_extensions import NotRequired, TypedDict
 from truefoundry.pydantic_v1 import BaseModel, Field, NonEmptyStr, validator
 
 
-class UserType(Enum):
-    user = "user"
-    serviceaccount = "serviceaccount"
-
-
 class UserInfo(BaseModel):
     class Config:
         allow_population_by_field_name = True
         allow_mutation = False
 
     user_id: NonEmptyStr
-    user_type: UserType = UserType.user
     email: Optional[str] = None
     tenant_name: NonEmptyStr = Field(alias="tenantName")
 
@@ -27,9 +20,16 @@ class UserInfo(BaseModel):
 class _DecodedToken(TypedDict):
     tenantName: str
     exp: int
-    username: str
+    username: NotRequired[str]
     email: NotRequired[str]
-    userType: UserType
+
+
+def _user_slug(decoded_token: _DecodedToken) -> str:
+    return (
+        decoded_token.get("username")
+        or decoded_token.get("email")
+        or "--user-slug-missing--"
+    )
 
 
 class Token(BaseModel):
@@ -55,19 +55,21 @@ class Token(BaseModel):
 
     @property
     def tenant_name(self) -> str:
+        assert self.decoded_value is not None
         return self.decoded_value["tenantName"]
 
     def is_going_to_be_expired(self, buffer_in_seconds: int = 120) -> bool:
+        assert self.decoded_value is not None
         exp = int(self.decoded_value["exp"])
         return (exp - time.time()) < buffer_in_seconds
 
     def to_user_info(self) -> UserInfo:
-        return UserInfo(  # type: ignore[call-arg]
-            user_id=self.decoded_value["username"],
+        assert self.decoded_value is not None
+        return UserInfo(
+            user_id=_user_slug(self.decoded_value),
             email=self.decoded_value["email"]
             if "email" in self.decoded_value
             else None,
-            user_type=UserType(self.decoded_value.get("userType", UserType.user.value)),
             tenant_name=self.tenant_name,
         )
 
@@ -81,9 +83,7 @@ class CredentialsFileContent(BaseModel):
     host: NonEmptyStr
 
     def to_token(self) -> Token:
-        return Token(  # type: ignore[call-arg]
-            access_token=self.access_token, refresh_token=self.refresh_token
-        )
+        return Token(access_token=self.access_token, refresh_token=self.refresh_token)
 
 
 class TenantInfo(BaseModel):

truefoundry/common/servicefoundry_client.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
 import functools
+from typing import Callable, TypeVar
 
 import requests
 from packaging import version
+from typing_extensions import ParamSpec
 
 from truefoundry.common.constants import (
     SERVICEFOUNDRY_CLIENT_MAX_RETRIES,
@@ -24,10 +26,13 @@ from truefoundry.common.utils import (
 from truefoundry.logger import logger
 from truefoundry.version import __version__
 
+P = ParamSpec("P")
+R = TypeVar("R")
 
-def check_min_cli_version(fn):
+
+def check_min_cli_version(fn: Callable[P, R]) -> Callable[P, R]:
     @functools.wraps(fn)
-    def inner(*args, **kwargs):
+    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
         client: "ServiceFoundryServiceClient" = args[0]
         client.check_min_cli_version()
         return fn(*args, **kwargs)

truefoundry/common/session.py

@@ -50,10 +50,9 @@ class Session:
 
             ACTIVE_SESSION = new_session
             logger.info(
-                "Logged in to %r as %r (%s)",
+                "Logged in to %r as %r",
                 new_session.tfy_host,
                 new_session.user_info.user_id,
-                new_session.user_info.email or new_session.user_info.user_type.value,
             )
 
             return ACTIVE_SESSION

truefoundry/common/types.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+
+class UploadCodePackageCallable(Protocol):
+    def __call__(
+        self, workspace_fqn: str, component_name: str, package_local_path: str
+    ) -> str: ...

truefoundry/common/utils.py

@@ -53,7 +53,7 @@ def get_tfy_servers_config(tfy_host: str) -> _TFYServersConfig:
     global _tfy_servers_config
     if _tfy_servers_config is None:
         if ENV_VARS.TFY_CLI_LOCAL_DEV_MODE:
-            _tfy_servers_config = _TFYServersConfig()  # type: ignore[call-arg]
+            _tfy_servers_config = _TFYServersConfig()
         else:
             _tfy_servers_config = _TFYServersConfig.from_tfy_host(tfy_host)
     return _tfy_servers_config

truefoundry/deploy/auto_gen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2025-01-29T10:40:43+00:00
+#   timestamp: 2025-02-19T09:48:05+00:00
 
 from __future__ import annotations
 
@@ -1565,7 +1565,7 @@ class Notebook(BaseWorkbenchInput):
     image: WorkbenchImage
     cull_timeout: conint(ge=5) = Field(
         30,
-        description="+label=Stop after (minutes of inactivity)\n+usage=Stop the notebook instance after this much time in minutes of inactivity.\nThe notebook instance will be stopped even if the notebook is open in your browser, but nothing is running on the notebook.\n+sort=5",
+        description='+label=Stop after (minutes of inactivity)\n+usage=Stop the notebook instance after this much time in minutes of inactivity.\nThe notebook instance will be stopped even if the notebook is open in your browser, but nothing is running on the notebook.\n+sort=5\n+uiProps={"descriptionInline":true}',
     )
 
 
@@ -1656,7 +1656,7 @@ class SSHServer(BaseWorkbenchInput):
     )
     cull_timeout: Optional[conint(ge=5)] = Field(
         None,
-        description="+label=Stop after (minutes of inactivity)\n+usage=Stop the SSH Server instance after this much time in minutes of inactivity. \\\nThe instance is considered active if there is at least one active SSH connection (a client connected to the SSH server), \\\nor if a background job is running using tmux or screen, or if the pod has restarted.\n+sort=5",
+        description='+label=Stop after (minutes of inactivity)\n+usage=Stop the SSH Server instance after this much time in minutes of inactivity. The instance is considered active if there is at least one active SSH connection (a client connected to the SSH server), or if a background job is running using tmux or screen, or if the pod has restarted.\n+sort=5\n+uiProps={"descriptionInline":true, "warningMessage":"Please note that stop after inactivity is only available for images with tag(including custom images) >= v0.3.10"}',
     )
 
 
@@ -1696,6 +1696,10 @@ class SparkJob(BaseModel):
         None,
         description="+label=Environment Variables\n+usage=Configure environment variables to be injected in the service either as plain text. [Docs](https://docs.truefoundry.com/docs/env-variables)\n+icon=fa-globe\n+sort=21000",
     )
+    conf: Optional[Dict[str, Any]] = Field(
+        None,
+        description="+label=Spark Config Properties\n+usage=Extra configuration properties to be passed to the spark job. [Docs](https://spark.apache.org/docs/latest/configuration.html)\n+icon=fa-gear:#68BBE3\n+sort=21500",
+    )
     mounts: Optional[List[VolumeMount]] = Field(
         None,
         description="+label=Mounts\n+usage=Configure volumes to be mounted to driver and executors. [Docs](https://docs.truefoundry.com/docs/mounting-volumes-job)\n+sort=22000\n+uiType=Mounts",
@@ -1888,6 +1892,10 @@ class ApplicationSet(BaseModel):
         None,
         description="+label=Workspace FQN\n+docs=Fully qualified name of the workspace\n+uiType=Hidden",
     )
+    convert_template_manifest: Optional[bool] = Field(
+        None,
+        description="+label=Convert Template Manifest\n+docs=Flag to indicate if the template manifest should be converted to TrueFoundry manifest\n+uiType=Hidden",
+    )
 
 
 class Application(BaseModel):

truefoundry/deploy/builder/docker_service.py

@@ -38,7 +38,7 @@ def _catch_error_in_push(response: List[dict]):
     for line in response:
         if line.get("error") is not None:
             raise Exception(
-                f'Failed to push to registry with message \'{line.get("error")}\''
+                f"Failed to push to registry with message '{line.get('error')}'"
             )
 
 

truefoundry/deploy/cli/commands/delete_command.py

@@ -1,31 +1,63 @@
+from typing import List, Tuple
+
 import rich_click as click
 
 from truefoundry.cli.config import CliConfig
+from truefoundry.cli.console import console
 from truefoundry.cli.const import COMMAND_CLS, GROUP_CLS
 from truefoundry.cli.display_util import print_json
 from truefoundry.cli.util import handle_exception_wrapper
 from truefoundry.deploy.io.rich_output_callback import RichOutputCallBack
+from truefoundry.deploy.lib.clients.servicefoundry_client import (
+    ServiceFoundryServiceClient,
+)
 from truefoundry.deploy.lib.dao import application as application_lib
+from truefoundry.deploy.lib.dao import delete as delete_lib
 from truefoundry.deploy.lib.dao import workspace as workspace_lib
 from truefoundry.deploy.lib.messages import (
     PROMPT_DELETED_APPLICATION,
     PROMPT_DELETED_WORKSPACE,
+    PROMPT_DELETING_MANIFEST,
 )
+from truefoundry.deploy.lib.model.entity import DeleteResult
 
 # TODO (chiragjn): --json should disable all non json console prints
 
 
-@click.group(name="delete", cls=GROUP_CLS)
-def delete_command():
+@click.group(name="delete", cls=GROUP_CLS, invoke_without_command=True)
+@click.pass_context
+@click.option(
+    "-f",
+    "--file",
+    "files",
+    type=click.Path(exists=True, dir_okay=False, resolve_path=True),
+    help="Path to yaml manifest file (You can pass multiple files at once by providing multiple -f options)",
+    show_default=True,
+    required=False,
+    multiple=True,
+)
+@handle_exception_wrapper
+def delete_command(ctx, files: Tuple[str, ...]):
     """
     Delete TrueFoundry resources
-
-    \b
-    Supported resources:
-    - Workspace
-    - Application
     """
-    pass
+    if ctx.invoked_subcommand is None:
+        if not files:
+            raise click.UsageError("Missing option '-f' / '--file'")
+        delete_results: List[DeleteResult] = []
+        client = ServiceFoundryServiceClient()
+        for file in files:
+            with console.status(PROMPT_DELETING_MANIFEST.format(file), spinner="dots"):
+                for delete_result in delete_lib.delete_manifest_file(file, client):
+                    if delete_result.success:
+                        console.print(f"[green]\u2714 {delete_result.message}[/]")
+                    else:
+                        console.print(f"[red]\u2718 {delete_result.message}[/]")
+
+                    delete_results.append(delete_result)
+
+        if not all(delete_result.success for delete_result in delete_results):
+            raise Exception("Failed to delete one or more resource manifests")
 
 
 @click.command(name="workspace", cls=COMMAND_CLS, help="Delete a Workspace")

truefoundry/deploy/cli/commands/deploy_command.py

@@ -55,7 +55,7 @@ def _get_default_spec_file():
     help="Wait and tail the deployment progress",
 )
 @click.option(
-    "--force-deploy/--no-force-deploy",
+    "--force/--no-force",
     is_flag=True,
     show_default=True,
     default=False,
@@ -68,7 +68,7 @@ def deploy_command(
     file: str,
     workspace_fqn: Optional[str],
     wait: bool,
-    force_deploy: bool,
+    force: bool = False,
 ):
     if ctx.invoked_subcommand is not None:
         return
@@ -85,9 +85,7 @@ def deploy_command(
             application_definition = yaml.safe_load(f)
 
         application = Application.parse_obj(application_definition)
-        application.deploy(
-            workspace_fqn=workspace_fqn, wait=wait, force_deploy=force_deploy
-        )
+        application.deploy(workspace_fqn=workspace_fqn, wait=wait, force=force)
         sys.exit(0)
 
     click.echo(

truefoundry/deploy/lib/clients/servicefoundry_client.py

@@ -4,7 +4,7 @@ import json
 import os
 import time
 from datetime import datetime, timezone
-from typing import TYPE_CHECKING, Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional
 from urllib.parse import urljoin
 
 import requests
@@ -50,9 +50,6 @@ DEPLOYMENT_LOGS_SUBSCRIBE_MESSAGE = "DEPLOYMENT_LOGS"
 BUILD_LOGS_SUBSCRIBE_MESSAGE = "BUILD_LOGS"
 MAX_RETRIES_WORKFLOW_TRIGGER = 3
 
-if TYPE_CHECKING:
-    from truefoundry.deploy.auto_gen.models import Application
-
 
 def _upload_packaged_code(metadata, package_file):
     file_size = os.stat(package_file).st_size
@@ -242,13 +239,13 @@ class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
         self,
         workspace_id: str,
         application: auto_gen_models.Workflow,
-        force_deploy: bool,
+        force: bool = False,
     ) -> Deployment:
         data = {
             "workspaceId": workspace_id,
             "name": application.name,
             "manifest": application.dict(exclude_none=True),
-            "forceDeploy": force_deploy,
+            "forceDeploy": force,
         }
         logger.debug(json.dumps(data))
         url = f"{self._api_server_url}/{VERSION_PREFIX}/deployment"
@@ -265,7 +262,7 @@ class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
         time_obj.replace(tzinfo=timezone.utc)
         local_time = time_obj.astimezone(tzlocal())
         local_time_str = local_time.isoformat()
-        return f'[{local_time_str}] {log["log"].strip()}'
+        return f"[{local_time_str}] {log['log'].strip()}"
 
     def _tail_logs(
         self,
@@ -696,6 +693,16 @@ class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
         response_data = request_handling(response)
         return response_data
 
+    @check_min_cli_version
+    def delete(self, manifest: Dict[str, Any]):
+        url = f"{self._api_server_url}/{VERSION_PREFIX}/delete"
+        body = {"manifest": manifest}
+        response = session_with_retries().post(
+            url, headers=self._get_header(), json=body
+        )
+        response_data = request_handling(response)
+        return response_data
+
     def terminate_job_run(
         self,
         deployment_id: str,

truefoundry/deploy/lib/dao/delete.py

@@ -0,0 +1,88 @@
+from pathlib import Path
+from typing import Any, Dict, Iterator, Optional
+
+import yaml
+
+from truefoundry.deploy.lib.clients.servicefoundry_client import (
+    ServiceFoundryServiceClient,
+)
+from truefoundry.deploy.lib.model.entity import DeleteResult, Manifest
+from truefoundry.pydantic_v1 import ValidationError
+
+
+def _delete_manifest(
+    manifest: Dict[str, Any],
+    client: Optional[ServiceFoundryServiceClient] = None,
+    filename: Optional[str] = None,
+    index: Optional[int] = None,
+) -> DeleteResult:
+    client = client or ServiceFoundryServiceClient()
+
+    file_metadata = ""
+    if index is not None:
+        file_metadata += f" at index {index}"
+    if filename:
+        file_metadata += f" from file {filename}"
+
+    try:
+        manifest = Manifest.parse_obj(manifest)
+    except ValidationError as ex:
+        return DeleteResult(
+            success=False,
+            message=f"Failed to parse manifest{file_metadata}. Error: {ex}",
+        )
+
+    try:
+        client.delete(manifest.dict())
+
+        return DeleteResult(
+            success=True,
+            message=(
+                f"Successfully deleted resource manifest {manifest.name} of type {manifest.type}."
+            ),
+        )
+    except Exception as ex:
+        return DeleteResult(
+            success=False,
+            message=(
+                f"Failed to delete resource manifest {manifest.name} of type {manifest.type}. Error: {ex}."
+            ),
+        )
+
+
+def delete_manifest(
+    manifest: Dict[str, Any],
+    client: Optional[ServiceFoundryServiceClient] = None,
+) -> DeleteResult:
+    return _delete_manifest(manifest=manifest, client=client)
+
+
+def delete_manifest_file(
+    filepath: str,
+    client: Optional[ServiceFoundryServiceClient] = None,
+) -> Iterator[DeleteResult]:
+    client = client or ServiceFoundryServiceClient()
+    filename = Path(filepath).name
+    try:
+        with open(filepath, "r") as f:
+            manifests_it = list(yaml.safe_load_all(f))
+    except Exception as ex:
+        yield DeleteResult(
+            success=False,
+            message=f"Failed to read file {filepath} as a valid YAML file. Error: {ex}",
+        )
+    else:
+        for index, manifest in enumerate(manifests_it):
+            if not isinstance(manifest, dict):
+                yield DeleteResult(
+                    success=False,
+                    message=f"Failed to delete resource manifest at index {index} from file {filename}. Error: A manifest must be a dict, got type {type(manifest)}",
+                )
+                continue
+
+            yield _delete_manifest(
+                manifest=manifest,
+                client=client,
+                filename=filename,
+                index=index,
+            )

truefoundry/deploy/lib/messages.py

@@ -10,3 +10,4 @@ PROMPT_NO_WORKSPACES = f"""[yellow]No workspaces found. Either cluster name is w
 PROMPT_NO_APPLICATIONS = f"""[yellow]No applications found. You can create one with [bold]{TFY} deploy[/] from within your application folder"""
 PROMPT_NO_VERSIONS = """[yellow]No application versions found."""
 PROMPT_APPLYING_MANIFEST = """[yellow]Applying manifest for file {!r}[/]"""
+PROMPT_DELETING_MANIFEST = """[yellow]Deleting manifest for file {!r}[/]"""

truefoundry/deploy/lib/model/entity.py

@@ -280,6 +280,11 @@ class ApplyResult(BaseModel):
     message: str
 
 
+class DeleteResult(BaseModel):
+    success: bool
+    message: str
+
+
 class Manifest(Base):
     type: str
     name: str

truefoundry/deploy/lib/session.py

@@ -57,10 +57,9 @@ def login(
                     return login(api_key=api_key, host=host, relogin=True)
 
             user_info = cred_file_content.to_token().to_user_info()
-            user_name_display_info = user_info.email or user_info.user_type.value
             output_hook.print_line(
                 relogin_error_message(
-                    f"Already logged in to {cred_file_content.host!r} as {user_info.user_id!r} ({user_name_display_info})",
+                    f"Already logged in to {cred_file_content.host!r} as {user_info.user_id!r}",
                     host=host,
                 )
             )
@@ -81,10 +80,8 @@ def login(
         cred_file.write(cred_file_content)
 
     user_info = token.to_user_info()
-    user_name_display_info = user_info.email or user_info.user_type.value
     output_hook.print_line(
-        f"Successfully logged in to {cred_file_content.host!r} as "
-        f"{user_info.user_id!r} ({user_name_display_info})"
+        f"Successfully logged in to {cred_file_content.host!r} as {user_info.user_id!r}"
     )
     return True
 

truefoundry/deploy/python_deploy_codegen.py

@@ -27,7 +27,7 @@ logging.basicConfig(level=logging.INFO)
 
 {application_type} = {spec_repr}
 
-{application_type}.deploy(workspace_fqn="{workspace_fqn}")\
+{application_type}.deploy(workspace_fqn="{workspace_fqn}", wait=False)\
 """
     return code
 

truefoundry/deploy/v2/lib/deploy.py

@@ -214,8 +214,8 @@ No Workspace FQN was provided or mentioned in the spec.
 Either add a `workspace_fqn` to your yaml spec as
 
 ```
-name: {getattr(component, 'name', 'my-app')}
-type: {getattr(component, 'type', 'undefined')}
+name: {getattr(component, "name", "my-app")}
+type: {getattr(component, "type", "undefined")}
 ...
 workspace_fqn: <your workspace fqn>
 ```
@@ -224,7 +224,7 @@ or Python deployment spec as
 
 ```
 app = {component.__class__.__name__}(
-    name='{getattr(component, 'name', 'my-app')}',
+    name='{getattr(component, "name", "my-app")}',
     ...
     workspace_fqn='<your workspace fqn>'
 )
@@ -252,7 +252,7 @@ def deploy_component(
     component: Component,
     workspace_fqn: Optional[str] = None,
     wait: bool = True,
-    force_deploy: bool = False,
+    force: bool = False,
 ) -> Deployment:
     _warn_when_gpu_selected_without_cuda(component=component)
     workspace_fqn = _resolve_workspace_fqn(
@@ -274,7 +274,7 @@ def deploy_component(
     response = client.deploy_application(
         workspace_id=workspace_id,
         application=updated_component,
-        force_deploy=force_deploy,
+        force=force,
     )
     logger.info(
         "🚀 Deployment started for application '%s'. Deployment FQN is '%s'.",

truefoundry/deploy/v2/lib/deploy_workflow.py

@@ -1,7 +1,7 @@
 import os
 import sys
 from pathlib import Path
-from typing import Callable, Dict, List, Optional, Union
+from typing import Dict, List, Optional, Union
 
 import requirements
 from flytekit.configuration import (
@@ -19,6 +19,7 @@ from flytekit.tools.translator import TaskSpec as FlyteTaskSpec
 from flytekit.tools.translator import WorkflowSpec as FlyteWorkflowSpec
 from google.protobuf.json_format import MessageToDict
 
+from truefoundry.common.types import UploadCodePackageCallable
 from truefoundry.deploy.auto_gen import models as auto_gen_models
 from truefoundry.deploy.lib.clients.servicefoundry_client import (
     ServiceFoundryServiceClient,
@@ -39,7 +40,7 @@ from truefoundry.workflow.workflow import (
 def _handle_code_upload_for_workflow(
     workflow: auto_gen_models.Workflow,
     workspace_fqn: str,
-    upload_code_package: Callable[[str, str, str], str],
+    upload_code_package: UploadCodePackageCallable,
 ) -> auto_gen_models.Workflow:
     new_workflow = workflow.copy(deep=True)
     new_workflow.source = local_source_to_remote_source(
@@ -92,7 +93,7 @@ def _is_tfy_wf_present_in_task_python_build(
 
 
 def _is_dynamic_task(flyte_task: FlyteTaskSpec) -> bool:
-    envs: Dict[str:str] = flyte_task.template.container.env or {}
+    envs: Dict[str, str] = flyte_task.template.container.env or {}
     return SERIALIZED_CONTEXT_ENV_VAR in envs.keys()
 
 
@@ -273,7 +274,7 @@ def deploy_workflow(
     workflow: auto_gen_models.Workflow,
     workspace_fqn: str,
     wait: bool = True,
-    force_deploy: bool = False,
+    force: bool = False,
 ) -> Deployment:
     _generate_manifest_for_workflow(workflow)
     _validate_workspace_fqn(workflow, workspace_fqn)
@@ -296,7 +297,9 @@ def deploy_workflow(
     )
 
     deployment = client.deploy_application(
-        workspace_id=workspace_id, application=workflow
+        workspace_id=workspace_id,
+        application=workflow,
+        force=force,
     )
     logger.info(
         "🚀 Deployment started for application '%s'. Deployment FQN is '%s'.",