From 7583358da05b37f822e60f9c7b440064d20fbe7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milan=20Ondra=C5=A1ovi=C4=8D?= Date: Thu, 23 Jan 2025 07:10:47 +0100 Subject: [PATCH] fix: Rename retrieve_engine_queue_stats to retrieve_engine_queues The new name better conveys the essence that we're retrieving only a list of queues associated with the given engine. The docstring pointing to official documentation was also corrected. --- rossum_api/elis_api_client.py | 4 ++-- rossum_api/elis_api_client_sync.py | 6 +++--- tests/elis_api_client/test_engines.py | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/rossum_api/elis_api_client.py b/rossum_api/elis_api_client.py index b1ed7a1..125e2c2 100644 --- a/rossum_api/elis_api_client.py +++ b/rossum_api/elis_api_client.py @@ -557,8 +557,8 @@ async def retrieve_engine_fields( ): yield self._deserializer(Resource.EngineField, engine_field) - async def retrieve_engine_queue_stats(self, engine_id: int) -> AsyncIterator[Queue]: - """https://elis.rossum.ai/api/docs/internal/#get-queue-statistics-for-an-engine.""" + async def retrieve_engine_queues(self, engine_id: int) -> AsyncIterator[Queue]: + """https://elis.rossum.ai/api/docs/internal/#list-all-queues.""" async for queue in self._http_client.fetch_all(Resource.Queue, engine=engine_id): yield self._deserializer(Resource.Queue, queue) diff --git a/rossum_api/elis_api_client_sync.py b/rossum_api/elis_api_client_sync.py index 776a565..62544da 100644 --- a/rossum_api/elis_api_client_sync.py +++ b/rossum_api/elis_api_client_sync.py @@ -281,9 +281,9 @@ def retrieve_engine_fields(self, engine_id: int | None = None) -> Iterator[Engin """https://elis.rossum.ai/api/docs/internal/#engine-field.""" return self._iter_over_async(self.elis_api_client.retrieve_engine_fields(engine_id)) - def retrieve_engine_queue_stats(self, engine_id: int) -> Iterator[Queue]: - """https://elis.rossum.ai/api/docs/internal/#get-queue-statistics-for-an-engine.""" - return self._iter_over_async(self.elis_api_client.retrieve_engine_queue_stats(engine_id)) + def retrieve_engine_queues(self, engine_id: int) -> Iterator[Queue]: + """https://elis.rossum.ai/api/docs/internal/#list-all-queues.""" + return self._iter_over_async(self.elis_api_client.retrieve_engine_queues(engine_id)) # ##### USERS ##### def list_all_users(self, ordering: Sequence[str] = (), **filters: Any) -> Iterator[User]: diff --git a/tests/elis_api_client/test_engines.py b/tests/elis_api_client/test_engines.py index 9101335..28da4f3 100644 --- a/tests/elis_api_client/test_engines.py +++ b/tests/elis_api_client/test_engines.py @@ -44,11 +44,11 @@ async def test_list_all_engines(self, elis_client, dummy_engine, mock_generator) http_client.fetch_all.assert_called_with(Resource.Engine, (), ()) - async def test_retrieve_engine_queue_stats(self, elis_client, dummy_queue, mock_generator): + async def test_retrieve_engine_queues(self, elis_client, dummy_queue, mock_generator): client, http_client = elis_client http_client.fetch_all.return_value = mock_generator(dummy_queue) - queues = client.retrieve_engine_queue_stats(TEST_ENGINE_ID) + queues = client.retrieve_engine_queues(TEST_ENGINE_ID) async for queue in queues: assert queue == Queue(**dummy_queue)