Merge branch 'main' into bump-meilisearch-v0.21.0

Author: curquiza

.code-samples.meilisearch.yaml

@@ -37,7 +37,7 @@ delete_one_document_1: |-
   client.index('movies').delete_document(25684)
 delete_documents_1: |-
   client.index('movies').delete_documents([23488, 153738, 437035, 363869])
-search_1: |-
+search_post_1: |-
   client.index('movies').search('American ninja')
 get_update_1: |-
   client.index('movies').get_update_status(1)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,7 +6,7 @@ labels: ''
 assignees: ''
 ---
 
-[comment]: <> (This is not an exhaustive model but a help. No step is mandatory.)
+<!-- This is not an exhaustive model but a help. No step is mandatory. -->
 
 **Description**
 Description of what the bug is about.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,7 +6,7 @@ labels: ''
 assignees: ''
 ---
 
-[comment]: <> (This is not an exhaustive model but a help. No step is mandatory.)
+<!-- This is not an exhaustive model but a help. No step is mandatory. -->
 
 **Description**
 Brief explanation of the feature.

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  labels:
+  - skip-changelog
+  - dependencies
+  rebase-strategy: disabled

.github/release-draft-template.yml

@@ -21,6 +21,8 @@ sort-direction: 'ascending'
 replacers:
   - search: '/(?:and )?@dependabot-preview(?:\[bot\])?,?/g'
     replace: ''
+  - search: '/(?:and )?@dependabot(?:\[bot\])?,?/g'
+    replace: ''
   - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
     replace: ''
   - search: '/(?:and )?@meili-bot,?/g'

.github/workflows/tests.yml

@@ -50,3 +50,19 @@ jobs:
         run: pipenv install --dev
       - name: Linter with pylint
         run: pipenv run pylint meilisearch
+
+  mypy:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Install pipenv
+        uses: dschep/install-pipenv-action@v1
+      - name: Install dependencies
+        run: pipenv install --dev
+      - name: mypy type check
+        run: pipenv run mypy meilisearch

CONTRIBUTING.md

@@ -34,18 +34,20 @@ pipenv install --dev
 
 ### Tests and Linter <!-- omit in toc -->
 
-Each PR should pass the tests and the linter to be accepted.
+Each PR should pass the tests, mypy type checking, and the linter to be accepted.
 
 ```bash
 # Tests
 docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
 docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
 pipenv run pytest meilisearch
+# MyPy
+pipenv run mypy meilisearch
 # Linter
 pipenv run pylint meilisearch
 ```
 
-Optionally tox can be used to run test on all supported version of Python and linting.
+Optionally tox can be used to run test on all supported version of Python, mypy, and linting.
 
 ```bash
 docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub

Pipfile

@@ -4,12 +4,14 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
+mypy = "*"
 pylint = "*"
 pytest = "*"
 pdoc3 = "*"
 pytest-ordering = "*"
 tox = "*"
 tox-pipenv = "*"
+types-requests = "*"
 
 [packages]
 requests = "*"

Pipfile.lock

@@ -1,5 +1,6 @@
 status = [
   'pylint',
+  'mypy',
   'integration-tests (3.6)',
   'integration-tests (3.7)',
   'integration-tests (3.8)',

bors.toml

@@ -1,67 +1,82 @@
+import json
+from typing import Any, Callable, Dict, List, Optional, Union
 import requests
+from meilisearch.config import Config
 from meilisearch.errors import (
     MeiliSearchApiError,
     MeiliSearchCommunicationError,
     MeiliSearchTimeoutError,
 )
 
 class HttpRequests:
-
-    config = None
-    headers = {}
-
-    def __init__(self, config):
+    def __init__(self, config: Config) -> None:
         self.config = config
         self.headers = {
             'X-Meili-Api-Key': self.config.api_key,
             'Content-Type': 'application/json'
         }
 
-    def send_request(self, http_method, path, body=None):
+    def send_request(
+        self,
+        http_method: Callable,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
+    ) -> Any:
         try:
             request_path = self.config.url + '/' + path
-            if body is None:
-                request = http_method(
-                    request_path,
-                    timeout=self.config.timeout,
-                    headers=self.headers,
-                )
-            else:
-                request = http_method(
-                    request_path,
-                    timeout=self.config.timeout,
-                    headers=self.headers,
-                    json=body,
-                )
+            request = http_method(
+                request_path,
+                timeout=self.config.timeout,
+                headers=self.headers,
+                data=json.dumps(body) if body else "null"
+            )
             return self.__validate(request)
 
         except requests.exceptions.Timeout as err:
-            raise MeiliSearchTimeoutError(err) from err
+            raise MeiliSearchTimeoutError(str(err)) from err
         except requests.exceptions.ConnectionError as err:
-            raise MeiliSearchCommunicationError(err) from err
+            raise MeiliSearchCommunicationError(str(err)) from err
 
-    def get(self, path):
+    def get(
+        self, path: str
+    ) -> Any:
         return self.send_request(requests.get, path)
 
-    def post(self, path, body=None):
+    def post(
+        self,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
+    ) -> Any:
         return self.send_request(requests.post, path, body)
 
-    def put(self, path, body=None):
+    def put(
+        self,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
+    ) -> Any:
         return self.send_request(requests.put, path, body)
 
-    def delete(self, path, body=None):
+    def delete(
+        self,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str]]] = None,
+    ) -> Any:
         return self.send_request(requests.delete, path, body)
 
     @staticmethod
-    def __to_json(request):
+    def __to_json(
+        request: requests.Response
+    ) -> Any:
         if request.content == b'':
             return request
         return request.json()
 
     @staticmethod
-    def __validate(request):
+    def __validate(
+        request: requests.Response
+    ) -> Any:
         try:
             request.raise_for_status()
             return HttpRequests.__to_json(request)
         except requests.exceptions.HTTPError as err:
-            raise MeiliSearchApiError(err, request) from err
+            raise MeiliSearchApiError(str(err), request) from err