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

[PY-403][external] Set Priority Meta Item & ItemQuery functions #720

Merged
merged 10 commits into from
Nov 16, 2023
13 changes: 13 additions & 0 deletions darwin/future/meta/objects/item.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from darwin.future.core.items.archive_items import archive_list_of_items
from darwin.future.core.items.delete_items import delete_list_of_items
from darwin.future.core.items.move_items_to_folder import move_list_of_items_to_folder
from darwin.future.core.items.set_item_priority import set_item_priority
from darwin.future.core.items.restore_items import restore_list_of_items
from darwin.future.data_objects.item import ItemCore, ItemLayout, ItemSlot
from darwin.future.meta.objects.base import MetaBase
Expand Down Expand Up @@ -68,6 +69,18 @@ def move_to_folder(self, path: str) -> None:
filters = {"item_ids": [str(self.id)]}
move_list_of_items_to_folder(self.client, team_slug, dataset_id, path, filters)

def set_priority(self, priority: int) -> None:
team_slug, dataset_id = (
self.meta_params["team_slug"],
self.meta_params["dataset_id"]
if "dataset_id" in self.meta_params
else self.meta_params["dataset_ids"],
)
assert isinstance(team_slug, str)
dataset_id = cast(Union[int, List[int]], dataset_id)
filters = {"item_ids": [str(self.id)]}
set_item_priority(self.client, team_slug, dataset_id, priority, filters)

def restore(self) -> None:
team_slug, dataset_id = (
self.meta_params["team_slug"],
Expand Down
22 changes: 22 additions & 0 deletions darwin/future/meta/queries/item.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from darwin.future.core.items.delete_items import delete_list_of_items
from darwin.future.core.items.get import list_items
from darwin.future.core.items.move_items_to_folder import move_list_of_items_to_folder
from darwin.future.core.items.set_item_priority import set_item_priority
from darwin.future.core.items.restore_items import restore_list_of_items
from darwin.future.core.types.common import QueryString
from darwin.future.core.types.query import PaginatedQuery
Expand Down Expand Up @@ -84,6 +85,27 @@ def move_to_folder(self, path) -> None:
filters = {"item_ids": [str(item) for item in ids]}
move_list_of_items_to_folder(self.client, team_slug, dataset_ids, path, filters)

def set_priority(self, priority: int) -> None:
if "team_slug" not in self.meta_params:
raise ValueError("Must specify team_slug to query items")
if (
"dataset_ids" not in self.meta_params
and "dataset_id" not in self.meta_params
):
raise ValueError("Must specify dataset_ids to query items")
if not priority:
raise ValueError("Must specify priority to set items to")
dataset_ids = (
self.meta_params["dataset_ids"]
if "dataset_ids" in self.meta_params
else self.meta_params["dataset_id"]
)
team_slug = self.meta_params["team_slug"]
self.collect_all()
ids = [item.id for item in self]
filters = {"item_ids": [str(item) for item in ids]}
set_item_priority(self.client, team_slug, dataset_ids, priority, filters)

def restore(self) -> None:
if "team_slug" not in self.meta_params:
raise ValueError("Must specify team_slug to query items")
Expand Down
58 changes: 58 additions & 0 deletions darwin/future/tests/meta/objects/test_itemmeta.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,64 @@ def test_move_to_folder_with_bad_team_slug(item: Item) -> None:
item.move_to_folder(path)


def test_set_priority(item: Item) -> None:
with responses.RequestsMock() as rsps:
team_slug = item.meta_params["team_slug"]
dataset_id = item.meta_params["dataset_id"]
priority = 10
rsps.add(
rsps.POST,
item.client.config.api_endpoint + f"v2/teams/{team_slug}/items/priority",
status=200,
match=[
json_params_matcher(
{
"filters": {
"item_ids": [str(item.id)],
"dataset_ids": [dataset_id],
},
"priority": priority,
}
)
],
json={},
)
item.set_priority(priority)


def test_set_priority_raises_on_incorrect_parameters(item: Item) -> None:
with responses.RequestsMock() as rsps:
team_slug = item.meta_params["team_slug"]
dataset_id = item.meta_params["dataset_id"]
priority = "10"
rsps.add(
rsps.POST,
item.client.config.api_endpoint + f"v2/teams/{team_slug}/items/priority",
status=400,
match=[
json_params_matcher(
{
"filters": {
"item_ids": [str(item.id)],
"dataset_ids": [dataset_id],
},
"priority": priority,
}
)
],
json={},
)
with pytest.raises(BadRequest):
item.set_priority(priority)


def test_set_priority_with_bad_team_slug(item: Item) -> None:
with pytest.raises(AssertionError):
priority = 10
item.meta_params["team_slug"] = 123
item.set_priority(priority)


def test_restore(item: Item) -> None:
with responses.RequestsMock() as rsps:
team_slug = item.meta_params["team_slug"]
Expand Down
77 changes: 77 additions & 0 deletions darwin/future/tests/meta/queries/test_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,83 @@ def test_move_to_folder_raises_on_incorrect_parameters(
item_query.move_to_folder(path)


def test_set_priority(
item_query: ItemQuery, items_json: List[dict], items: List[Item]
) -> None:
with responses.RequestsMock() as rsps:
rsps.add(
rsps.GET,
item_query.client.config.api_endpoint + "v2/teams/test/items",
match=[
query_param_matcher(
{"page[offset]": "0", "page[size]": "500", "dataset_ids": "1"}
)
],
json={"items": items_json, "errors": []},
)
team_slug = items[0].meta_params["team_slug"]
dataset_id = items[0].meta_params["dataset_id"]
priority = 10
rsps.add(
rsps.POST,
items[0].client.config.api_endpoint
+ f"v2/teams/{team_slug}/items/priority",
status=200,
match=[
json_params_matcher(
{
"filters": {
"item_ids": [str(item.id) for item in items],
"dataset_ids": [dataset_id],
},
"priority": priority,
}
)
],
json={},
)
item_query.set_priority(priority)


def test_set_priority_raises_on_incorrect_parameters(
item_query: ItemQuery, items_json: List[dict], items: List[Item]
) -> None:
with responses.RequestsMock() as rsps:
rsps.add(
rsps.GET,
item_query.client.config.api_endpoint + "v2/teams/test/items",
match=[
query_param_matcher(
{"page[offset]": "0", "page[size]": "500", "dataset_ids": "1"}
)
],
json={"items": items_json, "errors": []},
)
team_slug = items[0].meta_params["team_slug"]
dataset_id = items[0].meta_params["dataset_id"]
priority = "10"
rsps.add(
rsps.POST,
items[0].client.config.api_endpoint
+ f"v2/teams/{team_slug}/items/priority",
status=400,
match=[
json_params_matcher(
{
"filters": {
"item_ids": [str(item.id) for item in items],
"dataset_ids": [dataset_id],
},
"priority": priority,
}
)
],
json={},
)
with pytest.raises(BadRequest):
item_query.set_priority(priority)


def test_restore(
item_query: ItemQuery, items_json: List[dict], items: List[Item]
) -> None:
Expand Down
Loading