Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Rename retrieve_engine_queue_stats to retrieve_engine_queues #95

Merged
merged 1 commit into from
Jan 23, 2025
Merged

refactor: Rename retrieve_engine_queue_stats to retrieve_engine_queues #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions rossum_api/elis_api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions rossum_api/elis_api_client_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]:
Expand Down
4 changes: 2 additions & 2 deletions tests/elis_api_client/test_engines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading