Merge pull request #1994 from kili-technology/chore/upgrade-pyright

chore: bump pyright to 1.1.407 and remove unused libs

Author: baptiste-olivier

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install -e ".[dev]"
       - name: Run pyright
-        run: pyright .
+        run: pyright src/kili
 
   unit-integration-test:
     timeout-minutes: 15

pyproject.toml

@@ -73,16 +73,11 @@ dev = [
   # linting
   "pre-commit >= 3.3.0, < 4.0.0",
   "pylint == 4.0.3",
-  "pyright ==1.1.347",
+  "pyright ==1.1.407",
   # notebooks tests
   "nbformat",
   "nbconvert",
   "ipykernel",
-  # profiling
-  "pyinstrument",
-  # dead code detection
-  "vulture==2.11",
-  "dead==1.5.2",
   # optional dependencies
   "kili-formats[all] == 1.0.0",
   "opencv-python >= 4.0.0, < 5.0.0",

src/kili/client.py

@@ -5,7 +5,8 @@
 import os
 import sys
 import warnings
-from typing import Optional, Union
+from pathlib import Path
+from typing import Optional, TypedDict, Union
 
 from kili.adapters.authentification import is_api_key_valid
 from kili.adapters.http_client import HttpClient
@@ -40,6 +41,13 @@
 warnings.filterwarnings("default", module="kili", category=DeprecationWarning)
 
 
+class GraphQLClientParams(TypedDict, total=False):
+    """Parameters for GraphQLClient initialization."""
+
+    enable_schema_caching: bool
+    graphql_schema_cache_dir: Optional[Union[str, Path]]
+
+
 class FilterPoolFullWarning(logging.Filter):
     """Filter out the specific urllib3 warning related to the connection pool."""
 
@@ -82,7 +90,7 @@ def __init__(
         api_endpoint: Optional[str] = None,
         verify: Optional[Union[bool, str]] = None,
         client_name: GraphQLClientName = GraphQLClientName.SDK,
-        graphql_client_params: Optional[dict[str, object]] = None,
+        graphql_client_params: Optional[GraphQLClientParams] = None,
     ) -> None:
         """Initialize Kili client.
 
@@ -166,7 +174,7 @@ def __init__(
             client_name=client_name,
             verify=self.verify,
             http_client=self.http_client,
-            **(graphql_client_params or {}),  # pyright: ignore[reportGeneralTypeIssues]
+            **(graphql_client_params or {}),
         )
         self.kili_api_gateway = KiliAPIGateway(self.graphql_client, self.http_client)
         self.internal = InternalClientMethods(self.kili_api_gateway)

src/kili/client_domain.py

@@ -5,6 +5,7 @@
 from functools import cached_property
 from typing import TYPE_CHECKING, Optional, Union
 
+from kili.client import GraphQLClientParams
 from kili.client import Kili as KiliLegacy
 from kili.core.graphql.graphql_client import GraphQLClientName
 
@@ -46,7 +47,7 @@ def __init__(
         api_key: Optional[str] = None,
         api_endpoint: Optional[str] = None,
         verify: Optional[Union[bool, str]] = None,
-        graphql_client_params: Optional[dict[str, object]] = None,
+        graphql_client_params: Optional[GraphQLClientParams] = None,
     ) -> None:
         """Initialize Kili client (domain mode).
 

src/kili/core/graphql/graphql_client.py

@@ -192,7 +192,10 @@ def _get_graphql_schema_from_endpoint(self) -> str:
             fetch_schema_from_transport=True,
             introspection_args=self._get_introspection_args(),
         ) as session:
-            return print_schema(session.client.schema)  # pyright: ignore[reportGeneralTypeIssues]
+            schema = session.client.schema
+            if schema is None:
+                raise ValueError("Failed to fetch GraphQL schema from endpoint")
+            return print_schema(schema)
 
     def _cache_graphql_schema(self, graphql_schema_path: Path, schema_str: str) -> None:
         """Cache the graphql schema on disk."""
@@ -332,7 +335,7 @@ def _raw_execute(
             )
             transport = self._gql_client.transport
             if transport:
-                headers = transport.response_headers  # pyright: ignore[reportGeneralTypeIssues]
+                headers = transport.response_headers  # pyright: ignore[reportAttributeAccessIssue]
                 returned_complexity = int(headers.get("x-complexity", 0)) if headers else 0
                 self.complexity_consumed += returned_complexity
             return res

src/kili/core/helpers.py

@@ -35,15 +35,15 @@ def format_result(
     """
     formatted_json = format_json(result[name], http_client)
     if object_ is None:
-        return formatted_json  # pyright: ignore[reportGeneralTypeIssues]
+        return formatted_json  # pyright: ignore[reportReturnType]
     if isinstance(formatted_json, list):
         if get_origin(object_) is list:
             obj = get_args(object_)[0]
-            return [obj(element) for element in formatted_json]  # pyright: ignore[reportGeneralTypeIssues]
+            return [obj(element) for element in formatted_json]  # pyright: ignore[reportReturnType]
         # the legacy "orm" objects fall into this category.
-        return [object_(element) for element in formatted_json]  # pyright: ignore[reportGeneralTypeIssues]
+        return [object_(element) for element in formatted_json]  # pyright: ignore[reportReturnType,reportCallIssue]
 
-    return object_(formatted_json)
+    return object_(formatted_json)  # pyright: ignore[reportCallIssue]
 
 
 def get_mime_type(path: str):

src/kili/entrypoints/mutations/asset/__init__.py

@@ -197,7 +197,7 @@ def append_many_to_dataset(
             if value is not None:
                 assets = [{**assets[i], key: value[i]} for i in range(nb_data)]
         created_asset_ids = import_assets(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             project_id=ProjectId(project_id),
             assets=assets,
             disable_tqdm=disable_tqdm,

src/kili/entrypoints/mutations/plugins/__init__.py

@@ -57,7 +57,7 @@ def upload_plugin(
             raise TypeError('"plugin_path is nullish, please provide a value')
 
         return PluginUploader(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             plugin_path,
             plugin_name,
             verbose,
@@ -106,7 +106,7 @@ def create_webhook(
             >>> kili.create_webhook(webhook_url='https://my-custom-url-publicly-accessible/', plugin_name='my webhook', header='...')
         """
         return WebhookUploader(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             webhook_url,
             plugin_name,
             header,
@@ -148,7 +148,7 @@ def update_webhook(
             >>> kili.update_webhook(webhook_url='https://my-custom-url-publicly-accessible/', plugin_name='my webhook', header='...')
         """
         return WebhookUploader(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             new_webhook_url,
             plugin_name,
             new_header,
@@ -246,7 +246,7 @@ def update_plugin(
             raise TypeError('"plugin_name is nullish, please provide a value')
 
         return PluginUploader(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             plugin_path,
             plugin_name,
             verbose,

src/kili/entrypoints/mutations/project/__init__.py

@@ -253,7 +253,7 @@ def copy_project(  # pylint: disable=too-many-arguments
                 "The 'copy_json_interface' and 'copy_quality_settings' arguments are deprecated."
             )
 
-        return ProjectCopier(self).copy_project(  # pyright: ignore[reportGeneralTypeIssues]
+        return ProjectCopier(self).copy_project(  # pyright: ignore[reportArgumentType]
             from_project_id,
             title,
             description,

src/kili/entrypoints/queries/plugins/__init__.py

@@ -108,7 +108,7 @@ def get_plugin_status(
             >>> kili.get_plugin_status(plugin_name="my_plugin_name")
         """
         return PluginUploader(
-            self,  # pyright: ignore[reportGeneralTypeIssues]
+            self,  # pyright: ignore[reportArgumentType]
             "",
             plugin_name,
             verbose,