Allow custom headers in requests

meilisearch/_httprequests.py

@@ -17,13 +17,16 @@
 
 
 class HttpRequests:
-    def __init__(self, config: Config) -> None:
+    def __init__(self, config: Config, custom_headers: Optional[Mapping[str, str]] = None) -> None:
         self.config = config
         self.headers = {
             "Authorization": f"Bearer {self.config.api_key}",
             "User-Agent": _build_user_agent(config.client_agents),
         }
 
+        if custom_headers is not None:
+            self.headers.update(custom_headers)
+
     def send_request(
         self,
         http_method: Callable,

meilisearch/client.py

@@ -34,6 +34,7 @@ def __init__(
         api_key: Optional[str] = None,
         timeout: Optional[int] = None,
         client_agents: Optional[Tuple[str, ...]] = None,
+        custom_headers: Optional[Mapping[str, str]] = None,
     ) -> None:
         """
         Parameters
@@ -48,10 +49,13 @@ def __init__(
         client_agents (optional):
             Used to send additional client agent information for clients extending the functionality
             of this client.
+        custom_headers (optional):
+            Custom headers to add when sending data to Meilisearch.
         """
+
         self.config = Config(url, api_key, timeout=timeout, client_agents=client_agents)
 
-        self.http = HttpRequests(self.config)
+        self.http = HttpRequests(self.config, custom_headers)
 
         self.task_handler = TaskHandler(self.config)
 

tests/client/test_client.py

@@ -1,5 +1,7 @@
 # pylint: disable=invalid-name
 
+import pytest
+
 import meilisearch
 from tests import BASE_URL, MASTER_KEY
 
@@ -26,3 +28,33 @@ def test_client_timeout_not_set():
     response = client.health()
     assert client.config.timeout == default_timeout
     assert response["status"] == "available"
+
+
+@pytest.mark.parametrize(
+    "api_key, custom_headers, expected",
+    (
+        ("testKey", None, {"Authorization": "Bearer testKey"}),
+        (
+            "testKey",
+            {"header_key_1": "header_value_1", "header_key_2": "header_value_2"},
+            {
+                "Authorization": "Bearer testKey",
+                "header_key_1": "header_value_1",
+                "header_key_2": "header_value_2",
+            },
+        ),
+        (
+            None,
+            {"header_key_1": "header_value_1", "header_key_2": "header_value_2"},
+            {
+                "header_key_1": "header_value_1",
+                "header_key_2": "header_value_2",
+            },
+        ),
+        (None, None, {}),
+    ),
+)
+def test_headers(api_key, custom_headers, expected):
+    client = meilisearch.Client("127.0.0.1:7700", api_key=api_key, custom_headers=custom_headers)
+
+    assert client.http.headers.items() >= expected.items()