Merge branch 'main' into meili-bot/feb-23-code-samples

Author: alallema

.github/workflows/pypi-publish.yml

@@ -9,7 +9,7 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
       uses: actions/setup-python@v4
       with:

.github/workflows/tests.yml

@@ -89,12 +89,12 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.9
       - name: Install pipenv
         uses: dschep/install-pipenv-action@v1
       - name: Install dependencies
         run: pipenv install --dev --python=${{ matrix.python-version }}
       - name: isort
-        run: pipenv run isort meilisearch tests setup.py --check-only
+        run: pipenv run isort meilisearch tests --check-only

Pipfile

@@ -15,7 +15,7 @@ types-requests = "*"
 black = "*"
 isort = "*"
 importlib_metadata = {version = "*", markers="python_version < '3.8'"}
-zipp = {version = "==3.14.0", markers="python_version < '3.8'"}
+zipp = {version = "==3.15.0", markers="python_version < '3.8'"}
 exceptiongroup = {version = "*", markers="python_version < '3.11'"}
 tomli = {version = "*", markers="python_version < '3.11'"}
 wrapt = {version = "*", markers="python_version < '3.11'"}

Pipfile.lock

@@ -7,9 +7,9 @@
 
 from meilisearch.config import Config
 from meilisearch.errors import (
-    MeiliSearchApiError,
-    MeiliSearchCommunicationError,
-    MeiliSearchTimeoutError,
+    MeilisearchApiError,
+    MeilisearchCommunicationError,
+    MeilisearchTimeoutError,
 )
 from meilisearch.version import qualified_version
 
@@ -50,9 +50,9 @@ def send_request(
             return self.__validate(request)
 
         except requests.exceptions.Timeout as err:
-            raise MeiliSearchTimeoutError(str(err)) from err
+            raise MeilisearchTimeoutError(str(err)) from err
         except requests.exceptions.ConnectionError as err:
-            raise MeiliSearchCommunicationError(str(err)) from err
+            raise MeilisearchCommunicationError(str(err)) from err
 
     def get(self, path: str) -> Any:
         return self.send_request(requests.get, path)
@@ -100,4 +100,4 @@ def __validate(request: requests.Response) -> Any:
             request.raise_for_status()
             return HttpRequests.__to_json(request)
         except requests.exceptions.HTTPError as err:
-            raise MeiliSearchApiError(str(err), request) from err
+            raise MeilisearchApiError(str(err), request) from err

meilisearch/_httprequests.py

@@ -11,7 +11,7 @@
 
 from meilisearch._httprequests import HttpRequests
 from meilisearch.config import Config
-from meilisearch.errors import MeiliSearchError
+from meilisearch.errors import MeilisearchError
 from meilisearch.index import Index
 from meilisearch.models.key import Key, KeysResults
 from meilisearch.models.task import TaskInfo
@@ -61,7 +61,7 @@ def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Ta
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return Index.create(self.config, uid, options)
@@ -82,7 +82,7 @@ def delete_index(self, uid: str) -> TaskInfo:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
 
@@ -105,7 +105,7 @@ def get_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str,
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         if parameters is None:
@@ -138,7 +138,7 @@ def get_raw_indexes(self, parameters: Optional[Dict[str, Any]] = None) -> List[D
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         if parameters is None:
@@ -161,7 +161,7 @@ def get_index(self, uid: str) -> Index:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return Index(self.config, uid).fetch_info()
@@ -182,7 +182,7 @@ def get_raw_index(self, uid: str) -> Dict[str, Any]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.http.get(f"{self.config.paths.index}/{uid}")
@@ -218,7 +218,7 @@ def get_all_stats(self) -> Dict[str, Any]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.http.get(self.config.paths.stat)
@@ -233,7 +233,7 @@ def health(self) -> Dict[str, str]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.http.get(self.config.paths.health)
@@ -242,7 +242,7 @@ def is_healthy(self) -> bool:
         """Get health of the Meilisearch server."""
         try:
             self.health()
-        except MeiliSearchError:
+        except MeilisearchError:
             return False
         return True
 
@@ -262,7 +262,7 @@ def get_key(self, key_or_uid: str) -> Key:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         key = self.http.get(f"{self.config.paths.keys}/{key_or_uid}")
@@ -285,7 +285,7 @@ def get_keys(self, parameters: Optional[Dict[str, Any]] = None) -> KeysResults:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         if parameters is None:
@@ -314,7 +314,7 @@ def create_key(self, options: Dict[str, Any]) -> Key:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         task = self.http.post(f"{self.config.paths.keys}", options)
@@ -340,7 +340,7 @@ def update_key(self, key_or_uid: str, options: Dict[str, Any]) -> Key:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         url = f"{self.config.paths.keys}/{key_or_uid}"
@@ -364,7 +364,7 @@ def delete_key(self, key_or_uid: str) -> int:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         response = self.http.delete(f"{self.config.paths.keys}/{key_or_uid}")
@@ -381,7 +381,7 @@ def get_version(self) -> Dict[str, str]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.http.get(self.config.paths.version)
@@ -396,7 +396,7 @@ def version(self) -> Dict[str, str]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.get_version()
@@ -412,7 +412,7 @@ def create_dump(self) -> TaskInfo:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         task = self.http.post(self.config.paths.dumps)
@@ -435,7 +435,7 @@ def swap_indexes(self, parameters: List[Dict[str, List[str]]]) -> TaskInfo:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return TaskInfo(**self.http.post(self.config.paths.swap, parameters))
@@ -457,7 +457,7 @@ def get_tasks(
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.task_handler.get_tasks(parameters=parameters)
@@ -477,7 +477,7 @@ def get_task(self, uid: int) -> Dict[str, Any]:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.task_handler.get_task(uid)
@@ -498,7 +498,7 @@ def cancel_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:
 
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.task_handler.cancel_tasks(parameters=parameters)
@@ -517,7 +517,7 @@ def delete_tasks(self, parameters: Dict[str, Any]) -> TaskInfo:
             https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
         Raises
         ------
-        MeiliSearchApiError
+        MeilisearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.task_handler.delete_tasks(parameters=parameters)
@@ -535,7 +535,7 @@ def wait_for_task(
         uid:
             Identifier of the task to wait for being processed.
         timeout_in_ms (optional):
-            Time the method should wait before raising a MeiliSearchTimeoutError
+            Time the method should wait before raising a MeilisearchTimeoutError
         interval_in_ms (optional):
             Time interval the method should wait (sleep) between requests
 
@@ -546,7 +546,7 @@ def wait_for_task(
 
         Raises
         ------
-        MeiliSearchTimeoutError
+        MeilisearchTimeoutError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         return self.task_handler.wait_for_task(uid, timeout_in_ms, interval_in_ms)

meilisearch/client.py

@@ -5,18 +5,18 @@
 from requests import Response
 
 
-class MeiliSearchError(Exception):
+class MeilisearchError(Exception):
     """Generic class for Meilisearch error handling"""
 
     def __init__(self, message: str) -> None:
         self.message = message
         super().__init__(self.message)
 
     def __str__(self) -> str:
-        return f"MeiliSearchError. Error message: {self.message}"
+        return f"MeilisearchError. Error message: {self.message}"
 
 
-class MeiliSearchApiError(MeiliSearchError):
+class MeilisearchApiError(MeilisearchError):
     """Error sent by Meilisearch API"""
 
     def __init__(self, error: str, request: Response) -> None:
@@ -37,20 +37,20 @@ def __init__(self, error: str, request: Response) -> None:
 
     def __str__(self) -> str:
         if self.code and self.link:
-            return f"MeiliSearchApiError. Error code: {self.code}. Error message: {self.message} Error documentation: {self.link} Error type: {self.type}"
+            return f"MeilisearchApiError. Error code: {self.code}. Error message: {self.message} Error documentation: {self.link} Error type: {self.type}"
 
-        return f"MeiliSearchApiError. {self.message}"
+        return f"MeilisearchApiError. {self.message}"
 
 
-class MeiliSearchCommunicationError(MeiliSearchError):
+class MeilisearchCommunicationError(MeilisearchError):
     """Error when connecting to Meilisearch"""
 
     def __str__(self) -> str:
-        return f"MeiliSearchCommunicationError, {self.message}"
+        return f"MeilisearchCommunicationError, {self.message}"
 
 
-class MeiliSearchTimeoutError(MeiliSearchError):
+class MeilisearchTimeoutError(MeilisearchError):
     """Error when Meilisearch operation takes longer than expected"""
 
     def __str__(self) -> str:
-        return f"MeiliSearchTimeoutError, {self.message}"
+        return f"MeilisearchTimeoutError, {self.message}"