Merge #625

625: Change typing using the typing lib r=alallema a=pbrochar

# Pull Request

## Related issue
Fixes #611 

## What does this PR do?
- Change typing for more coherence in the definition of functions

## PR checklist
Please check if your PR fulfills the following requirements:
- [X] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [X] Have you read the contributing guidelines?
- [X] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: paul <[email protected]>

Author: bors[bot]

meilisearch/_httprequests.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import json
-from typing import Any, Callable
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import requests
 
@@ -26,8 +26,8 @@ def send_request(
         self,
         http_method: Callable,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
-        content_type: str | None = None,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = None,
     ) -> Any:
         if content_type:
             self.headers["Content-Type"] = content_type
@@ -60,31 +60,31 @@ def get(self, path: str) -> Any:
     def post(
         self,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
-        content_type: str | None = "application/json",
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = "application/json",
     ) -> Any:
         return self.send_request(requests.post, path, body, content_type)
 
     def patch(
         self,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
-        content_type: str | None = "application/json",
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = "application/json",
     ) -> Any:
         return self.send_request(requests.patch, path, body, content_type)
 
     def put(
         self,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
-        content_type: str | None = "application/json",
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = "application/json",
     ) -> Any:
         return self.send_request(requests.put, path, body, content_type)
 
     def delete(
         self,
         path: str,
-        body: dict[str, Any] | list[dict[str, Any]] | list[str] | None = None,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
     ) -> Any:
         return self.send_request(requests.delete, path, body)
 

meilisearch/client.py

@@ -6,7 +6,7 @@
 import hmac
 import json
 import re
-from typing import Any
+from typing import Any, Dict, List, Optional, Union
 from urllib import parse
 
 from meilisearch._httprequests import HttpRequests
@@ -25,7 +25,9 @@ class Client:
     Meilisearch and its permissions.
     """
 
-    def __init__(self, url: str, api_key: str | None = None, timeout: int | None = None) -> None:
+    def __init__(
+        self, url: str, api_key: Optional[str] = None, timeout: Optional[int] = None
+    ) -> None:
         """
         Parameters
         ----------
@@ -38,7 +40,7 @@ def __init__(self, url: str, api_key: str | None = None, timeout: int | None = N
 
         self.http = HttpRequests(self.config)
 
-    def create_index(self, uid: str, options: dict[str, Any] | None = None) -> dict[str, Any]:
+    def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Create an index.
 
         Parameters
@@ -61,7 +63,7 @@ def create_index(self, uid: str, options: dict[str, Any] | None = None) -> dict[
         """
         return Index.create(self.config, uid, options)
 
-    def delete_index(self, uid: str) -> dict[str, Any]:
+    def delete_index(self, uid: str) -> Dict[str, Any]:
         """Deletes an index
 
         Parameters
@@ -83,7 +85,7 @@ def delete_index(self, uid: str) -> dict[str, Any]:
 
         return self.http.delete(f"{self.config.paths.index}/{uid}")
 
-    def get_indexes(self, parameters: dict[str, Any] | None = None) -> dict[str, list[Index]]:
+    def get_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, List[Index]]:
         """Get all indexes.
 
         Parameters
@@ -116,7 +118,7 @@ def get_indexes(self, parameters: dict[str, Any] | None = None) -> dict[str, lis
         ]
         return response
 
-    def get_raw_indexes(self, parameters: dict[str, Any] | None = None) -> list[dict[str, Any]]:
+    def get_raw_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
         """Get all indexes in dictionary format.
 
         Parameters
@@ -159,7 +161,7 @@ def get_index(self, uid: str) -> Index:
         """
         return Index(self.config, uid).fetch_info()
 
-    def get_raw_index(self, uid: str) -> dict[str, Any]:
+    def get_raw_index(self, uid: str) -> Dict[str, Any]:
         """Get the index as a dictionary.
         This index should already exist.
 
@@ -198,7 +200,7 @@ def index(self, uid: str) -> Index:
             return Index(self.config, uid=uid)
         raise Exception("The index UID should not be None")
 
-    def get_all_stats(self) -> dict[str, Any]:
+    def get_all_stats(self) -> Dict[str, Any]:
         """Get all stats of Meilisearch
 
         Get information about database size and all indexes
@@ -216,7 +218,7 @@ def get_all_stats(self) -> dict[str, Any]:
         """
         return self.http.get(self.config.paths.stat)
 
-    def health(self) -> dict[str, str]:
+    def health(self) -> Dict[str, str]:
         """Get health of the Meilisearch server.
 
         Returns
@@ -239,7 +241,7 @@ def is_healthy(self) -> bool:
             return False
         return True
 
-    def get_key(self, key_or_uid: str) -> dict[str, Any]:
+    def get_key(self, key_or_uid: str) -> Dict[str, Any]:
         """Gets information about a specific API key.
 
         Parameters
@@ -260,7 +262,7 @@ def get_key(self, key_or_uid: str) -> dict[str, Any]:
         """
         return self.http.get(f"{self.config.paths.keys}/{key_or_uid}")
 
-    def get_keys(self, parameters: dict[str, Any] | None = None) -> dict[str, Any]:
+    def get_keys(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Gets the Meilisearch API keys.
 
         Parameters
@@ -283,7 +285,7 @@ def get_keys(self, parameters: dict[str, Any] | None = None) -> dict[str, Any]:
             parameters = {}
         return self.http.get(f"{self.config.paths.keys}?{parse.urlencode(parameters)}")
 
-    def create_key(self, options: dict[str, Any]) -> dict[str, Any]:
+    def create_key(self, options: Dict[str, Any]) -> Dict[str, Any]:
         """Creates a new API key.
 
         Parameters
@@ -308,7 +310,7 @@ def create_key(self, options: dict[str, Any]) -> dict[str, Any]:
         """
         return self.http.post(f"{self.config.paths.keys}", options)
 
-    def update_key(self, key_or_uid: str, options: dict[str, Any]) -> dict[str, Any]:
+    def update_key(self, key_or_uid: str, options: Dict[str, Any]) -> Dict[str, Any]:
         """Update an API key.
 
         Parameters
@@ -333,7 +335,7 @@ def update_key(self, key_or_uid: str, options: dict[str, Any]) -> dict[str, Any]
         url = f"{self.config.paths.keys}/{key_or_uid}"
         return self.http.patch(url, options)
 
-    def delete_key(self, key_or_uid: str) -> dict[str, int]:
+    def delete_key(self, key_or_uid: str) -> Dict[str, int]:
         """Deletes an API key.
 
         Parameters
@@ -354,7 +356,7 @@ def delete_key(self, key_or_uid: str) -> dict[str, int]:
         """
         return self.http.delete(f"{self.config.paths.keys}/{key_or_uid}")
 
-    def get_version(self) -> dict[str, str]:
+    def get_version(self) -> Dict[str, str]:
         """Get version Meilisearch
 
         Returns
@@ -369,7 +371,7 @@ def get_version(self) -> dict[str, str]:
         """
         return self.http.get(self.config.paths.version)
 
-    def version(self) -> dict[str, str]:
+    def version(self) -> Dict[str, str]:
         """Alias for get_version
 
         Returns
@@ -384,7 +386,7 @@ def version(self) -> dict[str, str]:
         """
         return self.get_version()
 
-    def create_dump(self) -> dict[str, str]:
+    def create_dump(self) -> Dict[str, str]:
         """Trigger the creation of a Meilisearch dump.
 
         Returns
@@ -400,7 +402,7 @@ def create_dump(self) -> dict[str, str]:
         """
         return self.http.post(self.config.paths.dumps)
 
-    def swap_indexes(self, parameters: list[dict[str, list[str]]]) -> TaskInfo:
+    def swap_indexes(self, parameters: List[Dict[str, List[str]]]) -> TaskInfo:
         """Swap two indexes.
 
         Parameters
@@ -422,8 +424,8 @@ def swap_indexes(self, parameters: list[dict[str, list[str]]]) -> TaskInfo:
         return TaskInfo(**self.http.post(self.config.paths.swap, parameters))
 
     def get_tasks(
-        self, parameters: dict[str, Any] | None = None
-    ) -> dict[str, list[dict[str, Any]]]:
+        self, parameters: Optional[Dict[str, Any]] = None
+    ) -> Dict[str, List[Dict[str, Any]]]:
         """Get all tasks.
 
         Parameters
@@ -443,7 +445,7 @@ def get_tasks(
         """
         return get_tasks(self.config, parameters=parameters)
 
-    def get_task(self, uid: int) -> dict[str, Any]:
+    def get_task(self, uid: int) -> Dict[str, Any]:
         """Get one task.
 
         Parameters
@@ -463,7 +465,7 @@ def get_task(self, uid: int) -> dict[str, Any]:
         """
         return get_task(self.config, uid)
 
-    def cancel_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
+    def cancel_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:
         """Cancel a list of enqueued or processing tasks.
 
         Parameters
@@ -484,7 +486,7 @@ def cancel_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
         """
         return cancel_tasks(self.config, parameters=parameters)
 
-    def delete_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
+    def delete_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:
         """Delete a list of finished tasks.
 
         Parameters
@@ -508,7 +510,7 @@ def wait_for_task(
         uid: int,
         timeout_in_ms: int = 5000,
         interval_in_ms: int = 50,
-    ) -> dict[str, Any]:
+    ) -> Dict[str, Any]:
         """Wait until Meilisearch processes a task until it fails or succeeds.
 
         Parameters
@@ -535,10 +537,10 @@ def wait_for_task(
     def generate_tenant_token(
         self,
         api_key_uid: str,
-        search_rules: dict[str, Any] | list[str],
+        search_rules: Union[Dict[str, Any], List[str]],
         *,
-        expires_at: datetime.datetime | None = None,
-        api_key: str | None = None,
+        expires_at: Optional[datetime.datetime] = None,
+        api_key: Optional[str] = None,
     ) -> str:
         """Generate a JWT token for the use of multitenancy.
 

meilisearch/config.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 
 class Config:
     """
@@ -31,7 +33,9 @@ class Paths:
         faceting = "faceting"
         swap = "swap-indexes"
 
-    def __init__(self, url: str, api_key: str | None = None, timeout: int | None = None) -> None:
+    def __init__(
+        self, url: str, api_key: Optional[str] = None, timeout: Optional[int] = None
+    ) -> None:
         """
         Parameters
         ----------