[ml] Hit next-pylint compliance (#35342)

* Remove Optional type annotation from get() methods

* Remove duplicate overloads

* Remove interrogate from pre-commit-config

* Ignore bare exception errors

* Update disable comment for exceptions

* Fix more errors

* Fix exception disable comments

* Fix exception disable comments

* Fix pylint errors

* Fix import pylint error

* Reformat with black

* Fix dictionary literal error

* Fix sphinx error in sweep

* Add clarifying note about kwargs to from_config

Author: diondrapeck

sdk/ml/azure-ai-ml/.pre-commit-config.yaml

@@ -5,14 +5,6 @@ repos:
     hooks:
     -   id: black
         args: [--config=eng/black-pyproject.toml]
-- repo: https://github.com/econchick/interrogate
-  rev: 1.5.0 
-  hooks:
-  - id: interrogate
-    types_or: [python]
-    args: [--ignore-init-method, --ignore-private, --ignore-semiprivate, --ignore-magic]
-    exclude: ^(sdk/ml/azure-ai-ml/tests/|sdk/ml/azure-ai-ml/samples/|sdk/ml/azure-ai-ml/scripts/|sdk/ml/azure-ai-ml/azure/ai/ml/_restclient|sdk/ml/azure-ai-ml/setup.py)
-    # exclude defined here because exclude in pyproject.toml is not being respected
 - repo: https://github.com/streetsidesoftware/cspell-cli
   rev: v6.31.0
   hooks:

sdk/ml/azure-ai-ml/azure/ai/ml/_arm_deployments/arm_deployment_executor.py

@@ -111,7 +111,7 @@ def deploy_resource(
 
                     if poller._exception is not None:
                         error = poller._exception
-                except Exception as e:  # pylint: disable=broad-except
+                except Exception as e:  # pylint: disable=W0718
                     error = e
                 finally:
                     # one last check to make sure all print statements make it
@@ -213,7 +213,7 @@ def _check_deployment_status(self) -> None:
                 # duration comes in format: "PT1M56.3454108S"
                 try:
                     duration_in_min_sec = from_iso_duration_format_min_sec(duration)
-                except Exception:  # pylint: disable=broad-except
+                except Exception:  # pylint: disable=W0718
                     duration_in_min_sec = ""
 
                 self._resources_being_deployed[resource_name] = (

sdk/ml/azure-ai-ml/azure/ai/ml/_artifacts/_artifact_utilities.py

@@ -44,7 +44,7 @@
 from azure.ai.ml.entities._assets._artifacts.artifact import Artifact, ArtifactStorageInfo
 from azure.ai.ml.entities._credentials import AccountKeyConfiguration
 from azure.ai.ml.entities._datastore._constants import WORKSPACE_BLOB_STORE
-from azure.ai.ml.exceptions import ErrorTarget, ValidationException
+from azure.ai.ml.exceptions import ErrorTarget, MlException, ValidationException
 from azure.ai.ml.operations._datastore_operations import DatastoreOperations
 from azure.storage.blob import BlobSasPermissions, generate_blob_sas
 from azure.storage.filedatalake import FileSasPermissions, generate_file_sas
@@ -116,7 +116,7 @@ def get_datastore_info(
         else:
             try:
                 datastore_info["credential"] = credential.sas_token
-            except Exception as e:  # pylint: disable=broad-except
+            except Exception as e:  # pylint: disable=W0718
                 if not hasattr(credential, "sas_token"):
                     datastore_info["credential"] = operations._credential
                 else:
@@ -127,10 +127,11 @@ def get_datastore_info(
     elif datastore.type == DatastoreType.AZURE_DATA_LAKE_GEN2:
         datastore_info["container_name"] = str(datastore.filesystem)
     else:
-        raise Exception(
+        msg = (
             f"Datastore type {datastore.type} is not supported for uploads. "
             f"Supported types are {DatastoreType.AZURE_BLOB} and {DatastoreType.AZURE_DATA_LAKE_GEN2}."
         )
+        raise MlException(message=msg, no_personal_data_message=msg)
 
     for override_param_name, value in kwargs.items():
         if override_param_name in datastore_info:
@@ -162,7 +163,8 @@ def list_logs_in_datastore(
         DatastoreType.AZURE_BLOB,
         DatastoreType.AZURE_DATA_LAKE_GEN2,
     ]:
-        raise Exception("Only Blob and Azure DataLake Storage Gen2 datastores are supported.")
+        msg = "Only Blob and Azure DataLake Storage Gen2 datastores are supported."
+        raise MlException(message=msg, no_personal_data_message=msg)
 
     storage_client = get_storage_client(
         credential=ds_info["credential"],

sdk/ml/azure-ai-ml/azure/ai/ml/_artifacts/_blob_storage_helper.py

@@ -196,7 +196,7 @@ def check_blob_exists(self) -> None:
             self.overwrite = True  # if upload never confirmed, approve overriding the partial upload
         except ResourceNotFoundError:
             pass
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:  # pylint: disable=W0718
             # pylint: disable=no-member
             if hasattr(e, "error_code") and e.error_code == STORAGE_AUTH_MISMATCH_ERROR:
                 msg = (

sdk/ml/azure-ai-ml/azure/ai/ml/_artifacts/_gen2_storage_helper.py

@@ -165,7 +165,7 @@ def check_blob_exists(self) -> None:
                     self.name = metadata.get("name")
                     self.version = metadata.get("version")
                     raise AssetNotChangedError
-        except Exception as e:  # pylint: disable=broad-except
+        except Exception as e:  # pylint: disable=W0718
             # pylint: disable=no-member
             if hasattr(e, "error_code") and e.error_code == STORAGE_AUTH_MISMATCH_ERROR:
                 msg = (

sdk/ml/azure-ai-ml/azure/ai/ml/_azure_environments.py

@@ -10,6 +10,7 @@
 
 from azure.ai.ml._utils.utils import _get_mfe_url_override
 from azure.ai.ml.constants._common import AZUREML_CLOUD_ENV_NAME, ArmConstants
+from azure.ai.ml.exceptions import MlException
 from azure.core.rest import HttpRequest
 from azure.mgmt.core import ARMPipelineClient
 
@@ -73,7 +74,8 @@ def _get_cloud(cloud: str) -> Dict[str, str]:
         _environments.update(new_cloud)  # type: ignore[arg-type]
         return new_cloud
     except KeyError as e:
-        raise Exception('Unknown cloud environment "{0}".'.format(cloud)) from e
+        msg = 'Unknown cloud environment "{0}".'.format(cloud)
+        raise MlException(message=msg, no_personal_data_message=msg) from e
 
 
 def _get_default_cloud_name() -> str:
@@ -111,7 +113,8 @@ def _set_cloud(cloud: str = AzureEnvironments.ENV_DEFAULT):
         try:
             _get_cloud(cloud)
         except Exception as e:
-            raise Exception('Unknown cloud environment supplied: "{0}".'.format(cloud)) from e
+            msg = 'Unknown cloud environment supplied: "{0}".'.format(cloud)
+            raise MlException(message=msg, no_personal_data_message=msg) from e
     else:
         cloud = _get_default_cloud_name()
     os.environ[AZUREML_CLOUD_ENV_NAME] = cloud

sdk/ml/azure-ai-ml/azure/ai/ml/_exception_helper.py

@@ -5,7 +5,7 @@
 import json
 import logging
 import traceback
-from typing import Dict, Optional, Tuple, Union, NoReturn
+from typing import Dict, NoReturn, Optional, Tuple, Union
 
 from colorama import Fore, Style, init
 from marshmallow.exceptions import ValidationError as SchemaValidationError
@@ -15,7 +15,7 @@
     SCHEMA_VALIDATION_ERROR_TEMPLATE,
     YAML_CREATION_ERROR_DESCRIPTION,
 )
-from azure.ai.ml.exceptions import ErrorTarget, ValidationErrorType, ValidationException
+from azure.ai.ml.exceptions import ErrorTarget, MlException, ValidationErrorType, ValidationException
 
 module_logger = logging.getLogger(__name__)
 
@@ -334,4 +334,4 @@ def log_and_raise_error(error: Exception, debug: bool = False, yaml_operation: b
     else:
         raise error
 
-    raise Exception(formatted_error)
+    raise MlException(message=formatted_error, no_personal_data_message=formatted_error)

sdk/ml/azure-ai-ml/azure/ai/ml/_internal/entities/component.py

@@ -187,7 +187,7 @@ def _read_additional_include_configs(cls, yaml_path: Path) -> List[str]:
                     configs = yaml.safe_load(file_content)
                     if isinstance(configs, dict):
                         return configs.get(_ADDITIONAL_INCLUDES_CONFIG_KEY, [])
-                except Exception:  # pylint: disable=broad-except
+                except Exception:  # pylint: disable=W0718
                     # TODO: check if we should catch yaml.YamlError instead here
                     pass
                 return [line.strip() for line in file_content.splitlines(keepends=False) if len(line.strip()) > 0]

sdk/ml/azure-ai-ml/azure/ai/ml/_logging/debug_mode.py

@@ -42,7 +42,7 @@ def stack_info() -> list:
 
 def connection_info(gc_objects: list) -> List[ConnectionInfo]:
     connections = [obj for obj in gc_objects if isinstance(obj, http.client.HTTPConnection)]
-    return [ConnectionInfo(host=c.host, port=c.port, hasSocket=(c.sock is not None)) for c in connections]
+    return [ConnectionInfo(host=c.host, port=c.port, hasSocket=c.sock is not None) for c in connections]  # disable
 
 
 # pylint: disable=client-incorrect-naming-convention

sdk/ml/azure-ai-ml/azure/ai/ml/_ml_client.py

@@ -698,7 +698,8 @@ def from_config(
             }
 
         Then, you can use this method to load the same workspace in different Python notebooks or projects without
-        retyping the workspace ARM properties.
+        retyping the workspace ARM properties. Note that `from_config` accepts the same kwargs as the main
+        `~azure.ai.ml.MLClient` constructor such as `cloud`.
 
         :param credential: The credential object for the workspace.
         :type credential: ~azure.core.credentials.TokenCredential
@@ -708,8 +709,6 @@ def from_config(
         :keyword file_name: The configuration file name to search for when path is a directory path. Defaults to
             "config.json".
         :paramtype file_name: Optional[str]
-        :keyword cloud: The cloud name to use. Defaults to "AzureCloud".
-        :paramtype cloud: Optional[str]
         :raises ~azure.ai.ml.exceptions.ValidationException: Raised if "config.json", or file_name if overridden,
             cannot be found in directory. Details will be provided in the error message.
         :returns: The client for an existing Azure ML Workspace.