lint: pydocstyle

Author: shamrin

datacrunch/InferenceClient/inference_client.py

@@ -16,6 +16,8 @@ class InferenceClientError(Exception):
 
 
 class AsyncStatus(str, Enum):
+    """Async status."""
+
     Initialized = 'Initialized'
     Queue = 'Queue'
     Inference = 'Inference'
@@ -25,6 +27,8 @@ class AsyncStatus(str, Enum):
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclass
 class InferenceResponse:
+    """Inference response."""
+
     headers: CaseInsensitiveDict[str]
     status_code: int
     status_text: str
@@ -66,6 +70,7 @@ def _is_stream_response(self, headers: CaseInsensitiveDict[str]) -> bool:
         )
 
     def output(self, is_text: bool = False) -> Any:
+        """Get response output as a string or object."""
         try:
             if is_text:
                 return self._original_response.text
@@ -99,11 +104,12 @@ def stream(self, chunk_size: int = 512, as_text: bool = True) -> Generator[Any,
 
 
 class InferenceClient:
+    """Inference client."""
+
     def __init__(
         self, inference_key: str, endpoint_base_url: str, timeout_seconds: int = 60 * 5
     ) -> None:
-        """
-        Initialize the InferenceClient.
+        """Initialize the InferenceClient.
 
         Args:
             inference_key: The authentication key for the API
@@ -139,17 +145,15 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
     @property
     def global_headers(self) -> dict[str, str]:
-        """
-        Get the current global headers that will be used for all requests.
+        """Get the current global headers that will be used for all requests.
 
         Returns:
             Dictionary of current global headers
         """
         return self._global_headers.copy()
 
     def set_global_header(self, key: str, value: str) -> None:
-        """
-        Set or update a global header that will be used for all requests.
+        """Set or update a global header that will be used for all requests.
 
         Args:
             key: Header name
@@ -158,17 +162,15 @@ def set_global_header(self, key: str, value: str) -> None:
         self._global_headers[key] = value
 
     def set_global_headers(self, headers: dict[str, str]) -> None:
-        """
-        Set multiple global headers at once that will be used for all requests.
+        """Set multiple global headers at once that will be used for all requests.
 
         Args:
             headers: Dictionary of headers to set globally
         """
         self._global_headers.update(headers)
 
     def remove_global_header(self, key: str) -> None:
-        """
-        Remove a global header.
+        """Remove a global header.
 
         Args:
             key: Header name to remove from global headers
@@ -183,8 +185,7 @@ def _build_url(self, path: str) -> str:
     def _build_request_headers(
         self, request_headers: dict[str, str] | None = None
     ) -> dict[str, str]:
-        """
-        Build the final headers by merging global headers with request-specific headers.
+        """Build the final headers by merging global headers with request-specific headers.
 
         Args:
             request_headers: Optional headers specific to this request
@@ -198,8 +199,7 @@ def _build_request_headers(
         return headers
 
     def _make_request(self, method: str, path: str, **kwargs) -> requests.Response:
-        """
-        Make an HTTP request with error handling.
+        """Make an HTTP request with error handling.
 
         Args:
             method: HTTP method to use
@@ -224,7 +224,9 @@ def _make_request(self, method: str, path: str, **kwargs) -> requests.Response:
             response.raise_for_status()
             return response
         except requests.exceptions.Timeout as e:
-            raise InferenceClientError(f'Request to {path} timed out after {timeout} seconds') from e
+            raise InferenceClientError(
+                f'Request to {path} timed out after {timeout} seconds'
+            ) from e
         except requests.exceptions.RequestException as e:
             raise InferenceClientError(f'Request to {path} failed: {str(e)}') from e
 
@@ -331,6 +333,7 @@ def get(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make GET request."""
         return self._make_request(
             'GET', path, params=params, headers=headers, timeout_seconds=timeout_seconds
         )
@@ -344,6 +347,7 @@ def post(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make POST request."""
         return self._make_request(
             'POST',
             path,
@@ -363,6 +367,7 @@ def put(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make PUT request."""
         return self._make_request(
             'PUT',
             path,
@@ -380,6 +385,7 @@ def delete(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make DELETE request."""
         return self._make_request(
             'DELETE',
             path,
@@ -397,6 +403,7 @@ def patch(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make PATCH request."""
         return self._make_request(
             'PATCH',
             path,
@@ -414,6 +421,7 @@ def head(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make HEAD request."""
         return self._make_request(
             'HEAD',
             path,
@@ -429,6 +437,7 @@ def options(
         headers: dict[str, str] | None = None,
         timeout_seconds: int | None = None,
     ) -> requests.Response:
+        """Make OPTIONS request."""
         return self._make_request(
             'OPTIONS',
             path,
@@ -438,8 +447,7 @@ def options(
         )
 
     def health(self, healthcheck_path: str = '/health') -> requests.Response:
-        """
-        Check the health status of the API.
+        """Check the health status of the API.
 
         Returns:
             requests.Response: The response from the health check
@@ -456,22 +464,23 @@ def health(self, healthcheck_path: str = '/health') -> requests.Response:
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclass
 class AsyncInferenceExecution:
+    """Async inference execution."""
+
     _inference_client: 'InferenceClient'
     id: str
     _status: AsyncStatus
     INFERENCE_ID_HEADER = 'X-Inference-Id'
 
     def status(self) -> AsyncStatus:
-        """Get the current stored status of the async inference execution. Only the status value type
+        """Get the current stored status of the async inference execution. Only the status value type.
 
         Returns:
             AsyncStatus: The status object
         """
-
         return self._status
 
     def status_json(self) -> dict[str, Any]:
-        """Get the current status of the async inference execution. Return the status json
+        """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

datacrunch/authentication/authentication.py

@@ -11,15 +11,15 @@
 
 
 class AuthenticationService:
-    """A service for client authentication"""
+    """A service for client authentication."""
 
     def __init__(self, client_id: str, client_secret: str, base_url: str) -> None:
         self._base_url = base_url
         self._client_id = client_id
         self._client_secret = client_secret
 
     def authenticate(self) -> dict:
-        """Authenticate the client and store the access & refresh tokens
+        """Authenticate the client and store the access & refresh tokens.
 
         returns an authentication data dictionary with the following schema:
         {

datacrunch/balance/balance.py

@@ -2,10 +2,10 @@
 
 
 class Balance:
-    """A balance model class"""
+    """A balance model class."""
 
     def __init__(self, amount: float, currency: str) -> None:
-        """Initialize a new Balance object
+        """Initialize a new Balance object.
 
         :param amount: Balance amount
         :type amount: float
@@ -17,7 +17,7 @@ def __init__(self, amount: float, currency: str) -> None:
 
     @property
     def amount(self) -> float:
-        """Get the balance amount
+        """Get the balance amount.
 
         :return: amount
         :rtype: float
@@ -26,7 +26,7 @@ def amount(self) -> float:
 
     @property
     def currency(self) -> str:
-        """Get the currency code
+        """Get the currency code.
 
         :return: currency code
         :rtype: str
@@ -35,13 +35,13 @@ def currency(self) -> str:
 
 
 class BalanceService:
-    """A service for interacting with the balance endpoint"""
+    """A service for interacting with the balance endpoint."""
 
     def __init__(self, http_client) -> None:
         self._http_client = http_client
 
     def get(self) -> Balance:
-        """Get the client's current balance
+        """Get the client's current balance.
 
         :return: Balance object containing the amount and currency.
         :rtype: Balance

datacrunch/constants.py

@@ -1,4 +1,6 @@
 class Actions:
+    """Instance actions."""
+
     START = 'start'
     SHUTDOWN = 'shutdown'
     DELETE = 'delete'
@@ -10,6 +12,8 @@ def __init__(self):
 
 
 class VolumeActions:
+    """Storage volume actions."""
+
     ATTACH = 'attach'
     DETACH = 'detach'
     RENAME = 'rename'
@@ -22,6 +26,8 @@ def __init__(self):
 
 
 class InstanceStatus:
+    """Instance status."""
+
     ORDERED = 'ordered'
     RUNNING = 'running'
     PROVISIONING = 'provisioning'
@@ -36,6 +42,8 @@ def __init__(self):
 
 
 class VolumeStatus:
+    """Storage volume status."""
+
     ORDERED = 'ordered'
     CREATING = 'creating'
     ATTACHED = 'attached'
@@ -49,6 +57,8 @@ def __init__(self):
 
 
 class VolumeTypes:
+    """Storage volume types."""
+
     NVMe = 'NVMe'
     HDD = 'HDD'
 
@@ -57,6 +67,8 @@ def __init__(self):
 
 
 class Locations:
+    """Datacenter locations."""
+
     FIN_01: str = 'FIN-01'
     FIN_02: str = 'FIN-02'
     FIN_03: str = 'FIN-03'
@@ -67,6 +79,8 @@ def __init__(self):
 
 
 class ErrorCodes:
+    """Error codes."""
+
     INVALID_REQUEST = 'invalid_request'
     UNAUTHORIZED_REQUEST = 'unauthorized_request'
     INSUFFICIENT_FUNDS = 'insufficient_funds'
@@ -80,6 +94,8 @@ def __init__(self):
 
 
 class Constants:
+    """Constants."""
+
     def __init__(self, base_url, version):
         self.instance_actions: Actions = Actions()
         """Available actions to perform on an instance"""

datacrunch/containers/containers.py

@@ -993,7 +993,7 @@ def get_compute_resources(
 
         Args:
             size: Optional size to filter resources by (e.g. 8 for 8x GPUs)
-            available: Optional boolean to filter by availability status
+            is_available: Optional boolean to filter by availability status
 
         Returns:
             List[ComputeResource]: List of compute resources matching the filters.
@@ -1089,6 +1089,7 @@ def create_fileset_secret_from_file_paths(
         self, secret_name: str, file_paths: list[str]
     ) -> None:
         """Creates a new fileset secret.
+
         A fileset secret is a secret that contains several files,
         and can be used to mount a directory with the files in a container.
 

datacrunch/datacrunch.py

@@ -15,7 +15,7 @@
 
 
 class DataCrunchClient:
-    """Client for interacting with DataCrunch's public API"""
+    """Client for interacting with DataCrunch's public API."""
 
     def __init__(
         self,
@@ -24,7 +24,7 @@ def __init__(
         base_url: str = 'https://api.datacrunch.io/v1',
         inference_key: str = None,
     ) -> None:
-        """The DataCrunch client
+        """The DataCrunch client.
 
         :param client_id: client id
         :type client_id: str
@@ -35,7 +35,6 @@ def __init__(
         :param inference_key: inference key, optional
         :type inference_key: str, optional
         """
-
         # Validate that client_id and client_secret are not empty
         if not client_id or not client_secret:
             raise ValueError('client_id and client_secret must be provided')

datacrunch/exceptions.py

@@ -1,12 +1,13 @@
 class APIException(Exception):
     """This exception is raised if there was an error from datacrunch's API.
+
     Could be an invalid input, token etc.
 
     Raised when an API HTTP call response has a status code >= 400
     """
 
     def __init__(self, code: str, message: str) -> None:
-        """
+        """API Exception.
 
         :param code: error code
         :type code: str