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.

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

[IO-1805][external] Core delete item method & tests #703

Merged
merged 1 commit into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions darwin/future/core/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -219,10 +219,15 @@ def post(self, endpoint: str, data: dict) -> JSONType:
return self._generic_call(self.session.post, endpoint, data)

def delete(
self, endpoint: str, query_string: Optional[QueryString] = None
self,
endpoint: str,
query_string: Optional[QueryString] = None,
data: Optional[dict] = None,
) -> JSONType:
return self._generic_call(
self.session.delete, self._contain_qs_and_endpoint(endpoint, query_string)
self.session.delete,
self._contain_qs_and_endpoint(endpoint, query_string),
data if data is not None else {},
)

def patch(self, endpoint: str, data: dict) -> JSONType:
Expand Down
44 changes: 44 additions & 0 deletions darwin/future/core/items/delete_items.py
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 delete_list_of_items(
api_client: ClientCore,
team_slug: str,
dataset_id: int,
item_ids: List[UUID],
filters: Dict[str, UnknownType] = {},
) -> JSONType:
"""
Delete 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 deleted
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.delete(f"/v2/teams/{team_slug}/items", data=payload)
54 changes: 54 additions & 0 deletions darwin/future/tests/core/items/test_delete_items.py
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.delete_items import delete_list_of_items
from darwin.future.tests.core.fixtures import *


@responses.activate
def test_delete_items_including_filters(base_client: ClientCore) -> None:
# Define the expected response
responses.add(
responses.DELETE,
base_client.config.api_endpoint + "v2/teams/test-team/items",
json={"affected_item_count": 2},
)

# Call the function
response = delete_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_delete_items_with_error_response() -> None:
api_client = Mock(spec=ClientCore)
api_client.delete.side_effect = DarwinException("Something went wrong")

with pytest.raises(DarwinException):
delete_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"),
],
)
Loading