teradataml 17.20.0.6__py3-none-any.whl → 20.0.0.0__py3-none-any.whl

teradataml/scriptmgmt/lls_utils.py

@@ -37,13 +37,18 @@ import warnings
 import webbrowser
 from urllib.parse import parse_qs, urlparse
 from teradataml.utils.utils import _async_run_id_info
+from teradatasqlalchemy.telemetry.queryband import collect_queryband
 
 
+@collect_queryband(queryband="LstBsEnv")
 def list_base_envs():
     """
     DESCRIPTION:
-        Lists the available Python OR R base environments versions configured in the
+        Lists the available Python and R base environments versions configured in the
         Open Analytics Framework.
+        Note:
+            Function is not applicable for conda environments.
+            User can use any Python version while creating conda environment as long as Anaconda supports it.
 
     PARAMETERS:
             None.
@@ -90,6 +95,7 @@ def list_base_envs():
         raise TeradataMlException(error_msg, msg_code)
 
 
+@collect_queryband(queryband="LstUsrEnv")
 def list_user_envs(env_name=None, **kwargs):
     """
     DESCRIPTION:
@@ -118,7 +124,15 @@ def list_user_envs(env_name=None, **kwargs):
             Specifies whether filtering operation should be case sensitive or not.
             Default Value: False
             Types: boolean
-        
+
+        conda_env:
+            Optional Argument.
+            Specifies the boolean value to filter the conda environment(s).
+            When set to True, all conda environments are listed.
+            When set to False, all non-conda environments are listed.
+            If not specified, all user environments are listed.
+            Types: bool
+
         regex:
             Optional Argument.
             Specifies whether string passed to "env_name", "base_env", and "desc"
@@ -172,64 +186,74 @@ def list_user_envs(env_name=None, **kwargs):
         ...            'r_3.6.3',
         ...            'Prediction of carbon credits consumption.')
         User environment 'Carbon_Credits' created.
-        
+        >>> create_env('Sales_cond_env',
+        ...            'python_3.9',
+        ...            'Sales team environment.',
+        ...            conda_env=True)
+        Conda environment creation initiated
+        User environment 'Sales_cond_env' created.
+
         # Example 1: List all available user environments.
         >>> list_user_envs()
-                   env_name                           env_description  base_env_name language
-        0    Carbon_Credits  Prediction of carbon credits consumption        r_3.6.3        R
-        1   Customer_Trends                   Analyse customer trends        r_4.1.3        R
-        2   Fraud_Detection     Fraud detection through time matching  python_3.7.13   Python
-        3     Lie_Detection       Lie detection through time matching  python_3.7.13   Python
-        4  Lie_Detection_ML      Detect lie through machine learning.  python_3.8.13   Python
-        5         Sales_env                   Sales team environment.  python_3.9.13   Python
-        >>>
+                   env_name                           env_description  base_env_name language  conda
+        0    Carbon_Credits  Prediction of carbon credits consumption        r_3.6.3        R  False
+        1   Customer_Trends                   Analyse customer trends        r_4.1.3        R  False
+        2   Fraud_Detection     Fraud detection through time matching  python_3.7.13   Python  False
+        3     Lie_Detection       Lie detection through time matching  python_3.7.13   Python  False
+        4  Lie_Detection_ML      Detect lie through machine learning.  python_3.8.13   Python  False
+        5         Sales_env                   Sales team environment.  python_3.9.13   Python  False
+        6    Sales_cond_env                   Sales team environment.     python_3.9   Python  True
+
 
         # Example 2: List all user environments with environment name containing string
         #            "Detection" and description that contains string "."(period).
         >>> list_user_envs(env_name="Detection", desc=".", regex=False)
-                   env_name                       env_description  base_env_name language
-        4  Lie_Detection_ML  Detect lie through machine learning.  python_3.8.13   Python
+                   env_name                       env_description base_env_name language  conda
+        2  Lie_Detection_ML  Detect lie through machine learning. python_3.8.13   Python  False
         >>>
 
         # Example 3: List all user environments with description that contains string "lie"
         #            and is case sensitive. 
         >>> list_user_envs(desc="lie", case=True)
-                   env_name                       env_description  base_env_name language
-        4  Lie_Detection_ML  Detect lie through machine learning.  python_3.8.13   Python
+                   env_name                       env_description  base_env_name language  conda
+        4  Lie_Detection_ML  Detect lie through machine learning.  python_3.8.13   Python  False
         >>>
 
         # Example 4: List all user environments with base environment version containing string
         #            "3.".
         >>> list_user_envs(base_env="3.")
-                   env_name                           env_description  base_env_name language
-        0    Carbon_Credits  Prediction of carbon credits consumption        r_3.6.3        R
-        2   Fraud_Detection     Fraud detection through time matching  python_3.7.13   Python
-        3     Lie_Detection       Lie detection through time matching  python_3.7.13   Python
-        4  Lie_Detection_ML      Detect lie through machine learning.  python_3.8.13   Python
-        5         Sales_env                   Sales team environment.  python_3.9.13   Python
+                   env_name                           env_description  base_env_name language  conda
+        0    Carbon_Credits  Prediction of carbon credits consumption        r_3.6.3        R  False
+        2   Fraud_Detection     Fraud detection through time matching  python_3.7.13   Python  False
+        3     Lie_Detection       Lie detection through time matching  python_3.7.13   Python  False
+        4  Lie_Detection_ML      Detect lie through machine learning.  python_3.8.13   Python  False
+        5         Sales_env                   Sales team environment.  python_3.9.13   Python  False
+        6   Sales_conda_env                   Sales team environment.     python_3.9   Python  True
+
         >>>
 
         # Example 5: List all user environments with environment name contains string "detection",
         #            description containing string "fraud" and base environment containing string "3.7".
         >>> list_user_envs("detection", desc="fraud", base_env="3.7")
-                  env_name                        env_description  base_env_name language
-        2  Fraud_Detection  Fraud detection through time matching  python_3.7.13   Python
+                  env_name                        env_description  base_env_name language  conda
+        2  Fraud_Detection  Fraud detection through time matching  python_3.7.13   Python  False
         >>>
 
         # Example 6: List all user environments with environment name that ends with "detection".
         >>> list_user_envs("detection$")
-                  env_name                        env_description  base_env_name language
-        2  Fraud_Detection  Fraud detection through time matching  python_3.7.13   Python
-        3    Lie_Detection    Lie detection through time matching  python_3.7.13   Python
+                  env_name                        env_description  base_env_name language  conda
+        2  Fraud_Detection  Fraud detection through time matching  python_3.7.13   Python  False
+        3    Lie_Detection    Lie detection through time matching  python_3.7.13   Python  False
         >>>
 
         # Example 7: List all user environments with description that has either "lie" or "sale".
         #            Use re.VERBOSE flag to add inline comment.
         >>> list_user_envs(desc="lie|sale # Search for lie or sale.", flags=re.VERBOSE)
-                   env_name                       env_description  base_env_name language
-        3     Lie_Detection   Lie detection through time matching  python_3.7.13   Python
-        4  Lie_Detection_ML  Detect lie through machine learning.  python_3.8.13   Python
-        5         Sales_env               Sales team environment.  python_3.9.13   Python
+                   env_name                       env_description  base_env_name language  conda
+        3     Lie_Detection   Lie detection through time matching  python_3.7.13   Python  False
+        4  Lie_Detection_ML  Detect lie through machine learning.  python_3.8.13   Python  False
+        5         Sales_env               Sales team environment.  python_3.9.13   Python  False
+        6   Sales_conda_env               Sales team environment.     python_3.9   Python  True
         >>>
 
         # Example 8: List all user environments where python 3 environment release version has 
@@ -242,6 +266,11 @@ def list_user_envs(env_name=None, **kwargs):
         5        Sales_env                Sales team environment.  python_3.9.13   Python
         >>>
 
+        # Example 9: List all conda environments.
+        >>> list_user_envs(conda_env=True)
+                  env_name          env_description base_env_name language  conda
+        6  Sales_conda_env  Sales team environment.    python_3.9   Python   True
+        >>>
         # Remove example environments.
         remove_env("Fraud_Detection")
         remove_env("Lie_Detection")
@@ -249,14 +278,18 @@ def list_user_envs(env_name=None, **kwargs):
         remove_env("Sales_env")
         remove_env("Carbon_Credits")
         remove_env("Customer_Trends")
+        remove_env("Sales_conda_env")
     """
     base_env = kwargs.pop("base_env", None)
     desc = kwargs.pop("desc", None)
     case = kwargs.pop("case", False)
+    conda_env = kwargs.pop("conda_env", None)
+
     __arg_info_matrix = []
     __arg_info_matrix.append(["env_name", env_name, True, (str), True])
     __arg_info_matrix.append(["base_env", base_env, True, (str), True])
     __arg_info_matrix.append(["desc", desc, True, (str), True])
+    __arg_info_matrix.append(["conda_env", conda_env, True, (bool)])
 
     # Validate arguments
     _Validators._validate_function_arguments(__arg_info_matrix)
@@ -283,7 +316,6 @@ def list_user_envs(env_name=None, **kwargs):
 
             # Return result as Pandas dataframe.
             pandas_df = pd.DataFrame.from_records(data)
-
             # Filter based on arguments passed by user.
             exprs = []
             if env_name is not None:
@@ -292,6 +324,8 @@ def list_user_envs(env_name=None, **kwargs):
                 exprs.append(pandas_df.base_env_name.str.contains(pat=base_env, case=case, **kwargs))
             if desc is not None:
                 exprs.append(pandas_df.env_description.str.contains(pat=desc, case=case, **kwargs))
+            if conda_env is not None:
+                exprs.append(pandas_df.conda == conda_env)
 
             pandas_df = pandas_df[functools.reduce(operator.and_, exprs)] if exprs else pandas_df
 
@@ -361,6 +395,8 @@ def __create_envs(template):
     for env_request in requested_envs:
         # Create env.
         env_name = env_request.get('env_name', None)
+        conda_env = env_request.get('conda_env', False)
+
         if env_name:
             try:
                 # Remove from dictionary and store the specifications
@@ -371,7 +407,9 @@ def __create_envs(template):
 
                 print("Creating environment '{}'...".format(env_name))
                 create_env(**env_request)
+
                 print("An empty environment '{}' is created.".format(env_name))
+
                 env_handle = get_env(env_name)
 
                 errored = False
@@ -450,7 +488,8 @@ def __install_files(env, directory):
             env.install_file(os.path.join(dir_path, file_name))
 
 
-def create_env(env_name=None, base_env=None, desc=None, template=None):
+@collect_queryband(queryband="CrtEnv")
+def create_env(env_name=None, base_env=None, desc=None, template=None, conda_env=False):
     """
     DESCRIPTION:
         Creates isolated remote user environment(s) in the Open Analytics
@@ -474,10 +513,12 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
             Specifies the name of the base Python or R environment
             to be used to create remote user environment when "env_name"
             is provided. This argument is ignored when "template" is provided.
-            Note:
-                *   When "base_env" is not provided, latest available Python
-                    base environment is used. To check available base
-                    environments use list_base_envs().
+            Notes:
+                 *   When "base_env" is not provided, highest Python
+                     base environment listed by list_base_envs() is used.
+                 *   When creating a conda environment, user can pass any Python version
+                     supported by Anaconda to "base_env", irrespective of base environments
+                     listed with list_base_envs().
             Types: str
 
         desc:
@@ -533,6 +574,16 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
                   above. Check example for more details.
             Types: str
 
+        conda_env:
+            Optional Argument.
+            Specifies whether the environment to be created is a conda environment or not.
+            When set to True, conda environment is created.
+            Otherwise, non conda environment is created.
+            Note:
+                * Currently, only Python conda environment is supported.
+            Default value: False
+            Types: bool
+
 
     RETURNS:
         An object of class UserEnv representing the user environment.
@@ -660,6 +711,15 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
         27       tcltk    4.1.3
         28       tools    4.1.3
         29       utils    4.1.3
+
+        # Example 4: Create a Conda Python 3.8 environment with given name and
+        #            description in the Vantage.
+        >>> fraud_detection_env = create_env('Fraud_detection_conda',
+        ...                                  'python_3.8',
+        ...                                  'Fraud detection through time matching',
+                                              conda_env=True)
+            Conda environment creation initiated
+            User environment 'Fraud_detection_conda' created.
     """
 
     # Either env_name or template can be used.
@@ -675,6 +735,8 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
         __arg_info_matrix.append(["env_name", env_name, False, (str), True])
         __arg_info_matrix.append(["base_env", base_env, True, (str), True])
         __arg_info_matrix.append(["desc", desc, True, (str)])
+        __arg_info_matrix.append(["conda_env", conda_env, True, (bool)])
+
         # Validate arguments
         _Validators._validate_function_arguments(__arg_info_matrix, skip_empty_check=False)
 
@@ -689,14 +751,21 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
                     "env_description": desc,
                     "base_env_name": base_env
                     }
-
             response = UtilFuncs._http_request(
-                _get_ues_url(), HTTPRequest.POST, headers=_get_auth_token(), json=data)
+                _get_ues_url(conda_env=conda_env), HTTPRequest.POST, headers=_get_auth_token(), json=data)
 
-            # Validate the ues response.
-            _process_ues_response(api_name="create_env", response=response)
+            # UES reponse.
+            resp = _process_ues_response(api_name="create_env", response=response)
 
-            print("User environment '{0}' created.".format(env_name))
+            msg = "User environment '{}' created."
+
+            if conda_env:
+                print("Conda environment creation initiated")
+                # Get claim_id.
+                claim_id = response.json().get("claim_id", "")
+                # Poll the claim_id status.
+                __poll_claim_id_status(claim_id, "create_env")
+            print(msg.format(env_name))
 
             # Return an instance of class UserEnv.
             return UserEnv(env_name, base_env, desc)
@@ -709,8 +778,9 @@ def create_env(env_name=None, base_env=None, desc=None, template=None):
             error_msg = Messages.get_message(msg_code, "create_env", str(emsg))
             raise TeradataMlException(error_msg, msg_code)
 
-    # When template is provided, proceed with recursive way.
-    return __create_envs(template)
+    else:
+        # When template is provided, proceed with recursive way.
+        return __create_envs(template)
 
 
 def _async_run_status_open_af(claim_id):
@@ -782,6 +852,7 @@ def __get_status(claim_id):
                                  response=response).json()
 
 
+@collect_queryband(queryband="RmEnv")
 def remove_env(env_name, **kwargs):
     """
     DESCRIPTION:
@@ -909,8 +980,8 @@ def __manage_envs(env_name=None, api_name="remove_env", **kwargs):
 
     try:
         # Get the ues url for corresponding API.
-        ues_url = _get_ues_url(env_name=env_name) if api_name == "remove_env" \
-            else _get_ues_url(remove_all_envs=True)
+        ues_url = _get_ues_url(env_name=env_name, api_name=api_name) if api_name == "remove_env" \
+            else _get_ues_url(remove_all_envs=True, api_name=api_name)
 
         response = UtilFuncs._http_request(ues_url, HTTPRequest.DELETE,
                                            headers=_get_auth_token())
@@ -968,7 +1039,7 @@ def __poll_claim_id_status(claim_id, api_name="remove_env"):
         api_name:
             Optional Argument.
             Specifies the name of the API.
-            Permitted Values: remove_env, remove_all_envs
+            Permitted Values: remove_env, remove_all_envs, create_env
             Default Value: remove_env
             Types: str
 
@@ -990,14 +1061,15 @@ def __poll_claim_id_status(claim_id, api_name="remove_env"):
         resp_data = __get_status(claim_id)
 
         # Breaking condition -
-        # For remove_env: Check for the 'Finished' stage in the list of resp.
+        # For create_env and remove_env: Check for the 'Finished' stage in the list of resp.
         # For remove_all_envs: above cond. and No user envs condition should break it .
         for data in resp_data:
             if ("Finished" in data["stage"]) or \
-                    (api_name == "remove_all_envs" and "Errored" in data["stage"]):
+                    (api_name in ["create_env", "remove_all_envs"] and "Errored" in data["stage"]):
                 return
 
 
+@collect_queryband(queryband="GtEnv")
 def get_env(env_name):
     """
     DESCRIPTION:
@@ -1081,6 +1153,7 @@ def get_env(env_name):
         raise TeradataMlException(error_msg, msg_code)
 
 
+@collect_queryband(queryband="RmAllEnvs")
 def remove_all_envs(env_type=None, **kwargs):
     """
         DESCRIPTION:
@@ -1317,13 +1390,19 @@ def _remove_all_envs(env_type, **kwargs):
           >>> remove_all_envs(env_type="R", asynchronous=True)
               Request to remove environment initiated successfully. Check status using async_run_status(['82cd24d6-1264-49f5-81e1-76e83e09c303'])
     """
-    env_type = "Python" if env_type.capitalize() == "Py" else "R"
+    # Variable for the message on lines 1437 and 1444.
+    env_type_message = "Python"
+    if env_type.capitalize() == "Py":
+        env_type = ["Python", "python"]
+    else:
+        env_type = ["R"]
+        env_type_message = "R"
     asynchronous = kwargs.get("asynchronous", False)
 
     try:
         # Retrieve all user env data.
         user_envs_df = list_user_envs()
-        user_envs_lang_df = user_envs_df[user_envs_df.language == env_type] if \
+        user_envs_lang_df = user_envs_df[user_envs_df.language.isin(env_type)] if \
             user_envs_df is not None else pd.DataFrame(index=[])
 
         claim_id_list = []
@@ -1364,14 +1443,14 @@ def _remove_all_envs(env_type, **kwargs):
             # Positive case - Envs removed without any failure print msg
             # as per sync or async removal.
             if not asynchronous:
-                msg = "All {} environment(s) removed.".format(env_type)
+                msg = "All {} environment(s) removed.".format(env_type_message)
             else:
                 msg = "Request to remove environment initiated successfully. Check " \
                       "the status using " \
                       "async_run_status(['" + "', '".join(claim_id_list) + "'])"
             print(msg)
         elif user_envs_lang_df.empty and user_envs_df is not None:
-            print("No {} user environment(s) found.".format(env_type))
+            print("No {} user environment(s) found.".format(env_type_message))
         return True
     except (TeradataMlException, RuntimeError) as tdemsg:
         # TeradataMlException and RuntimeError are raised by list_user_envs.
@@ -1385,6 +1464,7 @@ def _remove_all_envs(env_type, **kwargs):
         raise TeradataMlException(error_msg, msg_code)
 
 
+@collect_queryband(queryband="StUsrEnv")
 def set_user_env(env):
     """
     DESCRIPTION:
@@ -1434,6 +1514,7 @@ def set_user_env(env):
     return True
 
 
+@collect_queryband(queryband="GtUsrEnv")
 def get_user_env():
     """
     DESCRIPTION:
@@ -1466,6 +1547,7 @@ def get_user_env():
     return configure._default_user_env
 
 
+@collect_queryband(queryband="StAthTkn")
 def set_auth_token(ues_url, client_id=None):
     """
     DESCRIPTION:
@@ -1518,7 +1600,7 @@ def set_auth_token(ues_url, client_id=None):
 
     if client_id is None:
         netloc = url_parser.netloc
-        client_id = "tdpub-" + netloc.split('.')[0]
+        client_id = "{}-oaf-device".format(netloc.split('.')[0])
 
     da_wf = _DAWorkflow(base_url, client_id)
     token_data = da_wf._get_token_data()

teradataml/table_operators/Apply.py

@@ -230,14 +230,9 @@ class Apply(TableOperator):
                                   env_name=testenv,
                                   delimiter='\t')
 
-            # Run user script locally within docker container and using data from csv.
+            # Run user script locally using data from csv.
             # This helps the user to fix script level issues outside Open Analytics
             # Framework.
-            # Setup the environment by providing local path to docker image file.
-            >>> apply_obj.setup_sto_env(docker_image_location='/tmp/sto_sandbox_docker_image.tar'))
-            Loading image from /tmp/sto_sandbox_docker_image.tar. It may take few minutes.
-            Image loaded successfully.
-
             >>> apply_obj.test_script(input_data_file=os.path.join(teradataml_dir, 'data', 'barrier.csv'))
             ############ STDOUT Output ############
 
@@ -327,6 +322,7 @@ class Apply(TableOperator):
         self.env_name = env_name if env_name is not None else get_user_env()
         self.style = style
         self.returns = returns
+        self._skip_argument_validation = False
 
         # Create AnalyticsWrapperUtils instance which contains validation functions.
         # This is required for is_default_or_not check.
@@ -351,8 +347,44 @@ class Apply(TableOperator):
         if isinstance(self.env_name, UserEnv):
             self.env_name = self.env_name.env_name
 
+    @property
+    def skip_argument_validation(self):
+        """
+        DESCRIPTION:
+            Getter for self._skip_argument_validation.
+
+        RETURNS:
+            bool
+
+        RAISES:
+            None
+        """
+        return self._skip_argument_validation
+
+    @skip_argument_validation.setter
+    def skip_argument_validation(self, flag):
+        """
+        DESCRIPTION:
+            Setter for self._skip_argument_validation
+
+        PARAMETERS:
+            flag:
+               Required Argument.
+               Specifies whether the argument validation should be skipped or not.
+               Types: bool
+
+        RETURNS:
+            None
+
+        RAISES:
+            None
+        """
+        self._skip_argument_validation = flag
+
     def __apply__validate(self):
 
+        if self._skip_argument_validation:
+            return
         # Make sure that a non-NULL value has been supplied for all mandatory arguments.
         _Validators._validate_missing_required_arguments(self.__arg_info_matrix)