meilisearch-python-sdk 5.2.0__tar.gz → 5.3.0__tar.gz

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.0
+    rev: v0.14.2
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/CONTRIBUTING.md

@@ -164,7 +164,7 @@ Now with the container running, run the test suite
 uv run pytest
 ```
 
-In additon to mainting the coverage percentage please ensure that all
+In addition to mainting the coverage percentage please ensure that all
 tests are passing before submitting a pull request.
 
 #### just
@@ -288,7 +288,7 @@ git fetch upstream
 git rebase upstream/main
 ```
 
-There may be some merge conficts that need to be resolved. After the feature branch has been update
+There may be some merge conflicts that need to be resolved. After the feature branch has been update
 locally, you can now update your pull request by pushing to the branch on GitHub:
 
 ```sh

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 5.2.0
+Version: 5.3.0
 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
@@ -252,7 +252,7 @@ Meilisearch takes to index the documents since that is outside of the library fu
 
 ![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
-### Muiltiple Searches
+### Multiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/README.md

@@ -196,7 +196,7 @@ Meilisearch takes to index the documents since that is outside of the library fu
 
 ![Add Documents in Batches](https://raw.githubusercontent.com/sanders41/meilisearch-python-sdk/main/assets/add_in_batches.png)
 
-### Muiltiple Searches
+### Multiple Searches
 
 This test compares how long it takes to complete 1000 searches (lower is better)
 

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/docs/async_index_api.md

@@ -1,6 +1,6 @@
 ## `AsyncIndex` Usage
 
-The `AsyncIndex` is the the same as the `Index`, but gives asyncronous methods to work with, and
+The `AsyncIndex` is the the same as the `Index`, but gives asynchronous methods to work with, and
 and should be used when using the `AsyncClient`. When you create a new index with the `AsyncClient`
 it will create an `AsyncIndex` instance.
 

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/docs/json_handler.md

@@ -1,6 +1,6 @@
 # JSON Handler
 
-For json loads and dumps you have the option to use the `json` module from the standard libary,
+For json loads and dumps you have the option to use the `json` module from the standard library,
 orjson, or ujson. This done by setting the `json_handler` when creating the `AsyncClient` or
 `Client`. By default the standard library `json` module will be used. The examples below use
 `Client`, and the same options are available for `AsyncClient`.

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/docs/plugins.md

@@ -15,7 +15,7 @@ is done through a named tuple that specifies where the plugin should run. The op
 - update_documents_plugins: Run on the `update_document` method.
 
 When creating your plugin you specify if you want it to run before or after the default
-functionality. Additionaly plugins for async indexes can be run concurrently with the default
+functionality. Additionally plugins for async indexes can be run concurrently with the default
 functionality.
 
 ## Examples:
@@ -27,9 +27,9 @@ way to track this out of the box. A search plugin could be used to implement thi
 yourself.
 
 Note that in these examples the protocol is satisfied by providing the `CONNECURRENT_EVENT`,
-`POST_EVENT`, and `PRE_EVENT` vairables and the
+`POST_EVENT`, and `PRE_EVENT` variables and the
 `async def run_plugin(self, event: AsyncEvent, **kwargs: Any) -> None:` method for an async index,
-or the `POST_EVENT` and `PRE_EVENT` vairables , and
+or the `POST_EVENT` and `PRE_EVENT` variables , and
 `def run_plugin(self, event: Event, **kwargs: Any) -> None:` method for a non-async index. You
 class can contain any additional methods/variables needed as long as the protocol requirements
 have been satisfied.
@@ -160,12 +160,12 @@ if __name__ == "__main__":
 ### Modify documents and search results
 
 A pre event plugin can be used to modify the documents before sending for indexing. In this example
-a new `access` field will be added to the doocuments before they are added or updated. The example
+a new `access` field will be added to the documents before they are added or updated. The example
 will set every other record to `admin` access with the other records being set to `read`. This will
-illustrate the idea of modifing documents even it if doesn't make real world sense.
+illustrate the idea of modifying documents even it if doesn't make real world sense.
 
 A post search plugin, this type of search plugin can only be used post search because it requires
-the result of the search, will be used to remove records marked as `admin` before returing the result.
+the result of the search, will be used to remove records marked as `admin` before returning the result.
 In the real world this filtering would probably be done with a filterable field in Meilisearch,but
 again, this is just used here to illustrate the idea.
 

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/docs/pydantic.md

@@ -55,7 +55,7 @@ Movie(
 ```
 
 By inheriting from CamelBase, or any of the other [provided models](https://github.com/sanders41/meilisearch-python-sdk/tree/main/meilisearch_python_sdk/models)
-you will be inheriting Pydantic models and therefore have access to the funcitonality Pydantic provides
+you will be inheriting Pydantic models and therefore have access to the functionality Pydantic provides
 such as [validators](https://pydantic-docs.helpmanual.io/usage/validators/) and [Fields](https://pydantic-docs.helpmanual.io/usage/model_config/#alias-precedence).
 Pydantic will also automatically deserialized the data into the correct data type based on the type
 hint provided.

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/meilisearch_python_sdk/_client.py

@@ -87,7 +87,7 @@ class BaseClient:
                 token.
             api_key: The API key to use to generate the token.
             expires_at: The timepoint at which the token should expire. If value is provided it
-                shoud be a UTC time in the future. Default = None.
+                should be a UTC time in the future. Default = None.
 
         Returns:
             A JWT token
@@ -1170,7 +1170,7 @@ class AsyncClient(BaseClient):
             timeout_in_ms: Amount of time in milliseconds to wait before raising a
                 MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
                 if the `None` option is used the wait time could be very long. Defaults to 5000.
-            interval_in_ms: Time interval in miliseconds to sleep between requests. Defaults to 50.
+            interval_in_ms: Time interval in milliseconds to sleep between requests. Defaults to 50.
             raise_for_status: When set to `True` a MeilisearchTaskFailedError will be raised if a task
                 has a failed status. Defaults to False.
 
@@ -2271,7 +2271,7 @@ class Client(BaseClient):
             timeout_in_ms: Amount of time in milliseconds to wait before raising a
                 MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
                 if the `None` option is used the wait time could be very long. Defaults to 5000.
-            interval_in_ms: Time interval in miliseconds to sleep between requests. Defaults to 50.
+            interval_in_ms: Time interval in milliseconds to sleep between requests. Defaults to 50.
             raise_for_status: When set to `True` a MeilisearchTaskFailedError will be raised if a task
                 has a failed status. Defaults to False.
 

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/meilisearch_python_sdk/_task.py

@@ -73,7 +73,7 @@ async def async_cancel_tasks(
     )
 
     if not parameters:
-        # Cancel all tasks if no parmaeters provided
+        # Cancel all tasks if no parameters provided
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
@@ -107,7 +107,7 @@ async def async_delete_tasks(
     )
 
     if not parameters:
-        # delete all tasks if no parmaeters provided
+        # delete all tasks if no parameters provided
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"
@@ -214,7 +214,7 @@ def cancel_tasks(
     )
 
     if not parameters:
-        # Cancel all tasks if no parmaeters provided
+        # Cancel all tasks if no parameters provided
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
@@ -248,7 +248,7 @@ def delete_tasks(
     )
 
     if not parameters:
-        # delete all tasks if no parmaeters provided
+        # delete all tasks if no parameters provided
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"

meilisearch_python_sdk-5.3.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/meilisearch_python_sdk/decorators.py

@@ -10,7 +10,7 @@ from meilisearch_python_sdk._utils import use_task_groups
 
 
 class ConnectionInfo(NamedTuple):
-    """Infomation on how to connect to Meilisearch.
+    """Information on how to connect to Meilisearch.
 
     url: URL for the Meilisearch server.
     api_key: The API key for the server.
@@ -29,13 +29,13 @@ def async_add_documents(
     wait_for_task: bool = False,
     verify: bool = True,
 ) -> Callable:
-    """Decorator that takes the returned documents from a function and asyncronously adds them to Meilisearch.
+    """Decorator that takes the returned documents from a function and asynchronously adds them to Meilisearch.
 
     It is required that either an async_client or url is provided.
 
     Args:
         index_name: The name of the index to which the documents should be added.
-        connection_info: Either an AsyncClient instance ConnectionInfo with informtaion on how to
+        connection_info: Either an AsyncClient instance ConnectionInfo with information on how to
             connect to Meilisearch.
         batch_size: If provided the documents will be sent in batches of the specified size.
             Otherwise all documents are sent at once. Default = None.
@@ -46,7 +46,7 @@ def async_add_documents(
         verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
-        The list of documents proviced by the decorated function.
+        The list of documents provided by the decorated function.
 
     Raises:
         MeilisearchCommunicationError: If there was an error communicating with the server.
@@ -117,7 +117,7 @@ def add_documents(
 
     Args:
         index_name: The name of the index to which the documents should be added.
-        connection_info: Either an Client instance ConnectionInfo with informtaion on how to
+        connection_info: Either an Client instance ConnectionInfo with information on how to
             connect to Meilisearch.
         batch_size: If provided the documents will be sent in batches of the specified size.
             Otherwise all documents are sent at once. Default = None.
@@ -128,7 +128,7 @@ def add_documents(
         verify: If set to `False` the decorator will not verify the SSL certificate of the server.
 
     Returns:
-        The list of documents proviced by the decorated function.
+        The list of documents provided by the decorated function.
 
     Raises:
         MeilisearchCommunicationError: If there was an error communicating with the server.

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/meilisearch_python_sdk/index.py

@@ -562,7 +562,7 @@ class AsyncIndex(_BaseIndex):
         return self
 
     async def fetch_info(self) -> Self:
-        """Gets the infromation about the index.
+        """Gets the information about the index.
 
         Returns:
             An instance of the AsyncIndex containing the retrieved information.
@@ -757,7 +757,7 @@ class AsyncIndex(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -765,7 +765,7 @@ class AsyncIndex(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -1036,7 +1036,7 @@ class AsyncIndex(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -1044,7 +1044,7 @@ class AsyncIndex(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -1372,6 +1372,7 @@ class AsyncIndex(_BaseIndex):
     async def get_documents(
         self,
         *,
+        ids: list[str] | None = None,
         offset: int = 0,
         limit: int = 20,
         fields: list[str] | None = None,
@@ -1382,6 +1383,7 @@ class AsyncIndex(_BaseIndex):
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defaults to None (Gets all documents).
             offset: Number of documents to skip. Defaults to 0.
             limit: Maximum number of documents returnedd. Defaults to 20.
             fields: Document attributes to show. If this value is None then all
@@ -1418,7 +1420,7 @@ class AsyncIndex(_BaseIndex):
         if retrieve_vectors:
             parameters["retrieveVectors"] = "true"
 
-        if not filter:
+        if not filter and not ids:
             if fields:
                 parameters["fields"] = ",".join(fields)
 
@@ -1432,6 +1434,9 @@ class AsyncIndex(_BaseIndex):
 
         parameters["filter"] = filter
 
+        if ids:
+            parameters["ids"] = ids
+
         response = await self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)
 
         return DocumentsInfo(**response.json())
@@ -1663,8 +1668,8 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
-                the field names, and ever for should have a title.
+                ndjson. For csv files the first row of the document should be a header row
+                containing the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
             combine_documents: If set to True this will combine the documents from all the files
@@ -1827,7 +1832,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2350,7 +2355,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2462,7 +2467,7 @@ class AsyncIndex(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -2907,7 +2912,7 @@ class AsyncIndex(_BaseIndex):
             MeilisearchApiError: If the Meilisearch API returned an error.
 
         Examples
-            >>> from meilisearch_pyrhon_sdk import AsyncClient
+            >>> from meilisearch_python_sdk import AsyncClient
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = client.index("movies")
             >>>     await index.delete_documents_by_filter("genre=horor"))
@@ -5028,7 +5033,7 @@ class Index(_BaseIndex):
         return self
 
     def fetch_info(self) -> Self:
-        """Gets the infromation about the index.
+        """Gets the information about the index.
 
         Returns:
             An instance of the AsyncIndex containing the retrieved information.
@@ -5216,7 +5221,7 @@ class Index(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -5224,7 +5229,7 @@ class Index(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -5401,7 +5406,7 @@ class Index(_BaseIndex):
             attributes_to_retrieve: Attributes to display in the returned documents.
                 Defaults to ["*"].
             attributes_to_crop: Attributes whose values have to be cropped. Defaults to None.
-            crop_length: The maximun number of words to display. Defaults to 200.
+            crop_length: The maximum number of words to display. Defaults to 200.
             attributes_to_highlight: Attributes whose values will contain highlighted matching terms.
                 Defaults to None.
             sort: Attributes by which to sort the results. Defaults to None.
@@ -5409,7 +5414,7 @@ class Index(_BaseIndex):
                 matches should be returned or not. Defaults to False.
             highlight_pre_tag: The opening tag for highlighting text. Defaults to <em>.
             highlight_post_tag: The closing tag for highlighting text. Defaults to </em>
-            crop_marker: Marker to display when the number of words excedes the `crop_length`.
+            crop_marker: Marker to display when the number of words exceeds the `crop_length`.
                 Defaults to ...
             matching_strategy: Specifies the matching strategy Meilisearch should use. Defaults to
                 `last`.
@@ -5640,6 +5645,7 @@ class Index(_BaseIndex):
     def get_documents(
         self,
         *,
+        ids: list[str] | None = None,
         offset: int = 0,
         limit: int = 20,
         fields: list[str] | None = None,
@@ -5650,6 +5656,7 @@ class Index(_BaseIndex):
         """Get a batch documents from the index.
 
         Args:
+            ids: Array of document primary keys to retrieve. Defaults to None (Gets all documents).
             offset: Number of documents to skip. Defaults to 0.
             limit: Maximum number of documents returnedd. Defaults to 20.
             fields: Document attributes to show. If this value is None then all
@@ -5686,7 +5693,7 @@ class Index(_BaseIndex):
         if retrieve_vectors:
             parameters["retrieveVectors"] = "true"
 
-        if not filter:
+        if not filter and not ids:
             if fields:
                 parameters["fields"] = ",".join(fields)
 
@@ -5700,6 +5707,9 @@ class Index(_BaseIndex):
 
         parameters["filter"] = filter
 
+        if ids:
+            parameters["ids"] = ids
+
         response = self._http_requests.post(f"{self._documents_url}/fetch", body=parameters)
 
         return DocumentsInfo(**response.json())
@@ -5817,7 +5827,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -5893,7 +5903,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -6282,7 +6292,7 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
+                ndjson. For csv files the first row of the document should be a header row containing
                 the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
@@ -6357,8 +6367,8 @@ class Index(_BaseIndex):
             primary_key: The primary key of the documents. This will be ignored if already set.
                 Defaults to None.
             document_type: The type of document being added. Accepted types are json, csv, and
-                ndjson. For csv files the first row of the document should be a header row contining
-                the field names, and ever for should have a title.
+                ndjson. For csv files the first row of the document should be a header row
+                containing the field names, and ever for should have a title.
             csv_delimiter: A single ASCII character to specify the delimiter for csv files. This
                 can only be used if the file is a csv file. Defaults to comma.
             combine_documents: If set to True this will combine the documents from all the files

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/pyproject.toml

@@ -47,7 +47,7 @@ dev = [
   "pytest-cov==7.0.0",
   "pytest-asyncio==1.2.0",
   "pytest-xdist==3.8.0",
-  "ruff==0.14.1",
+  "ruff==0.14.3",
   "types-aiofiles==25.1.0.20251011",
   "typing-extensions==4.15.0",
   "types-ujson==5.10.0.20250822",

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/tests/test_async_documents.py

@@ -748,6 +748,18 @@ async def test_get_documents_filter(async_index_with_documents):
     assert next(iter(genres)) == "action"
 
 
+async def test_get_documents_ids(async_index_with_documents):
+    index = await async_index_with_documents()
+    documents = await index.get_documents()
+    assert len(documents.results) > 2
+    ids = [documents.results[0]["id"], documents.results[1]["id"]]
+    response = await index.get_documents(ids=ids)
+    assert len(response.results) == 2
+    retrieved_ids = [result["id"] for result in response.results]
+    assert ids[0] in retrieved_ids
+    assert ids[1] in retrieved_ids
+
+
 async def test_get_documents_filter_with_fields(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.update_filterable_attributes(["genre"])

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/tests/test_async_search.py

@@ -57,7 +57,7 @@ async def test_custom_search(async_index_with_documents):
     assert "dragon" in response.hits[0]["_formatted"]["title"].lower()
 
 
-async def test_custom_search_hightlight_tags_and_crop_marker(async_index_with_documents):
+async def test_custom_search_highlight_tags_and_crop_marker(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.search(
         "Dragon",
@@ -288,7 +288,7 @@ async def test_search_sort(sort, titles, async_index_with_documents):
     await async_wait_for_task(index.http_client, response.task_uid)
     stats = await index.get_stats()  # get this to get the total document count
 
-    # Using a placeholder search because ranking rules affect sort otherwaise meaning the results
+    # Using a placeholder search because ranking rules affect sort otherwise meaning the results
     # will almost never be in alphabetical order.
     response = await index.search(sort=sort, limit=stats.number_of_documents)
     assert response.hits[0]["title"] == titles[0]
@@ -482,14 +482,14 @@ async def test_attributes_to_search_on_search_no_match(async_index_with_document
     assert response.hits == []
 
 
-async def test_show_ranking_score_serach(async_index_with_documents):
+async def test_show_ranking_score_search(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.search("How to Train Your Dragon", show_ranking_score=True)
     assert response.hits[0]["id"] == "166428"
     assert "_rankingScore" in response.hits[0]
 
 
-async def test_show_ranking_details_serach(async_index_with_documents):
+async def test_show_ranking_details_search(async_index_with_documents):
     index = await async_index_with_documents()
     response = await index.search("How to Train Your Dragon", show_ranking_score_details=True)
     assert response.hits[0]["id"] == "166428"

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/tests/test_documents.py

@@ -668,6 +668,18 @@ def test_get_documents_filter(index_with_documents):
     assert next(iter(genres)) == "action"
 
 
+def test_get_documents_ids(index_with_documents):
+    index = index_with_documents()
+    documents = index.get_documents()
+    assert len(documents.results) > 2
+    ids = [documents.results[0]["id"], documents.results[1]["id"]]
+    response = index.get_documents(ids=ids)
+    assert len(response.results) == 2
+    retrieved_ids = [result["id"] for result in response.results]
+    assert ids[0] in retrieved_ids
+    assert ids[1] in retrieved_ids
+
+
 def test_get_documents_with_vectors(index_with_documents):
     index = index_with_documents()
     response = index.update_filterable_attributes(["genre"])

{meilisearch_python_sdk-5.2.0 → meilisearch_python_sdk-5.3.0}/tests/test_search.py

@@ -57,7 +57,7 @@ def test_custom_search(index_with_documents):
     assert "dragon" in response.hits[0]["_formatted"]["title"].lower()
 
 
-def test_custom_search_hightlight_tags_and_crop_marker(index_with_documents):
+def test_custom_search_highlight_tags_and_crop_marker(index_with_documents):
     index = index_with_documents()
     response = index.search(
         "Dragon",
@@ -288,7 +288,7 @@ def test_search_sort(sort, titles, index_with_documents):
     wait_for_task(index.http_client, response.task_uid)
     stats = index.get_stats()  # get this to get the total document count
 
-    # Using a placeholder search because ranking rules affect sort otherwaise meaning the results
+    # Using a placeholder search because ranking rules affect sort otherwise meaning the results
     # will almost never be in alphabetical order.
     response = index.search(sort=sort, limit=stats.number_of_documents)
     assert response.hits[0]["title"] == titles[0]
@@ -459,14 +459,14 @@ def test_attributes_to_search_on_search_no_match(index_with_documents):
     assert response.hits == []
 
 
-def test_show_ranking_score_serach(index_with_documents):
+def test_show_ranking_score_search(index_with_documents):
     index = index_with_documents()
     response = index.search("How to Train Your Dragon", show_ranking_score=True)
     assert response.hits[0]["id"] == "166428"
     assert "_rankingScore" in response.hits[0]
 
 
-def test_show_ranking_details_serach(index_with_documents):
+def test_show_ranking_details_search(index_with_documents):
     index = index_with_documents()
     response = index.search("How to Train Your Dragon", show_ranking_score_details=True)
     assert response.hits[0]["id"] == "166428"