teradataml 20.0.0.2__py3-none-any.whl → 20.0.0.4__py3-none-any.whl

teradataml/plot/plot.py

@@ -472,26 +472,78 @@ class _Plot:
             self.figure = Figure()
         self._figure = self.figure
 
-        axis = kwargs.get("ax")
+        self.axis = kwargs.get("ax", None)
         # If axis is not passed, generate a default one.
-        if axis is None:
-            axis = Axis(kind=kind, **kwargs)
+        if self.axis is None:
+            self.axis = Axis(kind=kind, **kwargs)
         else:
             # If user passes axes, i.e., for subplot, add additional params
             # which is passed as kwargs.
-            axis.set_params(kind=kind, **kwargs)
+            self.axis.set_params(kind=kind, **kwargs)
 
         # Set the axis data.
-        axis._set_data(x, y, scale=scale)
+        self.axis._set_data(x, y, scale=scale)
 
         # Add the axis to figure.
-        self._figure._add_axis(axis)
+        self._figure._add_axis(self.axis)
         self._query = None
         self._plot_image_data = None
-        self.__heading = kwargs.get("heading")
-        _Validators._validate_input_columns_not_empty(self.__heading, "heading")
+        self.heading = kwargs.get("heading")
+        _Validators._validate_input_columns_not_empty(self.heading, "heading")
         self.__params = kwargs
 
+    def __eq__(self, other):
+        """
+        DESCRIPTION:
+            Magic method to check if two Plot objects are equal or not.
+            If all the associated parameters are same, then two Plot objects
+            are equal. Else, they are not equal.
+
+        PARAMETERS:
+            other:
+                Required Argument.
+                Specifies the object of Plot.
+                Types: Plot
+
+        RETURNS:
+            bool
+
+        RAISES:
+            None.
+
+        EXAMPLES:
+            >>> _Plot() == _Plot()
+        """
+
+        # Check whether x and y are same or not.
+        # If two plots to be same, their data and plot parameters to be same.
+        if self.x.compile() != other.x.compile():
+            return False
+
+        self_y = (self.y, ) if isinstance(self.y, ColumnExpression) else self.y
+        other_y = (other.y, ) if isinstance(other.y, ColumnExpression) else other.y
+
+        if len(self_y) != len(other_y):
+            return False
+
+        for self_col, other_col in zip(self_y, other_y):
+            if self_col.compile() != other_col.compile():
+                return False
+
+        # Validate plot parameters are same or not.
+        attrs = ["scale", "kind",
+                 "figsize", "figtype", "figdpi",
+                 "heading", "wiggle_fill", "wiggle_scale",
+                 "axis", "figure"]
+
+        for attr in attrs:
+            if getattr(self, attr) == getattr(other, attr):
+                continue
+            else:
+                return False
+
+        return True
+
     def _execute_query(self):
         """
         DESCRIPTION:
@@ -504,7 +556,6 @@ class _Plot:
             query = self._get_query()
 
             res = get_connection().execute(text(query))
-
             self._plot_image_data = res.fetchone().IMAGE
 
     def show_query(self):
@@ -563,9 +614,8 @@ class _Plot:
             >>> plot = ibm_stock.plot(x=ibm_stock.period, y=ibm_stock.stockprice, kind="bar")
             >>> plot.show()
         """
-        query = self._get_query()
-
-        self._execute_query()
+        if self._plot_image_data is None:
+            self._execute_query()
 
         # If user choose for inline plot, then check if Python console supports
         # inline plotting or not. If not supports, then go for outline plot.
@@ -691,7 +741,7 @@ class _Plot:
                                     "HEIGHT": height
                                     })
 
-            heading = self.__heading if self.__heading is not None else self._figure.heading
+            heading = self.heading if self.heading is not None else self._figure.heading
             if heading:
                 func_other_args["TITLE"] = "'{}'".format(heading)
 

teradataml/scriptmgmt/UserEnv.py

@@ -86,8 +86,8 @@ def _get_ues_url(env_type="users", **kwargs):
         raise TeradataMlException(error_msg, MessageCodes.FUNC_EXECUTION_FAILED)
 
     if configure.ues_url is None:
-        error_msg = Messages.get_message(MessageCodes.DEPENDENT_ARGUMENT,
-                                         api_name, 'configure.ues_url')
+        error_msg = Messages.get_message(MessageCodes.SET_REQUIRED_PARAMS,
+                                         'Authentication Token', api_name, 'set_auth_token')
         raise RuntimeError(error_msg)
 
     ues_url = "{}/{}".format(configure.ues_url, env_type)
@@ -205,7 +205,7 @@ def _process_ues_response(api_name, response, success_status_code=None):
 def _get_auth_token():
     """
     DESCRIPTION:
-        Internal function to get Authentication token for all UES REST calls
+        Internal function to get Authentication token for all CCP enabled REST calls
 
     PARAMETERS:
         None
@@ -238,8 +238,8 @@ def _get_auth_token():
 
             # Store the jwt token in internal class attribute.
             _InternalBuffer.add(auth_token=_AuthToken(token=token_data["access_token"]))
-
-    return {"Authorization": "Bearer {}".format(_InternalBuffer.get("auth_token").value)}
+    if _InternalBuffer.get("auth_token"):
+        return {"Authorization": "Bearer {}".format(_InternalBuffer.get("auth_token").value)}
 
 
 class UserEnv:

teradataml/scriptmgmt/lls_utils.py

@@ -23,6 +23,7 @@ from json.decoder import JSONDecodeError
 from teradataml import configure
 from teradataml.context.context import _get_user, get_connection
 from teradataml.common.constants import HTTPRequest, AsyncStatusColumns
+from teradataml.common.deprecations import argument_deprecation
 from teradataml.common.exceptions import TeradataMlException
 from teradataml.common.messages import Messages
 from teradataml.common.messagecodes import MessageCodes
@@ -40,7 +41,6 @@ from urllib.parse import parse_qs, urlparse
 from teradataml.utils.utils import _async_run_id_info
 from teradataml.telemetry_utils.queryband import collect_queryband
 
-
 @collect_queryband(queryband="LstBsEnv")
 def list_base_envs():
     """
@@ -74,6 +74,11 @@ def list_base_envs():
             5        r_4.0.2        R   4.0.2
             >>>
     """
+    # Check if the cache data is available and is not stale.
+    # If available, return the data.
+    if _InternalBuffer.get('list_base_envs') is not None:
+        return _InternalBuffer.get('list_base_envs')
+
     try:
         response = UtilFuncs._http_request(_get_ues_url("base_environments"), headers=_get_auth_token())
 
@@ -86,7 +91,8 @@ def list_base_envs():
             return
 
         # Create a pandas DataFrame from data.
-        return pd.DataFrame.from_records(data)
+        _InternalBuffer.add(list_base_envs=pd.DataFrame.from_records(data))
+        return _InternalBuffer.get('list_base_envs')
 
     except (TeradataMlException, RuntimeError):
         raise
@@ -417,31 +423,37 @@ def __create_envs(template):
                 # Install files if requested any.
                 if files:
                     print("Installing files in environment '{}'...".format(env_name))
-                    try:
-                        if isinstance(files, str):
-                            files = [files]
+                    if isinstance(files, str):
+                        files = [files]
 
-                        for file in files:
+                    for file in files:
+                        try:
                             if os.path.isfile(file):
                                 env_handle.install_file(file)
                             elif os.path.isdir(file):
-                                __install_files(env_handle, file)
-                        print("File installation in environment '{}' - Completed.".format(env_name))
-                    except Exception as file_installation_failure:
-                        print("Failed to process file installation request for environment: '{}'".format(env_name))
-                        print(str(file_installation_failure))
-                        errored = errored or True
-                        pass
+                                errored = __install_files(env_handle, file)
+                        except Exception as file_installation_failure:
+                            print("Failed to install file '{}' in environment '{}'.".format(file, env_name))
+                            print(str(file_installation_failure))
+                            errored = True
+                            pass
 
                 # Install libraries if requested any.
                 if libs or libs_file_path:
                     print("Installing libraries in environment '{}'...".format(env_name))
                     try:
-                        env_handle.install_lib(libs, libs_file_path)
-                        print("Libraries installation in environment '{}' - Completed.".format(env_name))
+                        status = env_handle.install_lib(libs, libs_file_path)
+                        if status['Stage'][1] == 'Errored':
+                            err_message = status['Additional Details'][1].replace("Error with package maintenance -> ", "\n")
+                            raise Exception(err_message)
+                        else:
+                            print("Libraries installation in environment '{}' - Completed.".format(env_name))
                     except Exception as lib_installation_failure:
-                        print("Failed to process library installation request for environment: '{}'".format(env_name))
-                        print(str(lib_installation_failure))
+                        error_code = MessageCodes.FUNC_EXECUTION_FAILED
+                        error_msg = Messages.get_message(error_code,
+                                                         "'install_lib' request for enviornment: '{}'".format(env_name), 
+                                                         '\n'+str(lib_installation_failure))
+                        print(error_msg)
                         errored = errored or True
                         pass
 
@@ -465,6 +477,10 @@ def __get_default_base_env():
     Function returns the latest python environment available with
     Open Analytics Framework.
     """
+    # Check if the default base environment is already available.
+    if _InternalBuffer.get('default_base_env') is not None:
+        return _InternalBuffer.get('default_base_env')
+
     try:
         base_envs = list_base_envs()
         python_versions = base_envs[base_envs.language == 'Python']['version']
@@ -474,7 +490,9 @@ def __get_default_base_env():
         latest_version_tuple = max(version_tuples)
         # Convert the latest version tuple back to a string
         latest_version = '.'.join(map(str, latest_version_tuple))
-        return base_envs[base_envs.version == latest_version]['base_name'].to_list()[0]
+        # Get the base environment name for the latest version
+        _InternalBuffer.add(default_base_env=base_envs[base_envs.version == latest_version]['base_name'].to_list()[0])
+        return _InternalBuffer.get('default_base_env')
     except Exception as base_env_err:
         raise Exception("Failed to obtain default base environment.", str(base_env_err.exception))
 
@@ -484,9 +502,20 @@ def __install_files(env, directory):
     Function to install files under given directory and
     all the subdirectories recursively.
     """
+    errored = False
     for (dir_path, dir_names, file_names) in os.walk(directory):
+        # install the files under all the directories.
+        # If any problem with any file installation, skip the error
+        # and proceed to install other files.
         for file_name in file_names:
-            env.install_file(os.path.join(dir_path, file_name))
+            try:
+                env.install_file(os.path.join(dir_path, file_name))
+            except Exception as file_installation_failure:
+                print("Failed to install file '{}' in environment '{}'.".format(file_name, env.env_name))
+                print(str(file_installation_failure))
+                errored = True
+
+    return errored
 
 
 @collect_queryband(queryband="CrtEnv")
@@ -741,10 +770,30 @@ def create_env(env_name=None, base_env=None, desc=None, template=None, conda_env
         # Validate arguments
         _Validators._validate_function_arguments(__arg_info_matrix, skip_empty_check=False)
 
-        # Get the latest python base env in OpenAF, if base_env is not provided.
+        # Get the latest python base env in OpenAF, if base_env is not provided,
+        # Or if base_env is provided and not in the list of base envs.
         # Note: By default python base env is obtained.
-        if not base_env:
-            base_env = __get_default_base_env()
+        if configure.ues_url is not None and \
+        get_connection() is not None:
+            # Check if base_env is provided or not in the list of base envs.
+
+            # Check if user requested for conda environment but do not specify the base_env.
+            # In such case, set base_env to the default python base environment.
+            if conda_env:
+                if base_env is None:
+                    base_env = __get_default_base_env()
+            # Not a conda environment.
+            else:
+                # Check if base_env provided or not. If provided, check if it is available in
+                # the list of base envs. If not available, set base_env to the default python base env.
+                if not base_env or \
+                    base_env.lower() not in list_base_envs()['base_name'].str.lower().to_list():
+                    # Print warning message if base_env provided is not available.
+                    if base_env:
+                        print(f"Note: The specified base environment '{base_env}' is unavailable. "\
+                               "Using the default base environment as specified in the documentation.")
+                    # Set base_env to the default
+                    base_env = __get_default_base_env()
         if not desc:
             desc = "This env '{}' is created with base env '{}'.".format(env_name, base_env)
         try:
@@ -1550,7 +1599,7 @@ def get_user_env():
 
 
 @collect_queryband(queryband="StAthTkn")
-def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwargs):
+def set_auth_token(base_url=None, client_id=None, pat_token=None, pem_file=None, **kwargs):
     """
     DESCRIPTION:
         Function to set the Authentication token to connect to User Environment Service
@@ -1558,14 +1607,14 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         Note:
             User must have a privilege to login with a NULL password to use set_auth_token().
             Please refer to GRANT LOGON section in Teradata Documentation for more details.
-            If ues_url and client_id are specified then authentication is through OAuth.
-            If ues_url, pat_token, pem_file are specified then authentication is through PAT.
+            If base_url and client_id are specified then authentication is through OAuth.
+            If base_url, pat_token, pem_file are specified then authentication is through PAT.
             Refresh token still works but only for OAuth authentication.
 
     PARAMETERS:
-        ues_url:
+        base_url:
             Required Argument.
-            Specifies the URL for User Environment Service in VantageCloud Lake.
+            Specifies the CCP endpoint URL.
             Types: str
 
         client_id:
@@ -1601,6 +1650,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
                 Default Value: 31536000
                 Types: int
 
+            auth_token:
+                Optional Parameter.
+                Specifies the authentication token to connect to VantageCloud Lake.
+                Notes:
+                     * if "auth_token" is set through this function, then this function
+                       should always be used only after create_context.
+                     * use this option only if user has got JWT token and wants to set the same
+                       instead of generating it again from this function.
+                Types: str
+
     RETURNS:
         True, if the operation is successful.
 
@@ -1611,16 +1670,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
 
         # Example 1: Set the Authentication token using default client_id.
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "))
+        >>> set_auth_token(base_url=getpass.getpass("ues_url : "))
 
         # Example 2: Set the Authentication token by specifying the client_id.
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                client_id=getpass.getpass("client_id : "))
 
         # Example 3: Set the Authentication token by specifying the "pem_file" and "pat_token"
         #            without specifying "username".
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                pat_token=getpass.getpass("pat_token : "),
         ...                pem_file=getpass.getpass("pem_file : "))
         True
@@ -1628,7 +1687,7 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         # Example 4: Set the Authentication token by specifying the "pem_file" and "pat_token"
         #            and "username".
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                pat_token=getpass.getpass("pat_token : "),
         ...                pem_file=getpass.getpass("pem_file : "))
         ...                username = "alice")
@@ -1640,8 +1699,12 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_CONTEXT_CONNECTION), 
                                   MessageCodes.INVALID_CONTEXT_CONNECTION)
 
+    # Getting the ues_url.
+    ues_url = kwargs.get("ues_url", None)
+
     __arg_info_matrix = []
-    __arg_info_matrix.append(["ues_url", ues_url, False, (str), True])
+    __arg_info_matrix.append(["base_url", base_url, True, (str), True])
+    __arg_info_matrix.append(["ues_url", ues_url, True, (str), True])
     __arg_info_matrix.append(["client_id", client_id, True, (str), True])
     __arg_info_matrix.append(["pat_token", pat_token, True, (str), True])
     __arg_info_matrix.append(["pem_file", pem_file, True, (str), True])
@@ -1649,12 +1712,38 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
     username = kwargs.get("username", None)
     __arg_info_matrix.append((["username", username, True, (str), True]))
 
+    auth_token = kwargs.get("auth_token")
+    __arg_info_matrix.append((["auth_token", auth_token, True, (str), True]))
+
     expiration_time = kwargs.get("expiration_time", 31536000)
     __arg_info_matrix.append((["expiration_time", expiration_time, True, (int), True]))
 
     # Validate arguments.
     _Validators._validate_function_arguments(__arg_info_matrix)
 
+    # base_url should not end with 'open-analytics' or 'data-insights'
+    if base_url:
+        if base_url.endswith('open-analytics') or base_url.endswith('data-insights'):
+            message = Messages.get_message(MessageCodes.ARG_NONE,
+                                           "base_url", "ending with 'data-insights' or 'open-analytics", None)
+            raise TeradataMlException(message, MessageCodes.ARG_NONE)
+
+        # Set the vector_store_base_url. This should only be done if base_url is set.
+        # In case ues_url is set, vector_store_base_url should not be set.
+        configure._vector_store_base_url = f'{base_url}/data-insights'
+
+    # If ues_url is provided, then use it as base_url.
+    base_url = kwargs.get("ues_url", base_url)
+
+    # Set the OpenAF url.
+    # If ues_url is present use that otherwise generate it from base_url.
+    configure.ues_url = ues_url if ues_url else f'{base_url}/open-analytics'
+
+    # If user pass Auth token, set it.
+    if auth_token:
+        _InternalBuffer.add(auth_token=_AuthToken(token=auth_token))
+        return True
+
     if client_id and any([pat_token, pem_file]):
         message = Messages.get_message(MessageCodes.EITHER_THIS_OR_THAT_ARGUMENT,
                                        "client_id", "pat_token' and 'pem_file")
@@ -1670,16 +1759,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
     if pem_file is not None:
         _Validators._validate_file_exists(pem_file)
 
-    # Extract the base URL from "ues_url".
-    url_parser = urlparse(ues_url)
-    base_url = "{}://{}".format(url_parser.scheme, url_parser.netloc)
+    # Extract the base URL.
+    url_parser = urlparse(base_url)
+    parsed_base_url = "{}://{}".format(url_parser.scheme, url_parser.netloc)
     netloc = url_parser.netloc.split('.')[0]
 
     # Check if the authentication is PAT based or OAuth.
     if all(arg is None for arg in [pat_token, pem_file]):
         configure._oauth = True
         client_id = "{}-oaf-device".format(netloc) if client_id is None else client_id
-        da_wf = _DAWorkflow(base_url, client_id)
+        da_wf = _DAWorkflow(parsed_base_url, client_id)
         token_data = da_wf._get_token_data()
 
         # Set Open AF parameters.
@@ -1702,7 +1791,7 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
 
         # Construct a dictionary to be passed to _AuthWorkflow().
         state_dict = {}
-        state_dict["base_url"] = base_url
+        state_dict["base_url"] = parsed_base_url
         state_dict["org_id"] = org_id
         state_dict["pat_token"] = pat_token
         state_dict["pem_file"] = pem_file
@@ -1713,8 +1802,9 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         token_data = auth_wf._proxy_jwt()
         # Store the jwt token in internal class attribute.
         _InternalBuffer.add(auth_token=_AuthToken(token=token_data))
-
-    # Set Open AF parameters.
-    configure.ues_url = ues_url
+    # If set_auth_token is triggered then it will be ccp_enabled = True.
+    # The function returns if we have just passed the auth_token, thus
+    # having ccp_enabled = False.
+    configure._ccp_enabled = True
 
     return True

teradataml/store/__init__.py

@@ -0,0 +1,12 @@
+"""
+Copyright (c) 2024 by Teradata Corporation. All rights reserved.
+TERADATA CORPORATION CONFIDENTIAL AND TRADE SECRET
+
+Primary Owner: pradeep.garre@teradata.com
+Secondary Owner: aanchal.kavedia@teradata.com
+
+This file imports components from Feature Store and Vector Store.
+"""
+
+from teradataml.store.feature_store.feature_store import FeatureStore
+from teradataml.store.feature_store.models import *