Merge pull request #97 from sanders41/delete_if_exists

Delete if exists

Author: sanders41

async_search_client/client.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from asyncio import get_running_loop
+from functools import partial
 from types import TracebackType
 from typing import Optional, Type
 
@@ -43,6 +45,19 @@ async def create_dump(self) -> DumpInfo:
     async def create_index(self, uid: str, primary_key: Optional[str] = None) -> Index:
         return await Index.create(self._http_client, uid, primary_key)
 
+    async def delete_index_if_exists(self, uid: str) -> bool:
+        try:
+            loop = get_running_loop()
+            url = await loop.run_in_executor(
+                None, partial(build_url, section=Paths.INDEXES, uid=uid)
+            )
+            await self._http_requests.delete(url)
+            return True
+        except MeiliSearchApiError as error:
+            if error.error_code != "index_not_found":
+                raise error
+            return False
+
     async def get_indexes(self) -> Optional[list[Index]]:
         response = await self._http_requests.get(build_url(Paths.INDEXES))
 

async_search_client/errors.py

@@ -21,8 +21,8 @@ def __init__(self, error: str, response: Response) -> None:
         self.message = ""
         self.error_link = ""
         if response.text:
-            self.message = f" Error code: {response.json().get('message') or ''}."
-            self.error_code = f" Error message: {response.json().get('errorCode') or ''}"
+            self.message = f" Error message: {response.json().get('message') or ''}."
+            self.error_code = f"{response.json().get('errorCode') or ''}"
             self.error_link = f" Error documentation: {response.json().get('errorLink') or ''}"
         else:
             self.message = error

async_search_client/index.py

@@ -12,7 +12,11 @@
 from httpx import AsyncClient
 
 from async_search_client._http_requests import HttpRequests
-from async_search_client.errors import MeiliSearchError, MeiliSearchTimeoutError
+from async_search_client.errors import (
+    MeiliSearchApiError,
+    MeiliSearchError,
+    MeiliSearchTimeoutError,
+)
 from async_search_client.models import (
     IndexStats,
     MeiliSearchSettings,
@@ -53,6 +57,18 @@ async def delete(self) -> int:
         response = await self._http_requests.delete(url)
         return response.status_code
 
+    async def delete_if_exists(self) -> bool:
+        """
+        Deletes the index if it already exists
+        """
+        try:
+            await self.delete()
+            return True
+        except MeiliSearchApiError as error:
+            if error.error_code != "index_not_found":
+                raise error
+            return False
+
     async def update(self, primary_key: str = None) -> Index:
         """
         Update the index primary-key.

async_search_client/paths/__init__.py

@@ -1,2 +1,2 @@
-from async_search_client.paths.build_url import build_url  # noqa: F401
+from async_search_client.paths.url import build_url  # noqa: F401
 from async_search_client.paths.valid_paths import Paths  # noqa: F401

async_search_client/paths/build_url.py renamed to async_search_client/paths/url.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "async-search-client"
-version = "0.7.3"
+version = "0.8.0"
 description = "A Python async client for the MeiliSearch API"
 authors = ["Paul Sanders <[email protected]>"]
 license = "MIT"

pyproject.toml

@@ -1,7 +1,9 @@
 from datetime import datetime
 
 import pytest
+from httpx import Response
 
+from async_search_client._http_requests import HttpRequests
 from async_search_client.errors import MeiliSearchApiError, MeiliSearchTimeoutError
 from async_search_client.index import Index
 from async_search_client.models import MeiliSearchSettings
@@ -441,3 +443,63 @@ async def test_repr(empty_index):
     assert "primary_key" in got
     assert "created_at" in got
     assert "updated_at" in got
+
+
+@pytest.mark.asyncio
+@pytest.mark.usefixtures("indexes_sample")
+async def test_delete_if_exists(test_client, index_uid):
+    assert await test_client.get_index(uid=index_uid)
+    deleted = await test_client.index(index_uid).delete_if_exists()
+    assert deleted is True
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.get_index(uid=index_uid)
+
+
+@pytest.mark.asyncio
+async def test_delete_if_exists_no_delete(test_client):
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.get_index(uid="none")
+
+    deleted = await test_client.index("none").delete_if_exists()
+    assert deleted is False
+
+
+@pytest.mark.asyncio
+@pytest.mark.usefixtures("indexes_sample")
+async def test_delete_if_exists_error(test_client, index_uid, monkeypatch):
+    async def mock_response(*args, **kwargs):
+        raise MeiliSearchApiError("test", Response(status_code=404))
+
+    monkeypatch.setattr(HttpRequests, "_send_request", mock_response)
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.index(index_uid).delete_if_exists()
+
+
+@pytest.mark.asyncio
+@pytest.mark.usefixtures("indexes_sample")
+async def test_delete_index_if_exists(test_client, index_uid):
+    assert await test_client.get_index(uid=index_uid)
+    deleted = await test_client.delete_index_if_exists(index_uid)
+    assert deleted is True
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.get_index(uid=index_uid)
+
+
+@pytest.mark.asyncio
+async def test_delete_index_if_exists_no_delete(test_client):
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.get_index(uid="none")
+
+    deleted = await test_client.delete_index_if_exists("none")
+    assert deleted is False
+
+
+@pytest.mark.asyncio
+@pytest.mark.usefixtures("indexes_sample")
+async def test_delete_index_if_exists_error(test_client, index_uid, monkeypatch):
+    async def mock_response(*args, **kwargs):
+        raise MeiliSearchApiError("test", Response(status_code=404))
+
+    monkeypatch.setattr(HttpRequests, "_send_request", mock_response)
+    with pytest.raises(MeiliSearchApiError):
+        await test_client.delete_index_if_exists(index_uid)