truefoundry 0.3.4rc1__py3-none-any.whl → 0.4.0__py3-none-any.whl

truefoundry/common/servicefoundry_client.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import functools
+from urllib.parse import urlparse
+
+import requests
+from packaging import version
+
+from truefoundry.common.constants import (
+    SERVICEFOUNDRY_CLIENT_MAX_RETRIES,
+    VERSION_PREFIX,
+)
+from truefoundry.common.entities import (
+    PythonSDKConfig,
+    TenantInfo,
+)
+from truefoundry.common.request_utils import request_handling, requests_retry_session
+from truefoundry.common.utils import (
+    append_servicefoundry_path_to_base_url,
+    timed_lru_cache,
+)
+from truefoundry.logger import logger
+from truefoundry.version import __version__
+
+
+def check_min_cli_version(fn):
+    @functools.wraps(fn)
+    def inner(*args, **kwargs):
+        if __version__ != "0.0.0":
+            client: "ServiceFoundryServiceClient" = args[0]
+            # "0.0.0" indicates dev version
+            # noinspection PyProtectedMember
+            min_cli_version_required = client._min_cli_version_required
+            if version.parse(__version__) < version.parse(min_cli_version_required):
+                raise Exception(
+                    "You are using an outdated version of `truefoundry`.\n"
+                    f"Run `pip install truefoundry>={min_cli_version_required}` to install the supported version.",
+                )
+        else:
+            logger.debug("Ignoring minimum cli version check")
+
+        return fn(*args, **kwargs)
+
+    return inner
+
+
+def session_with_retries() -> requests.Session:
+    return requests_retry_session(retries=SERVICEFOUNDRY_CLIENT_MAX_RETRIES)
+
+
+@timed_lru_cache(seconds=30 * 60)
+def _cached_get_tenant_info(api_server_url: str) -> TenantInfo:
+    res = session_with_retries().get(
+        url=f"{api_server_url}/{VERSION_PREFIX}/tenant-id",
+        params={"hostName": urlparse(api_server_url).netloc},
+    )
+    res = request_handling(res)
+    return TenantInfo.parse_obj(res)
+
+
+@timed_lru_cache(seconds=30 * 60)
+def _cached_get_python_sdk_config(api_server_url: str) -> PythonSDKConfig:
+    res = session_with_retries().get(
+        url=f"{api_server_url}/{VERSION_PREFIX}/min-cli-version"
+    )
+    res = request_handling(res)
+    return PythonSDKConfig.parse_obj(res)
+
+
+class ServiceFoundryServiceClient:
+    def __init__(self, base_url: str):
+        self._base_url = base_url.strip("/")
+        self._api_server_url = append_servicefoundry_path_to_base_url(self._base_url)
+
+    @property
+    def base_url(self) -> str:
+        return self._base_url
+
+    @property
+    def tenant_info(self) -> TenantInfo:
+        return _cached_get_tenant_info(self._api_server_url)
+
+    @property
+    def python_sdk_config(self) -> PythonSDKConfig:
+        return _cached_get_python_sdk_config(self._api_server_url)
+
+    @functools.cached_property
+    def _min_cli_version_required(self) -> str:
+        return _cached_get_python_sdk_config(
+            self._api_server_url
+        ).truefoundry_cli_min_version

truefoundry/common/utils.py

@@ -0,0 +1,56 @@
+import os
+import time
+from functools import lru_cache, wraps
+from time import monotonic_ns
+from typing import Callable, Generator, Optional, TypeVar
+from urllib.parse import urljoin, urlsplit
+
+from truefoundry.common.constants import (
+    API_SERVER_RELATIVE_PATH,
+    SERVICEFOUNDRY_SERVER_URL_ENV_KEY,
+    TFY_HOST_ENV_KEY,
+)
+
+T = TypeVar("T")
+
+
+def timed_lru_cache(
+    seconds: int = 300, maxsize: Optional[int] = None
+) -> Callable[[Callable[..., T]], Callable[..., T]]:
+    def wrapper_cache(func: Callable[..., T]) -> Callable[..., T]:
+        func = lru_cache(maxsize=maxsize)(func)
+        func.delta = seconds * 10**9
+        func.expiration = monotonic_ns() + func.delta
+
+        @wraps(func)
+        def wrapped_func(*args, **kwargs):
+            if monotonic_ns() >= func.expiration:
+                func.cache_clear()
+                func.expiration = monotonic_ns() + func.delta
+            return func(*args, **kwargs)
+
+        return wrapped_func
+
+    return wrapper_cache
+
+
+def poll_for_function(
+    func: Callable[..., T], poll_after_secs: int = 5, *args, **kwargs
+) -> Generator[T, None, None]:
+    while True:
+        yield func(*args, **kwargs)
+        time.sleep(poll_after_secs)
+
+
+def resolve_base_url(host: Optional[str] = None) -> str:
+    if not host and not os.getenv(TFY_HOST_ENV_KEY):
+        raise ValueError(
+            f"Either `host` should be provided by --host <value>, or `{TFY_HOST_ENV_KEY}` env must be set"
+        )
+    return host or os.getenv(TFY_HOST_ENV_KEY)
+
+
+def append_servicefoundry_path_to_base_url(base_url: str):
+    if urlsplit(base_url).netloc.startswith("localhost"):
+        return os.getenv(SERVICEFOUNDRY_SERVER_URL_ENV_KEY)
+    return urljoin(base_url, API_SERVER_RELATIVE_PATH)

truefoundry/deploy/auto_gen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2024-09-19T11:05:06+00:00
+#   timestamp: 2024-09-29T10:28:22+00:00
 
 from __future__ import annotations
 
@@ -310,9 +310,7 @@ class GcpTPU(BaseModel):
 
 
 class GitHelmRepo(BaseModel):
-    type: constr(regex=r"^git-helm-repo$") = Field(
-        ..., description="+value=git-helm-repo"
-    )
+    type: Literal["git-helm-repo"] = Field(..., description="+value=git-helm-repo")
     repo_url: constr(
         regex=r"^(((https?|wss):\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&\/=]*))$"
     ) = Field(
@@ -357,7 +355,7 @@ class GitSource(BaseModel):
 
 
 class HelmRepo(BaseModel):
-    type: constr(regex=r"^helm-repo$") = Field(..., description="+value=helm-repo")
+    type: Literal["helm-repo"] = Field(..., description="+value=helm-repo")
     repo_url: constr(
         regex=r"^(((https?|wss):\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&\/=]*))$"
     ) = Field(
@@ -647,7 +645,7 @@ class OCIRepo(BaseModel):
     +label=OCIRepo
     """
 
-    type: constr(regex=r"^oci-repo$") = Field(..., description="+value=oci-repo")
+    type: Literal["oci-repo"] = Field(..., description="+value=oci-repo")
     oci_chart_url: constr(
         regex=r"^(((oci):\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&\/=]*))$"
     ) = Field(..., description="+label=OCI chart URL\n+message=Need to be a valid URL.")

truefoundry/deploy/cli/cli.py

@@ -13,6 +13,7 @@ from truefoundry.deploy.cli.commands import (
     get_logout_command,
     get_patch_application_command,
     get_patch_command,
+    get_terminate_command,
     get_trigger_command,
 )
 from truefoundry.deploy.cli.config import CliConfig
@@ -24,7 +25,7 @@ from truefoundry.version import __version__
 click.rich_click.USE_RICH_MARKUP = True
 
 
-def create_truefoundry_cli():
+def create_truefoundry_cli() -> click.MultiCommand:
     """Generates CLI by combining all subcommands into a main CLI and returns in
 
     Returns:
@@ -38,6 +39,7 @@ def create_truefoundry_cli():
     cli.add_command(get_patch_application_command())
     cli.add_command(get_delete_command())
     cli.add_command(get_trigger_command())
+    cli.add_command(get_terminate_command())
 
     if not (sys.platform.startswith("win32") or sys.platform.startswith("cygwin")):
         cli.add_command(get_patch_command())

truefoundry/deploy/cli/commands/apply_command.py

@@ -17,7 +17,7 @@ from truefoundry.deploy.lib.model.entity import ApplyResult
     name="apply",
     cls=GROUP_CLS,
     invoke_without_command=True,
-    help="Create resources by appling manifest locally from Truefoundry spec",
+    help="Create resources by applying manifest locally from TrueFoundry spec",
     context_settings={"ignore_unknown_options": True, "allow_interspersed_args": True},
 )
 @click.option(

truefoundry/deploy/cli/commands/build_command.py

@@ -13,7 +13,7 @@ from truefoundry.version import __version__
     name="build",
     cls=GROUP_CLS,
     invoke_without_command=True,
-    help="Build docker image locally from Truefoundry spec",
+    help="Build docker image locally from TrueFoundry spec",
     context_settings={"ignore_unknown_options": True, "allow_interspersed_args": True},
 )
 @click.option(

truefoundry/deploy/cli/commands/deploy_command.py

@@ -29,7 +29,7 @@ def _get_default_spec_file():
     name="deploy",
     cls=GROUP_CLS,
     invoke_without_command=True,
-    help="Deploy application to Truefoundry",
+    help="Deploy application to TrueFoundry",
 )
 @click.option(
     "-f",

truefoundry/deploy/cli/commands/login_command.py

@@ -1,18 +1,18 @@
 import rich_click as click
 
+from truefoundry.common.constants import TFY_HOST_ENV_KEY
 from truefoundry.deploy.cli.const import COMMAND_CLS
 from truefoundry.deploy.cli.util import (
     _prompt_if_no_value_and_supported,
     handle_exception_wrapper,
 )
 from truefoundry.deploy.io.rich_output_callback import RichOutputCallBack
-from truefoundry.deploy.lib.const import HOST_ENV_NAME
 from truefoundry.deploy.lib.session import login
 
 
 @click.command(name="login", cls=COMMAND_CLS)
 @click.option("--relogin", type=click.BOOL, is_flag=True, default=False)
-@click.option("--host", type=click.STRING, required=True, envvar=HOST_ENV_NAME)
+@click.option("--host", type=click.STRING, required=True, envvar=TFY_HOST_ENV_KEY)
 @click.option(
     "--api-key",
     "--api_key",

truefoundry/deploy/cli/commands/patch_application_command.py

@@ -12,7 +12,7 @@ from truefoundry.deploy.lib.dao import application as application_lib
     name="patch-application",
     cls=GROUP_CLS,
     invoke_without_command=True,
-    help="Deploy application with patches to Truefoundry",
+    help="Deploy application with patches to TrueFoundry",
 )
 @click.option(
     "-f",

truefoundry/deploy/cli/commands/patch_command.py

@@ -12,7 +12,7 @@ from truefoundry.deploy.io.rich_output_callback import RichOutputCallBack
     name="patch",
     cls=GROUP_CLS,
     invoke_without_command=True,
-    help="Patch parts of servicefoundry.yaml file",
+    help="Patch parts of truefoundry.yaml file",
 )
 @click.option(
     "-f",

truefoundry/deploy/cli/commands/terminate_comand.py

@@ -9,7 +9,7 @@ from truefoundry.deploy.lib.dao import application as application_lib
 @click.group(name="terminate", cls=GROUP_CLS)
 def terminate_command():
     """
-    Terminate the job
+    Terminate Job Runs
     """
     pass
 

truefoundry/deploy/cli/util.py

@@ -10,9 +10,9 @@ from rich.padding import Padding
 from rich.panel import Panel
 from rich.table import Table
 
+from truefoundry.common.exceptions import BadRequestException
 from truefoundry.deploy.cli.console import console
 from truefoundry.deploy.lib.exceptions import (
-    BadRequestException,
     ConfigurationException,
 )
 from truefoundry.deploy.lib.util import is_debug_env_set

truefoundry/deploy/function_service/remote/remote.py

@@ -66,7 +66,7 @@ class RemoteClass(Remote):
         # methods in the class, but internally doing network call.
         # But I am sticking with this now because not all the concepts of a python
         # class right now, will work in both remote and local. Examples, you cannot
-        # access arbitary attributes, properties etc. I want to keep the behaviour
+        # access arbitrary attributes, properties etc. I want to keep the behaviour
         # identical for now.
         absent = object()
         methods = inspect.getmembers(class_, predicate=inspect.isfunction)

truefoundry/deploy/lib/auth/servicefoundry_session.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 from typing import Optional
 
-from truefoundry.deploy.lib.auth.credential_provider import (
+from truefoundry.common.credential_provider import (
     CredentialProvider,
     EnvCredentialProvider,
     FileCredentialProvider,
 )
-from truefoundry.deploy.lib.model.entity import UserInfo
+from truefoundry.common.entities import UserInfo
 from truefoundry.logger import logger
 
 ACTIVE_SESSION: Optional[ServiceFoundrySession] = None