mark 'AssetsWidget' and 'TasksWidget' as deprecated

client/ayon_core/tools/utils/assets_widget.py

@@ -31,7 +31,7 @@ ASSET_UNDERLINE_COLORS_ROLE = QtCore.Qt.UserRole + 4
 ASSET_PATH_ROLE = QtCore.Qt.UserRole + 5
 
 
-class AssetsView(TreeViewSpinner, DeselectableTreeView):
+class _AssetsView(TreeViewSpinner, DeselectableTreeView):
     """Asset items view.
 
     Adds abilities to deselect, show loading spinner and add flick charm
@@ -39,7 +39,7 @@ class AssetsView(TreeViewSpinner, DeselectableTreeView):
     """
 
     def __init__(self, parent=None):
-        super(AssetsView, self).__init__(parent)
+        super(_AssetsView, self).__init__(parent)
         self.setIndentation(15)
         self.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
         self.setHeaderHidden(True)
@@ -73,7 +73,7 @@ class AssetsView(TreeViewSpinner, DeselectableTreeView):
             elif modifiers == QtCore.Qt.ControlModifier:
                 return
 
-        super(AssetsView, self).mousePressEvent(event)
+        super(_AssetsView, self).mousePressEvent(event)
 
     def set_loading_state(self, loading, empty):
         """Change loading state.
@@ -97,7 +97,7 @@ class AssetsView(TreeViewSpinner, DeselectableTreeView):
         self.is_empty = empty
 
 
-class AssetModel(QtGui.QStandardItemModel):
+class _AssetModel(QtGui.QStandardItemModel):
     """A model listing assets in the active project.
 
     The assets are displayed in a treeview, they are visually parented by
@@ -129,7 +129,7 @@ class AssetModel(QtGui.QStandardItemModel):
     }
 
     def __init__(self, dbcon, parent=None):
-        super(AssetModel, self).__init__(parent=parent)
+        super(_AssetModel, self).__init__(parent=parent)
         self.dbcon = dbcon
 
         self._refreshing = False
@@ -378,7 +378,7 @@ class AssetModel(QtGui.QStandardItemModel):
             self._doc_fetching_thread = None
 
 
-class AssetsWidget(QtWidgets.QWidget):
+class _AssetsWidget(QtWidgets.QWidget):
     """Base widget to display a tree of assets with filter.
 
     Assets have only one column and are sorted by name.
@@ -405,7 +405,7 @@ class AssetsWidget(QtWidgets.QWidget):
     double_clicked = QtCore.Signal()
 
     def __init__(self, dbcon, parent=None):
-        super(AssetsWidget, self).__init__(parent=parent)
+        super(_AssetsWidget, self).__init__(parent=parent)
 
         self.dbcon = dbcon
 
@@ -413,7 +413,7 @@ class AssetsWidget(QtWidgets.QWidget):
         model = self._create_source_model()
         proxy = self._create_proxy_model(model)
 
-        view = AssetsView(self)
+        view = _AssetsView(self)
         view.setModel(proxy)
 
         header_widget = QtWidgets.QWidget(self)
@@ -488,7 +488,7 @@ class AssetsWidget(QtWidgets.QWidget):
         return self._header_widget
 
     def _create_source_model(self):
-        model = AssetModel(dbcon=self.dbcon, parent=self)
+        model = _AssetModel(dbcon=self.dbcon, parent=self)
         model.refreshed.connect(self._on_model_refresh)
         return model
 
@@ -617,10 +617,13 @@ class AssetsWidget(QtWidgets.QWidget):
         self._view.setCurrentIndex(valid_indexes[0])
 
 
-class SingleSelectAssetsWidget(AssetsWidget):
+class SingleSelectAssetsWidget(_AssetsWidget):
     """Single selection asset widget.
 
     Contain single selection specific api methods.
+
+    Deprecated:
+        This widget will be removed soon. Please do not use it in new code.
     """
 
     def get_selected_asset_id(self):

client/ayon_core/tools/utils/tasks_widget.py

@@ -17,11 +17,11 @@ TASK_ORDER_ROLE = QtCore.Qt.UserRole + 3
 TASK_ASSIGNEE_ROLE = QtCore.Qt.UserRole + 4
 
 
-class TasksModel(QtGui.QStandardItemModel):
+class _TasksModel(QtGui.QStandardItemModel):
     """A model listing the tasks combined for a list of assets"""
 
     def __init__(self, dbcon, parent=None):
-        super(TasksModel, self).__init__(parent=parent)
+        super(_TasksModel, self).__init__(parent=parent)
         self.dbcon = dbcon
         self.setHeaderData(
             0, QtCore.Qt.Horizontal, "Tasks", QtCore.Qt.DisplayRole
@@ -68,7 +68,7 @@ class TasksModel(QtGui.QStandardItemModel):
             ):
                 return "Tasks"
 
-        return super(TasksModel, self).headerData(section, orientation, role)
+        return super(_TasksModel, self).headerData(section, orientation, role)
 
     def _get_current_project(self):
         return self.dbcon.Session.get("AVALON_PROJECT")
@@ -141,7 +141,7 @@ class TasksModel(QtGui.QStandardItemModel):
         root_item.appendRows(items)
 
 
-class TasksProxyModel(QtCore.QSortFilterProxyModel):
+class _TasksProxyModel(QtCore.QSortFilterProxyModel):
     def lessThan(self, x_index, y_index):
         x_order = x_index.data(TASK_ORDER_ROLE)
         y_order = y_index.data(TASK_ORDER_ROLE)
@@ -168,7 +168,11 @@ class TasksProxyModel(QtCore.QSortFilterProxyModel):
 
 
 class TasksWidget(QtWidgets.QWidget):
-    """Widget showing active Tasks"""
+    """Widget showing active Tasks
+
+    Deprecated:
+        This widget will be removed soon. Please do not use it in new code.
+    """
 
     task_changed = QtCore.Signal()
 
@@ -208,10 +212,10 @@ class TasksWidget(QtWidgets.QWidget):
         Model must have available 'refresh' method and 'set_asset_id' to change
         context of asset.
         """
-        return TasksModel(self._dbcon)
+        return _TasksModel(self._dbcon)
 
     def _create_proxy_model(self, source_model):
-        proxy = TasksProxyModel()
+        proxy = _TasksProxyModel()
         proxy.setSourceModel(source_model)
         return proxy