# Copyright (c) 2021 Autodesk Inc.
#
@@ -225,12 +153,13 @@ Source code for filtering.filter_menu
import sgtk
from sgtk.platform.qt import QtCore, QtGui
+from sgtk.util import sgre as re
from .filter_definition import FilterMenuFiltersDefinition
from .filter_item import FilterItem
from .filter_item_widget import (
ChoicesFilterItemWidget,
- TextFilterItemWidget,
+ SearchFilterItemWidget,
)
from .filter_menu_group import FilterMenuGroup
@@ -345,7 +274,7 @@ Source code for filtering.filter_menu
# Signal emitted when menu is finished a complete refreshing (e.g. exit refresh method)
menu_refreshed = QtCore.Signal()
- def __init__(self, parent=None, refresh_on_show=True):
+ def __init__(self, parent=None, refresh_on_show=True, bg_task_manager=None):
"""
Constructor
@@ -356,6 +285,9 @@ Source code for filtering.filter_menu
but ensures the data is the most up to date. To only refresh the menu on show
on demand, set the `refresh_on_show` property instead of this parm on init.
:type refresh_on_show: bool
+ :param bg_task_manager: An instance of a Background Task Manager that could be used to perform
+ background task processing.
+ :type bg_task_manager: :class:`~task_manager.BackgroundTaskManager`
"""
super(FilterMenu, self).__init__(parent)
@@ -373,6 +305,9 @@ Source code for filtering.filter_menu
bundle.tank.pipeline_configuration.get_project_id()
)
+ # The Background Task Manager shared instance, useful when dealing with ShotGrid Filter Menu
+ self._task_manager = bg_task_manager
+
# A mapping of field id (group) to list of FilterMenuGroup objects.
self._filter_groups = {}
# A mapping of field id to whether or not that group of filters is visible.
@@ -810,9 +745,7 @@ Source code for filtering.filter_menu
Get the current filters that are active in the menu.
The menu filtering is built by:
- 1. Within a filter field:
- a. All choice filters are grouped with OR, to create a group filter item
- b. The choices filter item is then grouped with the search filter with AND
+ 1. Within a filter field, all choice filters are grouped with OR, to create a group filter item
2. All filter field group items are then combined with AND to get the final filter item
If the `exclude_choices_from_fields` is provided, this will not add any choice filters
@@ -841,30 +774,16 @@ Source code for filtering.filter_menu
if self._get_filter_group_action(field_id, filter_item.id)
.defaultWidget()
.has_value()
+ and isinstance(
+ self._get_filter_group_action(
+ field_id, filter_item.id
+ ).defaultWidget(),
+ ChoicesFilterItemWidget,
+ )
]
- search_filter_item = None
- if filter_group.search_filter_action and filter_group.search_filter_item:
- if filter_group.search_filter_action.defaultWidget().has_value():
- search_filter_item = filter_group.search_filter_item
-
- if choices_filters and search_filter_item:
- # Add a filter OR all choice filtesr together, within the field, and AND it
- # with the search filter.
- choices_filter_group = FilterItem.create_group(
- FilterItem.FilterOp.OR,
- group_filters=choices_filters,
- group_id=field_id,
- )
- current_filters.append(
- FilterItem.create_group(
- FilterItem.FilterOp.AND,
- group_filters=[choices_filter_group, search_filter_item],
- group_id=field_id,
- )
- )
- elif choices_filters:
- # Add just the filter OR all choice filtesr together, within the field
+ if choices_filters:
+ # Add just the filter OR all choice filters together, within the field
current_filters.append(
FilterItem.create_group(
FilterItem.FilterOp.OR,
@@ -872,9 +791,6 @@ Source code for filtering.filter_menu
group_id=field_id,
)
)
- elif search_filter_item:
- # Add just the search filter.
- current_filters.append(search_filter_item)
return current_filtersSource code for filtering.filter_menu
continue
filter_item_and_actions = []
- if field_data["type"] == FilterItem.FilterType.STR:
- # Create a text search filter item.
+
+ # We want to create a search filter item in case we are dealing with a string field
+ # or an SG entity/multi-entity field
+ sg_data_type = None
+ if isinstance(field_data.get("sg_data"), dict):
+ sg_data_type = field_data["sg_data"].get("data_type")
+ if (
+ field_data["type"] == FilterItem.FilterType.STR
+ or (sg_data_type in ["entity", "multi-entity"])
+ and self._task_manager
+ ):
+ # Create a search filter item.
filter_id = self._get_search_filter_item_id(field_id)
search_filter_item_and_action = self._create_filter_item_and_action(
field_id, field_data, filter_id
@@ -1145,14 +1071,20 @@ Source code for filtering.filter_menu
}
)
else:
- filter_widget_class = TextFilterItemWidget
- filter_item_data["filter_type"] = FilterItem.FilterType.STR
- filter_item_data["filter_op"] = FilterItem.FilterOp.IN
+ filter_widget_class = SearchFilterItemWidget
+ sg_data = field_data.get("sg_data", {})
+ if sg_data and sg_data.get("data_type") in ["entity", "multi-entity"]:
+ filter_item_data["filter_type"] = FilterItem.FilterType.DICT
+ filter_item_data["filter_op"] = FilterItem.FilterOp.EQUAL
+ else:
+ filter_item_data["filter_type"] = FilterItem.FilterType.STR
+ filter_item_data["filter_op"] = FilterItem.FilterOp.IN
filter_item_data["display_name"] = field_data.get("name")
filter_item_data["short_name"] = field_data.get("short_name")
# The default value is in the field data since it is applicable to the whole
# filter group.
filter_item_data["default_value"] = field_data.get("default_value")
+ filter_item_data["sg_data"] = field_data.get("sg_data")
filter_item = FilterItem.create(filter_id, filter_item_data)
action = self._create_filter_action_widget(
@@ -1179,7 +1111,8 @@ Source code for filtering.filter_menu
the new widget.
:type widget_class: FilterItemWidget class or subclass
- :return: The QWidgetAaction object that has the FilterItemWidget set as
+ :return: The QWidgetAction object that has the FilterItemWidget set as
+ :return: The QWidgetAction object that has the FilterItemWidget set as
its default widget.
:rtype: :class:`sgtk.platform.qt.QWidgetAction`
"""
@@ -1187,7 +1120,9 @@ Source code for filtering.filter_menu
widget_action = QtGui.QWidgetAction(None)
widget_action.setCheckable(True)
- widget = widget_class(filter_item.id, field_id, filter_data)
+ widget = widget_class(
+ filter_item.id, field_id, filter_data, bg_task_manager=self._task_manager
+ )
widget_action.setDefaultWidget(widget)
if filter_data.get("default_value") is not None:
widget.value = filter_data["default_value"]
@@ -1201,12 +1136,12 @@ Source code for filtering.filter_menu
lambda state, a=widget_action: self._filter_widget_checked(a, state)
)
widget.value_changed.connect(
- lambda text, f=filter_item: self._filter_widget_value_changed(f, text)
+ lambda search, f=filter_item: self._filter_widget_value_changed(f, search)
)
if isinstance(widget, ChoicesFilterItemWidget):
# Only connect signal/slot to update value based on check state, if the filter
- # item is checkable (e.g. do not connect this for TextFilterItemWidgets).
+ # item is checkable (e.g. do not connect this for SearchFilterItemWidgets).
widget_action.triggered.connect(
lambda checked=None, a=widget_action: self.set_widget_action_default_widget_value(
a, checked
@@ -1339,9 +1274,22 @@ Source code for filtering.filter_menu
:rtype: str
"""
- # There should only be one TextFilterItemWidget per field group, which makes
+ # There should only be one SearchFilterItemWidget per field group, which makes
# it safe to use the widget class name as part of the id.
- return "{}.{}".format(field_id, str(TextFilterItemWidget))
+ return "{}.{}".format(field_id, str(SearchFilterItemWidget))
+
+ @staticmethod
+ def _get_search_filter_field_id(filter_id):
+ """
+ Convenience method to get the field id from the filter id.
+
+ :param filter_id: The id for the search filter item widget.
+ :type: str
+
+ :return: The field id that the search filter item widget refers to.
+ :rtype: str
+ """
+ return re.sub(rf".{str(SearchFilterItemWidget)}$", "", filter_id)
def _get_filter_group_items(self, field_id):
"""
@@ -1461,19 +1409,37 @@ Source code for filtering.filter_menu
action.setChecked(checked)
self._emit_filters_changed()
- def _filter_widget_value_changed(self, filter_item, text):
+ def _filter_widget_value_changed(self, filter_item, search):
"""
Callback triggered when a FilterItemWidget `value_changed` signal emitted.
- :param filter_item: The FilterItem assoicated with the filter widget.
+ :param filter_item: The FilterItem associated with the filter widget.
:type filter_item: FilterItem
- :param text: The new text value the filter widget has.
- :type text: str
+ :param search: The new search value the filter widget has.
+ :type search: any
"""
- updated = filter_item.set_filter_value(text)
- if updated:
- self._emit_filters_changed()Source code for filtering.filter_menu
the ShotgunModel class.
"""
- def __init__(self, parent=None, refresh_on_show=True):
+ def __init__(self, parent=None, refresh_on_show=True, bg_task_manager=None):
"""
Constructor.
Set the filter_roles to the ShotgunModel role pointing to its SG data.
"""
- super(ShotgunFilterMenu, self).__init__(parent, refresh_on_show=refresh_on_show)
+ super(ShotgunFilterMenu, self).__init__(
+ parent, refresh_on_show=refresh_on_show, bg_task_manager=bg_task_manager
+ )
# Use the SG_DATA_ROLE to extract the data from the ShotgunModel. This class fixes the
# filte roles to the ShotgunModel.SG_DATA_ROLE since it is designed to work with this
@@ -1645,41 +1613,27 @@ Source code for filtering.filter_menu