meilisearch-python-sdk 4.9.0__tar.gz → 4.10.1__tar.gz

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.github/renovate.json5

@@ -2,7 +2,8 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:recommended",
-    ":disableDependencyDashboard"
+    ":disableDependencyDashboard",
+    ":semanticCommitsDisabled"
   ],
   lockFileMaintenance: {
     enabled: true,

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.github/workflows/docs_publish.yml

@@ -16,7 +16,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.github/workflows/nightly_testing.yml

@@ -20,7 +20,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.github/workflows/pypi_publish.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.github/workflows/testing.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install Dependencies
@@ -42,7 +42,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
@@ -50,7 +50,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v5.5.0
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -70,7 +70,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
@@ -90,7 +90,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v5.5.0
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -110,7 +110,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
@@ -118,7 +118,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v5.5.0
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -138,7 +138,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Dependencies
@@ -158,7 +158,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v5.5.0
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -173,7 +173,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           cache: pip
@@ -191,7 +191,7 @@ jobs:
         with:
           enable-cache: true
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
       - name: Install Dependencies

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.17.1
+    rev: v1.18.1
     hooks:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.9
+    rev: v0.13.0
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.9.0
+Version: 4.10.1
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk

meilisearch_python_sdk-4.10.1/docs/css/custom.css

@@ -0,0 +1,45 @@
+.md-source__repository {
+  overflow: visible;
+}
+
+.md-footer {
+  padding: 16px 0;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  background-color: #111317;
+  color: #ffffff;
+}
+
+.footer-buttons {
+  display: flex;
+  gap: 16px;
+  align-items: center;
+  flex-wrap: wrap;
+}
+
+.footer-btn,
+.bmc-wrapper iframe {
+  height: 40px;
+  width: 150px;
+  min-width: 120px;
+  max-width: 100%;
+  border-radius: 6px;
+  display: block;
+}
+
+.bmc-wrapper {
+  display: flex;
+  align-items: center;
+}
+
+div.autodoc-docstring {
+  padding-left: 20px;
+  margin-bottom: 30px;
+  border-left: 5px solid rgba(230, 230, 230);
+}
+
+div.autodoc-members {
+  padding-left: 20px;
+  margin-bottom: 15px;
+}

meilisearch_python_sdk-4.10.1/docs/overrides/partials/footer.html

@@ -0,0 +1,25 @@
+<footer class="md-footer">
+  <div class="footer-buttons">
+    <iframe
+      src="https://github.com/sponsors/sanders41/button"
+      title="Sponsor sanders41"
+      class="footer-btn"
+    ></iframe>
+
+    <div class="bmc-wrapper">
+      <script
+        type="text/javascript"
+        src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js"
+        data-name="bmc-button"
+        data-slug="sanders41"
+        data-color="#87ceeb"
+        data-emoji=""
+        data-font="Cookie"
+        data-text="Buy me a coffee"
+        data-outline-color="#000000"
+        data-font-color="#000000"
+        data-coffee-color="#FFDD00"
+      ></script>
+    </div>
+  </div>
+</footer>

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/justfile

@@ -78,7 +78,7 @@
   uv run mkdocs build --strict
 
 @serve-docs:
-  mkdocs serve
+  uv run mkdocs serve
 
 @install:
   uv sync --frozen --all-extras
@@ -88,6 +88,3 @@
 
 @lock-upgrade:
   uv lock --upgrade
-
-@benchmark: start-meilisearch-detached && stop-meilisearch
-  -uv run benchmark/run_benchmark.py

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/meilisearch_python_sdk/_client.py

@@ -812,11 +812,13 @@ class AsyncClient(BaseClient):
 
         return Health(**response.json())
 
-    async def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
+    async def swap_indexes(self, indexes: list[tuple[str, str]], rename: bool = False) -> TaskInfo:
         """Swap two indexes.
 
         Args:
             indexes: A list of tuples, each tuple should contain the indexes to swap.
+            rename: Use rename false if you are swapping two existing indexes. Use rename true if
+                the second index in your array does not exist. Default = False
 
         Returns:
             The details of the task.
@@ -830,7 +832,10 @@ class AsyncClient(BaseClient):
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = await client.swap_indexes([("index_a", "index_b")])
         """
-        processed_indexes = [{"indexes": x} for x in indexes]
+        if rename:
+            processed_indexes = [{"indexes": x, "rename": True} for x in indexes]
+        else:
+            processed_indexes = [{"indexes": x} for x in indexes]
         response = await self._http_requests.post("swap-indexes", processed_indexes)
 
         return TaskInfo(**response.json())
@@ -1775,11 +1780,13 @@ class Client(BaseClient):
 
         return Health(**response.json())
 
-    def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
+    def swap_indexes(self, indexes: list[tuple[str, str]], rename: bool = False) -> TaskInfo:
         """Swap two indexes.
 
         Args:
             indexes: A list of tuples, each tuple should contain the indexes to swap.
+            rename: Use rename false if you are swapping two existing indexes. Use rename true if
+                the second index in your array does not exist. Default = False
 
         Returns:
             The details of the task.
@@ -1793,7 +1800,10 @@ class Client(BaseClient):
             >>> client = Client("http://localhost.com", "masterKey")
             >>> index = client.swap_indexes([("index_a", "index_b")])
         """
-        processed_indexes = [{"indexes": x} for x in indexes]
+        if rename:
+            processed_indexes = [{"indexes": x, "rename": True} for x in indexes]
+        else:
+            processed_indexes = [{"indexes": x} for x in indexes]
         response = self._http_requests.post("swap-indexes", processed_indexes)
 
         return TaskInfo(**response.json())

meilisearch_python_sdk-4.10.1/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "4.10.1"

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/meilisearch_python_sdk/index.py

@@ -3593,7 +3593,7 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    async def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
+    async def get_filterable_attributes(self) -> list[str | FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
@@ -3616,22 +3616,22 @@ class AsyncIndex(_BaseIndex):
 
         response_json = response.json()
 
-        if isinstance(response_json[0], str):
-            return response_json
-
-        filterable_attributes = []
+        filterable_attributes: list[str | FilterableAttributes] = []
         for r in response_json:
-            filterable_attributes.append(
-                FilterableAttributes(
-                    attribute_patterns=r["attributePatterns"],
-                    features=FilterableAttributeFeatures(**r["features"]),
+            if isinstance(r, str):
+                filterable_attributes.append(r)
+            else:
+                filterable_attributes.append(
+                    FilterableAttributes(
+                        attribute_patterns=r["attributePatterns"],
+                        features=FilterableAttributeFeatures(**r["features"]),
+                    )
                 )
-            )
 
         return filterable_attributes
 
     async def update_filterable_attributes(
-        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
+        self, body: list[str | FilterableAttributes], *, compress: bool = False
     ) -> TaskInfo:
         """Update filterable attributes of the index.
 
@@ -7224,7 +7224,7 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
-    def get_filterable_attributes(self) -> list[str] | list[FilterableAttributes] | None:
+    def get_filterable_attributes(self) -> list[str | FilterableAttributes] | None:
         """Get filterable attributes of the index.
 
         Returns:
@@ -7247,22 +7247,22 @@ class Index(_BaseIndex):
 
         response_json = response.json()
 
-        if isinstance(response_json[0], str):
-            return response_json
-
-        filterable_attributes = []
+        filterable_attributes: list[str | FilterableAttributes] = []
         for r in response_json:
-            filterable_attributes.append(
-                FilterableAttributes(
-                    attribute_patterns=r["attributePatterns"],
-                    features=FilterableAttributeFeatures(**r["features"]),
+            if isinstance(r, str):
+                filterable_attributes.append(r)
+            else:
+                filterable_attributes.append(
+                    FilterableAttributes(
+                        attribute_patterns=r["attributePatterns"],
+                        features=FilterableAttributeFeatures(**r["features"]),
+                    )
                 )
-            )
 
         return filterable_attributes
 
     def update_filterable_attributes(
-        self, body: list[str] | list[FilterableAttributes], *, compress: bool = False
+        self, body: list[str | FilterableAttributes], *, compress: bool = False
     ) -> TaskInfo:
         """Update filterable attributes of the index.
 

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/meilisearch_python_sdk/models/settings.py

@@ -167,7 +167,7 @@ class MeilisearchSettings(CamelBase):
     synonyms: JsonDict | None = None
     stop_words: list[str] | None = None
     ranking_rules: list[str] | None = None
-    filterable_attributes: list[str] | list[FilterableAttributes] | None = None
+    filterable_attributes: list[str | FilterableAttributes] | None = None
     distinct_attribute: str | None = None
     searchable_attributes: list[str] | None = None
     displayed_attributes: list[str] | None = None

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/mkdocs.yaml

@@ -4,6 +4,7 @@ site_url: https://meilisearch-python-sdk.paulsanders.dev
 
 theme:
   name: material
+  custom_dir: docs/overrides
   locale: en
   icon:
     repo: fontawesome/brands/github
@@ -44,3 +45,6 @@ plugins:
 
 extra_javascript:
   - "js/umami.js"
+
+extra_css:
+  - "css/custom.css"

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/pyproject.toml

@@ -41,19 +41,18 @@ all = ["orjson", "ujson"]
 [dependency-groups]
 dev = [
   "mkdocs==1.6.1",
-  "mkdocs-material==9.6.18",
+  "mkdocs-material==9.6.20",
   "mkdocstrings[python]==0.30.0",
-  "mypy[faster-cache]==1.17.1",
+  "mypy[faster-cache]==1.18.2",
   "pre-commit==4.3.0",
-  "pytest==8.4.1",
-  "pytest-cov==6.2.1",
-  "pytest-asyncio==1.1.0",
+  "pytest==8.4.2",
+  "pytest-cov==7.0.0",
+  "pytest-asyncio==1.2.0",
   "pytest-xdist==3.8.0",
-  "ruff==0.12.10",
+  "ruff==0.13.1",
   "types-aiofiles==24.1.0.20250822",
-  "typing-extensions==4.14.1",
+  "typing-extensions==4.15.0",
   "types-ujson==5.10.0.20250822",
-  "meilisearch==0.37.0",
   "rich==14.1.0",
 ]
 

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/tests/test_async_client.py

@@ -550,6 +550,21 @@ async def test_swap_indexes(async_client, async_empty_index):
     assert task.task_type == "indexSwap"
 
 
+@pytest.mark.no_parallel
+async def test_swap_indexes_rename(async_client, async_empty_index):
+    new_name = str(uuid4())
+    index = await async_empty_index()
+    task = await index.add_documents([{"id": 1, "title": index.uid}])
+    await async_client.wait_for_task(task.task_uid)
+    swapTask = await async_client.swap_indexes([(index.uid, new_name)], rename=True)
+    task = async_client.wait_for_task(swapTask.task_uid)
+
+    indexes = await async_client.get_indexes()
+    uids = [index.uid for index in indexes]
+    assert index.uid not in uids
+    assert new_name in uids
+
+
 @pytest.mark.usefixtures("create_tasks")
 @pytest.mark.no_parallel
 async def test_cancel_task_statuses(async_client):

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/tests/test_async_index.py

@@ -586,6 +586,7 @@ async def test_get_filterable_attributes(async_empty_index):
                     facet_search=True, filter=Filter(equality=True, comparison=False)
                 ),
             ),
+            "genre",
         ],
     ),
 )
@@ -594,7 +595,7 @@ async def test_update_filterable_attributes(compress, async_empty_index, filtera
     response = await index.update_filterable_attributes(filterable_attributes, compress=compress)
     await async_wait_for_task(index.http_client, response.task_uid)
     response = await index.get_filterable_attributes()
-    assert sorted(response) == filterable_attributes
+    assert response == filterable_attributes
 
 
 @pytest.mark.parametrize(

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/tests/test_client.py

@@ -547,6 +547,21 @@ def test_swap_indexes(client, empty_index):
     assert task.task_type == "indexSwap"
 
 
+@pytest.mark.no_parallel
+def test_swap_indexes_rename(client, empty_index):
+    new_name = str(uuid4())
+    index = empty_index()
+    task = index.add_documents([{"id": 1, "title": index.uid}])
+    client.wait_for_task(task.task_uid)
+    swapTask = client.swap_indexes([(index.uid, new_name)], rename=True)
+    task = client.wait_for_task(swapTask.task_uid)
+
+    indexes = client.get_indexes()
+    uids = [index.uid for index in indexes]
+    assert index.uid not in uids
+    assert new_name in uids
+
+
 @pytest.mark.usefixtures("create_tasks")
 @pytest.mark.no_parallel
 def test_cancel_statuses(client):

{meilisearch_python_sdk-4.9.0 → meilisearch_python_sdk-4.10.1}/tests/test_index.py

@@ -574,6 +574,7 @@ def test_get_filterable_attributes(empty_index):
                     facet_search=True, filter=Filter(equality=True, comparison=False)
                 ),
             ),
+            "genre",
         ],
     ),
 )
@@ -582,7 +583,7 @@ def test_update_filterable_attributes(compress, empty_index, filterable_attribut
     response = index.update_filterable_attributes(filterable_attributes, compress=compress)
     wait_for_task(index.http_client, response.task_uid)
     response = index.get_filterable_attributes()
-    assert sorted(response) == filterable_attributes
+    assert response == filterable_attributes
 
 
 @pytest.mark.parametrize(