Skip to content

For #35229: Added support for 'additional_server_presets' in read req… #108

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
merged 8 commits into from
May 18, 2016
Merged

For #35229: Added support for 'additional_server_presets' in read req… #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6c3a753
For #35229: Added support for 'additional_server_presets' in read req…
Feb 26, 2016
971cd53
For #35229: CR fixes
Feb 29, 2016
50125df
For #35229: CR fixes
Mar 14, 2016
3d1def8
For #35229: API polishing following CR discussions.
Mar 31, 2016
7fa3666
Merge branch 'master' into 35229_add_additional_server_presets
robblau Apr 6, 2016
9232276
For #35229: CR fixes
Apr 6, 2016
7a3386a
Merge branch '35229_add_additional_server_presets' of https://github.…
Apr 6, 2016
5e0920f
For #35229: Bypassing api tests that only run on SG v7 when the SG ve…
Apr 8, 2016
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
55 changes: 45 additions & 10 deletions shotgun_api3/shotgun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ def ensure_per_project_customization(self):
'label': 'project parameter'
}, True)

def ensure_support_for_additional_filter_presets(self):
"""Wrapper for ensure_support"""
return self._ensure_support({
'version': (7, 0, 0),
'label': 'additional_filter_presets parameter'
}, True)

def __str__(self):
return "ServerCapabilities: host %s, version %s, is_dev %s"\
Expand Down Expand Up @@ -528,7 +534,8 @@ def info(self):
return self._call_rpc("info", None, include_auth_params=False)

def find_one(self, entity_type, filters, fields=None, order=None,
filter_operator=None, retired_only=False, include_archived_projects=True):
filter_operator=None, retired_only=False, include_archived_projects=True,
additional_filter_presets=None):
"""Calls the find() method and returns the first result, or None.

:param entity_type: Required, entity type (string) to find.
Expand All @@ -553,20 +560,32 @@ def find_one(self, entity_type, filters, fields=None, order=None,
:param retired_only: Optional, flag to return only entities that have
been retried. Defaults to False which returns only entities which
have not been retired.


:param additional_filter_presets: Optional list of presets to
further filter the result set, list has the form:
[{"preset_name": <preset_name>, <optional_param1>: <optional_value1>, ... }]

Note that these filters are ANDed together and ANDed with the 'filter'
argument.

For details on supported presets and the format of this parameter,
please consult the API documentation:
https://github.com/shotgunsoftware/python-api/wiki/Reference%3A-Filter-Syntax

:returns: Dictionary of requested Shotgun fields and values.
"""

results = self.find(entity_type, filters, fields, order,
filter_operator, 1, retired_only, include_archived_projects=include_archived_projects)
filter_operator, 1, retired_only, include_archived_projects=include_archived_projects,
additional_filter_presets=additional_filter_presets)

if results:
return results[0]
return None

def find(self, entity_type, filters, fields=None, order=None,
filter_operator=None, limit=0, retired_only=False, page=0,
include_archived_projects=True):
include_archived_projects=True, additional_filter_presets=None):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be added to find_one as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point! Added!

"""Find entities matching the given filters.

:param entity_type: Required, entity type (string) to find.
Expand All @@ -593,7 +612,18 @@ def find(self, entity_type, filters, fields=None, order=None,
have not been retired.

:param include_archived_projects: Optional, flag to include entities
whose projects have been archived
whose projects have been archived.

:param additional_filter_presets: Optional list of presets to
further filter the result set, list has the form:
[{"preset_name": <preset_name>, <optional_param1>: <optional_value1>, ... }]

Note that these filters are ANDed together and ANDed with the 'filter'
argument.

For details on supported presets and the format of this parameter,
please consult the API documentation:
https://github.com/shotgunsoftware/python-api/wiki/Reference%3A-Filter-Syntax

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should link to the docs for how to use filter presets.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think small example would also be handy, like in doc string for the order parameter!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, might be useful to add a small note here that presets get ANDed together with the rest of the filters?

:returns: list of the dicts for each entity with the requested fields,
and their id and type.
Expand All @@ -617,13 +647,16 @@ def find(self, entity_type, filters, fields=None, order=None,
# So we only need to check the server version if it is False
self.server_caps.ensure_include_archived_projects()

if additional_filter_presets:
self.server_caps.ensure_support_for_additional_filter_presets()

params = self._construct_read_parameters(entity_type,
fields,
filters,
retired_only,
order,
include_archived_projects)
include_archived_projects,
additional_filter_presets)

if limit and limit <= self.config.records_per_page:
params["paging"]["entities_per_page"] = limit
Expand Down Expand Up @@ -667,7 +700,8 @@ def _construct_read_parameters(self,
filters,
retired_only,
order,
include_archived_projects):
include_archived_projects,
additional_filter_presets):
params = {}
params["type"] = entity_type
params["return_fields"] = fields or ["id"]
Expand All @@ -677,6 +711,9 @@ def _construct_read_parameters(self,
params["paging"] = { "entities_per_page": self.config.records_per_page,
"current_page": 1 }

if additional_filter_presets:
params["additional_filter_presets"] = additional_filter_presets;

if include_archived_projects is False:
# Defaults to True on the server, so only pass it if it's False
params["include_archived_projects"] = False
Expand All @@ -695,7 +732,6 @@ def _construct_read_parameters(self,
params['sorts'] = sort_list
return params


def _add_project_param(self, params, project_entity):

if project_entity and self.server_caps.ensure_per_project_customization():
Expand Down Expand Up @@ -1889,8 +1925,7 @@ def text_search(self, text, entity_types, project_ids=None, limit=None):

api_entity_types = {}
for (entity_type, filter_list) in entity_types.iteritems():



if isinstance(filter_list, (list, tuple)):
resolved_filters = _translate_filters(filter_list, filter_operator=None)
api_entity_types[entity_type] = resolved_filters
Expand Down
Loading