Merge pull request #1068 from 07pepa/add-http2-support

enable http2 support

Author: sanders41

.github/workflows/testing.yaml

@@ -72,6 +72,50 @@ jobs:
       - name: Minimize uv cache
         run: uv cache prune --ci
 
+  parallel-testing-http2:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4" ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install Just
+        uses: taiki-e/install-action@just
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Restore uv cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.UV_CACHE_DIR }}
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+      - name: Install Dependencies
+        run: just install
+      - name: Test with pytest
+        run: |
+          sudo apt-get update && \
+          sudo apt-get install -y libnss3-tools build-essential gcc && \
+          /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
+          brew install mkcert && \
+          mkcert -install && \
+          mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
+          just test-parallel-ci-http2
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
   no-parallel-testing:
     strategy:
       fail-fast: false
@@ -108,6 +152,51 @@ jobs:
       - name: Minimize uv cache
         run: uv cache prune --ci
 
+  no-parallel-testing-http2:
+      strategy:
+        fail-fast: false
+        matrix:
+          python-version: ["3.9", "3.10", "3.11", "3.12", "3.13.0-beta.4"]
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - name: install Just
+          uses: taiki-e/install-action@just
+        - name: Install uv
+          run: curl -LsSf https://astral.sh/uv/install.sh | sh
+        - name: Set up Python ${{ matrix.python-version }}
+          uses: actions/setup-python@v5
+          with:
+            python-version: ${{ matrix.python-version }}
+        - name: Restore uv cache
+          uses: actions/cache@v4
+          with:
+            path: ${{ env.UV_CACHE_DIR }}
+            key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            restore-keys: |
+              uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+              uv-${{ runner.os }}
+        - name: Install Dependencies
+          run: just install
+        - name: Test with pytest
+          run: |
+            sudo apt-get update && \
+            sudo apt-get install -y libnss3-tools build-essential gcc && \
+            /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && \
+            eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)" && \
+            brew install mkcert && \
+            mkcert -install && \
+            mkcert -key-file meilisearch.key -cert-file meilisearch.crt localhost 127.0.0.1 ::1 && \
+            just test-no-parallel-ci-http2
+        - name: Upload coverage
+          uses: codecov/codecov-action@v4
+          with:
+            token: ${{ secrets.CODECOV_TOKEN }}
+            fail_ci_if_error: true
+        - name: Minimize uv cache
+          run: uv cache prune --ci
+
+
   docs:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -1,3 +1,5 @@
+meilisearch.crt
+meilisearch.key
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

docker-compose.https.yml

@@ -0,0 +1,12 @@
+services:
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700:7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true
+    volumes:
+      - ./meilisearch.key:/meilisearch.key
+      - ./meilisearch.crt:/meilisearch.crt
+    command: ["meilisearch", "--ssl-cert-path", "/meilisearch.crt", "--ssl-key-path", "/meilisearch.key"]

justfile

@@ -18,12 +18,21 @@
 @test:
   -uv run pytest -x
 
+@test-http2:
+  -uv run pytest -x --http2
+
 @test-parallel:
   -uv run pytest -n auto -x -m "not no_parallel"
 
 @test-no-parallel:
   -uv run pytest -x -m "no_parallel"
 
+@test-parallel-http2:
+  -uv run pytest -n auto -x -m "not no_parallel" --http2
+
+@test-no-parallel-http2:
+  -uv run pytest -x -m "no_parallel" --http2
+
 @test-ci: start-meilisearch-detached && stop-meilisearch
   uv run pytest --cov=meilisearch_python_sdk --cov-report=xml
 
@@ -33,6 +42,13 @@
 @test-no-parallel-ci: start-meilisearch-detached && stop-meilisearch
   uv run pytest --cov=meilisearch_python_sdk --cov-report=xml -m "no_parallel"
 
+@test-parallel-ci-http2: start-meilisearch-detached-http2 && stop-meilisearch-http2
+  uv run pytest --cov=meilisearch_python_sdk --cov-report=xml -n auto -m "not no_parallel" --http2
+
+@test-no-parallel-ci-http2: start-meilisearch-detached-http2 && stop-meilisearch-http2
+  uv run pytest --cov=meilisearch_python_sdk --cov-report=xml -m "no_parallel" --http2
+
+
 @start-meilisearch:
   docker compose up
 
@@ -42,6 +58,15 @@
 @stop-meilisearch:
   docker compose down
 
+@start-meilisearch-http2:
+  docker compose -f docker-compose.https.yml up
+
+@start-meilisearch-detached-http2:
+  docker compose -f docker-compose.https.yml up -d
+
+@stop-meilisearch-http2:
+  docker compose -f docker-compose.https.yml down
+
 @build-docs:
   uv run mkdocs build --strict
 

meilisearch_python_sdk/_client.py

@@ -150,6 +150,7 @@ def __init__(
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -168,11 +169,12 @@ def __init__(
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            http2: Whether or not to use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxAsyncClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
         self._http_requests = AsyncHttpRequests(self.http_client, json_handler=self.json_handler)
 
@@ -1073,6 +1075,7 @@ def __init__(
         verify: str | bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        http2: bool = False,
     ) -> None:
         """Class initializer.
 
@@ -1091,12 +1094,14 @@ def __init__(
                 (uses the json module from the standard library), OrjsonHandler (uses orjson), or
                 UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
                 extra needs to be included. Default: BuiltinHandler.
+            http2: If set to True, the client will use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
 
         self.http_client = HttpxClient(
-            base_url=url, timeout=timeout, headers=self._headers, verify=verify
+            base_url=url, timeout=timeout, headers=self._headers, verify=verify, http2=http2
         )
+
         self._http_requests = HttpRequests(self.http_client, json_handler=self.json_handler)
 
     def create_dump(self) -> TaskInfo:

meilisearch_python_sdk/decorators.py

@@ -26,6 +26,7 @@ def async_add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and asyncronously adds them to Meilisearch.
 
@@ -42,6 +43,7 @@ def async_add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -89,7 +91,9 @@ async def wrapper(*args: Any, **kwargs: Any) -> Any:
                 )
                 return result
 
-            async with AsyncClient(connection_info.url, connection_info.api_key) as client:
+            async with AsyncClient(
+                connection_info.url, connection_info.api_key, verify=verify
+            ) as client:
                 await _async_add_documents(
                     client, index_name, result, batch_size, primary_key, wait_for_task
                 )
@@ -108,6 +112,7 @@ def add_documents(
     batch_size: int | None = None,
     primary_key: str | None = None,
     wait_for_task: bool = False,
+    verify: bool = True,
 ) -> Callable:
     """Decorator that takes the returned documents from a function and adds them to Meilisearch.
 
@@ -124,6 +129,7 @@ def add_documents(
             Defaults to None.
         wait_for_task: If set to `True` the decorator will wait for the document addition to finish
             indexing before returning, otherwise it will return right away. Default = False.
+        verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
 
@@ -171,7 +177,9 @@ def wrapper(*args: Any, **kwargs: Any) -> Any:
                 )
                 return result
 
-            decorator_client = Client(url=connection_info.url, api_key=connection_info.api_key)
+            decorator_client = Client(
+                url=connection_info.url, api_key=connection_info.api_key, verify=verify
+            )
             _add_documents(
                 decorator_client,
                 index_name,

pyproject.toml

@@ -27,7 +27,7 @@ dependencies = [
   "camel-converter>=1.0.0",
   # allows pydantic to use pipe instead of Union
   "eval-type-backport>=0.2.0; python_version < '3.10'",
-  "httpx>=0.17",
+  "httpx[http2]>=0.17",
   "pydantic>=2.0.0",
   "PyJWT>=2.3.0",
 ]
@@ -49,13 +49,16 @@ dev-dependencies = [
   "pytest-asyncio==0.24.0",
   "pytest-xdist==3.6.1",
   "ruff==0.6.2",
+  "truststore==0.9.2; python_version >= '3.10'",
   "types-aiofiles==24.1.0.20240626",
   "typing-extensions==4.12.2",
   "types-ujson==5.10.0.20240515",
   "meilisearch==0.31.5",
   "rich==13.7.1",
 ]
 
+environments = ["python_version < '3.10'", "python_version >= '3.10'"]
+
 [tool.hatch.version]
 path = "meilisearch_python_sdk/_version.py"