Skip to content

SG-37548 Add payload optimization on update method #363

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

Merged
carlos-villavicencio-adsk merged 11 commits into from
Feb 7, 2025
Merged

SG-37548 Add payload optimization on update method #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9114ff5
Include the "in" and "not_in" for payload optimization
carlos-villavicencio-adsk Dec 19, 2024
594a079
Use a decorator to mock environmental variable
carlos-villavicencio-adsk Dec 19, 2024
e0e1ecd
Add payload optimization for update action
carlos-villavicencio-adsk Dec 20, 2024
8027f0b
Change conditional order
carlos-villavicencio-adsk Dec 20, 2024
02f67b8
Extract function to be reused. Improve testing.
carlos-villavicencio-adsk Dec 23, 2024
a62351e
Fix typo
carlos-villavicencio-adsk Dec 23, 2024
29747a5
Merge branch 'master' into ticket/SG-37548
carlos-villavicencio-adsk Jan 28, 2025
5c9dfa7
Fix test
carlos-villavicencio-adsk Jan 28, 2025
2faa5a2
Support multi entity, Add tests
carlos-villavicencio-adsk Jan 28, 2025
5536ef3
Apply CR feedback
carlos-villavicencio-adsk Jan 29, 2025
b37fa34
Update shotgun_api3/shotgun.py
carlos-villavicencio-adsk Jan 29, 2025
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
52 changes: 40 additions & 12 deletions shotgun_api3/shotgun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1132,6 +1132,28 @@ def _add_project_param(self, params, project_entity):
params["project"] = project_entity

return params

def _translate_update_params(
self, entity_type, entity_id, data, multi_entity_update_modes
):
global SHOTGUN_API_ENABLE_ENTITY_OPTIMIZATION

def optimize_field(field_dict):
if SHOTGUN_API_ENABLE_ENTITY_OPTIMIZATION:
return {k: _get_type_and_id_from_value(v) for k, v in field_dict.items()}
return field_dict

full_fields = self._dict_to_list(
data,
extra_data=self._dict_to_extra_data(
multi_entity_update_modes, "multi_entity_update_mode"
),
)
return {
"type": entity_type,
"id": entity_id,
"fields": [optimize_field(field_dict) for field_dict in full_fields],
}

def summarize(self,
entity_type,
Expand Down Expand Up @@ -1463,14 +1485,7 @@ def update(self, entity_type, entity_id, data, multi_entity_update_modes=None):
upload_filmstrip_image = data.pop("filmstrip_image")

if data:
params = {
"type": entity_type,
"id": entity_id,
"fields": self._dict_to_list(
data,
extra_data=self._dict_to_extra_data(
multi_entity_update_modes, "multi_entity_update_mode"))
}
params = self._translate_update_params(entity_type, entity_id, data, multi_entity_update_modes)
record = self._call_rpc("update", params)
result = self._parse_records(record)[0]
else:
Expand Down Expand Up @@ -4485,10 +4500,7 @@ def _translate_filters_simple(sg_filter):
and condition["relation"] in ["is", "is_not", "in", "not_in"]
and isinstance(values[0], dict)
):
try:
values = [{"type": v["type"], "id": v["id"]} for v in values]
except KeyError:
pass
values = [_get_type_and_id_from_value(v) for v in values]

condition["values"] = values

Expand All @@ -4500,3 +4512,19 @@ def _version_str(version):
Convert a tuple of int's to a '.' separated str.
"""
return ".".join(map(str, version))


def _get_type_and_id_from_value(value):
"""
For an entity dictionary, returns a new dictionary with only the type and id keys.
If any of these keys are not present, the original dictionary is returned.
"""
try:
if isinstance(value, dict):
return {"type": value["type"], "id": value["id"]}
elif isinstance(value, list):
return [{"type": v["type"], "id": v["id"]} for v in value]
except (KeyError, TypeError):
LOG.debug(f"Could not optimize entity value {value}")

return value
149 changes: 148 additions & 1 deletion tests/test_unit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ def test_py_version(self, mock_sys):


class TestFilters(unittest.TestCase):
maxDiff = None

def test_empty(self):
expected = {
"logical_operator": "and",
Expand Down Expand Up @@ -463,6 +465,28 @@ def test_related_object_entity_optimization_is(self):
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)

# Now test a non-related object. The expected result should not be optimized.
filters = [
[
"something",
"is",
{"foo": "foo", "bar": "bar"},
],
]
expected = {
"logical_operator": "and",
"conditions": [
{
"path": "something",
"relation": "is",
"values": [{'bar': 'bar', 'foo': 'foo'}],
}
],
}
api.Shotgun("http://server_path", "script_name", "api_key", connect=False)
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)

@mock.patch.dict(os.environ, {"SHOTGUN_API_ENABLE_ENTITY_OPTIMIZATION": "1"})
def test_related_object_entity_optimization_in(self):
filters = [
Expand All @@ -471,7 +495,8 @@ def test_related_object_entity_optimization_in(self):
"in",
[
{"foo1": "foo1", "bar1": "bar1", "id": 999, "baz1": "baz1", "type": "Anything"},
{"foo2": "foo2", "bar2": "bar2", "id": 998, "baz2": "baz2", "type": "Anything"}
{"foo2": "foo2", "bar2": "bar2", "id": 998, "baz2": "baz2", "type": "Anything"},
{"foo3": "foo3", "bar3": "bar3"},
],
],
]
Expand All @@ -489,6 +514,10 @@ def test_related_object_entity_optimization_in(self):
{
"id": 998,
"type": "Anything",
},
{
"foo3": "foo3",
"bar3": "bar3",
}
],
}
Expand All @@ -498,6 +527,124 @@ def test_related_object_entity_optimization_in(self):
result = api.shotgun._translate_filters(filters, "all")
self.assertEqual(result, expected)

def test_related_object_update_entity(self):
entity_type = "Anything"
entity_id = 999
multi_entity_update_modes = {"link": "set", "name": "set"}
data = {
"name": "test",
"link": {
"name": "test",
"url": "http://test.com",
},
}
expected = {
"id": 999,
"type": "Anything",
"fields": [
{
"field_name": "name",
"value": "test",
"multi_entity_update_mode": "set",
},
{
"field_name": "link",
"value": {
"name": "test",
"url": "http://test.com",
},
"multi_entity_update_mode": "set",
},
],
}
sg = api.Shotgun("http://server_path", "script_name", "api_key", connect=False)
result = sg._translate_update_params(entity_type, entity_id, data, multi_entity_update_modes)
self.assertEqual(result, expected)

@mock.patch.dict(os.environ, {"SHOTGUN_API_ENABLE_ENTITY_OPTIMIZATION": "1"})
def test_related_object_update_optimization_entity(self):
entity_type = "Anything"
entity_id = 999
multi_entity_update_modes = {"project": "set", "link": "set", "name": "set"}
data = {
"name": "test",
"link": {
"name": "test",
"url": "http://test.com",
},
"project": {
"foo1": "foo1",
"bar1": "bar1",
"id": 888,
"baz1": "baz1",
"type": "Project",
},
}
expected = {
"id": 999,
"type": "Anything",
"fields": [
{
"field_name": "name",
"value": "test",
"multi_entity_update_mode": "set",
},
{
"field_name": "link",
"value": {
"name": "test",
"url": "http://test.com",
},
"multi_entity_update_mode": "set",
},
{
"field_name": "project",
"multi_entity_update_mode": "set",
"value": {
# Entity is optimized with type/id fields.
"id": 888,
"type": "Project",
},
},
],
}
sg = api.Shotgun("http://server_path", "script_name", "api_key", connect=False)
result = sg._translate_update_params(entity_type, entity_id, data, multi_entity_update_modes)
self.assertEqual(result, expected)

@mock.patch.dict(os.environ, {"SHOTGUN_API_ENABLE_ENTITY_OPTIMIZATION": "1"})
def test_related_object_update_optimization_entity_multi(self):
entity_type = "Asset"
entity_id = 6626
data = {
"sg_status_list": "ip",
"project": {"id": 70, "type": "Project", "name": "disposable name 70"},
"sg_vvv": [
{"id": 6441, "type": "Asset", "name": "disposable name 6441"},
{"id": 6440, "type": "Asset"},
],
"sg_class": {"id": 1, "type": "CustomEntity53", "name": "disposable name 1"},
}
expected = {
"type": "Asset",
"id": 6626,
"fields": [
{"field_name": "sg_status_list", "value": "ip"},
{"field_name": "project", "value": {"type": "Project", "id": 70}},
{
"field_name": "sg_vvv",
"value": [
{"id": 6441, "type": "Asset"},
{"id": 6440, "type": "Asset"},
],
},
{"field_name": "sg_class", "value": {"type": "CustomEntity53", "id": 1}},
],
}
sg = api.Shotgun("http://server_path", "script_name", "api_key", connect=False)
result = sg._translate_update_params(entity_type, entity_id, data, None)
self.assertEqual(result, expected)


class TestCerts(unittest.TestCase):
# A dummy bad url provided by Amazon
Expand Down