oracle-ads 2.13.8__py3-none-any.whl → 2.13.9rc0__py3-none-any.whl

ads/common/object_storage_details.py

@@ -1,296 +0,0 @@
-#!/usr/bin/env python
-
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
-# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
-
-import json
-import os
-import re
-from concurrent.futures import ThreadPoolExecutor, as_completed
-from dataclasses import dataclass
-from typing import Dict, List
-from urllib.parse import urlparse
-
-import oci
-from ads.common import auth as authutil
-from ads.common import oci_client
-from ads.dataset.progress import TqdmProgressBar
-
-THREAD_POOL_MAX_WORKERS = 10
-
-
-class InvalidObjectStoragePath(Exception):  # pragma: no cover
-    """Invalid Object Storage Path."""
-
-    pass
-
-
-@dataclass
-class ObjectStorageDetails:
-    """Class that represents the Object Storage bucket URI details.
-
-    Attributes
-    ----------
-    bucket: str
-        The Object Storage bucket name.
-    namespace: (str, optional). Defaults to empty string.
-        The Object Storage namespace. Will be extracted automatically if not provided.
-    filepath: (str, optional). Defaults to empty string.
-        The path to the object.
-    version: (str, optional). Defaults to None.
-        The version of the object.
-    auth: (Dict, optional). Defaults to None.
-        ADS auth dictionary for OCI authentication.
-        This can be generated by calling ads.common.auth.api_keys() or ads.common.auth.resource_principal()
-        If this is None, ads.common.default_signer() will be used.
-    """
-
-    bucket: str
-    namespace: str = ""
-    filepath: str = ""
-    version: str = None
-    auth: Dict = None
-
-    def __post_init__(self):
-        if not self.auth:
-            self.auth = authutil.default_signer()
-        # Extract OS namespace if not provided.
-        if not self.namespace:
-            self.namespace = self.os_client.get_namespace().data
-
-    @property
-    def os_client(self):
-        if not hasattr(self, "__client"):
-            self.__client = self.create_os_client()
-        return self.__client
-
-    def create_os_client(self):
-        return oci_client.OCIClientFactory(**self.auth).object_storage
-
-    def __repr__(self):
-        return self.path
-
-    @property
-    def path(self):
-        """Full object storage path of this file."""
-        return os.path.join(
-            "oci://",
-            self.bucket + "@" + self.namespace,
-            self.filepath.lstrip("/") if self.filepath else "",
-        )
-
-    @classmethod
-    def from_path(cls, env_path: str) -> "ObjectStorageDetails":
-        """Construct an ObjectStorageDetails instance from conda pack path.
-
-        Parameters
-        ----------
-        env_path: (str)
-            codna pack object storage path.
-
-        Raises
-        ------
-        Exception: OCI conda url path not properly configured.
-
-        Returns
-        -------
-        ObjectStorageDetails
-            An ObjectStorageDetails instance.
-        """
-        try:
-            url_parse = urlparse(env_path)
-            bucket_name = url_parse.username
-            namespace = url_parse.hostname
-            object_name = url_parse.path.lstrip("/")
-            return cls(bucket=bucket_name, namespace=namespace, filepath=object_name)
-        except:
-            raise Exception(
-                "OCI path is not properly configured. "
-                "It should follow the pattern `oci://<bucket-name>@<namespace>/object_path`."
-            )
-
-    def to_tuple(self):
-        """Returns the values of the fields of ObjectStorageDetails class."""
-        return self.bucket, self.namespace, self.filepath
-
-    def fetch_metadata_of_object(self) -> Dict:
-        """Fetches the manifest metadata from the object storage of a conda pack.
-
-        Returns
-        -------
-        Dict
-            The metadata in dictionary format.
-        """
-        res = self.os_client.get_object(self.namespace, self.bucket, self.filepath)
-        metadata = res.data.headers["opc-meta-manifest"]
-        metadata_json = json.loads(metadata)
-        return metadata_json
-
-    @staticmethod
-    def is_valid_uri(uri: str) -> bool:
-        """Validates the Object Storage URI."""
-        if not re.match(r"oci://*@*", uri):
-            raise InvalidObjectStoragePath(
-                f"The `{uri}` is not a valid Object Storage path. "
-                "It must follow the pattern `oci://<bucket_name>@<namespace>/<prefix>`."
-            )
-        return True
-
-    @staticmethod
-    def is_oci_path(uri: str = None) -> bool:
-        """Check if the given path is oci object storage uri.
-
-        Parameters
-        ----------
-        uri: str
-            The URI of the target.
-
-        Returns
-        -------
-        bool: return True if the path is oci object storage uri.
-        """
-        if not uri:
-            return False
-        return uri.lower().startswith("oci://")
-
-    def is_bucket_versioned(self) -> bool:
-        """Check if the given bucket is versioned.
-        Returns
-        -------
-        bool: return True if the bucket is versioned.
-
-        """
-        res = self.os_client.get_bucket(
-            namespace_name=self.namespace, bucket_name=self.bucket
-        ).data
-        return res.versioning == "Enabled"
-
-    def list_objects(self, **kwargs):
-        """Lists objects in a given oss path
-            Parameters
-        -------
-        **kwargs:
-            namespace, bucket, filepath are set by the class. By default, fields gets all values. For other supported
-            parameters, check https://docs.oracle.com/iaas/api/#/en/objectstorage/20160918/Object/ListObjects
-
-        Returns
-        -------
-            Object of type oci.object_storage.models.ListObjects
-        """
-        fields = kwargs.pop(
-            "fields",
-            "name,etag,size,timeCreated,md5,timeModified,storageTier,archivalState",
-        )
-
-        objects = oci.pagination.list_call_get_all_results(
-            self.os_client.list_objects,
-            namespace_name=self.namespace,
-            bucket_name=self.bucket,
-            prefix=self.filepath,
-            fields=fields,
-            **kwargs,
-        ).data
-        return objects
-
-    def list_object_versions(
-        self,
-        **kwargs,
-    ):
-        """Lists object versions in a given oss path
-
-        Parameters
-        -------
-        **kwargs:
-            namespace, bucket, filepath are set by the class. By default, fields gets all values. For other supported
-            parameters, check https://docs.oracle.com/iaas/api/#/en/objectstorage/20160918/Object/ListObjectVersions
-
-        Returns
-        -------
-            Object of type oci.object_storage.models.ObjectVersionCollection
-        """
-        fields = kwargs.pop(
-            "fields",
-            "name,etag,size,timeCreated,md5,timeModified,storageTier,archivalState",
-        )
-
-        objects = oci.pagination.list_call_get_all_results(
-            self.os_client.list_object_versions,
-            namespace_name=self.namespace,
-            bucket_name=self.bucket,
-            prefix=self.filepath,
-            fields=fields,
-            **kwargs,
-        ).data
-        return objects
-
-    def download_from_object_storage(
-        self,
-        path: "ObjectStorageDetails",
-        target_dir: str,
-        progress_bar: TqdmProgressBar = None,
-    ):
-        """Downloads the files with object versions set in the paths dict.
-
-        Parameters
-        ----------
-        path:
-            OSS path along with a value of file version id.
-            If version_id is not available, download the latest version.
-        target_dir:
-            Local directory to save the files
-        progress_bar:
-            an instance of the TqdmProgressBar, can update description in the calling progress bar
-
-        Returns
-        -------
-            None
-        """
-        if progress_bar:
-            progress_bar.update(
-                description=f"Copying model artifacts by reference from {path.path} to {target_dir}",
-                n=0,
-            )
-        res = self.os_client.get_object(
-            namespace_name=path.namespace,
-            bucket_name=path.bucket,
-            object_name=path.filepath,
-            version_id=path.version,
-        )
-        local_filepath = os.path.join(target_dir, path.bucket, path.filepath)
-        os.makedirs(os.path.dirname(local_filepath), exist_ok=True)
-
-        with open(local_filepath, "wb") as _file:
-            for chunk in res.data.iter_content(chunk_size=4096):
-                _file.write(chunk)
-
-    def bulk_download_from_object_storage(
-        self,
-        paths: List["ObjectStorageDetails"],
-        target_dir: str,
-        progress_bar: TqdmProgressBar = None,
-    ):
-        """Downloads the files with object versions set in the paths dict parallely.
-
-        Parameters
-        ----------
-        paths:
-            Contains a list of OSS paths along with a value of file version id.
-            If version_id is not available, download the latest version.
-        target_dir:
-            Local directory to save the files
-        progress_bar:
-            an instance of the TqdmProgressBar, can update description in the calling progress bar
-
-        Returns
-        -------
-            None
-        """
-        with ThreadPoolExecutor(max_workers=THREAD_POOL_MAX_WORKERS) as pool:
-            futures = {
-                pool.submit(
-                    self.download_from_object_storage, path, target_dir, progress_bar
-                ): path
-                for path in paths
-            }
-            for future in as_completed(futures):
-                future.result()

ads/common/oci_client.py

@@ -1,175 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8; -*-
-
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
-# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
-
-import logging
-
-import oci.artifacts
-from oci.ai_language import AIServiceLanguageClient
-from oci.artifacts import ArtifactsClient
-from oci.data_catalog import DataCatalogClient
-from oci.data_flow import DataFlowClient
-from oci.data_labeling_service import DataLabelingManagementClient
-from oci.data_labeling_service_dataplane import DataLabelingClient
-from oci.data_science import DataScienceClient
-from oci.identity import IdentityClient
-from oci.marketplace import MarketplaceClient
-from oci.object_storage import ObjectStorageClient
-from oci.resource_search import ResourceSearchClient
-from oci.secrets import SecretsClient
-from oci.vault import VaultsClient
-from oci.logging import LoggingManagementClient
-from oci.core import VirtualNetworkClient
-from oci.limits import LimitsClient
-
-logger = logging.getLogger(__name__)
-
-
-class OCIClientFactory:
-    """
-    A factory class to create OCI client objects. The constructor takes in config, signer and client_kwargs. `client_kwargs` is passed
-    to the client constructor as key word arguments.
-
-    Examples
-    --------
-    from ads.common import auth as authutil
-    from ads.common import oci_client as oc
-
-    auth = authutil.default_signer()
-    oc.OCIClientFactory(**auth).object_storage # Creates Object storage client
-
-    auth = authutil.default_signer({"timeout": 6000})
-    oc.OCIClientFactory(**auth).object_storage # Creates Object storage client with timeout set to 6000
-
-    auth = authutil.api_keys(config="/home/datascience/.oci/config", profile="TEST", {"timeout": 6000})
-    oc.OCIClientFactory(**auth).object_storage # Creates Object storage client with timeout set to 6000 using API Key authentication
-
-    auth = authutil.resource_principal({"timeout": 6000})
-    oc.OCIClientFactory(**auth).object_storage # Creates Object storage client with timeout set to 6000 using resource principal authentication
-
-    auth = authutil.create_signer("instance_principal")
-    oc.OCIClientFactory(**auth).object_storage # Creates Object storage client using instance principal authentication
-    """
-
-    def __init__(self, config=None, signer=None, client_kwargs=None):
-        if not config:
-            config = {}
-        self.config = config
-        self.signer = signer
-        self.client_kwargs = client_kwargs
-
-    @staticmethod
-    def _client_impl(client):
-        client_map = {
-            "object_storage": ObjectStorageClient,
-            "data_science": DataScienceClient,
-            "dataflow": DataFlowClient,
-            "secret": SecretsClient,
-            "vault": VaultsClient,
-            "identity": IdentityClient,
-            "ai_language": AIServiceLanguageClient,
-            "data_labeling_dp": DataLabelingClient,
-            "data_labeling_cp": DataLabelingManagementClient,
-            "resource_search": ResourceSearchClient,
-            "data_catalog": DataCatalogClient,
-            "logging_management": LoggingManagementClient,
-            "virtual_network": VirtualNetworkClient,
-            "limits": LimitsClient,
-            "marketplace": MarketplaceClient,
-            "artifacts": ArtifactsClient,
-        }
-
-        assert (
-            client in client_map
-        ), f"Invalid client name. Client name not found in {client_map.keys()}"
-        return client_map[client]
-
-    @staticmethod
-    def _validate_auth_param(auth):
-        if not isinstance(auth, dict):
-            raise ValueError("auth parameter should be of type dictionary")
-        if "config" in auth and not isinstance(auth["config"], dict):
-            raise ValueError("auth[config] should be of type dict")
-        if "signer" in auth and auth["signer"] is None and len(auth["config"]) == 0:
-            raise ValueError(
-                "Signer is None and auth[config] is empty. Either assign config or if you are using resource principal, set resource principal signer to signer and {} for config"
-            )
-        return True
-
-    def create_client(self, client_name):
-        assert (
-            client_name is not None and client_name != ""
-        ), "Client name cannot be empty"
-        client = (
-            self._client_impl(client_name)
-            if isinstance(client_name, str)
-            else client_name
-        )
-        kwargs = self.client_kwargs or dict()
-        return client(config=self.config, signer=self.signer, **kwargs)
-
-    @property
-    def object_storage(self):
-        return self.create_client("object_storage")
-
-    @property
-    def identity(self):
-        return self.create_client("identity")
-
-    @property
-    def data_science(self):
-        return self.create_client("data_science")
-
-    @property
-    def dataflow(self):
-        return self.create_client("dataflow")
-
-    @property
-    def secret(self):
-        return self.create_client("secret")
-
-    @property
-    def vault(self):
-        return self.create_client("vault")
-
-    @property
-    def ai_language(self):
-        return self.create_client("ai_language")
-
-    @property
-    def data_labeling_cp(self):
-        return self.create_client("data_labeling_cp")
-
-    @property
-    def data_labeling_dp(self):
-        return self.create_client("data_labeling_dp")
-
-    @property
-    def resource_search(self):
-        return self.create_client("resource_search")
-
-    @property
-    def data_catalog(self):
-        return self.create_client("data_catalog")
-
-    @property
-    def logging_management(self):
-        return self.create_client("logging_management")
-
-    @property
-    def virtual_network(self):
-        return self.create_client("virtual_network")
-
-    @property
-    def limits(self):
-        return self.create_client("limits")
-
-    @property
-    def marketplace(self):
-        return self.create_client("marketplace")
-
-    @property
-    def artifacts(self) -> oci.artifacts.ArtifactsClient:
-        return self.create_client("artifacts")

ads/common/oci_datascience.py

@@ -1,46 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8; -*-
-
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
-# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
-
-import os
-
-import oci.data_science
-
-from ads.common.decorator.utils import class_or_instance_method
-from ads.common.oci_mixin import OCIModelMixin
-
-ENV_VAR_OCI_ODSC_SERVICE_ENDPOINT = "OCI_ODSC_SERVICE_ENDPOINT"
-
-
-class OCIDataScienceMixin(OCIModelMixin):
-    @class_or_instance_method
-    def init_client(cls, **kwargs) -> oci.data_science.DataScienceClient:
-        client_kwargs = kwargs.get("client_kwargs", {})
-        if os.environ.get(ENV_VAR_OCI_ODSC_SERVICE_ENDPOINT):
-            client_kwargs.update(
-                dict(service_endpoint=os.environ.get(ENV_VAR_OCI_ODSC_SERVICE_ENDPOINT))
-            )
-            kwargs.update(client_kwargs)
-        return cls._init_client(client=oci.data_science.DataScienceClient, **kwargs)
-
-    @property
-    def client(self) -> oci.data_science.DataScienceClient:
-        return super().client
-
-    @property
-    def client_composite(self) -> oci.data_science.DataScienceClientCompositeOperations:
-        return oci.data_science.DataScienceClientCompositeOperations(self.client)
-
-
-class DSCNotebookSession(OCIDataScienceMixin, oci.data_science.models.NotebookSession):
-    """Represents a data science notebook session
-
-    To get the information of an existing notebook session:
-    >>> notebook = DSCNotebookSession.from_ocid(NOTEBOOK_OCID)
-    Get the name of the notebook session
-    >>> notebook.display_name
-    Get the subnet ID of the notebook session
-    >>> notebook.notebook_session_configuration_details.subnet_id
-    """