-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[IO-1802][external] Added core item method to restore items + tests (#…
…706) * Added core item method to restore items + tests * Small docstring change
- Loading branch information
Showing
2 changed files
with
98 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
from typing import Dict, List | ||
from uuid import UUID | ||
|
||
from darwin.future.core.client import ClientCore | ||
from darwin.future.core.types.common import JSONType | ||
from darwin.future.data_objects.typing import UnknownType | ||
|
||
|
||
def restore_list_of_items( | ||
api_client: ClientCore, | ||
team_slug: str, | ||
dataset_id: int, | ||
item_ids: List[UUID], | ||
filters: Dict[str, UnknownType] = {}, | ||
) -> JSONType: | ||
""" | ||
Restore specified items | ||
Parameters | ||
---------- | ||
client: Client | ||
The client to use for the request | ||
team_slug: str | ||
The slug of the team containing the items | ||
dataset_id: int | ||
The ID of the dataset containing the items | ||
item_ids: List[UUID] | ||
The IDs of the items to be restored | ||
filters: Dict[str, UnknownType] | ||
Dataset filter parameters | ||
Returns | ||
------- | ||
JSONType | ||
""" | ||
payload = { | ||
"filters": { | ||
"dataset_ids": [dataset_id], | ||
"item_ids": [str(item_id) for item_id in item_ids], | ||
**filters, | ||
} | ||
} | ||
|
||
return api_client.post(f"/v2/teams/{team_slug}/items/restore", data=payload) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
from unittest.mock import Mock | ||
from uuid import UUID | ||
|
||
import pytest | ||
import responses | ||
|
||
from darwin.exceptions import DarwinException | ||
from darwin.future.core.client import ClientCore | ||
from darwin.future.core.items.restore_items import restore_list_of_items | ||
from darwin.future.tests.core.fixtures import * | ||
|
||
|
||
@responses.activate | ||
def test_restore_items_including_filters(base_client: ClientCore) -> None: | ||
# Define the expected response | ||
responses.add( | ||
responses.POST, | ||
base_client.config.api_endpoint + "v2/teams/test-team/items/restore", | ||
json={"affected_item_count": 2}, | ||
) | ||
|
||
# Call the function | ||
response = restore_list_of_items( | ||
api_client=base_client, | ||
team_slug="test-team", | ||
dataset_id=000000, | ||
item_ids=[ | ||
UUID("00000000-0000-0000-0000-000000000000"), | ||
UUID("00000000-0000-0000-0000-000000000000"), | ||
], | ||
filters={ | ||
"not_statuses": ["uploading", "annotate"], | ||
"not_assignees": [123, 456, 789], | ||
}, | ||
) | ||
|
||
# Check that the response mathces what we expect | ||
assert response == {"affected_item_count": 2} | ||
|
||
|
||
def test_restore_items_with_error_response() -> None: | ||
api_client = Mock(spec=ClientCore) | ||
api_client.post.side_effect = DarwinException("Something went wrong") | ||
|
||
with pytest.raises(DarwinException): | ||
restore_list_of_items( | ||
api_client=api_client, | ||
team_slug="test-team", | ||
dataset_id=000000, | ||
item_ids=[ | ||
UUID("00000000-0000-0000-0000-000000000000"), | ||
UUID("00000000-0000-0000-0000-000000000000"), | ||
], | ||
) |