refactor structure + document model

Author: elamc-2

meilisearch/index.py

@@ -5,7 +5,10 @@
 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, Task, TaskInfo, TaskResults, IndexStats
+
+from meilisearch.models.index import IndexStats
+from meilisearch.models.document import Document, DocumentsResults
+from meilisearch.models.task import Task, TaskInfo, TaskResults
 
 # pylint: disable=too-many-public-methods
 class Index():
@@ -255,7 +258,7 @@ def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dic
             body=body
         )
 
-    def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> Document:
         """Get one document with given document identifier.
 
         Parameters
@@ -279,9 +282,11 @@ def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] =
             parameters = {}
         elif 'fields' in parameters and isinstance(parameters['fields'], list):
             parameters['fields'] = ",".join(parameters['fields'])
-        return self.http.get(
+
+        document = self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}?{parse.urlencode(parameters)}'
         )
+        return Document(document)
 
     def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> DocumentsResults:
         """Get a set of documents from the index.
@@ -309,7 +314,7 @@ def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> Document
         response = self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}?{parse.urlencode(parameters)}'
         )
-        return DocumentsResults(**response)
+        return DocumentsResults(response)
 
     def add_documents(
         self,
@@ -337,8 +342,8 @@ 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)
-        response = self.http.post(url, documents)
-        return TaskInfo(**response)
+        add_document_task = self.http.post(url, documents)
+        return TaskInfo(**add_document_task)
 
     def add_documents_in_batches(
         self,

meilisearch/models/__init__.py

@@ -0,0 +1,24 @@
+from typing import Any, Iterator, List, Dict
+
+class Document:
+    __doc: dict
+
+    def __init__(self, doc: Dict[str, Any]) -> None:
+        self.__doc = doc
+        for key in doc:
+            setattr(self, key, doc[key])
+
+    def __getattr__(self, attr: str) -> str:
+        if attr in self.__doc.keys():
+            return attr
+        raise AttributeError(f"{self.__class__.__name__} object has no attribute {attr}")
+
+    def __iter__(self) -> Iterator:
+        return iter(self.__dict__.items())  # type: ignore
+
+class DocumentsResults:
+    def __init__(self, resp: Dict[str, Any]) -> None:
+        self.results: List[Document] = [Document(doc) for doc in resp['results']]
+        self.offset: int = resp['offset']
+        self.limit: int = resp['limit']
+        self.total: int = resp['total']

meilisearch/models/document.py

@@ -0,0 +1,7 @@
+from typing import Any, Dict
+from camel_converter.pydantic_base import CamelBase
+
+class IndexStats(CamelBase):
+    number_of_documents: int
+    is_indexing: bool
+    field_distribution: Dict[str, Any]

meilisearch/models/index.py

@@ -1,12 +1,6 @@
 from typing import Any, List, Dict, Optional
 from camel_converter.pydantic_base import CamelBase
 
-class DocumentsResults(CamelBase):
-    results: List[Dict[str, Any]]
-    offset: int
-    limit: int
-    total: int
-
 class Task(CamelBase):
     uid: str
     index_uid: str
@@ -35,8 +29,3 @@ def __init__(self, resp: Dict[str, Any]) -> None:
         self.limit: int = resp['limit']
         self.from_: int = resp['from']
         self.next_: int = resp['next']
-
-class IndexStats(CamelBase):
-    number_of_documents: int
-    is_indexing: bool
-    field_distribution: Dict[str, Any]

meilisearch/models.py renamed to meilisearch/models/task.py

@@ -2,7 +2,8 @@
 
 from math import ceil
 from meilisearch.client import Client
-from meilisearch.models import TaskInfo
+from meilisearch.models.document import Document
+from meilisearch.models.task import TaskInfo
 
 import pytest
 
@@ -47,17 +48,18 @@ def test_add_documents_in_batches(
 def test_get_document(index_with_documents):
     """Tests getting one document from a populated index."""
     response = index_with_documents().get_document('500682')
-    assert isinstance(response, dict)
-    assert 'title' in response
-    assert response['title'] == 'The Highwaymen'
+    assert isinstance(response, Document)
+    assert hasattr(response, 'title')
+    assert response.title == 'The Highwaymen'
 
 def test_get_document_with_fields(index_with_documents):
     """Tests getting one document from a populated index."""
     response = index_with_documents().get_document('500682', {'fields' : ['id', 'title']})
-    assert isinstance(response, dict)
-    assert 'title' in response
-    assert 'poster' not in response
-    assert response['title'] == 'The Highwaymen'
+    assert isinstance(response, Document)
+    assert hasattr(response, 'title')
+    assert not hasattr(response, 'poster')
+    # assert 'poster' not in response
+    assert response.title == 'The Highwaymen'
 
 def test_get_document_inexistent(empty_index):
     """Tests getting one inexistent document from a populated index."""
@@ -82,24 +84,24 @@ def test_get_documents_offset_optional_params(index_with_documents):
         'fields': 'title'
     })
     assert len(response_offset_limit.results) == 3
-    assert 'title' in response_offset_limit.results[0]
-    assert response_offset_limit.results[0]['title'] == response.results[1]['title']
+    assert hasattr(response_offset_limit.results[0], 'title')
+    assert response_offset_limit.results[0].title == response.results[1].title
 
 def test_update_documents(index_with_documents, small_movies):
     """Tests updating a single document and a set of documents."""
     index = index_with_documents()
     response = index.get_documents()
-    response.results[0]['title'] = 'Some title'
-    update = index.update_documents([response.results[0]])
+    response.results[0].title = 'Some title'
+    update = index.update_documents([dict(response.results[0])])
     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'
+    assert response.results[0].title == 'Some title'
     update = index.update_documents(small_movies)
     index.wait_for_task(update.task_uid)
     response = index.get_documents()
-    assert response.results[0]['title'] != 'Some title'
+    assert response.results[0].title != 'Some title'
 
 @pytest.mark.parametrize('batch_size', [2, 3, 1000])
 @pytest.mark.parametrize(

tests/index/test_index_document_meilisearch.py

@@ -1,4 +1,4 @@
-from meilisearch.models import IndexStats
+from meilisearch.models.index import IndexStats
 
 def test_get_stats(empty_index):
     """Tests getting stats of an index."""

tests/index/test_index_stats_meilisearch.py

@@ -2,7 +2,7 @@
 
 import pytest
 from tests import common
-from meilisearch.models import Task, TaskResults
+from meilisearch.models.task import Task, TaskResults
 
 def test_get_tasks_default(index_with_documents):
     """Tests getting the tasks list of an empty index."""

tests/index/test_index_task_meilisearch.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 import pytest
 from meilisearch.errors import MeiliSearchTimeoutError
-from meilisearch.models import Task
+from meilisearch.models.task import Task
 
 def test_wait_for_task_default(index_with_documents):
     """Tests waiting for an update with default parameters."""