Add docstrings

Author: Val Brodsky

libs/labelbox/src/labelbox/schema/dataset.py

@@ -31,16 +31,13 @@
 from labelbox.schema.identifiable import UniqueId, GlobalKey
 from labelbox.schema.task import Task, DataUpsertTask
 from labelbox.schema.user import User
-<<<<<<< HEAD
 from labelbox.schema.iam_integration import IAMIntegration
-=======
 from labelbox.schema.internal.data_row_create_upsert import (DataRowItemBase,
                                                              DataRowUpsertItem,
                                                              DataRowCreateItem)
 from labelbox.schema.internal.data_row_uploader import DataRowUploader
 from labelbox.schema.internal.datarow_upload_constants import (
     MAX_DATAROW_PER_API_OPERATION, FILE_UPLOAD_THREAD_COUNT, UPSERT_CHUNK_SIZE)
->>>>>>> 58e48ccf (Refactor upsert code so that it can be reused for create)
 
 logger = logging.getLogger(__name__)
 
@@ -644,11 +641,13 @@ def _exec_upsert_data_rows(
         task._user = self.client.get_user()
         return task
 
-    def add_iam_integration(self, iam_integration: Union[str, IAMIntegration]) -> IAMIntegration:
+    def add_iam_integration(
+            self, iam_integration: Union[str,
+                                         IAMIntegration]) -> IAMIntegration:
         """          
         Sets the IAM integration for the dataset. IAM integration is used to sign URLs for data row assets.
 
-        Args:
+    Args:
             iam_integration (Union[str, IAMIntegration]): IAM integration object or IAM integration id.
 
         Returns:
@@ -679,7 +678,8 @@ def add_iam_integration(self, iam_integration: Union[str, IAMIntegration]) -> IA
             >>>   dataset.set_iam_integration(iam_integration)
         """
 
-        iam_integration_id = iam_integration.uid if isinstance(iam_integration, IAMIntegration) else iam_integration
+        iam_integration_id = iam_integration.uid if isinstance(
+            iam_integration, IAMIntegration) else iam_integration
 
         query = """
             mutation SetSignerForDatasetPyApi($signerId: ID!, $datasetId: ID!) {
@@ -695,20 +695,30 @@ def add_iam_integration(self, iam_integration: Union[str, IAMIntegration]) -> IA
             }
         """
 
-        response = self.client.execute(query, {"signerId": iam_integration_id, "datasetId": self.uid})
+        response = self.client.execute(query, {
+            "signerId": iam_integration_id,
+            "datasetId": self.uid
+        })
 
         if not response:
-            raise ResourceNotFoundError(IAMIntegration, {"signerId": iam_integration_id, "datasetId": self.uid})
-        
-        try:
-            iam_integration_id = response.get("setSignerForDataset", {}).get("signer", {})["id"]
+            raise ResourceNotFoundError(IAMIntegration, {
+                "signerId": iam_integration_id,
+                "datasetId": self.uid
+            })
 
-            return [integration for integration 
-                    in self.client.get_organization().get_iam_integrations() 
-                    if integration.uid == iam_integration_id][0]
+        try:
+            iam_integration_id = response.get("setSignerForDataset",
+                                              {}).get("signer", {})["id"]
+
+            return [
+                integration for integration in
+                self.client.get_organization().get_iam_integrations()
+                if integration.uid == iam_integration_id
+            ][0]
         except:
-            raise LabelboxError(f"Can't retrieve IAM integration {iam_integration_id}")
-              
+            raise LabelboxError(
+                f"Can't retrieve IAM integration {iam_integration_id}")
+
     def remove_iam_integration(self) -> None:
         """
         Unsets the IAM integration for the dataset.
@@ -738,4 +748,3 @@ def remove_iam_integration(self) -> None:
 
         if not response:
             raise ResourceNotFoundError(Dataset, {"id": self.uid})
-        

libs/labelbox/src/labelbox/schema/internal/data_row_create_upsert.py

@@ -6,6 +6,9 @@
 
 
 class DataRowItemBase(BaseModel, ABC):
+    """
+    Base class for creating payloads for upsert operations.
+    """
     id: dict
     payload: dict
 

libs/labelbox/src/labelbox/schema/task.py

@@ -230,6 +230,9 @@ def get_task(client, task_id):
 
 
 class DataUpsertTask(Task):
+    """
+    Task class for data row upsert operations
+    """
     __max_donwload_size: Final = MAX_DATAROW_PER_API_OPERATION
 
     def __init__(self, *args, **kwargs):
@@ -238,12 +241,18 @@ def __init__(self, *args, **kwargs):
 
     @property
     def result(self) -> Optional[List[Dict[str, Any]]]:  # type: ignore
+        """
+        Fetches maximum 150K results. If you need to fetch more, use `result_all` property
+        """
         if self.status == "FAILED":
             raise ValueError(f"Job failed. Errors : {self.errors}")
         return self._results_as_list()
 
     @property
     def errors(self) -> Optional[List[Dict[str, Any]]]:  # type: ignore
+        """
+        Fetches maximum 150K errors. If you need to fetch more, use `errors_all` property
+        """
         return self._errors_as_list()
 
     @property
@@ -258,10 +267,19 @@ def failed_data_rows(  # type: ignore
 
     @property
     def result_all(self) -> PaginatedCollection:
+        """
+        This method uses our standard PaginatedCollection and allow to fetch any number of results
+        See here for more https://docs.labelbox.com/reference/sdk-fundamental-concepts-1#iterate-over-paginatedcollection
+        """
         return self._download_results_paginated()
 
     @property
     def errors_all(self) -> PaginatedCollection:
+        """
+        This method uses our standard PaginatedCollection and allow to fetch any number of errors
+        See here for more https://docs.labelbox.com/reference/sdk-fundamental-concepts-1#iterate-over-paginatedcollection
+        """
+
         return self._download_errors_paginated()
 
     def _download_results_paginated(self) -> PaginatedCollection: