Merge #564

564: Inconsistencies fix r=alallema a=Dark-Rock

# Pull Request

## Related issue
Fixes #563 

## What does this PR do?
- Fixed the inconsistencies using black throughout the project. This changed the single quote to double quote (Human readibility reasons), fixed the parenthesis anomaly and improved readibility of the code base.

## 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: JeremyNgu108 <[email protected]>
Co-authored-by: Dark-Rock <[email protected]>
Co-authored-by: Amélie <[email protected]>

Author: 3 people

CONTRIBUTING.md

@@ -57,6 +57,7 @@ pipenv install --dev
 ### Tests and Linter <!-- omit in toc -->
 
 Each PR should pass the tests, mypy type checking, and the linter to be accepted.
+Your PR also needs to be formatted using black and isort.
 
 ```bash
 # Tests
@@ -67,6 +68,10 @@ pipenv run pytest tests
 pipenv run mypy meilisearch
 # Linter
 pipenv run pylint meilisearch
+# Black
+pipenv run black meilisearch tests
+# Isort
+pipenv run isort meilisearch tests
 ```
 
 Optionally tox can be used to run test on all supported version of Python, mypy, and linting.

Pipfile

@@ -12,6 +12,8 @@ pytest-ordering = "*"
 tox = "*"
 tox-pipenv = "*"
 types-requests = "*"
+black = "*"
+isort = "*"
 
 [packages]
 requests = "*"

Pipfile.lock

@@ -12,13 +12,14 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- Project information -----------------------------------------------------
 
-project = 'meilisearch-python'
-copyright = '2019, Meili SAS'
-author = 'Charlotte Vermandel'
+project = "meilisearch-python"
+copyright = "2019, Meili SAS"
+author = "Charlotte Vermandel"
 
 
 # -- General configuration ---------------------------------------------------
@@ -27,27 +28,27 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
-#html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+# html_theme = 'alabaster'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/conf.py

@@ -18,8 +18,8 @@ class HttpRequests:
     def __init__(self, config: Config) -> None:
         self.config = config
         self.headers = {
-            'Authorization': f'Bearer {self.config.api_key}',
-            'User-Agent': qualified_version(),
+            "Authorization": f"Bearer {self.config.api_key}",
+            "User-Agent": qualified_version(),
         }
 
     def send_request(
@@ -30,22 +30,22 @@ def send_request(
         content_type: str | None = None,
     ) -> Any:
         if content_type:
-            self.headers['Content-Type'] = content_type
+            self.headers["Content-Type"] = content_type
         try:
-            request_path = self.config.url + '/' + path
+            request_path = self.config.url + "/" + path
             if isinstance(body, bytes):
                 request = http_method(
                     request_path,
                     timeout=self.config.timeout,
                     headers=self.headers,
-                    data=body
+                    data=body,
                 )
             else:
                 request = http_method(
                     request_path,
                     timeout=self.config.timeout,
                     headers=self.headers,
-                    data=json.dumps(body) if body else "null"
+                    data=json.dumps(body) if body else "null",
                 )
             return self.__validate(request)
 
@@ -54,32 +54,30 @@ def send_request(
         except requests.exceptions.ConnectionError as err:
             raise MeiliSearchCommunicationError(str(err)) from err
 
-    def get(
-        self, path: str
-    ) -> Any:
+    def get(self, path: str) -> Any:
         return self.send_request(requests.get, path)
 
     def post(
         self,
         path: str,
         body: dict[str, Any] | list[dict[str, Any]] | list[str] | str | None = None,
-        content_type: str | None = 'application/json',
+        content_type: str | None = "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',
+        content_type: str | None = "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',
+        content_type: str | None = "application/json",
     ) -> Any:
         return self.send_request(requests.put, path, body, content_type)
 
@@ -91,17 +89,13 @@ def delete(
         return self.send_request(requests.delete, path, body)
 
     @staticmethod
-    def __to_json(
-        request: requests.Response
-    ) -> Any:
-        if request.content == b'':
+    def __to_json(request: requests.Response) -> Any:
+        if request.content == b"":
             return request
         return request.json()
 
     @staticmethod
-    def __validate(
-        request: requests.Response
-    ) -> Any:
+    def __validate(request: requests.Response) -> Any:
         try:
             request.raise_for_status()
             return HttpRequests.__to_json(request)