Unexclude _local_endpoints folder (#33990)

* unexclude _local_endpoints folder

* update

* update

Author: CoderKevinZhang

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/azureml_image_context.py

@@ -4,8 +4,8 @@
 
 
 import logging
-from pathlib import Path
 import os
+from pathlib import Path
 from typing import Dict
 
 from azure.ai.ml.constants._endpoint import LocalEndpointConstants
@@ -108,7 +108,8 @@ def docker_conda_file_name(self) -> str:
         :return: The conda file name
         :rtype: str
         """
-        return self._docker_conda_file_name  # pylint: disable=no-member
+        # pylint: disable=no-member
+        return self._docker_conda_file_name  # type: ignore[attr-defined]
 
     @property
     def volumes(self) -> Dict[str, Dict[str, Dict[str, str]]]:

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/docker_client.py

@@ -27,7 +27,7 @@
 module_logger = logging.getLogger(__name__)
 initialize_logger_info(module_logger, terminator="")
 
-DEFAULT_LABELS = {
+DEFAULT_LABELS: Dict = {
     LocalEndpointConstants.LABEL_KEY_AZUREML_LOCAL_ENDPOINT: "",
     LocalEndpointConstants.LABEL_KEY_ENDPOINT_NAME: "",
     LocalEndpointConstants.LABEL_KEY_DEPLOYMENT_NAME: "",
@@ -45,14 +45,14 @@ class DockerClient(object):
 
     def __init__(
         self,
-        client: Optional["docker.DockerClient"] = None,
+        client: Optional["docker.DockerClient"] = None,  # type: ignore[name-defined]
         vscode_client: Optional[VSCodeClient] = None,
     ):
         self._lazy_client = client
         self._vscode_client = vscode_client if vscode_client else VSCodeClient()
 
     @property
-    def _client(self) -> "docker.DockerClient":
+    def _client(self) -> "docker.DockerClient":  # type: ignore[name-defined]
         """Lazy initializer for docker-py client.
 
         :return: docker.client.DockerClient
@@ -184,8 +184,8 @@ def create_deployment(
         labels = get_container_labels(
             endpoint_name=endpoint_name,
             deployment_name=deployment_name,
-            endpoint_metadata=endpoint_metadata,
-            deployment_metadata=deployment_metadata,
+            endpoint_metadata=endpoint_metadata,  # type: ignore[arg-type]
+            deployment_metadata=deployment_metadata,  # type: ignore[arg-type]
             azureml_port=azureml_port,
         )
         module_logger.debug("Setting labels: '%s'\n", labels)
@@ -213,7 +213,7 @@ def create_deployment(
                     build_directory=build_directory,
                     image_name=image_name,
                     environment=environment,
-                    volumes=volumes,
+                    volumes=volumes,  # type: ignore[arg-type]
                     labels=labels,
                 )
             finally:
@@ -262,7 +262,7 @@ def delete(
             container.remove()
             module_logger.debug("Endpoint container '%s' is removed.", container.name)
 
-    def get_endpoint(self, endpoint_name: str) -> dict:
+    def get_endpoint(self, endpoint_name: str) -> Optional[dict]:
         """Returns metadata for local endpoint or deployment.
 
         :param endpoint_name: name of local endpoint
@@ -275,7 +275,7 @@ def get_endpoint(self, endpoint_name: str) -> dict:
             raise LocalEndpointNotFoundError(endpoint_name=endpoint_name)
         return get_endpoint_json_from_container(container=container)
 
-    def get_deployment(self, endpoint_name: str, deployment_name: Optional[str] = None) -> dict:
+    def get_deployment(self, endpoint_name: str, deployment_name: Optional[str] = None) -> Optional[dict]:
         """Returns metadata for local deployment.
 
         :param endpoint_name: name of local endpoint
@@ -290,7 +290,7 @@ def get_deployment(self, endpoint_name: str, deployment_name: Optional[str] = No
             raise LocalEndpointNotFoundError(endpoint_name=endpoint_name, deployment_name=deployment_name)
         return get_deployment_json_from_container(container=container)
 
-    def get_scoring_uri(self, endpoint_name: str, deployment_name: Optional[str] = None) -> str:
+    def get_scoring_uri(self, endpoint_name: str, deployment_name: Optional[str] = None) -> Optional[str]:
         """Returns scoring uri for local endpoint or deployment.
 
         :param endpoint_name: name of local endpoint
@@ -309,7 +309,7 @@ def get_scoring_uri(self, endpoint_name: str, deployment_name: Optional[str] = N
             return None
         _validate_container_state(
             endpoint_name=endpoint_name,
-            deployment_name=deployment_name,
+            deployment_name=str(deployment_name),
             container=container,
         )
         return get_scoring_uri_from_container(container=container)
@@ -363,7 +363,7 @@ def get_endpoint_container(
         deployment_name: Optional[str] = None,
         verify_single_deployment: bool = False,
         include_stopped: bool = True,
-    ) -> "docker.models.containers.Container":
+    ) -> "docker.models.containers.Container":  # type: ignore[name-defined]
         """Builds and runs an image from provided image context.
 
         :param endpoint_name: name of local endpoint
@@ -470,21 +470,25 @@ def get_container_labels(
     return labels
 
 
-def get_endpoint_json_from_container(container: "docker.models.containers.Container") -> dict:
+def get_endpoint_json_from_container(
+    container: "docker.models.containers.Container",  # type: ignore[name-defined]
+) -> Optional[dict]:
     if container:
         data = container.labels[LocalEndpointConstants.LABEL_KEY_ENDPOINT_JSON]
         return json.loads(data)
     return None
 
 
-def get_deployment_json_from_container(container: "docker.models.containers.Container") -> dict:
+def get_deployment_json_from_container(
+    container: "docker.models.containers.Container",  # type: ignore[name-defined]
+) -> Optional[dict]:
     if container:
         data = container.labels[LocalEndpointConstants.LABEL_KEY_DEPLOYMENT_JSON]
         return json.loads(data)
     return None
 
 
-def get_status_from_container(container: "docker.models.containers.Container") -> str:
+def get_status_from_container(container: "docker.models.containers.Container") -> str:  # type: ignore[name-defined]
     """Returns status of container.
 
     :param container: container of local Deployment
@@ -495,7 +499,9 @@ def get_status_from_container(container: "docker.models.containers.Container") -
     return container.status
 
 
-def get_scoring_uri_from_container(container: "docker.models.containers.Container") -> str:
+def get_scoring_uri_from_container(
+    container: "docker.models.containers.Container",  # type: ignore[name-defined]
+) -> str:
     """Returns scoring_uri of container.
 
     :param container: container of local Deployment
@@ -547,7 +553,7 @@ def _get_container_name(endpoint_name: str, deployment_name: Optional[str] = Non
 def _validate_container_state(
     endpoint_name: str,
     deployment_name: str,
-    container: "docker.models.containers.Container",
+    container: "docker.models.containers.Container",  # type: ignore[name-defined]
 ):
     """Returns a container name.
 

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/dockerfile_resolver.py

@@ -93,7 +93,7 @@ def _construct(self, install_debugpy: bool = False) -> None:
             self._instructions.extend(
                 [
                     Run(f"mkdir -p {self._docker_azureml_app_path}"),
-                    Workdir(self._docker_azureml_app_path),
+                    Workdir(str(self._docker_azureml_app_path)),
                 ]
             )
 

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/endpoint_stub.py

@@ -82,7 +82,7 @@ def _create_endpoint_cache(self, endpoint: OnlineEndpoint) -> Path:
         :return: The endpoint cache path
         :rtype: Path
         """
-        endpoint_cache_path = self._get_endpoint_cache_file(endpoint_name=endpoint.name)
+        endpoint_cache_path = self._get_endpoint_cache_file(endpoint_name=str(endpoint.name))
         endpoint_metadata = json.dumps(endpoint.dump())
         endpoint_cache_path.write_text(endpoint_metadata, encoding=DefaultOpenEncoding.WRITE)
         return endpoint_cache_path

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/mdc_config_resolver.py

@@ -4,6 +4,7 @@
 import json
 import os.path
 from pathlib import Path
+from typing import Any, Dict
 
 from azure.ai.ml.constants._common import DefaultOpenEncoding
 from azure.ai.ml.entities._deployment.data_collector import DataCollector
@@ -21,9 +22,9 @@ def __init__(
         self,
         data_collector: DataCollector,
     ):
-        self.environment_variables = {}
-        self.volumes = {}
-        self.mdc_config = None
+        self.environment_variables: Dict = {}
+        self.volumes: Dict = {}
+        self.mdc_config: Any = None
         self.config_path = "/etc/mdc-config.json"
         self.local_config_name = "mdc-config.json"
         self._construct(data_collector)

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/validators/code_validator.py

@@ -5,6 +5,7 @@
 # pylint: disable=protected-access
 
 from pathlib import Path
+from typing import Optional, Union
 
 from azure.ai.ml._artifacts._artifact_utilities import download_artifact_from_storage_url
 from azure.ai.ml._utils._arm_id_utils import parse_prefixed_name_version
@@ -21,7 +22,7 @@ def get_code_configuration_artifacts(
     deployment: OnlineDeployment,
     code_operations: CodeOperations,
     download_path: str,
-) -> str:
+) -> Optional[Union[str, Path]]:
     """Validates and returns code artifacts from deployment specification.
 
     :param endpoint_name: name of endpoint which this deployment is linked to
@@ -51,7 +52,7 @@ def get_code_configuration_artifacts(
 
     if _code_configuration_contains_cloud_artifacts(deployment=deployment):
         return _get_cloud_code_configuration_artifacts(
-            deployment.code_configuration.code, code_operations, download_path
+            str(deployment.code_configuration.code), code_operations, download_path
         )
 
     if not _local_code_path_is_valid(deployment=deployment):

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/validators/environment_validator.py

@@ -6,10 +6,10 @@
 
 import os
 from pathlib import Path
-from typing import Dict, Optional, Tuple, Union
+from typing import Optional, Tuple, Union
 
 from azure.ai.ml._artifacts._artifact_utilities import download_artifact_from_storage_url
-from azure.ai.ml._utils._arm_id_utils import parse_name_version, parse_name_label
+from azure.ai.ml._utils._arm_id_utils import parse_name_label, parse_name_version
 from azure.ai.ml._utils.utils import dump_yaml, is_url
 from azure.ai.ml.constants._common import DefaultOpenEncoding
 from azure.ai.ml.entities import OnlineDeployment
@@ -23,9 +23,7 @@ def get_environment_artifacts(
     deployment: OnlineDeployment,
     environment_operations: EnvironmentOperations,
     download_path: str,
-) -> Union[
-    Tuple[str, Optional[Path], str, None, None, Optional[Dict]], Tuple[None, None, None, Path, str, Optional[Dict]]
-]:
+) -> Optional[Tuple]:
     """Validates and returns artifacts from environment specification.
 
     :param endpoint_name: name of endpoint which this deployment is linked to
@@ -82,16 +80,14 @@ def get_environment_artifacts(
             required_artifact_type=str(Environment),
             deployment_name=deployment.name,
         )
-    return _get_local_environment_artifacts(deployment.base_path, deployment.environment)
+    return _get_local_environment_artifacts(deployment.base_path, deployment.environment)  # type: ignore[arg-type]
 
 
 def _get_cloud_environment_artifacts(
     environment_operations: EnvironmentOperations,
     environment_asset: Environment,
     download_path: str,
-) -> Union[
-    Tuple[str, Optional[Path], str, None, None, Optional[Dict]], Tuple[None, None, None, Path, str, Optional[Dict]]
-]:
+) -> Tuple:
     """Retrieves the cloud environment's artifacts
 
     :param environment_operations: The environment operations
@@ -116,7 +112,7 @@ def _get_cloud_environment_artifacts(
             datastore_operation=environment_operations._datastore_operation,
             datastore_name="workspaceartifactstore",
         )
-        dockerfile_path = Path(environment_build_directory, environment_asset.build.dockerfile_path)
+        dockerfile_path = Path(environment_build_directory, str(environment_asset.build.dockerfile_path))
         dockerfile_contents = dockerfile_path.read_text(encoding=DefaultOpenEncoding.READ)
         return (
             None,
@@ -137,11 +133,7 @@ def _get_cloud_environment_artifacts(
     )
 
 
-def _get_local_environment_artifacts(
-    base_path: Union[str, os.PathLike], environment: Environment
-) -> Union[
-    Tuple[str, Optional[Path], str, None, None, Optional[Dict]], Tuple[None, None, None, Path, str, Optional[Dict]]
-]:
+def _get_local_environment_artifacts(base_path: Union[str, os.PathLike], environment: Environment) -> Optional[Tuple]:
     """Retrieves the local environment's artifacts
 
     :param base_path: The base path
@@ -168,7 +160,7 @@ def _get_local_environment_artifacts(
             environment.inference_config,
         )
     if environment.build and environment.build.dockerfile_path:
-        absolute_build_directory = Path(base_path, environment.build.path).resolve()
+        absolute_build_directory = Path(base_path, str(environment.build.path)).resolve()
         absolute_dockerfile_path = Path(absolute_build_directory, environment.build.dockerfile_path).resolve()
         dockerfile_contents = absolute_dockerfile_path.read_text(encoding=DefaultOpenEncoding.READ)
         return (
@@ -205,4 +197,6 @@ def _cloud_environment_is_valid(environment: Environment):
 
 
 def _environment_contains_cloud_artifacts(deployment: OnlineDeployment):
-    return isinstance(deployment.environment, str) or deployment.environment.id is not None
+    return isinstance(deployment.environment, str) or (
+        deployment.environment is not None and deployment.environment.id is not None
+    )

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/validators/model_validator.py

@@ -4,8 +4,9 @@
 
 # pylint: disable=protected-access
 
+from os import PathLike
 from pathlib import Path
-from typing import Tuple
+from typing import Tuple, Union
 
 from azure.ai.ml._artifacts._artifact_utilities import download_artifact
 from azure.ai.ml._utils._arm_id_utils import parse_prefixed_name_version
@@ -21,7 +22,7 @@ def get_model_artifacts(
     deployment: OnlineDeployment,
     model_operations: ModelOperations,
     download_path: str,
-) -> Tuple[str, str, Path]:
+) -> Union[str, Tuple]:
     """Validates and returns model artifacts from deployment specification.
 
     :param endpoint_name: name of endpoint which this deployment is linked to
@@ -41,7 +42,7 @@ def get_model_artifacts(
     if _model_contains_cloud_artifacts(deployment=deployment):
         return _get_cloud_model_artifacts(
             model_operations=model_operations,
-            model=deployment.model,
+            model=str(deployment.model),
             download_path=download_path,
         )
     if not _local_model_is_valid(deployment=deployment):
@@ -51,10 +52,12 @@ def get_model_artifacts(
             required_artifact_type=str,
             deployment_name=deployment.name,
         )
+    _model: Model = deployment.model  # type: ignore[assignment]
+    _model_path: Union[str, PathLike] = _model.path  # type: ignore[assignment]
     return (
-        deployment.model.name,
-        deployment.model.version,
-        Path(deployment._base_path, deployment.model.path).resolve().parent,
+        _model.name,
+        _model.version,
+        Path(deployment._base_path, _model_path).resolve().parent,
     )
 
 
@@ -64,10 +67,10 @@ def _local_model_is_valid(deployment: OnlineDeployment):
 
 def _model_contains_cloud_artifacts(deployment: OnlineDeployment):
     # If the deployment.model is a string, then it is the cloud model name or full arm ID
-    return isinstance(deployment.model, str) or deployment.model.id is not None
+    return isinstance(deployment.model, str) or (deployment.model is not None and deployment.model.id is not None)
 
 
-def _get_cloud_model_artifacts(model_operations: ModelOperations, model: str, download_path: str) -> str:
+def _get_cloud_model_artifacts(model_operations: ModelOperations, model: str, download_path: str) -> Tuple:
     if isinstance(model, Model):
         name = model.name
         version = model._version

sdk/ml/azure-ai-ml/azure/ai/ml/_local_endpoints/vscode_debug/devcontainer_properties.py

@@ -6,7 +6,7 @@
 # Reference: https://code.visualstudio.com/docs/remote/devcontainerjson-reference
 
 
-from typing import Optional
+from typing import Dict, Optional
 
 from azure.ai.ml.constants._endpoint import LocalEndpointConstants
 
@@ -37,7 +37,7 @@ def __init__(
         self._target = target
 
     def to_dict(self) -> dict:
-        build = {
+        build: Dict = {
             "build": {
                 "dockerfile": self._dockerfile_path,
             }