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

truefoundry/deploy/lib/model/entity.py

@@ -1,14 +1,11 @@
 from __future__ import annotations
 
 import datetime
-import time
 from enum import Enum
 from typing import Any, Dict, List, Optional, Union
 
-import jwt
-
 from truefoundry.deploy.lib.util import get_application_fqn_from_deployment_fqn
-from truefoundry.pydantic_v1 import BaseModel, Extra, Field, constr, validator
+from truefoundry.pydantic_v1 import BaseModel, Extra, Field
 
 # TODO: switch to Enums for str literals
 # TODO: Need a better approach to keep fields in sync with server
@@ -215,114 +212,6 @@ class Application(Entity):
         }
 
 
-class UserType(Enum):
-    user = "user"
-    serviceaccount = "serviceaccount"
-
-
-class UserInfo(BaseModel):
-    user_id: constr(min_length=1)
-    user_type: UserType = UserType.user
-    email: Optional[str] = None
-    tenant_name: constr(min_length=1) = Field(alias="tenantName")
-
-    class Config:
-        allow_population_by_field_name = True
-        allow_mutation = False
-
-
-class TenantInfo(BaseModel):
-    tenant_name: constr(min_length=1) = Field(alias="tenantName")
-    auth_server_url: str
-
-    class Config:
-        allow_population_by_field_name = True
-        allow_mutation = False
-
-
-class Token(BaseModel):
-    access_token: constr(min_length=1) = Field(alias="accessToken", repr=False)
-    refresh_token: Optional[constr(min_length=1)] = Field(
-        alias="refreshToken", repr=False
-    )
-    decoded_value: Optional[Dict] = Field(exclude=True, repr=False)
-
-    class Config:
-        allow_population_by_field_name = True
-        allow_mutation = False
-
-    @validator("decoded_value", always=True, pre=True)
-    def _decode_jwt(cls, v, values, **kwargs):
-        access_token = values["access_token"]
-        return jwt.decode(
-            access_token,
-            options={
-                "verify_signature": False,
-                "verify_aud": False,
-                "verify_exp": False,
-            },
-        )
-
-    @property
-    def tenant_name(self) -> str:
-        return self.decoded_value["tenantName"]
-
-    def is_going_to_be_expired(self, buffer_in_seconds: int = 120) -> bool:
-        exp = int(self.decoded_value["exp"])
-        return (exp - time.time()) < buffer_in_seconds
-
-    def to_user_info(self) -> UserInfo:
-        return UserInfo(
-            user_id=self.decoded_value["username"],
-            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,
-        )
-
-
-class CredentialsFileContent(BaseModel):
-    access_token: constr(min_length=1) = Field(repr=False)
-    refresh_token: Optional[constr(min_length=1)] = Field(repr=False)
-    host: constr(min_length=1)
-
-    class Config:
-        allow_mutation = False
-
-    def to_token(self) -> Token:
-        return Token(access_token=self.access_token, refresh_token=self.refresh_token)
-
-
-class DeviceCode(BaseModel):
-    user_code: str = Field(alias="userCode")
-    device_code: str = Field(alias="deviceCode")
-    verification_url: Optional[str] = Field(alias="verificationURI")
-    complete_verification_url: Optional[str] = Field(alias="verificationURIComplete")
-    expires_in_seconds: int = Field(alias="expiresInSeconds", default=60)
-    interval_in_seconds: int = Field(alias="intervalInSeconds", default=1)
-    message: Optional[str] = Field(alias="message")
-
-    class Config:
-        allow_population_by_field_name = True
-        allow_mutation = False
-
-    def get_user_clickable_url(self, auth_host: str) -> str:
-        return f"{auth_host}/authorize/device?userCode={self.user_code}"
-
-
-class PythonSDKConfig(BaseModel):
-    min_version: str = Field(alias="minVersion")
-    truefoundry_cli_min_version: str = Field(alias="truefoundryCliMinVersion")
-    use_sfy_server_auth_apis: Optional[bool] = Field(
-        alias="useSFYServerAuthAPIs", default=False
-    )
-
-    class Config:
-        allow_population_by_field_name = True
-        allow_mutation = False
-
-
 class JobRun(Base):
     name: str
     applicationName: str

truefoundry/deploy/lib/session.py

@@ -3,41 +3,22 @@ from typing import Optional
 
 import rich_click as click
 
+from truefoundry.common.auth_service_client import AuthServiceClient
+from truefoundry.common.constants import TFY_API_KEY_ENV_KEY, TFY_HOST_ENV_KEY
+from truefoundry.common.credential_file_manager import CredentialsFileManager
+from truefoundry.common.credential_provider import EnvCredentialProvider
+from truefoundry.common.entities import CredentialsFileContent, Token
+from truefoundry.common.utils import resolve_base_url
 from truefoundry.deploy.io.output_callback import OutputCallBack
-from truefoundry.deploy.lib.auth.auth_service_client import AuthServiceClient
-from truefoundry.deploy.lib.auth.credential_file_manager import CredentialsFileManager
-from truefoundry.deploy.lib.auth.credential_provider import EnvCredentialProvider
-from truefoundry.deploy.lib.clients.servicefoundry_client import (
-    ServiceFoundryServiceClient,
-)
-from truefoundry.deploy.lib.clients.utils import resolve_base_url
 from truefoundry.deploy.lib.const import (
-    API_KEY_ENV_NAME,
-    HOST_ENV_NAME,
-    OLD_SFY_PROFILES_FILEPATH,
-    OLD_SFY_SESSIONS_FILEPATH,
     RICH_OUTPUT_CALLBACK,
 )
 from truefoundry.deploy.lib.messages import (
     PROMPT_ALREADY_LOGGED_OUT,
     PROMPT_LOGOUT_SUCCESSFUL,
 )
-from truefoundry.deploy.lib.model.entity import CredentialsFileContent, Token
 from truefoundry.logger import logger
 
-if OLD_SFY_PROFILES_FILEPATH.exists():
-    logger.warning(
-        "%s file is deprecated. You can delete this file now.",
-        OLD_SFY_PROFILES_FILEPATH,
-    )
-
-
-if OLD_SFY_SESSIONS_FILEPATH.exists():
-    logger.warning(
-        "%s file is deprecated. You can delete this file now.",
-        OLD_SFY_SESSIONS_FILEPATH,
-    )
-
 
 def login(
     api_key: Optional[str] = None,
@@ -45,13 +26,13 @@ def login(
     relogin: bool = False,
     output_hook: OutputCallBack = RICH_OUTPUT_CALLBACK,
 ) -> bool:
-    if API_KEY_ENV_NAME in os.environ and HOST_ENV_NAME in os.environ:
+    if TFY_API_KEY_ENV_KEY in os.environ and TFY_HOST_ENV_KEY in os.environ:
         logger.warning(
             "Skipping login because environment variables %s and "
             "%s are set and will be used when running truefoundry. "
             "If you want to relogin then unset these environment keys.",
-            HOST_ENV_NAME,
-            API_KEY_ENV_NAME,
+            TFY_HOST_ENV_KEY,
+            TFY_API_KEY_ENV_KEY,
         )
         return False
 
@@ -85,12 +66,7 @@ def login(
             return False
 
         if api_key:
-            servicefoundry_client = ServiceFoundryServiceClient(
-                init_session=False, base_url=host
-            )
-            token = _login_with_api_key(
-                api_key=api_key, servicefoundry_client=servicefoundry_client
-            )
+            token = Token(access_token=api_key, refresh_token=None)
         else:
             auth_service = AuthServiceClient.from_base_url(base_url=host)
             # interactive login
@@ -122,13 +98,6 @@ def logout(
             output_hook.print_line(PROMPT_ALREADY_LOGGED_OUT)
 
 
-def _login_with_api_key(
-    api_key: str, servicefoundry_client: ServiceFoundryServiceClient
-) -> Token:
-    logger.debug("Logging in with api key")
-    return servicefoundry_client.get_token_from_api_key(api_key=api_key)
-
-
 def _login_with_device_code(
     base_url: str,
     auth_service: AuthServiceClient,
@@ -144,7 +113,10 @@ def _login_with_device_code(
         if device_code.message:
             message = device_code.message
         else:
-            message = f"Please open the following URL in a browser and enter the code {device_code.user_code} when prompted: {device_code.verification_url}"
+            message = (
+                f"Please open the following URL in a browser and enter the code {device_code.user_code} "
+                f"when prompted: {device_code.verification_url}"
+            )
     else:
         auto_open_url = device_code.get_user_clickable_url(auth_host=base_url)
     if auto_open_url:

truefoundry/deploy/lib/util.py

@@ -1,7 +1,5 @@
 import os
 import re
-from functools import lru_cache, wraps
-from time import monotonic_ns
 from typing import Union
 
 from truefoundry.deploy.lib.const import (
@@ -41,23 +39,6 @@ def get_deployment_fqn_from_application_fqn(
     return f"{application_fqn}:{version}"
 
 
-def is_notebook():
-    # https://stackoverflow.com/questions/15411967/how-can-i-check-if-code-is-executed-in-the-ipython-notebook
-    try:
-        # noinspection PyUnresolvedReferences
-        shell = get_ipython().__class__
-        if shell.__name__ == "ZMQInteractiveShell":
-            return True  # Jupyter notebook or qtconsole
-        elif shell.__name__ == "TerminalInteractiveShell":
-            return False  # Terminal running IPython
-        elif "google.colab" in str(shell):
-            return True  # google colab notebook
-        else:
-            return False  # Other type (?)
-    except NameError:
-        return False  # Probably standard Python interpreter
-
-
 def find_list_paths(data, parent_key="", sep="."):
     list_paths = []
     if isinstance(data, dict):
@@ -70,21 +51,3 @@ def find_list_paths(data, parent_key="", sep="."):
             new_key = f"{parent_key}[{i}]"
             list_paths.extend(find_list_paths(value, new_key, sep))
     return list_paths
-
-
-def timed_lru_cache(seconds: int = 300, maxsize: int = None):
-    def wrapper_cache(func):
-        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

truefoundry/{python_deploy_codegen.py → deploy/python_deploy_codegen.py}

@@ -101,11 +101,11 @@ def add_local_source_comment(code):
     return "\n".join(new_lines)
 
 
-def convert_deployment_config_to_python(workspace_fqn: str, deployment_config: dict):
+def convert_deployment_config_to_python(workspace_fqn: str, application_spec: dict):
     """
     Convert a deployment config to a python file that can be used to deploy to a workspace
     """
-    application = Application.parse_obj(deployment_config)
+    application = Application.parse_obj(application_spec)
     application_type = application.__root__.type
 
     spec_repr = get_python_repr(application.__root__)

truefoundry/deploy/v2/lib/deploy.py

@@ -4,12 +4,12 @@ from typing import List, Optional, TypeVar
 
 from rich.status import Status
 
+from truefoundry.common.utils import poll_for_function
 from truefoundry.deploy.auto_gen import models as auto_gen_models
 from truefoundry.deploy.builder.docker_service import env_has_docker
 from truefoundry.deploy.lib.clients.servicefoundry_client import (
     ServiceFoundryServiceClient,
 )
-from truefoundry.deploy.lib.clients.utils import poll_for_function
 from truefoundry.deploy.lib.dao.workspace import get_workspace_by_fqn
 from truefoundry.deploy.lib.model.entity import Deployment, DeploymentTransitionStatus
 from truefoundry.deploy.lib.util import get_application_fqn_from_deployment_fqn
@@ -45,7 +45,7 @@ def _handle_if_local_source(component: Component, workspace_fqn: str) -> Compone
                 local_build = False
             else:
                 logger.info(
-                    "Found locally installed docker, image will be built locally and then pushed. "
+                    "Found locally installed docker, image will be built locally and then pushed.\n"
                     "If you want to always build remotely instead of locally, "
                     "please set `image.build_source.local_build` to `false` in your YAML spec or equivalently set "
                     "`image=Build(build_source=LocalSource(local_build=False, ...))` in your "
@@ -72,7 +72,7 @@ def _handle_if_local_source(component: Component, workspace_fqn: str) -> Compone
                 component_name=component.name,
             )
         else:
-            # We'll build image on Truefoundry servers, upload the source and update image.build_source
+            # We'll build image on TrueFoundry servers, upload the source and update image.build_source
             logger.info("Uploading code for %s '%s'", component.type, component.name)
             new_component.image.build_source = local_source_to_remote_source(
                 local_source=component.image.build_source,

truefoundry/deploy/v2/lib/deployable_patched_models.py

@@ -81,7 +81,7 @@ class Application(models.Application, DeployablePatchedModelBase):
 class Workflow(models.Workflow, DeployablePatchedModelBase):
     type: Literal["workflow"] = "workflow"
     source: Union[models.RemoteSource, models.LocalSource] = Field(
-        default_factory=LocalSource
+        default_factory=lambda: LocalSource(local_build=False)
     )
 
     def deploy(self, workspace_fqn: str, wait: bool = True) -> Deployment:

truefoundry/langchain/truefoundry_chat.py

@@ -10,8 +10,8 @@ from langchain.schema.messages import (
     SystemMessage,
 )
 
+from truefoundry.common.request_utils import requests_retry_session
 from truefoundry.langchain.utils import (
-    requests_retry_session,
     validate_tfy_environment,
 )
 from truefoundry.logger import logger

truefoundry/langchain/truefoundry_embeddings.py

@@ -6,8 +6,8 @@ import tqdm
 from langchain.embeddings.base import Embeddings
 from langchain.pydantic_v1 import BaseModel, Extra, Field, root_validator
 
+from truefoundry.common.request_utils import requests_retry_session
 from truefoundry.langchain.utils import (
-    requests_retry_session,
     validate_tfy_environment,
 )
 from truefoundry.logger import logger

truefoundry/langchain/truefoundry_llm.py

@@ -3,8 +3,8 @@ from typing import Any, Dict, List, Optional
 from langchain.llms.base import LLM
 from langchain.pydantic_v1 import Extra, Field, root_validator
 
+from truefoundry.common.request_utils import requests_retry_session
 from truefoundry.langchain.utils import (
-    requests_retry_session,
     validate_tfy_environment,
 )
 from truefoundry.logger import logger

truefoundry/langchain/utils.py

@@ -2,10 +2,7 @@ import os
 from typing import Dict, List, Optional
 from urllib.parse import urljoin
 
-import requests
 from langchain.pydantic_v1 import BaseModel
-from requests.adapters import HTTPAdapter
-from urllib3.util.retry import Retry
 
 from truefoundry.deploy.lib.auth.servicefoundry_session import ServiceFoundrySession
 
@@ -45,41 +42,3 @@ def validate_tfy_environment(values: Dict):
     values["tfy_llm_gateway_url"] = gateway_url
     values["tfy_api_key"] = api_key
     return values
-
-
-def requests_retry_session(
-    retries=5,
-    backoff_factor=0.3,
-    status_forcelist=(500, 502, 503, 504),
-    method_whitelist=frozenset({"GET", "POST"}),
-    session=None,
-):
-    """
-    Returns a `requests` session with retry capabilities for certain HTTP status codes.
-
-    Args:
-        retries (int): The number of retries for HTTP requests.
-        backoff_factor (float): The backoff factor for exponential backoff during retries.
-        status_forcelist (tuple): A tuple of HTTP status codes that should trigger a retry.
-        method_whitelist (frozenset): The set of HTTP methods that should be retried.
-        session (requests.Session, optional): An optional existing requests session to use.
-
-    Returns:
-        requests.Session: A session with retry capabilities.
-    """
-    # Implementation taken from https://www.peterbe.com/plog/best-practice-with-retries-with-requests
-    session = session or requests.Session()
-    retry = Retry(
-        total=retries,
-        read=retries,
-        connect=retries,
-        status=retries,
-        backoff_factor=backoff_factor,
-        allowed_methods=method_whitelist,
-        status_forcelist=status_forcelist,
-        respect_retry_after_header=True,
-    )
-    adapter = HTTPAdapter(max_retries=retry)
-    session.mount("http://", adapter)
-    session.mount("https://", adapter)
-    return session

truefoundry/ml/__init__.py

@@ -1,6 +1,37 @@
-try:
-    from mlfoundry import *  # noqa: F403
-except ImportError:
-    print(
-        "To use metadata/artifact logging features, please run 'pip install truefoundry[ml]'."
-    )
+from truefoundry.ml.enums import (
+    DataSlice,
+    FileFormat,
+    ModelFramework,
+    ModelType,
+    ViewType,
+)
+from truefoundry.ml.exceptions import MlFoundryException
+from truefoundry.ml.log_types import Image, Plot
+from truefoundry.ml.log_types.artifacts.artifact import ArtifactPath, ArtifactVersion
+from truefoundry.ml.log_types.artifacts.dataset import DataDirectory, DataDirectoryPath
+from truefoundry.ml.log_types.artifacts.model import (
+    ModelVersion,
+)
+from truefoundry.ml.logger import init_logger
+from truefoundry.ml.mlfoundry_api import get_client
+from truefoundry.ml.mlfoundry_run import MlFoundryRun
+
+__all__ = [
+    "ArtifactPath",
+    "ArtifactVersion",
+    "DataDirectory",
+    "DataDirectoryPath",
+    "DataSlice",
+    "FileFormat",
+    "Image",
+    "MlFoundryRun",
+    "MlFoundryException",
+    "ModelFramework",
+    "ModelType",
+    "ModelVersion",
+    "Plot",
+    "ViewType",
+    "get_client",
+]
+
+init_logger()