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

teradataml/scriptmgmt/UserEnv.py

@@ -31,6 +31,7 @@ from teradataml.common.messagecodes import MessageCodes
 from teradataml.common.utils import UtilFuncs
 from teradataml.utils.validators import _Validators
 from urllib.parse import urlparse
+from teradatasqlalchemy.telemetry.queryband import collect_queryband
 
 
 def _get_ues_url(env_type="users", **kwargs):
@@ -74,6 +75,7 @@ def _get_ues_url(env_type="users", **kwargs):
             >>> _get_ues_url(env_name=self.env_name, files=True, is_property=True, api_name="files") # URL for listing down the files.
     """
     api_name = kwargs.pop("api_name", inspect.stack()[1].function)
+    conda_env = kwargs.get("conda_env", False)
 
     # Raise error if user is not connected to Vantage.
     if _get_user() is None:
@@ -109,8 +111,11 @@ def _get_ues_url(env_type="users", **kwargs):
                                                     env_type, kwargs["claim_id"])
 
     # We will reach here to process "users" env type.
-    ues_url = "{0}/{1}/environments".format(ues_url, _get_user())
+    env_type = "environments"
+    if conda_env:
+        env_type = "conda-environments"
 
+    ues_url = "{0}/{1}/{2}".format(ues_url, _get_user(), env_type)
     env_name, files, libs = kwargs.get("env_name"), kwargs.get("files", False), kwargs.get("libs", False)
 
     if env_name is not None:
@@ -123,7 +128,6 @@ def _get_ues_url(env_type="users", **kwargs):
             ues_url = "{0}/{1}".format(ues_url, file_name)
     elif libs:
         ues_url = "{0}/{1}".format(ues_url, "libraries")
-
     return ues_url
 
 
@@ -178,7 +182,8 @@ def _process_ues_response(api_name, response, success_status_code=None):
         data = response.json()
         request_id = add_paranthesis(data.get("req_id", ""))
         error_code = add_paranthesis(data.get("error_code", ""))
-        error_description = "{}{} {}".format(request_id, error_code, data.get("error_description", ""))
+        error_description = "{}{} {}".format(request_id, error_code, data.get("error_description",
+                                                                              response.text))
 
         exception_message = "Request Failed - {}".format(error_description)
 
@@ -351,6 +356,7 @@ class UserEnv:
         repr_string = repr_string + "\n================================================\n"
         return repr_string
 
+    @collect_queryband(queryband="InstlFl")
     def install_file(self, file_path, replace=False, **kwargs):
         """
         DESCRIPTION:
@@ -423,6 +429,11 @@ class UserEnv:
             >>> env = create_env('testenv', 'python_3.7.9', 'Test environment')
             User environment testenv created.
 
+            # Create conda environment.
+            >>> testenv_conda = create_env('testenv_conda', 'python_3.8', 'Test conda environment', conda_env=True)
+            Conda environment creation initiated
+            User environment 'testenv_conda' created.
+
             # Example 1: Install the file mapper.py in the 'testenv' environment.
             >>> import os, teradataml
             >>> file_path = os.path.join(os.path.dirname(teradataml.__file__), "data", "scripts", "mapper.py")
@@ -481,9 +492,17 @@ class UserEnv:
 
             >>> os.remove(os.path.join(tempfile.gettempdir(),"large_file")) # Remove the file created using function 'create_large_file'.
 
+            # Example 5: Install the file mapper.py in the 'testenv_conda' environment.
+            >>> import os, teradataml
+            >>> file_path = os.path.join(os.path.dirname(teradataml.__file__), "data", "scripts", "mapper.py")
+            >>> testenv_conda.install_file(file_path = file_path)
+            File 'mapper.py' installed successfully in the remote user environment 'testenv_conda'.
+
             # Remove the environment.
             >>> remove_env('testenv')
             User environment 'testenv' removed.
+            >>> remove_env("testenv_conda")
+            User environment 'testenv_conda' removed.
         """
         # Install/Replace file on Vantage
         asynchronous = kwargs.get("asynchronous", False)
@@ -770,6 +789,7 @@ class UserEnv:
 
         return claim_id
 
+    @collect_queryband(queryband="RmFl")
     def remove_file(self, file_name, **kwargs):
         """
         DESCRIPTION:
@@ -799,11 +819,12 @@ class UserEnv:
             # Create a Python 3.7.3 environment with given name and description in Vantage.
             >>> env = create_env('testenv', 'python_3.7.9', 'Test environment')
             User environment 'testenv' created.
+
             # Install the file "mapper.py" using the default text mode in the remote user environment.
             >>> import os, teradataml
             >>> file_path = os.path.join(os.path.dirname(teradataml.__file__), "data", "scripts", "mapper.py")
             >>> env.install_file(file_path = file_path)
-                File 'mapper.py' replaced successfully in the remote user environment 'testenv'.
+            File 'mapper.py' installed successfully in the remote user environment 'testenv'.
 
             # Example 1: Remove file from remote user environment.
             >>> env.remove_file('mapper.py')
@@ -834,6 +855,7 @@ class UserEnv:
             response = UtilFuncs._http_request(_get_ues_url(env_name=self.env_name, files=True, file_name=file_name),
                                                HTTPRequest.DELETE,
                                                headers=_get_auth_token())
+
             _process_ues_response(api_name=api_name, response=response)
 
             if not kwargs.get("suppress_output", False):
@@ -858,6 +880,7 @@ class UserEnv:
             raise TeradataMlException(error_msg, msg_code)
 
     @property
+    @collect_queryband(queryband="EnvFls")
     def files(self):
         """
         DESCRIPTION:
@@ -981,6 +1004,7 @@ class UserEnv:
             raise TeradataMlException(error_msg, msg_code)
 
     @property
+    @collect_queryband(queryband="EnvLbs")
     def libs(self):
         """
         DESCRIPTION:
@@ -1119,6 +1143,7 @@ class UserEnv:
             raise TeradataMlException(error_msg, msg_code)
 
     @property
+    @collect_queryband(queryband="EnvMdls")
     def models(self):
         """
         DESCRIPTION:
@@ -1435,10 +1460,16 @@ class UserEnv:
                                 } for key, value in result.items()]
                              })
 
+    @collect_queryband(queryband="InstlLbs")
     def install_lib(self, libs=None, libs_file_path=None, **kwargs):
         """
         DESCRIPTION:
             Function installs Python or R libraries in the remote user environment.
+            Note:
+                * Use "install_lib" API call for first time package installation within
+                  the environment. Use "update_lib" API only to upgrade or downgrade installed
+                  packages and do not use it for fresh package installation when multiple
+                  packages have the same dependency as it messes pip's package resolution ability.
 
         PARAMETERS:
             libs:
@@ -2033,6 +2064,7 @@ class UserEnv:
         claim_id = self.__manage_libraries(libs, libs_file_path, "INSTALL", asynchronous, timeout)
         return (claim_id)
 
+    @collect_queryband(queryband="UninstlLbs")
     def uninstall_lib(self, libs=None, libs_file_path=None, **kwargs):
         """
         DESCRIPTION:
@@ -2473,11 +2505,20 @@ class UserEnv:
         claim_id = self.__manage_libraries(libs, libs_file_path, "UNINSTALL", asynchronous, timeout)
         return (claim_id)
 
+    @collect_queryband(queryband="UpdtLbs")
     def update_lib(self, libs=None, libs_file_path=None, **kwargs):
         """
         DESCRIPTION:
             Function updates Python or R libraries if already installed,
             otherwise installs the libraries in remote user environment.
+            Notes:
+                * Use "install_lib" API call for first time package installation within
+                  the environment. Use "update_lib" API only to upgrade or downgrade installed
+                  packages and do not use it for fresh package installation when multiple
+                  packages have the same dependency as it messes pip's package resolution ability.
+                * Use "update_lib" to update packages one at a time to prevent dependency resolution
+                  issues.
+
 
         PARAMETERS:
             libs:
@@ -2488,6 +2529,11 @@ class UserEnv:
                     *   While passing the libraries as string or list of
                         strings, one should adhere to the requirements
                         specified by underlying language's package manager.
+                        For conda environment:
+                        *   Only library name(s) should be specified. Library version
+                            cannot be specified.
+                            Conda only updates the installed packages to the latest
+                            compatible version and cannot update to a specific version.
                         For R environment:
                         *   Refer to allowed formats here:
                             https://remotes.r-lib.org/reference/install_version.html
@@ -2525,6 +2571,11 @@ class UserEnv:
                                     "version": ">= 1.1.2, < 1.2"
                                 }]
                             }
+                    * For conda environment:
+                        The file should only contain the package names.
+                        Library version cannot be specified. Conda only updates the
+                        installed packages to the latest compatible version and
+                        cannot update to a specific version.
                 Types: str
 
         **kwargs:
@@ -2832,6 +2883,7 @@ class UserEnv:
         claim_id = self.__manage_libraries(libs, libs_file_path, "UPDATE", asynchronous, timeout)
         return (claim_id)
 
+    @collect_queryband(queryband="EnvRfrsh")
     def refresh(self):
         """
         DESCRIPTION:
@@ -3138,6 +3190,7 @@ class UserEnv:
         self.__files_changed = True
         self.__models_changed = True
 
+    @collect_queryband(queryband="EnvSts")
     def status(self, claim_ids=None):
         """
         DESCRIPTION:
@@ -3358,7 +3411,7 @@ class UserEnv:
         DESCRIPTION:
             Function to get the status of asynchronus process using the claim_id.
             The function polls the status of asynchronous process using the 'status' API
-            for 'timeout' seconds and get's the status of it. When asynchronus process
+            for 'timeout' seconds and gets the status of it. When asynchronus process
             is not completed in 'timeout' seconds, the function stops polling the status
             API and returns the claim-id.
 
@@ -3457,6 +3510,7 @@ class UserEnv:
         # For library installation/uninstallation/updation.
         return records if len(records) == 2 else False
 
+    @collect_queryband(queryband="InstlMdl")
     def install_model(self, model_path, **kwargs):
         """
         DESCRIPTION:
@@ -3557,6 +3611,7 @@ class UserEnv:
         records = self.install_file(model_path, **kwargs)
         return records
 
+    @collect_queryband(queryband="UninstlMdl")
     def uninstall_model(self, model_name, **kwargs):
         """
         DESCRIPTION:
@@ -3620,6 +3675,7 @@ class UserEnv:
         kwargs["is_model"] = True
         return self.remove_file(model_name, **kwargs)
 
+    @collect_queryband(queryband="EnvSnpsht")
     def snapshot(self, dir=None):
         """
         DESCRIPTION: