Skip to content

Commit c638ce8

Browse files
JBWilkieowencjones
JBWilkie
and
owencjones
authored
[PY-400][external] Move Meta Item & ItemQuery to folder (#717)
* Fixed missing path parameter in core move items to folder method * Fixed missing priority parameter in core set item priority method * Linting * Meta Item & ItemQuery functions to move between folders * Update darwin/future/tests/meta/queries/test_item.py Co-authored-by: Owen Jones <[email protected]> * Added sad path tests --------- Co-authored-by: Owen Jones <[email protected]>
1 parent 0efb835 commit c638ce8

File tree

6 files changed

+168
-2
lines changed

6 files changed

+168
-2
lines changed

‎darwin/future/core/items/move_items_to_folder.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ def move_list_of_items_to_folder(
4444
if isinstance(dataset_ids, list)
4545
else [dataset_ids],
4646
**filters,
47-
}
47+
},
48+
"path": path,
4849
}
4950

5051
return client.post(f"/v2/teams/{team_slug}/items/path", data=payload)

‎darwin/future/core/items/set_item_priority.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ def set_item_priority(
4242
if isinstance(dataset_ids, list)
4343
else [dataset_ids],
4444
**filters,
45-
}
45+
},
46+
"priority": priority,
4647
}
4748

4849
return client.post(

‎darwin/future/meta/objects/item.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
from uuid import UUID
55

66
from darwin.future.core.items.delete_items import delete_list_of_items
7+
from darwin.future.core.items.move_items_to_folder import move_list_of_items_to_folder
78
from darwin.future.data_objects.item import ItemCore, ItemLayout, ItemSlot
89
from darwin.future.meta.objects.base import MetaBase
910

@@ -53,6 +54,18 @@ def delete(self) -> None:
5354
filters = {"item_ids": [str(self.id)]}
5455
delete_list_of_items(self.client, team_slug, dataset_id, filters)
5556

57+
def move_to_folder(self, path: str) -> None:
58+
team_slug, dataset_id = (
59+
self.meta_params["team_slug"],
60+
self.meta_params["dataset_id"]
61+
if "dataset_id" in self.meta_params
62+
else self.meta_params["dataset_ids"],
63+
)
64+
assert isinstance(team_slug, str)
65+
dataset_id = cast(Union[int, List[int]], dataset_id)
66+
filters = {"item_ids": [str(self.id)]}
67+
move_list_of_items_to_folder(self.client, team_slug, dataset_id, path, filters)
68+
5669
@property
5770
def name(self) -> str:
5871
return self._element.name

‎darwin/future/meta/queries/item.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
from darwin.future.core.items.delete_items import delete_list_of_items
55
from darwin.future.core.items.get import list_items
6+
from darwin.future.core.items.move_items_to_folder import move_list_of_items_to_folder
67
from darwin.future.core.types.common import QueryString
78
from darwin.future.core.types.query import PaginatedQuery
89
from darwin.future.meta.objects.item import Item
@@ -59,3 +60,24 @@ def delete(self) -> None:
5960
ids = [item.id for item in self]
6061
filters = {"item_ids": [str(item) for item in ids]}
6162
delete_list_of_items(self.client, team_slug, dataset_ids, filters)
63+
64+
def move_to_folder(self, path) -> None:
65+
if "team_slug" not in self.meta_params:
66+
raise ValueError("Must specify team_slug to query items")
67+
if (
68+
"dataset_ids" not in self.meta_params
69+
and "dataset_id" not in self.meta_params
70+
):
71+
raise ValueError("Must specify dataset_ids to query items")
72+
if not path:
73+
raise ValueError("Must specify path to move items to")
74+
dataset_ids = (
75+
self.meta_params["dataset_ids"]
76+
if "dataset_ids" in self.meta_params
77+
else self.meta_params["dataset_id"]
78+
)
79+
team_slug = self.meta_params["team_slug"]
80+
self.collect_all()
81+
ids = [item.id for item in self]
82+
filters = {"item_ids": [str(item) for item in ids]}
83+
move_list_of_items_to_folder(self.client, team_slug, dataset_ids, path, filters)

‎darwin/future/tests/meta/objects/test_itemmeta.py‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
from uuid import UUID
22

3+
import pytest
34
import responses
45
from responses import json_params_matcher
56

67
from darwin.future.data_objects.item import ItemLayout, ItemSlot
8+
from darwin.future.exceptions import BadRequest
79
from darwin.future.meta.objects.item import Item
810
from darwin.future.tests.meta.objects.fixtures import *
911

@@ -44,3 +46,54 @@ def test_delete(item: Item) -> None:
4446
json={},
4547
)
4648
item.delete()
49+
50+
51+
def test_move_to_folder(item: Item) -> None:
52+
with responses.RequestsMock() as rsps:
53+
team_slug = item.meta_params["team_slug"]
54+
dataset_id = item.meta_params["dataset_id"]
55+
path = "/new_folder"
56+
rsps.add(
57+
rsps.POST,
58+
item.client.config.api_endpoint + f"v2/teams/{team_slug}/items/path",
59+
status=200,
60+
match=[
61+
json_params_matcher(
62+
{
63+
"filters": {
64+
"item_ids": [str(item.id)],
65+
"dataset_ids": [dataset_id],
66+
},
67+
"path": path,
68+
}
69+
)
70+
],
71+
json={},
72+
)
73+
item.move_to_folder(path)
74+
75+
76+
def test_move_to_folder_raises_on_incorrect_parameters(item: Item) -> None:
77+
with responses.RequestsMock() as rsps:
78+
team_slug = item.meta_params["team_slug"]
79+
dataset_id = item.meta_params["dataset_id"]
80+
path = 1234
81+
rsps.add(
82+
rsps.POST,
83+
item.client.config.api_endpoint + f"v2/teams/{team_slug}/items/path",
84+
status=400,
85+
match=[
86+
json_params_matcher(
87+
{
88+
"filters": {
89+
"item_ids": [str(item.id)],
90+
"dataset_ids": [dataset_id],
91+
},
92+
"path": path,
93+
}
94+
)
95+
],
96+
json={},
97+
)
98+
with pytest.raises(BadRequest):
99+
item.move_to_folder(path)

‎darwin/future/tests/meta/queries/test_item.py‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
from responses.matchers import json_params_matcher, query_param_matcher
66

77
from darwin.future.core.client import ClientCore
8+
from darwin.future.exceptions import BadRequest
89
from darwin.future.meta.objects.item import Item
910
from darwin.future.meta.queries.item import ItemQuery
1011
from darwin.future.tests.core.fixtures import *
@@ -70,3 +71,78 @@ def test_delete(
7071
json={},
7172
)
7273
item_query.delete()
74+
75+
76+
def test_move_to_folder(
77+
item_query: ItemQuery, items_json: List[dict], items: List[Item]
78+
) -> None:
79+
with responses.RequestsMock() as rsps:
80+
rsps.add(
81+
rsps.GET,
82+
item_query.client.config.api_endpoint + "v2/teams/test/items",
83+
match=[
84+
query_param_matcher(
85+
{"page[offset]": "0", "page[size]": "500", "dataset_ids": "1"}
86+
)
87+
],
88+
json={"items": items_json, "errors": []},
89+
)
90+
team_slug = items[0].meta_params["team_slug"]
91+
dataset_id = items[0].meta_params["dataset_id"]
92+
path = "/new_folder"
93+
rsps.add(
94+
rsps.POST,
95+
items[0].client.config.api_endpoint + f"v2/teams/{team_slug}/items/path",
96+
status=200,
97+
match=[
98+
json_params_matcher(
99+
{
100+
"filters": {
101+
"item_ids": [str(item.id) for item in items],
102+
"dataset_ids": [dataset_id],
103+
},
104+
"path": path,
105+
}
106+
)
107+
],
108+
json={},
109+
)
110+
item_query.move_to_folder(path)
111+
112+
113+
def test_move_to_folder_raises_on_incorrect_parameters(
114+
item_query: ItemQuery, items_json: List[dict], items: List[Item]
115+
) -> None:
116+
with responses.RequestsMock() as rsps:
117+
rsps.add(
118+
rsps.GET,
119+
item_query.client.config.api_endpoint + "v2/teams/test/items",
120+
match=[
121+
query_param_matcher(
122+
{"page[offset]": "0", "page[size]": "500", "dataset_ids": "1"}
123+
)
124+
],
125+
json={"items": items_json, "errors": []},
126+
)
127+
team_slug = items[0].meta_params["team_slug"]
128+
dataset_id = items[0].meta_params["dataset_id"]
129+
path = 1234
130+
rsps.add(
131+
rsps.POST,
132+
items[0].client.config.api_endpoint + f"v2/teams/{team_slug}/items/path",
133+
status=400,
134+
match=[
135+
json_params_matcher(
136+
{
137+
"filters": {
138+
"item_ids": [str(item.id) for item in items],
139+
"dataset_ids": [dataset_id],
140+
},
141+
"path": path,
142+
}
143+
)
144+
],
145+
json={},
146+
)
147+
with pytest.raises(BadRequest):
148+
item_query.move_to_folder(path)

0 commit comments

Comments
 (0)