Merge branch 'master' into v28-changes

Author: tharropoulos

.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Publish Package to PyPI
+on:
+  push:
+    tags:
+      - 'v*'
+jobs:
+  tests:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.8"
+        cache: 'pip'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/dev.txt
+    
+    - name: Run tests (excluding OpenAI)
+      run: coverage run -m pytest -m "not open_ai"
+      
+    - name: Show coverage report
+      run: coverage report
+  build-n-publish:
+    name: Build and Publish
+    needs: tests
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/typesense
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.8"
+        cache: pip
+        
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: |
+        rm -rf dist/
+        python -m build
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        attestations: true

.github/workflows/test-and-lint.yml

@@ -0,0 +1,57 @@
+name: Test and Lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    services:
+      typesense:
+        image: typesense/typesense:27.1
+        ports:
+          - 8108:8108
+        volumes:
+          - /tmp/typesense-data:/data
+          - /tmp/typesense-analytics:/analytics
+        env:
+          TYPESENSE_API_KEY: xyz
+          TYPESENSE_DATA_DIR: /data
+          TYPESENSE_ENABLE_CORS: true
+          TYPESENSE_ANALYTICS_DIR: /analytics
+          TYPESENSE_ENABLE_SEARCH_ANALYTICS: true
+
+    steps:
+    - name: Wait for Typesense
+      run: |
+        timeout 20 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8108/health)" != "200" ]]; do sleep 1; done' || false
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/dev.txt
+
+    - name: Lint with Flake8
+      run: |
+        flake8 src/typesense
+
+    - name: Check types with mypy
+      run: |
+        mypy src/typesense
+
+    - name: Run tests and coverage (excluding OpenAI)
+      run: |
+        coverage run -m pytest -m "not open_ai"

publish.sh

@@ -19,8 +19,8 @@ docstring-style = sphinx
 max-complexity = 6
 
 # # Excluding some directories:
-exclude = .git,__pycache__,venv,.eggs,*.egg
-ignore = Q000, WPS602, WPS432, WPS305, WPS221, WPS230, WPS234, WPS433, WPS440, W503, WPS331, WPS306, WPS237, WPS202, RST301, RST306, WPS214, WPS235, WPS226, WPS337, WPS320, F821, WPS201, E704, D102
+exclude = .git,__pycache__,venv,.eggs,*.egg,src/typesense/__init__.py
+ignore = Q000, WPS602, WPS432, WPS305, WPS221, WPS230, WPS234, WPS433, WPS440, W503, WPS331, WPS306, WPS237, WPS202, RST301, RST306, WPS214, WPS235, WPS226, WPS337, WPS320, F821, WPS201
 per-file-ignores = 
   tests/*.py: S101, WPS226, WPS118, WPS202, WPS204, WPS218, WPS211, WPS604, WPS431, WPS210, WPS201, WPS437
   src/typesense/types/*.py: B950, WPS215, WPS111, WPS462, WPS322, WPS428, WPS114, WPS110, WPS202 

setup.cfg

@@ -334,7 +334,7 @@ def _execute_request(
         as_json: typing.Literal[True],
         last_exception: typing.Union[None, Exception] = None,
         num_retries: int = 0,
-        **kwargs: typing.Unpack[SessionFunctionKwargs[TParams, TBody]],
+        **kwargs: SessionFunctionKwargs[TParams, TBody],
     ) -> TEntityDict:
         """
         Execute a request to the Typesense API with retry logic.
@@ -373,7 +373,7 @@ def _execute_request(
         as_json: typing.Literal[False],
         last_exception: typing.Union[None, Exception] = None,
         num_retries: int = 0,
-        **kwargs: typing.Unpack[SessionFunctionKwargs[TParams, TBody]],
+        **kwargs: SessionFunctionKwargs[TParams, TBody],
     ) -> str:
         """
         Execute a request to the Typesense API with retry logic.
@@ -411,7 +411,7 @@ def _execute_request(
         as_json: typing.Union[typing.Literal[True], typing.Literal[False]] = True,
         last_exception: typing.Union[None, Exception] = None,
         num_retries: int = 0,
-        **kwargs: typing.Unpack[SessionFunctionKwargs[TParams, TBody]],
+        **kwargs: SessionFunctionKwargs[TParams, TBody],
     ) -> typing.Union[TEntityDict, str]:
         """
         Execute a request to the Typesense API with retry logic.
@@ -473,7 +473,7 @@ def _make_request_and_process_response(
         url: str,
         entity_type: typing.Type[TEntityDict],
         as_json: bool,
-        **kwargs: typing.Any,
+        **kwargs: SessionFunctionKwargs[TParams, TBody],
     ) -> typing.Union[TEntityDict, str]:
         """Make the API request and process the response."""
         request_response = self.request_handler.make_request(
@@ -493,7 +493,7 @@ def _make_request_and_process_response(
     def _prepare_request_params(
         self,
         endpoint: str,
-        **kwargs: typing.Unpack[SessionFunctionKwargs[TParams, TBody]],
+        **kwargs: SessionFunctionKwargs[TParams, TBody],
     ) -> typing.Tuple[Node, str, SessionFunctionKwargs[TParams, TBody]]:
         node = self.node_manager.get_node()
         url = node.url() + endpoint