Merge pull request #108 from sanders41/docstrings

Formatting docstrings

Author: sanders41

async_search_client/client.py

@@ -33,9 +33,10 @@ async def __aexit__(
         await self.aclose()
 
     async def aclose(self) -> None:
+        """Closes the client. This only needs to be used if the client was not created with a
+        context manager
         """
-        Closes the client. This only needs to be used if the client was not created with a context manager.
-        """
+
         await self._http_client.aclose()
 
     async def create_dump(self) -> DumpInfo:
@@ -79,10 +80,10 @@ async def get_index(self, uid: str) -> Index:
         return await Index(self._http_client, uid).fetch_info()
 
     def index(self, uid: str) -> Index:
-        """
-        Create a local reference to an index identified by UID, without doing an HTTP call.
+        """Create a local reference to an index identified by UID, without doing an HTTP call.
         Because no network call is made this method is not awaitable.
         """
+
         return Index(self._http_client, uid=uid)
 
     async def get_all_stats(self) -> ClientStats:
@@ -124,16 +125,14 @@ async def get_raw_indexes(self) -> Optional[list[IndexInfo]]:
         return [IndexInfo(**x) for x in response.json()]
 
     async def get_version(self) -> Version:
-        """
-        Get version MeiliSearch that is running
-        """
+        """Get version MeiliSearch that is running"""
+
         response = await self._http_requests.get(build_url(Paths.VERSION))
         return Version(**response.json())
 
     async def health(self) -> Health:
-        """
-        Get health of the MeiliSearch server
-        """
+        """Get health of the MeiliSearch server"""
+
         response = await self._http_requests.get(build_url(Paths.HEALTH))
         return Health(**response.json())
 

async_search_client/index.py

@@ -58,9 +58,8 @@ async def delete(self) -> int:
         return response.status_code
 
     async def delete_if_exists(self) -> bool:
-        """
-        Deletes the index if it already exists
-        """
+        """Deletes the index if it already exists"""
+
         try:
             await self.delete()
             return True
@@ -70,9 +69,8 @@ async def delete_if_exists(self) -> bool:
             return False
 
     async def update(self, primary_key: str = None) -> Index:
-        """
-        Update the index primary-key.
-        """
+        """Update the index primary-key"""
+
         payload = {}
         if primary_key is not None:
             payload["primaryKey"] = primary_key
@@ -157,13 +155,13 @@ async def get_update_status(self, update_id: int) -> UpdateStatus:
     async def wait_for_pending_update(
         self, update_id: int, timeout_in_ms: int = 5000, interval_in_ms: int = 50
     ) -> UpdateStatus:
-        """
-        Wait until MeiliSearch processes an update, and get its status.
+        """Wait until MeiliSearch processes an update, and get its status.
 
         update_id: identifier of the update to retrieve
         timeout_in_ms (optional): time the method should wait before raising a MeiliSearchTimeoutError
         interval_in_ms (optional): time interval the method should wait (sleep) between requests
         """
+
         start_time = datetime.now()
         elapsed_time = 0.0
         while elapsed_time < timeout_in_ms:
@@ -280,9 +278,7 @@ async def add_documents(
     async def add_documents_in_batches(
         self, documents: list[dict], batch_size: int = 1000, primary_key: Optional[str] = None
     ) -> list[UpdateId]:
-        """
-        Splits documents into batches to reduce RAM usage with indexing.
-        """
+        """Splits documents into batches to reduce RAM usage with indexing"""
 
         update_ids: list[UpdateId] = []
 
@@ -295,9 +291,7 @@ async def add_documents_in_batches(
     async def add_documents_from_file(
         self, file_path: Path | str, primary_key: Optional[str] = None
     ) -> UpdateId:
-        """
-        Add documents to the index from a json file.
-        """
+        """Add documents to the index from a json file"""
 
         if isinstance(file_path, str):
             file_path = Path(file_path)
@@ -314,9 +308,7 @@ async def add_documents_from_file(
     async def add_documents_from_file_in_batches(
         self, file_path: Path | str, batch_size: int = 1000, primary_key: Optional[str] = None
     ) -> list[UpdateId]:
-        """
-        Add documents to the index from a json file in batches to reduce RAM usage.
-        """
+        """Add documents to the index from a json file in batches to reduce RAM usage"""
 
         if isinstance(file_path, str):
             file_path = Path(file_path)
@@ -349,9 +341,7 @@ async def update_documents(
     async def update_documents_in_batches(
         self, documents: list[dict], batch_size: int = 1000, primary_key: Optional[str] = None
     ) -> list[UpdateId]:
-        """
-        Splits documents into batches to reduce RAM usage with indexing.
-        """
+        """Splits documents into batches to reduce RAM usage with indexing"""
 
         update_ids: list[UpdateId] = []
 
@@ -364,9 +354,7 @@ async def update_documents_in_batches(
     async def update_documents_from_file(
         self, file_path: Path | str, primary_key: Optional[str] = None
     ) -> UpdateId:
-        """
-        Update documents in the index from a json file.
-        """
+        """Update documents in the index from a json file"""
 
         if isinstance(file_path, str):
             file_path = Path(file_path)
@@ -383,9 +371,7 @@ async def update_documents_from_file(
     async def update_documents_from_file_in_batches(
         self, file_path: Path | str, batch_size: int = 1000, primary_key: Optional[str] = None
     ) -> list[UpdateId]:
-        """
-        Update documents in the index from a json file in batches to reduce RAM usage.
-        """
+        """Update documents in the index from a json file in batches to reduce RAM usage"""
 
         if isinstance(file_path, str):
             file_path = Path(file_path)
@@ -623,8 +609,7 @@ async def reset_attributes_for_faceting(self) -> UpdateId:
 
     @staticmethod
     def _iso_to_date_time(iso_date: Optional[datetime | str]) -> Optional[datetime]:
-        """
-        The microseconds from MeiliSearch are sometimes too long for python to convert so this
+        """The microseconds from MeiliSearch are sometimes too long for python to convert so this
         strips off the last digits to shorten it when that happens.
         """
 

tests/conftest.py

@@ -39,10 +39,10 @@ async def test_client():
 @pytest.mark.asyncio
 @pytest.fixture(autouse=True)
 async def clear_indexes(test_client):
-    """
-    Auto-clears the indexes after each test function run.
+    """Auto-clears the indexes after each test function run.
     Makes all the test functions independent.
     """
+
     yield
     indexes = await test_client.get_indexes()
     if indexes:
@@ -92,9 +92,7 @@ async def indexes_sample(test_client):
 
 @pytest.fixture(scope="session")
 def small_movies():
-    """
-    Runs once per session. Provides the content of small_movies.json.
-    """
+    """Runs once per session. Provides the content of small_movies.json"""
 
     with open(SMALL_MOVIES_PATH, "r") as movie_file:
         yield json.loads(movie_file.read())