chore(inspect): adopt google style docstring (#3195)

adopt google style docstring

Signed-off-by: Max Xiang <xiangxiang.ma@intel.com>

Author: maxxgx

application/backend/src/api/dependencies/dependencies.py

@@ -105,8 +105,11 @@ def is_valid_uuid(identifier: str) -> bool:
     """
     Check if a given string identifier is formatted as a valid UUID
 
-    :param identifier: String to check
-    :return: True if valid UUID, False otherwise
+    Args:
+        identifier: String to check
+
+    Returns:
+        True if valid UUID, False otherwise
     """
     try:
         UUID(identifier)

application/backend/src/api/media_rest_validator.py

@@ -18,11 +18,17 @@ def validate_image_file(request: Request, file: UploadFile = File(None)) -> Uplo
         """
         Validates a request to upload an image, if the file is not present, returns None.
 
-        :param request: FastAPI request that was made to upload the file
-        :param file: uploaded image file
-        :raises InvalidMediaException if the file name is empty or the file extension is
-        not in the supported file extensions
-        :raises PayloadTooLargeException when the total size of the request exceeds 8GB
+        Args:
+            request: FastAPI request that was made to upload the file
+            file: uploaded image file
+
+        Raises:
+            InvalidMediaException: if the file name is empty or the file extension is
+                not in the supported file extensions
+            PayloadTooLargeException: when the total size of the request exceeds 8GB
+
+        Returns:
+            UploadFile if valid, None if file is not present
         """
         if file is None:
             return None

application/backend/src/entities/images_folder_stream.py

@@ -66,7 +66,9 @@ def __init__(self, folder_path: str, ignore_existing_images: bool) -> None:
     def _init_watchdog(self, folder_path: str) -> None:
         """
         Initialize the watchdog to monitor images folder events.
-        :param folder_path: path to the folder with images
+
+        Args:
+            folder_path: path to the folder with images
         """
         event_handler = ImagesFolderEventHandler(
             self.file_added,

application/backend/src/exceptions.py

@@ -8,9 +8,10 @@ class GetiBaseException(Exception):
     """
     Base class for Geti exceptions with a predefined HTTP error code.
 
-    :param message: str message providing short description of error
-    :param error_code: str id of error
-    :param http_status: int default http status code to return to user
+    Args:
+        message: str message providing short description of error
+        error_code: str id of error
+        http_status: int default http status code to return to user
     """
 
     def __init__(self, message: str, error_code: str, http_status: int) -> None:
@@ -24,7 +25,8 @@ class InvalidMediaException(GetiBaseException):
     """
     Exception raised when uploaded media file is invalid.
 
-    :param message: str containing a custom message.
+    Args:
+        message: str containing a custom message.
     """
 
     def __init__(self, message: str) -> None:
@@ -39,7 +41,8 @@ class PayloadTooLargeException(GetiBaseException):
     """
     Exception raised when the request payload is too large.
 
-    :param max_size: Max size in MB
+    Args:
+        max_size: Max size in MB
     """
 
     def __init__(self, max_size: float) -> None:
@@ -54,7 +57,8 @@ class DuplicateJobException(GetiBaseException):
     """
     Exception raised when attempting to submit a duplicate job.
 
-    :param message: str containing a custom message about the duplicate job.
+    Args:
+        message: str containing a custom message about the duplicate job.
     """
 
     def __init__(self, message: str = "A job with the same payload is already running or queued") -> None:
@@ -69,7 +73,8 @@ class ResourceNotFoundException(GetiBaseException):
     """
     Exception raised when a resource could not be found in database.
 
-    :param resource_id: ID of the resource that was not found
+    Args:
+        resource_id: ID of the resource that was not found
     """
 
     def __init__(self, resource_id: str | UUID, resource_name: str) -> None:

application/backend/src/repositories/binary_repo.py

@@ -31,8 +31,11 @@ async def read_file(self, filename: str) -> bytes:
         """
         Read a binary file from the filesystem.
 
-        :param filename: Relative path to the file.
-        :return: Binary content of the file.
+        Args:
+            filename: Relative path to the file.
+
+        Returns:
+            Binary content of the file.
         """
 
         def stdlib_read():
@@ -56,17 +59,23 @@ def get_full_path(self, filename: str) -> str:
         """
         Get the full path for a given filename within the project folder.
 
-        :param filename: Name of the file.
-        :return: Full path to the file.
+        Args:
+            filename: Name of the file.
+
+        Returns:
+            Full path to the file.
         """
 
     async def save_file(self, filename: str, content: bytes) -> str:
         """
         Save a binary file to the filesystem under the project directory.
 
-        :param filename: Name of the file to save.
-        :param content: Binary content of the file.
-        :return: The path where the file was saved.
+        Args:
+            filename: Name of the file to save.
+            content: Binary content of the file.
+
+        Returns:
+            The path where the file was saved.
         """
 
         def stdlib_write():
@@ -87,7 +96,8 @@ async def delete_file(self, filename: str) -> None:
         """
         Delete a binary file from the filesystem.
 
-        :param filename: Name of the file to delete.
+        Args:
+            filename: Name of the file to delete.
         """
 
         def stdlib_delete():
@@ -122,8 +132,11 @@ def get_snapshot_path(self, snapshot_id: str | UUID) -> str:
         """
         Get the full path for a dataset snapshot.
 
-        :param snapshot_id: ID of the snapshot.
-        :return: Full path to the snapshot file.
+        Args:
+            snapshot_id: ID of the snapshot.
+
+        Returns:
+            Full path to the snapshot file.
         """
         return self.get_full_path(f"{snapshot_id}.parquet")
 
@@ -149,7 +162,8 @@ def model_folder_path(self) -> str:
         """
         Get the folder path for models.
 
-        :return: Folder path for models.
+        Returns:
+            Folder path for models.
         """
         return os.path.join(self.project_folder_path, self._model_id)
 
@@ -171,9 +185,12 @@ def get_weights_file_path(self, format: ExportType, name: str) -> str:
         """
         Read a weights file from the model folder.
 
-        :param format: Format of the model (e.g., ExportType.OPENVINO).
-        :param name: Name of the weights to read.
-        :return: path of the weights file.
+        Args:
+            format: Format of the model (e.g., ExportType.OPENVINO).
+            name: Name of the weights to read.
+
+        Returns:
+            path of the weights file.
         """
         return os.path.join(self.model_folder_path, "weights", format, name)
 
@@ -191,17 +208,21 @@ def model_export_folder_path(self) -> str:
         """
         Get the folder path for model exports.
 
-        :return: Folder path for model exports.
+        Returns:
+            Folder path for model exports.
         """
         return os.path.join(self.project_folder_path, self._model_id)
 
     def get_model_export_path(self, model_name: str, export_params: ExportParameters) -> str:
         """
         Get the full path for a dataset snapshot.
 
-        :param model_name: name of the model
-        :param export_params: model export parameters
-        :return: Full path to the model export zip file.
+        Args:
+            model_name: name of the model
+            export_params: model export parameters
+
+        Returns:
+            Full path to the model export zip file.
         """
         compression_suffix = f"_{export_params.compression.value}" if export_params.compression else ""
         filename = f"{model_name}_{export_params.format.value}{compression_suffix}.zip"