Merge #529

529: Drop python 3.6 support r=alallema a=sanders41

# Pull Request

This drops support for Python 3.6 and updates to 3.7+ syntax.

## What does this PR do?
Fixes #378
<!-- Please link the issue you're trying to fix with this PR, if none then please create an issue first. -->

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [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 Sanders <[email protected]>
Co-authored-by: Amélie <[email protected]>

Author: 3 people

.github/workflows/pre-release-tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, '3.10.0-beta - 3.10.0']
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
     name: integration-tests-against-rc
     runs-on: ubuntu-latest
     steps:

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, '3.10.0-beta - 3.10.0']
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
     name: integration-tests
     runs-on: ubuntu-latest
     steps:

README.md

@@ -41,7 +41,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
 
 ## 🔧 Installation
 
-**Note**: Python 3.6+ is required.
+**Note**: Python 3.7+ is required.
 
 With `pip3` in command line:
 

bors.toml

@@ -1,10 +1,10 @@
 status = [
   'pylint',
   'mypy',
-  'integration-tests (3.6)',
   'integration-tests (3.7)',
   'integration-tests (3.8)',
-  'integration-tests (3.9)'
+  'integration-tests (3.9)',
+  'integration-tests (3.10)'
 ]
 # 1 hour timeout
 timeout-sec = 3600

meilisearch/_httprequests.py

@@ -1,6 +1,10 @@
+from __future__ import annotations
+
 import json
-from typing import Any, Callable, Dict, List, Optional, Union
+from typing import Any, Callable
+
 import requests
+
 from meilisearch.config import Config
 from meilisearch.errors import (
     MeiliSearchApiError,
@@ -9,6 +13,7 @@
 )
 from meilisearch.version import qualified_version
 
+
 class HttpRequests:
     def __init__(self, config: Config) -> None:
         self.config = config
@@ -21,8 +26,8 @@ def send_request(
         self,
         http_method: Callable,
         path: str,
-        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
-        content_type: Optional[str] = None,
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
+        content_type: str | None = None,
     ) -> Any:
         if content_type:
             self.headers['Content-Type'] = content_type
@@ -57,31 +62,31 @@ def get(
     def post(
         self,
         path: str,
-        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
-        content_type: Optional[str] = 'application/json',
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
+        content_type: str | None = 'application/json',
     ) -> Any:
         return self.send_request(requests.post, path, body, content_type)
 
     def patch(
         self,
         path: str,
-        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
-        content_type: Optional[str] = 'application/json',
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
+        content_type: str | None = 'application/json',
     ) -> Any:
         return self.send_request(requests.patch, path, body, content_type)
 
     def put(
         self,
         path: str,
-        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
-        content_type: Optional[str] = 'application/json',
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | None = None,
+        content_type: str | None = 'application/json',
     ) -> Any:
         return self.send_request(requests.put, path, body, content_type)
 
     def delete(
         self,
         path: str,
-        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
+        body: dict[str, Any] | list[dict[str, Any]] | list[str] | None = None,
     ) -> Any:
         return self.send_request(requests.delete, path, body)
 

meilisearch/client.py

@@ -1,16 +1,20 @@
-import re
+from __future__ import annotations
+
 import base64
+import datetime
 import hashlib
 import hmac
 import json
-import datetime
+import re
+from typing import Any
 from urllib import parse
-from typing import Any, Dict, List, Optional, Union
-from meilisearch.index import Index
-from meilisearch.config import Config
-from meilisearch.task import get_task, get_tasks, wait_for_task
+
 from meilisearch._httprequests import HttpRequests
+from meilisearch.config import Config
 from meilisearch.errors import MeiliSearchError
+from meilisearch.index import Index
+from meilisearch.task import get_task, get_tasks, wait_for_task
+
 
 class Client():
     """
@@ -21,7 +25,7 @@ class Client():
     """
 
     def __init__(
-        self, url: str, api_key: Optional[str] = None, timeout: Optional[int] = None
+        self, url: str, api_key: str | None = None, timeout: int | None = None
     ) -> None:
         """
         Parameters
@@ -35,7 +39,7 @@ def __init__(
 
         self.http = HttpRequests(self.config)
 
-    def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    def create_index(self, uid: str, options: dict[str, Any] | None = None) -> dict[str, Any]:
         """Create an index.
 
         Parameters
@@ -58,7 +62,7 @@ def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Di
         """
         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
@@ -80,7 +84,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: Optional[Dict[str, Any]] = None) -> Dict[str, List[Index]]:
+    def get_indexes(self, parameters: dict[str, Any] | None = None) -> dict[str, list[Index]]:
         """Get all indexes.
 
         Parameters
@@ -115,7 +119,7 @@ def get_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str,
             ]
         return response
 
-    def get_raw_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
+    def get_raw_indexes(self, parameters: dict[str, Any] | None = None) -> list[dict[str, Any]]:
         """Get all indexes in dictionary format.
 
         Parameters
@@ -160,7 +164,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.
 
@@ -199,7 +203,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
@@ -217,7 +221,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
@@ -241,7 +245,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
@@ -262,7 +266,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: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    def get_keys(self, parameters: dict[str, Any] | None = None) -> dict[str, Any]:
         """Gets the Meilisearch API keys.
 
         Parameters
@@ -289,8 +293,8 @@ def get_keys(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any
 
     def create_key(
         self,
-        options: Dict[str, Any]
-    ) -> Dict[str, Any]:
+        options: dict[str, Any]
+    ) -> dict[str, Any]:
         """Creates a new API key.
 
         Parameters
@@ -318,8 +322,8 @@ def create_key(
     def update_key(
         self,
         key_or_uid: str,
-        options: Dict[str, Any]
-    ) -> Dict[str, Any]:
+        options: dict[str, Any]
+    ) -> dict[str, Any]:
         """Update an API key.
 
         Parameters
@@ -345,7 +349,7 @@ def update_key(
         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
@@ -366,7 +370,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
@@ -381,7 +385,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
@@ -396,7 +400,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
@@ -412,7 +416,7 @@ def create_dump(self) -> Dict[str, str]:
         """
         return self.http.post(self.config.paths.dumps)
 
-    def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, List[Dict[str, Any]]]:
+    def get_tasks(self, parameters: dict[str, Any] | None = None) -> dict[str, list[dict[str, Any]]]:
         """Get all tasks.
 
         Parameters
@@ -433,7 +437,7 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Li
         """
         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
@@ -457,7 +461,7 @@ def wait_for_task(
         self, 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
@@ -484,10 +488,10 @@ def wait_for_task(
     def generate_tenant_token(
         self,
         api_key_uid: str,
-        search_rules: Union[Dict[str, Any], List[str]],
+        search_rules: dict[str, Any] | list[str],
         *,
-        expires_at: Optional[datetime.datetime] = None,
-        api_key: Optional[str] = None
+        expires_at: datetime.datetime | None = None,
+        api_key: str | None = None
     ) -> str:
         """Generate a JWT token for the use of multitenancy.
 

meilisearch/config.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from __future__ import annotations
 
 
 class Config:
@@ -33,8 +33,8 @@ class Paths():
     def __init__(
         self,
         url: str,
-        api_key: Optional[str] = None,
-        timeout: Optional[int] = None
+        api_key: str | None = None,
+        timeout: int | None = None
     ) -> None:
         """
         Parameters

meilisearch/errors.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 import json
 
 from requests import Response
 
+
 class MeiliSearchError(Exception):
     """Generic class for Meilisearch error handling"""