feat(lab-4126): handle custom tqdm

Author: florianlega

sdk-config.example.json

@@ -1,6 +1,6 @@
 {
   "api_key": "your-api-key-here",
-  "api_endpoint": "https://cloud.kili-technology.com/api/label/v2/graphql",
+  "api_endpoint": "https://api-endpoint.com",
   "verify_ssl": true,
   "disable_tqdm": false
 }

src/kili/presentation/client/asset.py

@@ -29,6 +29,7 @@
 from kili.domain.types import ListOrTuple
 from kili.presentation.client.helpers.common_validators import (
     disable_tqdm_if_as_generator,
+    resolve_disable_tqdm,
 )
 from kili.presentation.client.helpers.filter_conversion import (
     extract_step_ids_from_project_steps,
@@ -499,6 +500,9 @@ def assets(
                     step_name_in=step_name_not_in,
                 )
 
+        # Resolve disable_tqdm: function parameter > client global setting > function default
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
+
         asset_use_cases = AssetUseCases(self.kili_api_gateway)
         filters = AssetFilters(
             project_id=ProjectId(project_id),

src/kili/presentation/client/base.py

@@ -1,6 +1,7 @@
 """Base class for all client methods classes."""
 
 from abc import ABC
+from typing import Optional
 
 from kili.adapters.kili_api_gateway.kili_api_gateway import KiliAPIGateway
 
@@ -14,3 +15,4 @@ class BaseClientMethods(ABC):
     """
 
     kili_api_gateway: KiliAPIGateway  # instantiated in the Kili client child class
+    disable_tqdm: Optional[bool]  # instantiated in the Kili client child class

src/kili/presentation/client/cloud_storage.py

@@ -20,6 +20,7 @@
 from kili.domain.types import ListOrTuple
 from kili.presentation.client.helpers.common_validators import (
     disable_tqdm_if_as_generator,
+    resolve_disable_tqdm,
 )
 from kili.use_cases.cloud_storage import CloudStorageUseCases
 from kili.utils.logcontext import for_all_methods, log_call
@@ -127,6 +128,7 @@ def cloud_storage_connections(
                 " project_id must be specified"
             )
 
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
 
         cloud_storage_use_cases = CloudStorageUseCases(self.kili_api_gateway)
@@ -230,6 +232,7 @@ def cloud_storage_integrations(
             >>> kili.cloud_storage_integrations()
             [{'name': 'My bucket', 'id': '123456789', 'platform': 'AWS', 'status': 'CONNECTED'}]
         """
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
         options = QueryOptions(disable_tqdm, first, skip)
         data_integrations_gen = CloudStorageUseCases(self.kili_api_gateway).list_data_integrations(

src/kili/presentation/client/helpers/common_validators.py

@@ -20,6 +20,32 @@ def disable_tqdm_if_as_generator(
     return disable_tqdm
 
 
+def resolve_disable_tqdm(
+    disable_tqdm: bool | None, client_disable_tqdm: bool | None
+) -> bool | None:
+    """Resolve the disable_tqdm parameter with priority: function param > client global setting.
+
+    Args:
+        disable_tqdm: The disable_tqdm parameter passed to the function.
+        client_disable_tqdm: The global disable_tqdm setting from the client.
+            Can be None if the client doesn't have this attribute set (e.g., in tests).
+
+    Returns:
+        The resolved disable_tqdm value, or None if both are None (to use function default).
+
+    Examples:
+        >>> resolve_disable_tqdm(True, False)  # Function param takes priority
+        True
+        >>> resolve_disable_tqdm(None, True)   # Use client global setting
+        True
+        >>> resolve_disable_tqdm(None, None)   # Use function default
+        None
+    """
+    if disable_tqdm is not None:
+        return disable_tqdm
+    return client_disable_tqdm
+
+
 def assert_all_arrays_have_same_size(
     arrays: list[Optional[ListOrTuple[Any]]], raise_error: bool = True
 ) -> bool:

src/kili/presentation/client/internal.py

@@ -11,6 +11,7 @@
 from kili.domain.api_key import ApiKeyFilters
 from kili.domain.types import ListOrTuple
 from kili.entrypoints.mutations.project.queries import GQL_DELETE_PROJECT
+from kili.presentation.client.helpers.common_validators import resolve_disable_tqdm
 from kili.presentation.client.organization import InternalOrganizationClientMethods
 from kili.use_cases.api_key import ApiKeyUseCases
 
@@ -97,6 +98,7 @@ def api_keys(
             A result object which contains the query if it was successful,
                 or an error message.
         """
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         api_key_use_cases = ApiKeyUseCases(self.kili_api_gateway)
         filters = ApiKeyFilters(api_key_id=api_key_id, user_id=user_id, api_key=api_key)
         api_keys_gen = api_key_use_cases.list_api_keys(

src/kili/presentation/client/issue.py

@@ -15,6 +15,7 @@
 from kili.presentation.client.helpers.common_validators import (
     assert_all_arrays_have_same_size,
     disable_tqdm_if_as_generator,
+    resolve_disable_tqdm,
 )
 from kili.use_cases.issue import IssueUseCases
 from kili.use_cases.issue.types import IssueToCreateUseCaseInput
@@ -195,6 +196,7 @@ def issues(
                 "You cannot provide both `asset_id` and `asset_id_in` at the same time."
             )
 
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
         options = QueryOptions(disable_tqdm=disable_tqdm, first=first, skip=skip)
         issues_gen = IssueUseCases(self.kili_api_gateway).list_issues(

src/kili/presentation/client/label.py

@@ -37,6 +37,7 @@
 from kili.presentation.client.helpers.common_validators import (
     assert_all_arrays_have_same_size,
     disable_tqdm_if_as_generator,
+    resolve_disable_tqdm,
 )
 from kili.presentation.client.helpers.filter_conversion import (
     extract_step_ids_from_project_steps,
@@ -454,6 +455,7 @@ def labels(
         if category_search:
             validate_category_search_query(category_search)
 
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
         options = QueryOptions(disable_tqdm, first, skip)
 

src/kili/presentation/client/notification.py

@@ -11,6 +11,7 @@
 from kili.domain.user import UserFilter, UserId
 from kili.presentation.client.helpers.common_validators import (
     disable_tqdm_if_as_generator,
+    resolve_disable_tqdm,
 )
 from kili.use_cases.notification import NotificationUseCases
 from kili.utils.logcontext import for_all_methods, log_call
@@ -104,6 +105,7 @@ def notifications(
         Returns:
             An iterable of notifications.
         """
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
         options = QueryOptions(disable_tqdm, first, skip)
         filters = NotificationFilter(

src/kili/presentation/client/organization.py

@@ -17,6 +17,7 @@
 )
 from kili.domain.types import ListOrTuple
 from kili.presentation.client.base import BaseClientMethods
+from kili.presentation.client.helpers.common_validators import resolve_disable_tqdm
 from kili.use_cases.organization.use_cases import OrganizationUseCases
 from kili.utils.logcontext import for_all_methods, log_call
 
@@ -141,6 +142,7 @@ def organizations(
             >>> kili.organizations(organization_id=organization_id, fields=['users.email'])
             [{'users': [{'email': 'john@doe.com'}]}]
         """
+        disable_tqdm = resolve_disable_tqdm(disable_tqdm, getattr(self, "disable_tqdm", None))
         organization_use_cases = OrganizationUseCases(self.kili_api_gateway)
         organization_gen = organization_use_cases.list_organizations(
             OrganizationFilters(