docstrings: Dict -> dict and List -> list

Author: shamrin

datacrunch/InferenceClient/inference_client.py

@@ -483,7 +483,7 @@ def status_json(self) -> dict[str, Any]:
         """Get the current status of the async inference execution. Return the status json.
 
         Returns:
-            Dict[str, Any]: The status response containing the execution status and other metadata
+            dict[str, Any]: The status response containing the execution status and other metadata
         """
         url = (
             f'{self._inference_client.base_domain}/status/{self._inference_client.deployment_name}'
@@ -504,7 +504,7 @@ def result(self) -> dict[str, Any]:
         """Get the results of the async inference execution.
 
         Returns:
-            Dict[str, Any]: The results of the inference execution
+            dict[str, Any]: The results of the inference execution
         """
         url = (
             f'{self._inference_client.base_domain}/result/{self._inference_client.deployment_name}'

datacrunch/containers/containers.py

@@ -745,7 +745,7 @@ def get_deployments(self) -> list[Deployment]:
         """Retrieves all container deployments.
 
         Returns:
-            List[Deployment]: List of all deployments.
+            list[Deployment]: List of all deployments.
         """
         response = self.client.get(CONTAINER_DEPLOYMENTS_ENDPOINT)
         return [
@@ -860,7 +860,7 @@ def get_deployment_replicas(self, deployment_name: str) -> list[ReplicaInfo]:
             deployment_name: Name of the deployment.
 
         Returns:
-            List[ReplicaInfo]: List of replica information.
+            list[ReplicaInfo]: List of replica information.
         """
         response = self.client.get(f'{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/replicas')
         return [ReplicaInfo.from_dict(replica) for replica in response.json()['list']]
@@ -896,7 +896,7 @@ def get_deployment_environment_variables(self, deployment_name: str) -> dict[str
             deployment_name: Name of the deployment.
 
         Returns:
-            Dict[str, List[EnvVar]]: Dictionary mapping container names to their environment variables.
+            dict[str, list[EnvVar]]: Dictionary mapping container names to their environment variables.
         """
         response = self.client.get(
             f'{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables'
@@ -919,7 +919,7 @@ def add_deployment_environment_variables(
             env_vars: List of environment variables to add.
 
         Returns:
-            Dict[str, List[EnvVar]]: Updated environment variables for all containers.
+            dict[str, list[EnvVar]]: Updated environment variables for all containers.
         """
         response = self.client.post(
             f'{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables',
@@ -946,7 +946,7 @@ def update_deployment_environment_variables(
             env_vars: List of updated environment variables.
 
         Returns:
-            Dict[str, List[EnvVar]]: Updated environment variables for all containers.
+            dict[str, list[EnvVar]]: Updated environment variables for all containers.
         """
         response = self.client.patch(
             f'{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables',
@@ -973,7 +973,7 @@ def delete_deployment_environment_variables(
             env_var_names: List of environment variable names to delete.
 
         Returns:
-            Dict[str, List[EnvVar]]: Updated environment variables for all containers.
+            dict[str, list[EnvVar]]: Updated environment variables for all containers.
         """
         response = self.client.delete(
             f'{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables',
@@ -996,7 +996,7 @@ def get_compute_resources(
             is_available: Optional boolean to filter by availability status
 
         Returns:
-            List[ComputeResource]: List of compute resources matching the filters.
+            list[ComputeResource]: List of compute resources matching the filters.
                                  If no filters provided, returns all resources.
         """
         response = self.client.get(SERVERLESS_COMPUTE_RESOURCES_ENDPOINT)
@@ -1017,7 +1017,7 @@ def get_secrets(self) -> list[Secret]:
         """Retrieves all secrets.
 
         Returns:
-            List[Secret]: List of all secrets.
+            list[Secret]: List of all secrets.
         """
         response = self.client.get(SECRETS_ENDPOINT)
         return [Secret.from_dict(secret) for secret in response.json()]
@@ -1046,7 +1046,7 @@ def get_registry_credentials(self) -> list[RegistryCredential]:
         """Retrieves all registry credentials.
 
         Returns:
-            List[RegistryCredential]: List of all registry credentials.
+            list[RegistryCredential]: List of all registry credentials.
         """
         response = self.client.get(CONTAINER_REGISTRY_CREDENTIALS_ENDPOINT)
         return [RegistryCredential.from_dict(credential) for credential in response.json()]

datacrunch/images/images.py

@@ -16,7 +16,7 @@ def __init__(self, id: str, name: str, image_type: str, details: list[str]) -> N
         :param image_type: image type, e.g. 'ubuntu-20.04-cuda-11.0'
         :type image_type: str
         :param details: image details
-        :type details: List[str]
+        :type details: list[str]
         """
         self._id = id
         self._name = name
@@ -55,7 +55,7 @@ def details(self) -> list[str]:
         """Get the image details.
 
         :return: image details
-        :rtype: List[str]
+        :rtype: list[str]
         """
         return self._details
 
@@ -78,7 +78,7 @@ def get(self) -> list[Image]:
         """Get the available instance images.
 
         :return: list of images objects
-        :rtype: List[Image]
+        :rtype: list[Image]
         """
         images = self._http_client.get(IMAGES_ENDPOINT).json()
         image_objects = [

datacrunch/instance_types/instance_types.py

@@ -171,7 +171,7 @@ def get(self) -> list[InstanceType]:
         """Get all instance types.
 
         :return: list of instance type objects
-        :rtype: List[InstanceType]
+        :rtype: list[InstanceType]
         """
         instance_types = self._http_client.get(INSTANCE_TYPES_ENDPOINT).json()
         instance_type_objects = [

datacrunch/ssh_keys/ssh_keys.py

@@ -56,7 +56,7 @@ def get(self) -> list[SSHKey]:
         """Get all of the client's SSH keys.
 
         :return: list of SSH keys objects
-        :rtype: List[SSHKey]
+        :rtype: list[SSHKey]
         """
         keys = self._http_client.get(SSHKEYS_ENDPOINT).json()
         keys_object_list = [SSHKey(key['id'], key['name'], key['key']) for key in keys]
@@ -79,7 +79,7 @@ def delete(self, id_list: list[str]) -> None:
         """Delete multiple SSH keys by id.
 
         :param id_list: list of SSH keys ids
-        :type id_list: List[str]
+        :type id_list: list[str]
         """
         payload = {'keys': id_list}
         self._http_client.delete(SSHKEYS_ENDPOINT, json=payload)

datacrunch/startup_scripts/startup_scripts.py

@@ -56,7 +56,7 @@ def get(self) -> list[StartupScript]:
         """Get all of the client's startup scripts.
 
         :return: list of startup script objects
-        :rtype: List[StartupScript]
+        :rtype: list[StartupScript]
         """
         scripts = self._http_client.get(STARTUP_SCRIPTS_ENDPOINT).json()
         scripts_objects = [
@@ -80,7 +80,7 @@ def delete(self, id_list: list[str]) -> None:
         """Delete multiple startup scripts by id.
 
         :param id_list: list of startup scripts ids
-        :type id_list: List[str]
+        :type id_list: list[str]
         """
         payload = {'scripts': id_list}
         self._http_client.delete(STARTUP_SCRIPTS_ENDPOINT, json=payload)

datacrunch/volume_types/volume_types.py

@@ -52,7 +52,7 @@ def get(self) -> list[VolumeType]:
         """Get all volume types.
 
         :return: list of volume type objects
-        :rtype: List[VolumesType]
+        :rtype: list[VolumesType]
         """
         volume_types = self._http_client.get(VOLUME_TYPES_ENDPOINT).json()
         volume_type_objects = [

datacrunch/volumes/volumes.py

@@ -45,7 +45,7 @@ def __init__(
         :param instance_id: the instance id the volume is attached to, None if detached
         :type instance_id: str
         :param ssh_key_ids: list of ssh keys ids
-        :type ssh_key_ids: List[str]
+        :type ssh_key_ids: list[str]
         :param deleted_at: the time the volume was deleted (UTC), defaults to None
         :type deleted_at: str, optional
         """
@@ -157,7 +157,7 @@ def ssh_key_ids(self) -> list[str]:
         """Get the SSH key IDs of the instance.
 
         :return: SSH key IDs
-        :rtype: List[str]
+        :rtype: list[str]
         """
         return self._ssh_key_ids
 
@@ -215,7 +215,7 @@ def get(self, status: str = None) -> list[Volume]:
         :param status: optional, status of the volumes, defaults to None
         :type status: str, optional
         :return: list of volume details objects
-        :rtype: List[Volume]
+        :rtype: list[Volume]
         """
         volumes_dict = self._http_client.get(VOLUMES_ENDPOINT, params={'status': status}).json()
         return list(map(Volume.create_from_dict, volumes_dict))
@@ -236,7 +236,7 @@ def get_in_trash(self) -> list[Volume]:
         """Get all volumes that are in trash.
 
         :return: list of volume details objects
-        :rtype: List[Volume]
+        :rtype: list[Volume]
         """
         volumes_dicts = self._http_client.get(VOLUMES_ENDPOINT + '/trash').json()
 
@@ -282,7 +282,7 @@ def attach(self, id_list: list[str] | str, instance_id: str) -> None:
         Note: the instance needs to be shut-down (offline)
 
         :param id_list: list of volume ids, or a volume id
-        :type id_list: Union[List[str], str]
+        :type id_list: Union[list[str], str]
         :param instance_id: instance id the volume(s) will be attached to
         :type instance_id: str
         """
@@ -301,7 +301,7 @@ def detach(self, id_list: list[str] | str) -> None:
         Note: the instances need to be shut-down (offline)
 
         :param id_list: list of volume ids, or a volume id
-        :type id_list: Union[List[str], str]
+        :type id_list: Union[list[str], str]
         """
         payload = {
             'id': id_list,
@@ -315,13 +315,13 @@ def clone(self, id: str, name: str = None, type: str = None) -> Volume:
         """Clone a volume or multiple volumes.
 
         :param id: volume id or list of volume ids
-        :type id: str or List[str]
+        :type id: str or list[str]
         :param name: new volume name
         :type name: str
         :param type: volume type
         :type type: str, optional
         :return: the new volume object, or a list of volume objects if cloned mutliple volumes
-        :rtype: Volume or List[Volume]
+        :rtype: Volume or list[Volume]
         """
         payload = {'id': id, 'action': VolumeActions.CLONE, 'name': name, 'type': type}
 
@@ -342,7 +342,7 @@ def rename(self, id_list: list[str] | str, name: str) -> None:
         """Rename multiple volumes or single volume.
 
         :param id_list: list of volume ids, or a volume id
-        :type id_list: Union[List[str], str]
+        :type id_list: Union[list[str], str]
         :param name: new name
         :type name: str
         """
@@ -355,7 +355,7 @@ def increase_size(self, id_list: list[str] | str, size: int) -> None:
         """Increase size of multiple volumes or single volume.
 
         :param id_list: list of volume ids, or a volume id
-        :type id_list: Union[List[str], str]
+        :type id_list: Union[list[str], str]
         :param size: new size in GB
         :type size: int
         """
@@ -374,7 +374,7 @@ def delete(self, id_list: list[str] | str, is_permanent: bool = False) -> None:
         Note: if attached to any instances, they need to be shut-down (offline)
 
         :param id_list: list of volume ids, or a volume id
-        :type id_list: Union[List[str], str]
+        :type id_list: Union[list[str], str]
         """
         payload = {
             'id': id_list,