Merge pull request #1300 from sanders41/network

Add methods to get and set networks

Author: sanders41

meilisearch_python_sdk/_client.py

@@ -22,6 +22,7 @@
     KeyCreate,
     KeySearch,
     KeyUpdate,
+    Network,
 )
 from meilisearch_python_sdk.models.health import Health
 from meilisearch_python_sdk.models.index import IndexInfo
@@ -196,12 +197,66 @@ async def aclose(self) -> None:
         """
         await self.http_client.aclose()
 
+    async def add_or_update_networks(self, *, network: Network) -> Network:
+        """Set or update remote networks.
+
+        Args:
+            network: Information to use for the networks.
+
+        Returns:
+            An instance of Network containing the network information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>> from meilisearch_python_sdk.models.client import Network, Remote
+            >>>
+            >>>
+            >>> network = Network(
+            >>> self_="remote_1",
+            >>>     remotes={
+            >>>         "remote_1": {"url": "http://localhost:7700", "searchApiKey": "xxxx"},
+            >>>         "remote_2": {"url": "http://localhost:7720", "searchApiKey": "xxxx"},
+            >>>     },
+            >>> )
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     response = await client.add_or_update_networks(network=network)
+        """
+        response = await self._http_requests.patch(
+            "network", network.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Network(**response.json())
+
+    async def get_networks(self) -> Network:
+        """Fetches the remote-networks
+
+        Returns:
+            An instance of Network containing information about each remote.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>>
+            >>>
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     response = await client.get_networks()
+        """
+        response = await self._http_requests.get("network")
+
+        return Network(**response.json())
+
     async def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 
         Returns:
             The details of the task.
-
         Raises:
             MeilisearchCommunicationError: If there was an error communicating with the server.
             MeilisearchApiError: If the Meilisearch API returned an error.
@@ -1061,6 +1116,61 @@ def __init__(
 
         self._http_requests = HttpRequests(self.http_client, json_handler=self.json_handler)
 
+    def add_or_update_networks(self, *, network: Network) -> Network:
+        """Set or update remote networks.
+
+        Args:
+            network: Information to use for the networks.
+
+        Returns:
+            An instance of Network containing the network information.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import Client
+            >>> from meilisearch_python_sdk.models.client import Network, Remote
+            >>>
+            >>>
+            >>> network = Network(
+            >>> self_="remote_1",
+            >>>     remotes={
+            >>>         "remote_1": {"url": "http://localhost:7700", "searchApiKey": "xxxx"},
+            >>>         "remote_2": {"url": "http://localhost:7720", "searchApiKey": "xxxx"},
+            >>>     },
+            >>> )
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> response = client.add_or_update_networks(network=network)
+        """
+        response = self._http_requests.patch(
+            "network", network.model_dump(by_alias=True, exclude_none=True)
+        )
+
+        return Network(**response.json())
+
+    def get_networks(self) -> Network:
+        """Fetches the remote-networks
+
+        Returns:
+            An instance of Network containing information about each remote.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+            >>> from meilisearch_python_sdk import AsyncClient
+            >>>
+            >>>
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> response = client.get_networks()
+        """
+        response = self._http_requests.get("network")
+
+        return Network(**response.json())
+
     def create_dump(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch dump.
 

meilisearch_python_sdk/models/client.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from collections.abc import Mapping
 from datetime import datetime
 
 import pydantic
@@ -84,3 +85,13 @@ class KeySearch(CamelBase):
     offset: int
     limit: int
     total: int
+
+
+class Remote(CamelBase):
+    url: str | None = None
+    search_api_key: str | None = None
+
+
+class Network(CamelBase):
+    self_: str | None = pydantic.Field(None, alias="self")
+    remotes: Mapping[str, Remote] | None = None

tests/conftest.py

@@ -304,6 +304,15 @@ async def enable_edit_by_function(base_url, ssl_verify):
         yield
 
 
+@pytest.fixture(scope="session", autouse=True)
+async def enable_network(base_url, ssl_verify):
+    async with HttpxAsyncClient(
+        base_url=base_url, headers={"Authorization": f"Bearer {MASTER_KEY}"}, verify=ssl_verify
+    ) as client:
+        await client.patch("/experimental-features", json={"network": True})
+        yield
+
+
 @pytest.fixture
 async def create_tasks(async_empty_index, small_movies):
     """Ensures there are some tasks present for testing."""

tests/test_async_client.py

@@ -22,7 +22,7 @@
     MeilisearchTaskFailedError,
     MeilisearchTimeoutError,
 )
-from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate
+from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate, Network
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.version import Version
 from meilisearch_python_sdk.types import JsonDict
@@ -1048,3 +1048,25 @@ async def test_get_batch(async_client, async_empty_index, small_movies):
 async def test_get_batch_not_found(async_client):
     with pytest.raises(BatchNotFoundError):
         await async_client.get_batch(999999999)
+
+
+async def test_get_networks(async_client):
+    response = await async_client.get_networks()
+
+    assert isinstance(response, Network)
+
+
+async def test_add_or_update_networks(async_client):
+    network = Network(
+        self_="remote_1",
+        remotes={
+            "remote_1": {"url": "http://localhost:7700", "searchApiKey": "xxxxxxxxxxxxxx"},
+            "remote_2": {"url": "http://localhost:7720", "searchApiKey": "xxxxxxxxxxxxxxx"},
+        },
+    )
+    response = await async_client.add_or_update_networks(network=network)
+
+    assert response.self_ == "remote_1"
+    assert len(response.remotes) >= 2
+    assert "remote_1" in response.remotes
+    assert "remote_2" in response.remotes

tests/test_client.py

@@ -19,7 +19,7 @@
     MeilisearchTaskFailedError,
     MeilisearchTimeoutError,
 )
-from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate
+from meilisearch_python_sdk.models.client import KeyCreate, KeyUpdate, Network
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.version import Version
 from meilisearch_python_sdk.types import JsonDict
@@ -1029,3 +1029,25 @@ def test_get_batch(client, empty_index, small_movies):
 def test_get_batch_not_found(client):
     with pytest.raises(BatchNotFoundError):
         client.get_batch(999999999)
+
+
+def test_get_networks(client):
+    response = client.get_networks()
+
+    assert isinstance(response, Network)
+
+
+def test_add_or_update_networks(client):
+    network = Network(
+        self_="remote_1",
+        remotes={
+            "remote_1": {"url": "http://localhost:7700", "searchApiKey": "xxxxxxxxxxxxxx"},
+            "remote_2": {"url": "http://localhost:7720", "searchApiKey": "xxxxxxxxxxxxxxx"},
+        },
+    )
+    response = client.add_or_update_networks(network=network)
+
+    assert response.self_ == "remote_1"
+    assert len(response.remotes) >= 2
+    assert "remote_1" in response.remotes
+    assert "remote_2" in response.remotes