fixes

Author: elamc-2

meilisearch/index.py

@@ -5,7 +5,7 @@
 from meilisearch._httprequests import HttpRequests
 from meilisearch.config import Config
 from meilisearch.task import get_task, get_tasks, wait_for_task
-from meilisearch.models import DocumentsResults, TaskInfo, TaskResults, IndexStatsResults
+from meilisearch.models import DocumentsResults, Task, TaskInfo, TaskResults, IndexStats
 
 # pylint: disable=too-many-public-methods
 class Index():
@@ -152,7 +152,7 @@ def get_tasks(self, parameters: Optional[Dict[str, Any]] = None) -> TaskResults:
         tasks = get_tasks(self.config, parameters=parameters)
         return TaskResults(tasks)
 
-    def get_task(self, uid: int) -> TaskInfo:
+    def get_task(self, uid: int) -> Task:
         """Get one task through the route of a specific index.
 
         Parameters
@@ -171,13 +171,13 @@ def get_task(self, uid: int) -> TaskInfo:
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         task = get_task(self.config, uid)
-        return TaskInfo(**task)
+        return Task(**task)
 
     def wait_for_task(
         self, uid: int,
         timeout_in_ms: int = 5000,
         interval_in_ms: int = 50,
-    ) -> TaskInfo:
+    ) -> Task:
         """Wait until Meilisearch processes a task until it fails or succeeds.
 
         Parameters
@@ -200,9 +200,9 @@ def wait_for_task(
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         task = wait_for_task(self.config, uid, timeout_in_ms, interval_in_ms)
-        return TaskInfo(**task)
+        return Task(**task)
 
-    def get_stats(self) -> IndexStatsResults:
+    def get_stats(self) -> IndexStats:
         """Get stats of the index.
 
         Get information about the number of documents, field frequencies, ...
@@ -221,7 +221,7 @@ def get_stats(self) -> IndexStatsResults:
         stats = self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.stat}'
         )
-        return IndexStatsResults(**stats)
+        return IndexStats(**stats)
 
     def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Search in the index.
@@ -315,7 +315,7 @@ def add_documents(
         self,
         documents: List[Dict[str, Any]],
         primary_key: Optional[str] = None,
-    ) -> Dict[str, Any]:
+    ) -> TaskInfo:
         """Add documents to the index.
 
         Parameters
@@ -337,14 +337,15 @@ def add_documents(
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         url = self._build_url(primary_key)
-        return self.http.post(url, documents)
+        response = self.http.post(url, documents)
+        return TaskInfo(**response)
 
     def add_documents_in_batches(
         self,
         documents: List[Dict[str, Any]],
         batch_size: int = 1000,
         primary_key: Optional[str] = None,
-    ) -> List[Dict[str, Any]]:
+    ) -> List[TaskInfo]:
         """Add documents to the index in batches.
 
         Parameters
@@ -369,13 +370,13 @@ def add_documents_in_batches(
             Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
 
-        uids = []
+        tasks: List[TaskInfo] = []
 
         for document_batch in self._batch(documents, batch_size):
-            uid = self.add_documents(document_batch, primary_key)
-            uids.append(uid)
+            task = self.add_documents(document_batch, primary_key)
+            tasks.append(task)
 
-        return uids
+        return tasks
 
     def add_documents_json(
         self,
@@ -494,7 +495,7 @@ def update_documents(
         self,
         documents: List[Dict[str, Any]],
         primary_key: Optional[str] = None
-    ) -> Dict[str, Any]:
+    ) -> TaskInfo:
         """Update documents in the index.
 
         Parameters
@@ -516,14 +517,15 @@ def update_documents(
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
         url = self._build_url(primary_key)
-        return self.http.put(url, documents)
+        response = self.http.put(url, documents)
+        return TaskInfo(**response)
 
     def update_documents_in_batches(
         self,
         documents: List[Dict[str, Any]],
         batch_size: int = 1000,
         primary_key: Optional[str] = None
-    ) -> List[Dict[str, Any]]:
+    ) -> List[TaskInfo]:
         """Update documents to the index in batches.
 
         Parameters
@@ -548,15 +550,15 @@ def update_documents_in_batches(
             Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
 
-        uids = []
+        tasks = []
 
         for document_batch in self._batch(documents, batch_size):
-            uid = self.update_documents(document_batch, primary_key)
-            uids.append(uid)
+            update_task = self.update_documents(document_batch, primary_key)
+            tasks.append(update_task)
 
-        return uids
+        return tasks
 
-    def delete_document(self, document_id: str) -> Dict[str, Any]:
+    def delete_document(self, document_id: str) -> TaskInfo:
         """Delete one document from the index.
 
         Parameters
@@ -575,9 +577,10 @@ def delete_document(self, document_id: str) -> Dict[str, Any]:
         MeiliSearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
-        return self.http.delete(
+        response = self.http.delete(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}'
         )
+        return TaskInfo(**response)
 
     def delete_documents(self, ids: List[str]) -> Dict[str, int]:
         """Delete multiple documents from the index.

meilisearch/models.py

@@ -1,30 +1,26 @@
-from dataclasses import dataclass
 from typing import Any, List, Dict, Optional
 from camel_converter.pydantic_base import CamelBase
 
-@dataclass
-class DocumentsResults:
+class DocumentsResults(CamelBase):
     results: List[Dict[str, Any]]
     offset: int
     limit: int
     total: int
 
 class Task(CamelBase):
-    uid: Optional[str]
+    uid: str
     index_uid: str
-    task_uid: Optional[str]
     status: str
     type: str
     details: Optional[Dict[str, Any]]
-    duration: Optional[str]
+    duration: str
     enqueued_at: str
-    started_at: Optional[str]
-    finished_at: Optional[str]
+    started_at: str
+    finished_at: str
 
 class TaskInfo(CamelBase):
-    uid: Optional[str]
-    index_uid: str
     task_uid: Optional[str]
+    index_uid: str
     status: str
     type: str
     details: Optional[Dict[str, Any]]
@@ -40,7 +36,7 @@ def __init__(self, resp: Dict[str, Any]) -> None:
         self.from_: int = resp['from']
         self.next_: int = resp['next']
 
-class IndexStatsResults(CamelBase):
+class IndexStats(CamelBase):
     number_of_documents: int
     is_indexing: bool
     field_distribution: Dict[str, Any]

tests/conftest.py

@@ -89,7 +89,7 @@ def index_with_documents(empty_index, small_movies):
     def index_maker(index_uid=common.INDEX_UID, documents=small_movies):
         index = empty_index(index_uid)
         task = index.add_documents(documents)
-        index.wait_for_task(task['taskUid'])
+        index.wait_for_task(task.task_uid)
         return index
     return index_maker
 

tests/index/test_index_document_meilisearch.py

@@ -16,9 +16,9 @@ def test_add_documents(empty_index, small_movies):
     """Tests adding new documents to a clean index."""
     index = empty_index()
     response = index.add_documents(small_movies)
-    assert isinstance(response, dict)
-    assert 'taskUid' in response
-    update = index.wait_for_task(response['taskUid'])
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid != None
+    update = index.wait_for_task(response.task_uid)
     assert index.get_primary_key() == 'id'
     assert update.status == 'succeeded'
 
@@ -38,8 +38,8 @@ def test_add_documents_in_batches(
     assert ceil(len(small_movies) / batch_size) == len(response)
 
     for r in response:
-        assert 'taskUid' in r
-        update = index.wait_for_task(r['taskUid'])
+        assert r.task_uid != None
+        update = index.wait_for_task(r.task_uid)
         assert update.status == 'succeeded'
 
     assert index.get_primary_key() == expected_primary_key
@@ -91,13 +91,13 @@ def test_update_documents(index_with_documents, small_movies):
     response = index.get_documents()
     response.results[0]['title'] = 'Some title'
     update = index.update_documents([response.results[0]])
-    assert isinstance(update, dict)
-    assert 'taskUid' in update
-    index.wait_for_task(update['taskUid'])
+    assert isinstance(update, TaskInfo)
+    assert update.task_uid != None
+    index.wait_for_task(update.task_uid)
     response = index.get_documents()
     assert response.results[0]['title'] == 'Some title'
     update = index.update_documents(small_movies)
-    index.wait_for_task(update['taskUid'])
+    index.wait_for_task(update.task_uid)
     response = index.get_documents()
     assert response.results[0]['title'] != 'Some title'
 
@@ -117,8 +117,8 @@ def test_update_documents_in_batches(
     assert ceil(len(small_movies) / batch_size) == len(response)
 
     for r in response:
-        assert 'taskUid' in r
-        update = index.wait_for_task(r['taskUid'])
+        assert r.task_uid != None
+        update = index.wait_for_task(r.task_uid)
         assert update.status == 'succeeded'
 
     assert index.get_primary_key() == expected_primary_key
@@ -127,9 +127,9 @@ def test_delete_document(index_with_documents):
     """Tests deleting a single document."""
     index = index_with_documents()
     response = index.delete_document('500682')
-    assert isinstance(response, dict)
-    assert 'taskUid' in response
-    index.wait_for_task(response['taskUid'])
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid != None
+    index.wait_for_task(response.task_uid)
     with pytest.raises(Exception):
         index.get_document('500682')
 

tests/index/test_index_stats_meilisearch.py

@@ -1,7 +1,7 @@
-from meilisearch.models import IndexStatsResults
+from meilisearch.models import IndexStats
 
 def test_get_stats(empty_index):
     """Tests getting stats of an index."""
     response = empty_index().get_stats()
-    assert isinstance(response, IndexStatsResults)
+    assert isinstance(response, IndexStats)
     assert response.number_of_documents == 0

tests/index/test_index_task_meilisearch.py

@@ -2,7 +2,7 @@
 
 import pytest
 from tests import common
-from meilisearch.models import TaskInfo, TaskResults
+from meilisearch.models import Task, TaskResults
 
 def test_get_tasks_default(index_with_documents):
     """Tests getting the tasks list of an empty index."""
@@ -17,8 +17,8 @@ def test_get_tasks(empty_index, small_movies):
     current_tasks = index.get_tasks()
     pre_count = len(current_tasks.results)
     response = index.add_documents(small_movies)
-    assert 'taskUid' in response
-    index.wait_for_task(response['taskUid'])
+    assert response.task_uid != None
+    index.wait_for_task(response.task_uid)
     tasks = index.get_tasks()
     assert len(tasks.results) == pre_count + 1
 
@@ -49,8 +49,9 @@ def test_get_task(client):
     client.wait_for_task(task['taskUid'])
     index = client.get_index(uid=common.INDEX_UID)
     task = index.get_task(task['taskUid'])
-    assert isinstance(task, TaskInfo)
+    assert isinstance(task, Task)
     assert task.uid != None
+    assert task.index_uid != None
     assert task.status != None
     assert task.type != None
     assert task.duration != None

tests/index/test_index_wait_for_task.py

@@ -3,15 +3,15 @@
 from datetime import datetime
 import pytest
 from meilisearch.errors import MeiliSearchTimeoutError
-from meilisearch.models import TaskInfo
+from meilisearch.models import Task
 
 def test_wait_for_task_default(index_with_documents):
     """Tests waiting for an update with default parameters."""
     index = index_with_documents()
     response = index.add_documents([{'id': 1, 'title': 'Le Petit Prince'}])
-    assert 'taskUid' in response
-    update = index.wait_for_task(response['taskUid'])
-    assert isinstance(update, TaskInfo)
+    assert response.task_uid != None
+    update = index.wait_for_task(response.task_uid)
+    assert isinstance(update, Task)
     assert update.status != None
     assert update.status not in ('enqueued', 'processing')
 
@@ -24,15 +24,15 @@ def test_wait_for_task_interval_custom(index_with_documents, small_movies):
     """Tests call to wait for an update with custom interval."""
     index = index_with_documents()
     response = index.add_documents(small_movies)
-    assert 'taskUid' in response
+    assert response.task_uid != None
     start_time = datetime.now()
     wait_update = index.wait_for_task(
-        response['taskUid'],
+        response.task_uid,
         interval_in_ms=1000,
         timeout_in_ms=6000
     )
     time_delta = datetime.now() - start_time
-    assert isinstance(wait_update, TaskInfo)
+    assert isinstance(wait_update, Task)
     assert wait_update.status != None
     assert wait_update.status != 'enqueued'
     assert wait_update.status != 'processing'
@@ -42,13 +42,13 @@ def test_wait_for_task_interval_zero(index_with_documents, small_movies):
     """Tests call to wait for an update with custom interval."""
     index = index_with_documents()
     response = index.add_documents(small_movies)
-    assert 'taskUid' in response
+    assert response.task_uid != None
     wait_update = index.wait_for_task(
-        response['taskUid'],
+        response.task_uid,
         interval_in_ms=0,
         timeout_in_ms=6000
     )
-    assert isinstance(wait_update, TaskInfo)
+    assert isinstance(wait_update, Task)
     assert wait_update.status != None
     assert wait_update.status != 'enqueued'
     assert wait_update.status != 'processing'

tests/settings/test_settings_displayed_attributes_meilisearch.py

@@ -10,7 +10,7 @@ def test_get_displayed_attributes(empty_index, small_movies):
     assert isinstance(response, list)
     assert response == ['*']
     response = index.add_documents(small_movies)
-    index.wait_for_task(response['taskUid'])
+    index.wait_for_task(response.task_uid)
     get_attributes = index.get_displayed_attributes()
     assert get_attributes == ['*']
 

tests/settings/test_settings_searchable_attributes_meilisearch.py

@@ -9,7 +9,7 @@ def test_get_searchable_attributes(empty_index, small_movies):
     assert isinstance(response, list)
     assert response == ['*']
     response = index.add_documents(small_movies, primary_key='id')
-    index.wait_for_task(response['taskUid'])
+    index.wait_for_task(response.task_uid)
     get_attributes = index.get_searchable_attributes()
     assert get_attributes == ['*']