Add subscription graph (#839)

Display a job's usage's using the bar chart. Closes #838
AcademySoftwareFoundation · Dec 12, 2020 · 70810ac · 70810ac
1 parent 806488d
commit 70810ac
Show file tree

Hide file tree

Showing 4 changed files with 294 additions and 1 deletion.
diff --git a/cuegui/cuegui/DarkPalette.py b/cuegui/cuegui/DarkPalette.py
@@ -127,5 +127,5 @@ def ColorF(r, g, b):
 COLOR_SHOW_FOREGROUND = GreyF(0.79)
 COLOR_JOB_FOREGROUND = GreyF(0.79)
 
-KILL_ICON_COLOUR = QtGui.QColor(224, 52, 52) 
+KILL_ICON_COLOUR = QtGui.QColor(224, 52, 52)
 PAUSE_ICON_COLOUR = QtGui.QColor(88, 163, 209)
diff --git a/cuegui/cuegui/ItemDelegate.py b/cuegui/cuegui/ItemDelegate.py
@@ -210,6 +210,56 @@ def paint(self, painter, option, index):
  AbstractDelegate.paint(self, painter, option, index)
 
 
+class SubBookingBarDelegate(AbstractDelegate):
+ def __init__(self, parent, *args):
+ AbstractDelegate.__init__(self, parent, *args)
+
+ def paint(self, painter, option, index):
+ # This itemFromIndex could cause problems
+ sub = self.parent().itemFromIndex(index).rpcObject
+
+ # The total allocation core count x 100 to match sub value
+ alloc_obj = index.data(QtCore.Qt.DisplayRole)
+ alloc_size = (alloc_obj.data.stats.cores) * 100
+
+ rect = option.rect.adjusted(12, 6, -12, -6)
+ painter.save()
+ try:
+ self._drawBackground(painter, option, index)
+ try:
+ subRunning = sub.data.reserved_cores
+ subMin = int(sub.data.size)
+ subMax = int(sub.data.burst)
+ ratio = rect.width() / alloc_size
+
+ if alloc_size:
+ painter.fillRect(
+ rect.adjusted(0, 2, 0, -2),
+ RGB_FRAME_STATE[opencue.api.job_pb2.WAITING])
+
+ if subRunning:
+ painter.fillRect(
+ rect.adjusted(0, 0, -int(ceil(ratio * (alloc_size - subRunning))), 0),
+ RGB_FRAME_STATE[opencue.api.job_pb2.RUNNING])
+
+ painter.setPen(cuegui.Style.ColorTheme.PAUSE_ICON_COLOUR)
+ x = min(rect.x() + ratio * subMin, option.rect.right() - 9)
+ painter.drawLine(x, option.rect.y(), x,
+ option.rect.y() + option.rect.height())
+
+ painter.setPen(cuegui.Style.ColorTheme.KILL_ICON_COLOUR)
+ x = min(rect.x() + ratio * subMax, option.rect.right() - 6)
+ painter.drawLine(x, option.rect.y(), x,
+ option.rect.y() + option.rect.height())
+
+ except ZeroDivisionError:
+ pass
+
+ finally:
+ painter.restore()
+ del painter
+
+
 class JobThinProgressBarDelegate(AbstractDelegate):
  def __init__(self, parent, *args):
  AbstractDelegate.__init__(self, parent, *args)

diff --git a/cuegui/cuegui/SubscriptionGraphWidget.py b/cuegui/cuegui/SubscriptionGraphWidget.py
@@ -0,0 +1,214 @@
+from builtins import str
+
+import opencue
+
+from PySide2 import QtCore
+from PySide2 import QtGui
+from PySide2 import QtWidgets
+
+import cuegui.AbstractTreeWidget
+import cuegui.AbstractWidgetItem
+import cuegui.Constants
+import cuegui.CreatorDialog
+import cuegui.ItemDelegate
+import cuegui.MenuActions
+import cuegui.ShowDialog
+import cuegui.Utils
+
+
+class SubscriptionGraphWidget(QtWidgets.QWidget):
+ def __init__(self, parent):
+ QtWidgets.QWidget.__init__(self, parent)
+
+ self.__shows = []
+ self.__showMenuActions = {}
+ self.__subBars = []
+ self.__timer = QtCore.QTimer(self)
+ self.__timer.timeout.connect(self.update_data)
+ self.__timer.setInterval(1000 * 5)
+
+ widget = QtWidgets.QWidget()
+ self.mainLayout = QtWidgets.QHBoxLayout(widget)
+ self.mainLayout.setContentsMargins(0, 0, 0, 0)
+ scroll = QtWidgets.QScrollArea()
+ scroll.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff)
+ scroll.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOn)
+ scroll.setWidgetResizable(True)
+ scroll.setWidget(widget)
+
+ showMenuBtn = QtWidgets.QPushButton(" Shows")
+ showMenuBtn.setFixedWidth(100)
+ showMenuBtn.pressed.connect(self.__showMenuCheck)
+
+ self.__showMenu = QtWidgets.QMenu(self)
+ showMenuBtn.setMenu(self.__showMenu)
+ self.__showMenu.setStyleSheet("QMenu { menu-scrollable: 1; }")
+
+ showMenuBtn.setFocusPolicy(QtCore.Qt.NoFocus)
+ self.__showMenu.setFont(cuegui.Constants.STANDARD_FONT)
+ self.__showMenu.triggered.connect(self.__showMenuHandle)
+
+ layout = QtWidgets.QVBoxLayout(self)
+ layout.addWidget(showMenuBtn)
+ layout.addWidget(scroll)
+
+ def create_widgets(self):
+ self.clearLayout(self.mainLayout)
+ for show in self.__shows:
+ widget = QtWidgets.QWidget()
+ layout = QtWidgets.QVBoxLayout(widget)
+
+ show_label = QtWidgets.QLabel(show)
+ layout.addWidget(show_label)
+
+ sub_bar = SubGraphTreeWidget(self)
+ sub_bar.setShow(show)
+ layout.addWidget(sub_bar)
+ self.__subBars.append(sub_bar)
+
+ self.mainLayout.addWidget(widget)
+
+ self.__timer.start()
+
+ def clearLayout(self, layout):
+ while layout.count() > 0:
+ item = layout.takeAt(0)
+ if not item:
+ continue
+ w = item.widget()
+ if w:
+ w.deleteLater()
+
+ def __showMenuHandle(self, action):
+ if action.text() == 'All Shows':
+ try:
+ self.__shows = sorted(set([job.show() for job in opencue.api.getJobs(include_finished=True)]))
+ except Exception as e:
+ self.__shows = []
+ self.__showMenuUpdate()
+ elif action.text() == 'Clear':
+ self.__shows = []
+ self.__showMenuUpdate()
+ elif action.isChecked():
+ self.__shows.append(action.text())
+ self.__showMenuUpdate()
+ else:
+ self.__shows.remove(action.text())
+ self.__showMenuUpdate()
+
+ def __showMenuUpdate(self):
+ self.__showMenu.clear()
+ self.__showMenuActions = {}
+
+ # add all shows menu item
+ action = QtWidgets.QAction('All Shows', self.__showMenu)
+ self.__showMenu.addAction(action)
+ self.__showMenuActions['All Shows'] = action
+ action = QtWidgets.QAction('Clear', self.__showMenu)
+ self.__showMenu.addAction(action)
+ self.__showMenuActions['Clear'] = action
+ self.__showMenu.addSeparator()
+
+ try:
+ shows = sorted(set([job.show() for job in opencue.api.getJobs(include_finished=True)]))
+ except Exception as e:
+ shows = []
+
+ for show in shows:
+ action = QtWidgets.QAction(show, self.__showMenu)
+ action.setCheckable(True)
+ if show in self.__shows:
+ action.setChecked(True)
+ self.__showMenu.addAction(action)
+ self.__showMenuActions[show] = action
+
+ self.create_widgets()
+
+ def __showMenuCheck(self):
+ """Populate the list of shows if it is empty"""
+ if not self.__showMenuActions:
+ self.__showMenuUpdate()
+
+ def update_data(self):
+ for sub_bar in self.__subBars:
+ sub_bar._getUpdate()
+
+
+class SubGraphTreeWidget(cuegui.AbstractTreeWidget.AbstractTreeWidget):
+ def __init__(self, parent):
+ self.startColumnsForType(cuegui.Constants.TYPE_SUB)
+ self.addColumn("_Name", 110, id=0,
+ data=lambda sub: sub.data.allocation_name)
+ self.addColumn("_Booking Bar", 125, id=1,
+ delegate=cuegui.ItemDelegate.SubBookingBarDelegate,
+ data=lambda sub: opencue.api.findAllocation(sub.data.allocation_name))
+ cuegui.AbstractTreeWidget.AbstractTreeWidget.__init__(self, parent)
+
+ self.header().hide()
+ self.__show = None
+
+ # Used to build right click context menus
+ self.__menuActions = cuegui.MenuActions.MenuActions(
+ self, self.updateSoon, self.selectedObjects, self.getShow)
+
+ self.setMinimumSize(240, 80)
+
+ # self.setUpdateInterval(30)
+
+ def setShow(self, show=None):
+ self._itemsLock.lockForWrite()
+ try:
+ if not show:
+ self.__show = None
+ elif cuegui.Utils.isShow(show):
+ self.__show = show
+ elif isinstance(show, str):
+ try:
+ self.__show = opencue.api.findShow(show)
+ except:
+ pass
+ self._update()
+ finally:
+ self._itemsLock.unlock()
+
+ def getShow(self):
+ return self.__show
+
+ def _createItem(self, object):
+ """Creates and returns the proper item"""
+ return SubscriptionWidgetItem(object, self)
+
+ def _getUpdate(self):
+ """Returns the proper data from the cuebot"""
+ self._itemsLock.lockForWrite()
+ try:
+ if self.__show:
+ return self.__show.getSubscriptions()
+ return []
+ finally:
+ self._itemsLock.unlock()
+
+ def contextMenuEvent(self, e):
+ """When right clicking on an item, this raises a context menu"""
+
+ menu = QtWidgets.QMenu()
+ self.__menuActions.subscriptions().addAction(menu, "editSize")
+ self.__menuActions.subscriptions().addAction(menu, "editBurst")
+ menu.addSeparator()
+ self.__menuActions.subscriptions().addAction(menu, "delete")
+ menu.addSeparator()
+ if self.__show:
+ new_action = QtWidgets.QAction('Add new subscription', self)
+ new_action.triggered.connect(self.createSubscription)
+ menu.addAction(new_action)
+ menu.exec_(QtCore.QPoint(e.globalX(),e.globalY()))
+
+ def createSubscription(self):
+ d = cuegui.CreatorDialog.SubscriptionCreatorDialog(show=self.__show)
+ d.exec_()
+
+
+class SubscriptionWidgetItem(cuegui.AbstractWidgetItem.AbstractWidgetItem):
+ def __init__(self, object, parent):
+ cuegui.AbstractWidgetItem.AbstractWidgetItem.__init__(
+ self, cuegui.Constants.TYPE_SUB, object, parent)
diff --git a/cuegui/cuegui/plugins/SubscriptionsGraphPlugin.py b/cuegui/cuegui/plugins/SubscriptionsGraphPlugin.py
@@ -0,0 +1,29 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+
+from PySide2 import QtCore
+from PySide2 import QtWidgets
+
+import cuegui.AbstractDockWidget
+import cuegui.SubscriptionGraphWidget
+
+PLUGIN_NAME = 'Subscription Graphs'
+PLUGIN_CATEGORY = "Cuecommander"
+PLUGIN_DESCRIPTION = "An administrator interface to subscriptions"
+PLUGIN_REQUIRES = "CueCommander"
+PLUGIN_PROVIDES = 'SubscriptionGraphDockWidget'
+
+
+class SubscriptionGraphDockWidget(cuegui.AbstractDockWidget.AbstractDockWidget):
+ """This builds what is displayed on the dock widget"""
+ def __init__(self, parent):
+ cuegui.AbstractDockWidget.AbstractDockWidget.__init__(self, parent, PLUGIN_NAME)
+
+ self.__splitter = QtWidgets.QSplitter(QtCore.Qt.Horizontal)
+ self.layout().addWidget(self.__splitter)
+
+ self.__subgraph_widget = cuegui.SubscriptionGraphWidget.SubscriptionGraphWidget(self)
+ self.__splitter.addWidget(self.__subgraph_widget)
+
+ self.setMinimumSize(500, 190)