From 85a7d2e24e3f712eea225cb5baac4ea236cdedbe Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:27:45 +0200 Subject: [PATCH 01/67] added more information about plugin to report --- client/ayon_core/tools/publisher/models/publish.py | 8 +++++++- .../tools/publisher/publish_report_viewer/report_items.py | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/models/publish.py b/client/ayon_core/tools/publisher/models/publish.py index ef207bfb79..42dcca7bb3 100644 --- a/client/ayon_core/tools/publisher/models/publish.py +++ b/client/ayon_core/tools/publisher/models/publish.py @@ -172,7 +172,7 @@ def get_report( "crashed_file_paths": crashed_file_paths, "id": uuid.uuid4().hex, "created_at": now.isoformat(), - "report_version": "1.0.1", + "report_version": "1.1.0", } def _add_plugin_data_item(self, plugin: pyblish.api.Plugin): @@ -194,11 +194,17 @@ def _create_plugin_data_item( if hasattr(plugin, "label"): label = plugin.label + plugin_type = "instance" if plugin.__instanceEnabled__ else "context" + return { "id": plugin.id, "name": plugin.__name__, "label": label, "order": plugin.order, + "filepath": inspect.getfile(plugin), + "docstring": inspect.getdoc(plugin), + "plugin_type": plugin_type, + "families": list(plugin.families), "targets": list(plugin.targets), "instances_data": [], "actions_data": [], diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py b/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py index 206f999bac..cfc2fbfd67 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py @@ -13,6 +13,12 @@ def __init__(self, plugin_data): self.skipped = plugin_data["skipped"] self.passed = plugin_data["passed"] + # Introduced in report '1.1.0' + self.docstring = plugin_data.get("docstring") + self.filepath = plugin_data.get("filepath") + self.plugin_type = plugin_data.get("plugin_type") + self.families = plugin_data.get("families") + errored = False for instance_data in plugin_data["instances_data"]: for log_item in instance_data["logs"]: From d0ea1a31b1562a0803f62fc8c040eb7bb47bf941 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:30:25 +0200 Subject: [PATCH 02/67] mark tab widget as active to avoid long loading time --- .../publish_report_viewer/widgets.py | 103 +++++++++++++++--- 1 file changed, 87 insertions(+), 16 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 61a52533ba..3e2c6adc8a 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -23,32 +23,73 @@ class PluginLoadReportModel(QtGui.QStandardItemModel): - def set_report(self, report): - parent = self.invisibleRootItem() - parent.removeRows(0, parent.rowCount()) + def __init__(self): + super().__init__() + self._traceback_by_filepath = {} + self._items_by_filepath = {} + self._is_active = True + self._need_refresh = False + + def set_active(self, is_active): + if self._is_active is is_active: + return + self._is_active = is_active + self._update_items() + def set_report(self, report): + self._need_refresh = True if report is None: + self._traceback_by_filepath.clear() + self._update_items() + return + + filepaths = set(report.crashed_plugin_paths.keys()) + to_remove = set(self._traceback_by_filepath) - filepaths + for filepath in filepaths: + self._traceback_by_filepath[filepath] = ( + report.crashed_plugin_paths[filepath] + ) + + for filepath in to_remove: + self._traceback_by_filepath.pop(filepath) + self._update_items() + + def _update_items(self): + if not self._is_active or not self._need_refresh: + return + parent = self.invisibleRootItem() + if not self._traceback_by_filepath: + parent.removeRows(0, parent.rowCount()) return new_items = [] new_items_by_filepath = {} - for filepath in report.crashed_plugin_paths.keys(): + to_remove = ( + set(self._items_by_filepath) - set(self._traceback_by_filepath) + ) + for filepath in self._traceback_by_filepath: + if filepath in self._items_by_filepath: + continue item = QtGui.QStandardItem(filepath) new_items.append(item) new_items_by_filepath[filepath] = item + self._items_by_filepath[filepath] = item - if not new_items: - return + if new_items: + parent.appendRows(new_items) - parent.appendRows(new_items) for filepath, item in new_items_by_filepath.items(): - traceback_txt = report.crashed_plugin_paths[filepath] + traceback_txt = self._traceback_by_filepath[filepath] detail_item = QtGui.QStandardItem() detail_item.setData(filepath, FILEPATH_ROLE) detail_item.setData(traceback_txt, TRACEBACK_ROLE) detail_item.setData(True, IS_DETAIL_ITEM_ROLE) item.appendRow(detail_item) + for filepath in to_remove: + item = self._items_by_filepath.pop(filepath) + parent.removeRow(item.row()) + class DetailWidget(QtWidgets.QTextEdit): def __init__(self, text, *args, **kwargs): @@ -95,10 +136,12 @@ def __init__(self, parent): self._model = model self._widgets_by_filepath = {} - def _on_expand(self, index): - for row in range(self._model.rowCount(index)): - child_index = self._model.index(row, index.column(), index) - self._create_widget(child_index) + def set_active(self, is_active): + self._model.set_active(is_active) + + def set_report(self, report): + self._widgets_by_filepath = {} + self._model.set_report(report) def showEvent(self, event): super().showEvent(event) @@ -108,6 +151,11 @@ def resizeEvent(self, event): super().resizeEvent(event) self._update_widgets_size_hints() + def _on_expand(self, index): + for row in range(self._model.rowCount(index)): + child_index = self._model.index(row, index.column(), index) + self._create_widget(child_index) + def _update_widgets_size_hints(self): for item in self._widgets_by_filepath.values(): widget, index = item @@ -136,10 +184,6 @@ def _create_widget(self, index): self._view.setIndexWidget(index, widget) self._widgets_by_filepath[filepath] = (widget, index) - def set_report(self, report): - self._widgets_by_filepath = {} - self._model.set_report(report) - class ZoomPlainText(QtWidgets.QPlainTextEdit): min_point_size = 1.0 @@ -229,6 +273,8 @@ def __init__(self, parent): layout.setContentsMargins(0, 0, 0, 0) layout.addWidget(output_widget) + self._is_active = True + self._need_refresh = False self._output_widget = output_widget self._report_item = None self._instance_filter = set() @@ -237,21 +283,33 @@ def __init__(self, parent): def clear(self): self._output_widget.setPlainText("") + def set_active(self, is_active): + if self._is_active is is_active: + return + self._is_active = is_active + self._update_logs() + def set_report(self, report): self._report_item = report self._plugin_filter = set() self._instance_filter = set() + self._need_refresh = True self._update_logs() def set_plugin_filter(self, plugin_filter): self._plugin_filter = plugin_filter + self._need_refresh = True self._update_logs() def set_instance_filter(self, instance_filter): self._instance_filter = instance_filter + self._need_refresh = True self._update_logs() def _update_logs(self): + if not self._is_active or not self._need_refresh: + return + if not self._report_item: self._output_widget.setPlainText("") return @@ -422,6 +480,8 @@ def __init__(self, parent=None): logs_text_widget = DetailsWidget(details_tab_widget) plugin_load_report_widget = PluginLoadReportWidget(details_tab_widget) + plugin_load_report_widget.set_active(False) + details_tab_widget.addTab(logs_text_widget, "Logs") details_tab_widget.addTab(plugin_load_report_widget, "Crashed plugins") @@ -440,6 +500,7 @@ def __init__(self, parent=None): layout.addWidget(middle_widget, 0) layout.addWidget(details_widget, 1) + details_tab_widget.currentChanged.connect(self._on_tab_change) instances_view.selectionModel().selectionChanged.connect( self._on_instance_change ) @@ -458,6 +519,7 @@ def __init__(self, parent=None): details_popup_btn.clicked.connect(self._on_details_popup) details_popup.closed.connect(self._on_popup_close) + self._current_tab_idx = 0 self._ignore_selection_changes = False self._report_item = None self._logs_text_widget = logs_text_widget @@ -517,6 +579,15 @@ def set_report(self, report): self._instances_view.expandAll() self._plugins_view.expandAll() + def _on_tab_change(self, new_idx): + if self._current_tab_idx == new_idx: + return + old_widget = self._details_tab_widget.widget(self._current_tab_idx) + new_widget = self._details_tab_widget.widget(new_idx) + self._current_tab_idx = new_idx + old_widget.set_active(False) + new_widget.set_active(True) + def _on_instance_change(self, *_args): if self._ignore_selection_changes: return From d073f15a7a8dbd8e9271459e210384c52963898b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:30:43 +0200 Subject: [PATCH 03/67] added helper 'ElideLabel' widget to elide long text --- client/ayon_core/tools/utils/__init__.py | 2 + client/ayon_core/tools/utils/widgets.py | 64 ++++++++++++++++++++++++ 2 files changed, 66 insertions(+) diff --git a/client/ayon_core/tools/utils/__init__.py b/client/ayon_core/tools/utils/__init__.py index 4b5fbeaf67..1eada0c67a 100644 --- a/client/ayon_core/tools/utils/__init__.py +++ b/client/ayon_core/tools/utils/__init__.py @@ -5,6 +5,7 @@ ComboBox, CustomTextComboBox, PlaceholderLineEdit, + ElideLabel, ExpandingTextEdit, BaseClickableFrame, ClickableFrame, @@ -88,6 +89,7 @@ "ComboBox", "CustomTextComboBox", "PlaceholderLineEdit", + "ElideLabel", "ExpandingTextEdit", "BaseClickableFrame", "ClickableFrame", diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 28331fbc35..af85fc915e 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -104,6 +104,70 @@ def __init__(self, *args, **kwargs): self.setPalette(filter_palette) +class ElideLabel(QtWidgets.QLabel): + """Label which elide text. + + By default, elide happens in middle. Can be changed with + 'set_elide_mode' method. + """ + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.setSizePolicy( + QtWidgets.QSizePolicy.Expanding, + QtWidgets.QSizePolicy.Preferred + ) + # Store text set during init + self._text = self.text() + # Define initial elide mode + self._elide_mode = QtCore.Qt.ElideMiddle + # Make sure that text of QLabel is empty + super().setText("") + + def setText(self, text): + # Update private text attribute and force update + self._text = text + self.update() + + def setWordWrap(self, word_wrap): + # Word wrap is not supported in 'ElideLabel' + if word_wrap: + raise ValueError("Word wrap is not supported in 'ElideLabel'.") + + def set_set(self, text): + self.setText(text) + + def set_elide_mode(self, elide_mode): + """Change elide type. + + Args: + elide_mode: Possible elide type. Available in 'QtCore.Qt' + 'ElideLeft', 'ElideRight' and 'ElideMiddle'. + + """ + if elide_mode == QtCore.Qt.ElideNone: + raise ValueError( + "Invalid elide type. 'ElideNone' is not supported." + ) + + if elide_mode not in ( + QtCore.Qt.ElideLeft, + QtCore.Qt.ElideRight, + QtCore.Qt.ElideMiddle, + ): + raise ValueError(f"Unknown value '{elide_mode}'") + self._elide_mode = elide_mode + + def paintEvent(self, event): + super().paintEvent(event) + + painter = QtGui.QPainter(self) + fm = painter.fontMetrics() + elided_line = fm.elidedText( + self._text, self._elide_mode, self.width() + ) + painter.drawText(QtCore.QPoint(0, fm.ascent()), elided_line) + + class ExpandingTextEdit(QtWidgets.QTextEdit): """QTextEdit which does not have sroll area but expands height.""" From 2a0208a49406537aad756f7305b1cdc9a235e0eb Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 15:48:37 +0200 Subject: [PATCH 04/67] added plugin details widget --- .../publish_report_viewer/widgets.py | 161 +++++++++++++++++- 1 file changed, 159 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 3e2c6adc8a..1dc4eccce8 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -1,7 +1,7 @@ from math import ceil from qtpy import QtWidgets, QtCore, QtGui -from ayon_core.tools.utils import NiceCheckbox +from ayon_core.tools.utils import NiceCheckbox, ElideLabel # from ayon_core.tools.utils import DeselectableTreeView from .constants import ( @@ -352,6 +352,155 @@ def _set_logs(self, logs): self._output_widget.setPlainText(text) +class PluginDetailsWidget(QtWidgets.QWidget): + def __init__(self, plugin_item, parent): + super().__init__(parent) + + content_widget = QtWidgets.QWidget(self) + + plugin_label_widget = QtWidgets.QLabel(content_widget) + + plugin_type_label = QtWidgets.QLabel("Plugin type:") + plugin_type_widget = QtWidgets.QLabel(content_widget) + + plugin_path_label = QtWidgets.QLabel("File Path:") + plugin_path_widget = ElideLabel(content_widget) + + plugin_doc_widget = QtWidgets.QLabel(content_widget) + plugin_doc_widget.setWordWrap(True) + + plugin_families_label = QtWidgets.QLabel("Families:") + plugin_families_widget = QtWidgets.QLabel(content_widget) + plugin_families_widget.setWordWrap(True) + + plugin_label_widget.setText(plugin_item.label or plugin_item.name) + plugin_doc_widget.setText(plugin_item.docstring or "N/A") + plugin_type_widget.setText(plugin_item.plugin_type or "N/A") + plugin_path_widget.setText(plugin_item.filepath or "N/A") + plugin_path_widget.setToolTip(plugin_item.filepath or None) + plugin_families_widget.setText(str(plugin_item.families or "N/A")) + + row = 0 + + content_layout = QtWidgets.QGridLayout(content_widget) + content_layout.setContentsMargins(0, 0, 0, 0) + content_layout.setColumnStretch(0, 0) + content_layout.setColumnStretch(1, 1) + + content_layout.addWidget(plugin_label_widget, row, 0, 1, 2) + row += 1 + + content_layout.addWidget(plugin_doc_widget, row, 0, 1, 2) + row += 1 + + content_layout.addWidget(plugin_type_label, row, 0) + content_layout.addWidget(plugin_type_widget, row, 1) + row += 1 + + content_layout.addWidget(plugin_path_label, row, 0) + content_layout.addWidget(plugin_path_widget, row, 1) + row += 1 + + content_layout.addWidget(plugin_families_label, row, 0) + content_layout.addWidget(plugin_families_widget, row, 1) + row += 1 + + main_layout = QtWidgets.QVBoxLayout(self) + main_layout.setContentsMargins(0, 0, 0, 0) + main_layout.addWidget(content_widget, 0) + + +class PluginsDetailsWidget(QtWidgets.QWidget): + def __init__(self, parent): + super().__init__(parent) + + scroll_area = QtWidgets.QScrollArea(self) + scroll_area.setWidgetResizable(True) + + content_widget = QtWidgets.QWidget(scroll_area) + + scroll_area.setWidget(content_widget) + + content_layout = QtWidgets.QVBoxLayout(content_widget) + content_layout.addStretch(1) + + main_layout = QtWidgets.QVBoxLayout(self) + main_layout.setContentsMargins(0, 0, 0, 0) + main_layout.addWidget(scroll_area, 1) + + self._scroll_area = scroll_area + self._content_layout = content_layout + self._content_widget = content_widget + + self._widgets_by_plugin_id = {} + + self._is_active = True + self._need_refresh = False + + self._report_item = None + self._plugin_filter = set() + self._plugin_ids = None + + def set_active(self, is_active): + if self._is_active is is_active: + return + self._is_active = is_active + self._update_widgets() + + def set_plugin_filter(self, plugin_filter): + self._plugin_filter = plugin_filter + self._need_refresh = True + self._update_widgets() + + def set_report(self, report): + self._report_item = report + self._plugin_ids = None + self._plugin_filter = set() + self._need_refresh = True + self._update_widgets() + + def _get_plugin_ids(self): + if self._plugin_ids is not None: + return self._plugin_ids + + # Clear layout and clear widgets + while self._content_layout.count(): + self._content_layout.takeAt(0) + + self._widgets_by_plugin_id.clear() + + plugin_ids = [] + if self._report_item is not None: + plugin_ids = list(self._report_item.plugins_id_order) + self._plugin_ids = plugin_ids + return plugin_ids + + def _update_widgets(self): + if not self._is_active or not self._need_refresh: + return + + self._need_refresh = False + + is_new = len(self._widgets_by_plugin_id) == 0 + for plugin_id in self._get_plugin_ids(): + widget = self._widgets_by_plugin_id.get(plugin_id) + if is_new: + plugin_item = self._report_item.plugins_items_by_id[plugin_id] + widget = PluginDetailsWidget(plugin_item, self._content_widget) + self._widgets_by_plugin_id[plugin_id] = widget + + widget.setVisible( + not self._plugin_filter + or plugin_id in self._plugin_filter + ) + + if is_new: + self._content_layout.addWidget(widget, 0) + + if is_new: + self._content_layout.addStretch(1) + + class DeselectableTreeView(QtWidgets.QTreeView): """A tree view that deselects on clicking on an empty area in the view""" @@ -479,11 +628,16 @@ def __init__(self, parent=None): logs_text_widget = DetailsWidget(details_tab_widget) plugin_load_report_widget = PluginLoadReportWidget(details_tab_widget) + plugins_details_widget = PluginsDetailsWidget(details_tab_widget) plugin_load_report_widget.set_active(False) + plugins_details_widget.set_active(False) details_tab_widget.addTab(logs_text_widget, "Logs") - details_tab_widget.addTab(plugin_load_report_widget, "Crashed plugins") + details_tab_widget.addTab(plugins_details_widget, "Plugins Details") + details_tab_widget.addTab( + plugin_load_report_widget, "Crashed plugins" + ) middle_widget = QtWidgets.QWidget(self) middle_layout = QtWidgets.QGridLayout(middle_widget) @@ -524,6 +678,7 @@ def __init__(self, parent=None): self._report_item = None self._logs_text_widget = logs_text_widget self._plugin_load_report_widget = plugin_load_report_widget + self._plugins_details_widget = plugins_details_widget self._removed_instances_check = removed_instances_check self._instances_view = instances_view @@ -573,6 +728,7 @@ def set_report(self, report): self._plugins_model.set_report(report) self._logs_text_widget.set_report(report) self._plugin_load_report_widget.set_report(report) + self._plugins_details_widget.set_report(report) self._ignore_selection_changes = False @@ -609,6 +765,7 @@ def _on_plugin_change(self, *_args): plugin_ids.add(index.data(ITEM_ID_ROLE)) self._logs_text_widget.set_plugin_filter(plugin_ids) + self._plugins_details_widget.set_plugin_filter(plugin_ids) def _on_skipped_plugin_check(self): self._plugins_proxy.set_ignore_skipped( From f65cf0325bc62f53147074c8206a6a71a5fdf5d9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:04:54 +0200 Subject: [PATCH 05/67] overall fixes of details widget --- client/ayon_core/style/style.css | 12 +++ .../publish_report_viewer/widgets.py | 88 ++++++++++++------- 2 files changed, 69 insertions(+), 31 deletions(-) diff --git a/client/ayon_core/style/style.css b/client/ayon_core/style/style.css index 607fd1fa31..c8ba2ba8f2 100644 --- a/client/ayon_core/style/style.css +++ b/client/ayon_core/style/style.css @@ -1231,6 +1231,18 @@ ValidationArtistMessage QLabel { background: transparent; } +#PluginDetailsContent { + background: {color:bg-inputs}; + border-radius: 0.2em; +} +#PluginDetailsContent #PluginLabel { + font-size: 14pt; + font-weight: bold; +} +#PluginDetailsContent #PluginFormLabel { + font-weight: bold; +} + CreateNextPageOverlay { font-size: 32pt; } diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 1dc4eccce8..263ca0464a 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -356,46 +356,66 @@ class PluginDetailsWidget(QtWidgets.QWidget): def __init__(self, plugin_item, parent): super().__init__(parent) - content_widget = QtWidgets.QWidget(self) + content_widget = QtWidgets.QFrame(self) + content_widget.setObjectName("PluginDetailsContent") plugin_label_widget = QtWidgets.QLabel(content_widget) - - plugin_type_label = QtWidgets.QLabel("Plugin type:") - plugin_type_widget = QtWidgets.QLabel(content_widget) + plugin_label_widget.setObjectName("PluginLabel") + plugin_label_widget.setTextInteractionFlags( + QtCore.Qt.TextBrowserInteraction + ) plugin_path_label = QtWidgets.QLabel("File Path:") plugin_path_widget = ElideLabel(content_widget) - - plugin_doc_widget = QtWidgets.QLabel(content_widget) - plugin_doc_widget.setWordWrap(True) + plugin_path_widget.set_elide_mode(QtCore.Qt.ElideLeft) plugin_families_label = QtWidgets.QLabel("Families:") plugin_families_widget = QtWidgets.QLabel(content_widget) + plugin_families_widget.setTextInteractionFlags( + QtCore.Qt.TextBrowserInteraction + ) plugin_families_widget.setWordWrap(True) - plugin_label_widget.setText(plugin_item.label or plugin_item.name) - plugin_doc_widget.setText(plugin_item.docstring or "N/A") - plugin_type_widget.setText(plugin_item.plugin_type or "N/A") + for label_widget in ( + plugin_path_label, + plugin_families_label, + ): + label_widget.setObjectName("PluginFormLabel") + + plugin_doc_widget = QtWidgets.QLabel(content_widget) + plugin_doc_widget.setWordWrap(True) + plugin_doc_widget.setTextInteractionFlags( + QtCore.Qt.TextBrowserInteraction + ) + + plugin_label = plugin_item.label or plugin_item.name + if plugin_item.plugin_type: + plugin_label += " ({})".format( + plugin_item.plugin_type.capitalize() + ) + plugin_label_widget.setText(plugin_label) + # plugin_type_widget.setText(plugin_item.plugin_type or "N/A") plugin_path_widget.setText(plugin_item.filepath or "N/A") plugin_path_widget.setToolTip(plugin_item.filepath or None) plugin_families_widget.setText(str(plugin_item.families or "N/A")) + plugin_doc_widget.setText(plugin_item.docstring or "N/A") row = 0 content_layout = QtWidgets.QGridLayout(content_widget) - content_layout.setContentsMargins(0, 0, 0, 0) + content_layout.setContentsMargins(8, 8, 8, 8) content_layout.setColumnStretch(0, 0) content_layout.setColumnStretch(1, 1) content_layout.addWidget(plugin_label_widget, row, 0, 1, 2) row += 1 - content_layout.addWidget(plugin_doc_widget, row, 0, 1, 2) - row += 1 - - content_layout.addWidget(plugin_type_label, row, 0) - content_layout.addWidget(plugin_type_widget, row, 1) - row += 1 + # Hide docstring if it is empty + if plugin_item.docstring: + content_layout.addWidget(plugin_doc_widget, row, 0, 1, 2) + row += 1 + else: + plugin_doc_widget.setVisible(False) content_layout.addWidget(plugin_path_label, row, 0) content_layout.addWidget(plugin_path_widget, row, 1) @@ -417,12 +437,19 @@ def __init__(self, parent): scroll_area = QtWidgets.QScrollArea(self) scroll_area.setWidgetResizable(True) - content_widget = QtWidgets.QWidget(scroll_area) + scroll_content_widget = QtWidgets.QWidget(scroll_area) - scroll_area.setWidget(content_widget) + scroll_area.setWidget(scroll_content_widget) + + content_widget = QtWidgets.QWidget(scroll_content_widget) content_layout = QtWidgets.QVBoxLayout(content_widget) - content_layout.addStretch(1) + content_layout.setContentsMargins(0, 0, 0, 0) + + scroll_content_layout = QtWidgets.QVBoxLayout(scroll_content_widget) + scroll_content_layout.setContentsMargins(0, 0, 0, 0) + scroll_content_layout.addWidget(content_widget, 0) + scroll_content_layout.addStretch(1) main_layout = QtWidgets.QVBoxLayout(self) main_layout.setContentsMargins(0, 0, 0, 0) @@ -433,6 +460,7 @@ def __init__(self, parent): self._content_widget = content_widget self._widgets_by_plugin_id = {} + self._stretch_item_index = 0 self._is_active = True self._need_refresh = False @@ -448,15 +476,15 @@ def set_active(self, is_active): self._update_widgets() def set_plugin_filter(self, plugin_filter): - self._plugin_filter = plugin_filter self._need_refresh = True + self._plugin_filter = plugin_filter self._update_widgets() def set_report(self, report): - self._report_item = report self._plugin_ids = None self._plugin_filter = set() self._need_refresh = True + self._report_item = report self._update_widgets() def _get_plugin_ids(self): @@ -465,7 +493,11 @@ def _get_plugin_ids(self): # Clear layout and clear widgets while self._content_layout.count(): - self._content_layout.takeAt(0) + item = self._content_layout.takeAt(0) + widget = item.widget() + if widget: + widget.setVisible(False) + widget.deleteLater() self._widgets_by_plugin_id.clear() @@ -481,25 +513,19 @@ def _update_widgets(self): self._need_refresh = False - is_new = len(self._widgets_by_plugin_id) == 0 for plugin_id in self._get_plugin_ids(): widget = self._widgets_by_plugin_id.get(plugin_id) - if is_new: + if widget is None: plugin_item = self._report_item.plugins_items_by_id[plugin_id] widget = PluginDetailsWidget(plugin_item, self._content_widget) self._widgets_by_plugin_id[plugin_id] = widget + self._content_layout.addWidget(widget, 0) widget.setVisible( not self._plugin_filter or plugin_id in self._plugin_filter ) - if is_new: - self._content_layout.addWidget(widget, 0) - - if is_new: - self._content_layout.addStretch(1) - class DeselectableTreeView(QtWidgets.QTreeView): """A tree view that deselects on clicking on an empty area in the view""" From f16cb1f4e137fa0b20fd18e06472bbf74b2735b7 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:05:09 +0200 Subject: [PATCH 06/67] added option to copy text from ElideLabel --- client/ayon_core/tools/utils/widgets.py | 36 +++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index af85fc915e..e58333a07d 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -107,8 +107,11 @@ def __init__(self, *args, **kwargs): class ElideLabel(QtWidgets.QLabel): """Label which elide text. - By default, elide happens in middle. Can be changed with + By default, elide happens on right side. Can be changed with 'set_elide_mode' method. + + It is not possible to use other features of QLabel like word wrap or + interactive text. This is a simple label which elide text. """ def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -119,7 +122,7 @@ def __init__(self, *args, **kwargs): # Store text set during init self._text = self.text() # Define initial elide mode - self._elide_mode = QtCore.Qt.ElideMiddle + self._elide_mode = QtCore.Qt.ElideRight # Make sure that text of QLabel is empty super().setText("") @@ -133,6 +136,30 @@ def setWordWrap(self, word_wrap): if word_wrap: raise ValueError("Word wrap is not supported in 'ElideLabel'.") + def contextMenuEvent(self, event): + menu = self.create_context_menu(event.pos()) + if menu is None: + event.ignore() + return + event.accept() + menu.setAttribute(QtCore.Qt.WA_DeleteOnClose) + menu.popup(event.globalPos()) + + def create_context_menu(self, pos): + if not self._text: + return None + menu = QtWidgets.QMenu(self) + + # Copy text action + copy_action = menu.addAction("Copy") + copy_action.setObjectName("edit-copy") + icon = QtGui.QIcon.fromTheme("edit-copy") + if not icon.isNull(): + copy_action.setIcon(icon) + + copy_action.triggered.connect(self._on_copy_text) + return menu + def set_set(self, text): self.setText(text) @@ -156,6 +183,7 @@ def set_elide_mode(self, elide_mode): ): raise ValueError(f"Unknown value '{elide_mode}'") self._elide_mode = elide_mode + self.update() def paintEvent(self, event): super().paintEvent(event) @@ -167,6 +195,10 @@ def paintEvent(self, event): ) painter.drawText(QtCore.QPoint(0, fm.ascent()), elided_line) + def _on_copy_text(self): + clipboard = QtWidgets.QApplication.clipboard() + clipboard.setText(self._text) + class ExpandingTextEdit(QtWidgets.QTextEdit): """QTextEdit which does not have sroll area but expands height.""" From 3977a21820d0d6e5d8f547e95a0567b0f8e1450e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:33:59 +0200 Subject: [PATCH 07/67] use only plugin's docstring --- client/ayon_core/tools/publisher/models/publish.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/publisher/models/publish.py b/client/ayon_core/tools/publisher/models/publish.py index 42dcca7bb3..a973d47a11 100644 --- a/client/ayon_core/tools/publisher/models/publish.py +++ b/client/ayon_core/tools/publisher/models/publish.py @@ -195,14 +195,20 @@ def _create_plugin_data_item( label = plugin.label plugin_type = "instance" if plugin.__instanceEnabled__ else "context" - + # Get docstring + # NOTE we do care only about docstring from the plugin so we can't + # use 'inspect.getdoc' which also looks for docstring in parent + # classes. + docstring = getattr(plugin, "__doc__", None) + if docstring: + docstring = inspect.cleandoc(docstring) return { "id": plugin.id, "name": plugin.__name__, "label": label, "order": plugin.order, "filepath": inspect.getfile(plugin), - "docstring": inspect.getdoc(plugin), + "docstring": docstring, "plugin_type": plugin_type, "families": list(plugin.families), "targets": list(plugin.targets), From cf68742129e89f929793c22255a72ee2f84d2105 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:34:20 +0200 Subject: [PATCH 08/67] added class name and order --- .../publish_report_viewer/widgets.py | 74 ++++++++++++------- 1 file changed, 47 insertions(+), 27 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 263ca0464a..a403bd06fc 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -1,7 +1,7 @@ from math import ceil from qtpy import QtWidgets, QtCore, QtGui -from ayon_core.tools.utils import NiceCheckbox, ElideLabel +from ayon_core.tools.utils import NiceCheckbox, ElideLabel, SeparatorWidget # from ayon_core.tools.utils import DeselectableTreeView from .constants import ( @@ -361,51 +361,66 @@ def __init__(self, plugin_item, parent): plugin_label_widget = QtWidgets.QLabel(content_widget) plugin_label_widget.setObjectName("PluginLabel") - plugin_label_widget.setTextInteractionFlags( - QtCore.Qt.TextBrowserInteraction - ) - plugin_path_label = QtWidgets.QLabel("File Path:") - plugin_path_widget = ElideLabel(content_widget) - plugin_path_widget.set_elide_mode(QtCore.Qt.ElideLeft) + plugin_doc_widget = QtWidgets.QLabel(content_widget) + plugin_doc_widget.setWordWrap(True) + + form_separator = SeparatorWidget(parent=content_widget) plugin_families_label = QtWidgets.QLabel("Families:") plugin_families_widget = QtWidgets.QLabel(content_widget) - plugin_families_widget.setTextInteractionFlags( - QtCore.Qt.TextBrowserInteraction - ) plugin_families_widget.setWordWrap(True) + plugin_order_label = QtWidgets.QLabel("Order:") + plugin_order_widget = QtWidgets.QLabel(content_widget) + + plugin_class_label = QtWidgets.QLabel("Class:") + plugin_class_widget = QtWidgets.QLabel(content_widget) + + plugin_path_label = QtWidgets.QLabel("File Path:") + plugin_path_widget = ElideLabel(content_widget) + plugin_path_widget.set_elide_mode(QtCore.Qt.ElideLeft) + + # Set interaction flags + for label_widget in ( + plugin_label_widget, + plugin_families_widget, + plugin_order_widget, + plugin_class_widget, + plugin_doc_widget, + ): + label_widget.setTextInteractionFlags( + QtCore.Qt.TextBrowserInteraction + ) + + # Change style of form labels for label_widget in ( - plugin_path_label, plugin_families_label, + plugin_order_label, + plugin_class_label, + plugin_path_label, ): label_widget.setObjectName("PluginFormLabel") - plugin_doc_widget = QtWidgets.QLabel(content_widget) - plugin_doc_widget.setWordWrap(True) - plugin_doc_widget.setTextInteractionFlags( - QtCore.Qt.TextBrowserInteraction - ) - plugin_label = plugin_item.label or plugin_item.name if plugin_item.plugin_type: plugin_label += " ({})".format( plugin_item.plugin_type.capitalize() ) plugin_label_widget.setText(plugin_label) - # plugin_type_widget.setText(plugin_item.plugin_type or "N/A") + plugin_doc_widget.setText(plugin_item.docstring or "N/A") + plugin_families_widget.setText(str(plugin_item.families or "N/A")) + plugin_order_widget.setText(str(plugin_item.order or "N/A")) + plugin_class_widget.setText(plugin_item.name or "N/A") plugin_path_widget.setText(plugin_item.filepath or "N/A") + # Show full path in tooltip plugin_path_widget.setToolTip(plugin_item.filepath or None) - plugin_families_widget.setText(str(plugin_item.families or "N/A")) - plugin_doc_widget.setText(plugin_item.docstring or "N/A") - - row = 0 content_layout = QtWidgets.QGridLayout(content_widget) content_layout.setContentsMargins(8, 8, 8, 8) content_layout.setColumnStretch(0, 0) content_layout.setColumnStretch(1, 1) + row = 0 content_layout.addWidget(plugin_label_widget, row, 0, 1, 2) row += 1 @@ -417,13 +432,18 @@ def __init__(self, plugin_item, parent): else: plugin_doc_widget.setVisible(False) - content_layout.addWidget(plugin_path_label, row, 0) - content_layout.addWidget(plugin_path_widget, row, 1) + content_layout.addWidget(form_separator, row, 0, 1, 2) row += 1 - content_layout.addWidget(plugin_families_label, row, 0) - content_layout.addWidget(plugin_families_widget, row, 1) - row += 1 + for label_widget, value_widget in ( + (plugin_families_label, plugin_families_widget), + (plugin_class_label, plugin_class_widget), + (plugin_order_label, plugin_order_widget), + (plugin_path_label, plugin_path_widget), + ): + content_layout.addWidget(label_widget, row, 0) + content_layout.addWidget(value_widget, row, 1) + row += 1 main_layout = QtWidgets.QVBoxLayout(self) main_layout.setContentsMargins(0, 0, 0, 0) From 3bda6370e3049a163b8f642d45d4e71e32b0b51f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:34:29 +0200 Subject: [PATCH 09/67] added spacing to widgets --- .../ayon_core/tools/publisher/publish_report_viewer/widgets.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index a403bd06fc..de24e1f653 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -465,6 +465,7 @@ def __init__(self, parent): content_layout = QtWidgets.QVBoxLayout(content_widget) content_layout.setContentsMargins(0, 0, 0, 0) + content_layout.setSpacing(10) scroll_content_layout = QtWidgets.QVBoxLayout(scroll_content_widget) scroll_content_layout.setContentsMargins(0, 0, 0, 0) From 08e0eb03b631dbea795ccc8745a6564ea63ab803 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:34:44 +0200 Subject: [PATCH 10/67] remove bold style from labels --- client/ayon_core/style/style.css | 3 --- 1 file changed, 3 deletions(-) diff --git a/client/ayon_core/style/style.css b/client/ayon_core/style/style.css index c8ba2ba8f2..2e3ea53fb3 100644 --- a/client/ayon_core/style/style.css +++ b/client/ayon_core/style/style.css @@ -1239,9 +1239,6 @@ ValidationArtistMessage QLabel { font-size: 14pt; font-weight: bold; } -#PluginDetailsContent #PluginFormLabel { - font-weight: bold; -} CreateNextPageOverlay { font-size: 32pt; From 3eb960a8568e5366ad685572c9107c653b8fb9ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Thu, 8 Aug 2024 18:13:13 +0200 Subject: [PATCH 11/67] :art: use product name for render templates this is fixing issue where product name templates were hardcoded. Old behavior is enabled by default but deprecation warning is issued --- .../ayon_core/pipeline/create/product_name.py | 8 +- .../pipeline/farm/pyblish_functions.py | 276 +++++++++++++----- .../publish/collect_anatomy_instance_data.py | 17 +- client/ayon_core/plugins/publish/integrate.py | 5 + server/settings/tools.py | 8 + 5 files changed, 238 insertions(+), 76 deletions(-) diff --git a/client/ayon_core/pipeline/create/product_name.py b/client/ayon_core/pipeline/create/product_name.py index 8a08bdc36c..597c9f4862 100644 --- a/client/ayon_core/pipeline/create/product_name.py +++ b/client/ayon_core/pipeline/create/product_name.py @@ -1,7 +1,6 @@ import ayon_api - +from ayon_core.lib import StringTemplate, filter_profiles, prepare_template_data from ayon_core.settings import get_project_settings -from ayon_core.lib import filter_profiles, prepare_template_data from .constants import DEFAULT_PRODUCT_TEMPLATE @@ -183,7 +182,10 @@ def get_product_name( fill_pairs[key] = value try: - return template.format(**prepare_template_data(fill_pairs)) + return StringTemplate.format_template( + template=template, + data=prepare_template_data(fill_pairs) + ) except KeyError as exp: raise TemplateFillError( "Value for {} key is missing in template '{}'." diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 72deee185e..fc769a06bb 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -1,5 +1,5 @@ -import os import copy +import os import re import warnings from copy import deepcopy @@ -7,14 +7,11 @@ import attr import ayon_api import clique - -from ayon_core.pipeline import ( - get_current_project_name, - get_representation_path, -) from ayon_core.lib import Logger -from ayon_core.pipeline.publish import KnownPublishError +from ayon_core.pipeline import get_current_project_name, get_representation_path +from ayon_core.pipeline.create import get_product_name from ayon_core.pipeline.farm.patterning import match_aov_pattern +from ayon_core.pipeline.publish import KnownPublishError @attr.s @@ -250,6 +247,9 @@ def create_skeleton_instance( "colorspace": data.get("colorspace") } + if data.get("renderlayer"): + instance_skeleton_data["renderlayer"] = data["renderlayer"] + # skip locking version if we are creating v01 instance_version = data.get("version") # take this if exists if instance_version != 1: @@ -464,7 +464,9 @@ def create_instances_for_aov(instance, skeleton, aov_filter, Args: instance (pyblish.api.Instance): Original instance. skeleton (dict): Skeleton instance data. + aov_filter (dict): AOV filter. skip_integration_repre_list (list): skip + do_not_add_review (bool): Explicitly disable reviews Returns: list of pyblish.api.Instance: Instances created from @@ -515,6 +517,113 @@ def create_instances_for_aov(instance, skeleton, aov_filter, ) +def _get_legacy_product_name_and_group( + product_type, + source_product_name, + task_name, + dynamic_data): + """Get product name with legacy logic. + + This function holds legacy behaviour of creating product name + that is deprecated. This wasn't using product name templates + at all, only hardcoded values. It shouldn't be used anymore, + but transition to templates need careful checking of the project + and studio settings. + + Deprecated: + since 0.4.4 + + Args: + product_type (str): Product type. + source_product_name (str): Source product name. + task_name (str): Task name. + dynamic_data (dict): Dynamic data (camera, aov, ...) + + Returns: + tuple: product name and group name + + """ + warnings.warn("Using legacy product name for renders", + DeprecationWarning) + + if not source_product_name.startswith(product_type): + resulting_group_name = '{}{}{}{}{}'.format( + product_type, + task_name[0].upper(), task_name[1:], + source_product_name[0].upper(), source_product_name[1:]) + else: + resulting_group_name = source_product_name + + # create product name `` + if not source_product_name.startswith(product_type): + resulting_group_name = '{}{}{}{}{}'.format( + product_type, + task_name[0].upper(), task_name[1:], + source_product_name[0].upper(), source_product_name[1:]) + else: + resulting_group_name = source_product_name + + resulting_product_name = '{}'.format(resulting_group_name) + camera = dynamic_data.get("camera") + aov = dynamic_data.get("aov") + if camera: + if not aov: + resulting_product_name = '{}_{}'.format( + resulting_group_name, camera) + elif not aov.startswith(camera): + resulting_product_name = '{}_{}_{}'.format( + resulting_group_name, camera, aov) + else: + resulting_product_name = "{}_{}".format( + resulting_group_name, aov) + else: + if aov: + resulting_product_name = '{}_{}'.format( + resulting_group_name, aov) + + return resulting_product_name, resulting_group_name + + +def _get_product_name_and_group_from_template( + task_entity, + project_name, + host_name, + product_type, + variant, + project_settings, + dynamic_data=None): + """Get product name and group name from template. + + This will get product name and group name from template based on + data provided. It is doing similar work as + `func::_get_legacy_product_name_and_group` but using templates. + + Args: + task_entity (dict): Task entity. + project_name (str): Project name. + host_name (str): Host name. + product_type (str): Product type. + variant (str): Variant. + project_settings (dict): Project settings. + dynamic_data (dict): Dynamic data (aov, renderlayer, camera, ...). + + Returns: + tuple: product name and group name. + + """ + resulting_product_name = get_product_name( + project_name=project_name, + task_name=task_entity["taskName"], + task_type=task_entity["taskType"], + host_name=host_name, + product_type=product_type, + dynamic_data=dynamic_data, + variant=variant, + project_settings=project_settings, + ) + return resulting_product_name, "" + + def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, skip_integration_repre_list, do_not_add_review): """Create instance for each AOV found. @@ -526,10 +635,10 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, instance (pyblish.api.Instance): Original instance. skeleton (dict): Skeleton data for instance (those needed) later by collector. - additional_data (dict): .. + additional_data (dict): ... skip_integration_repre_list (list): list of extensions that shouldn't be published - do_not_addbe _review (bool): explicitly disable review + do_not_add_review (bool): explicitly disable review Returns: @@ -539,68 +648,69 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, ValueError: """ - # TODO: this needs to be taking the task from context or instance - task = os.environ["AYON_TASK_NAME"] anatomy = instance.context.data["anatomy"] - s_product_name = skeleton["productName"] + source_product_name = skeleton["productName"] cameras = instance.data.get("cameras", []) - exp_files = instance.data["expectedFiles"] + expected_files = instance.data["expectedFiles"] log = Logger.get_logger("farm_publishing") instances = [] # go through AOVs in expected files - for aov, files in exp_files[0].items(): - cols, rem = clique.assemble(files) - # we shouldn't have any reminders. And if we do, it should - # be just one item for single frame renders. - if not cols and rem: - if len(rem) != 1: - raise ValueError("Found multiple non related files " - "to render, don't know what to do " - "with them.") - col = rem[0] - ext = os.path.splitext(col)[1].lstrip(".") - else: - # but we really expect only one collection. - # Nothing else make sense. - if len(cols) != 1: - raise ValueError("Only one image sequence type is expected.") # noqa: E501 - ext = cols[0].tail.lstrip(".") - col = list(cols[0]) + for aov, files in expected_files[0].items(): + collected_files = _collect_expected_files_for_aov(files) - # create product name `` - # TODO refactor/remove me - product_type = skeleton["productType"] - if not s_product_name.startswith(product_type): - group_name = '{}{}{}{}{}'.format( - product_type, - task[0].upper(), task[1:], - s_product_name[0].upper(), s_product_name[1:]) - else: - group_name = s_product_name - - # if there are multiple cameras, we need to add camera name - expected_filepath = col[0] if isinstance(col, (list, tuple)) else col - cams = [cam for cam in cameras if cam in expected_filepath] - if cams: - for cam in cams: - if not aov: - product_name = '{}_{}'.format(group_name, cam) - elif not aov.startswith(cam): - product_name = '{}_{}_{}'.format(group_name, cam, aov) - else: - product_name = "{}_{}".format(group_name, aov) - else: - if aov: - product_name = '{}_{}'.format(group_name, aov) - else: - product_name = '{}'.format(group_name) + expected_filepath = collected_files[0] \ + if isinstance(collected_files, (list, tuple)) else collected_files + + dynamic_data = { + "aov": aov, + "renderlayer": instance.data.get("renderlayer"), + } + + # find if camera is used in the file path + # TODO: this must be changed to be more robust. Any coincidence + # of camera name in the file path will be considered as + # camera name. This is not correct. + camera = [cam for cam in cameras if cam in expected_filepath] + + # Is there just one camera matching? + # TODO: this is not true, we can have multiple cameras in the scene + # and we should be able to detect them all. Currently, we are + # keeping the old behavior, taking the first one found. + if camera: + dynamic_data["camera"] = camera[0] + + project_settings = instance.context.data.get("project_settings") + + use_legacy_product_name = True + try: + use_legacy_product_name = project_settings["core"]["tools"]["creator"]["product_name_profiles"]["use_legacy_for_renders"] # noqa: E501 + except KeyError: + warnings.warn( + ("use_legacy_for_renders not found in project settings. " + "Using legacy product name for renders. Please update " + "your ayon-core version."), DeprecationWarning) + use_legacy_product_name = True + + if use_legacy_product_name: + product_name, group_name = _get_legacy_product_name_and_group( + product_type=skeleton["productType"], + source_product_name=source_product_name, + task_name=instance.data["task"], + dynamic_data=dynamic_data) - if isinstance(col, (list, tuple)): - staging = os.path.dirname(col[0]) else: - staging = os.path.dirname(col) + product_name, group_name = _get_product_name_and_group_from_template( + task_entity=instance.data["taskEntity"], + project_name=instance.context.data["projectName"], + host_name=instance.context.data["hostName"], + product_type=skeleton["productType"], + variant=instance.data.get('variant', ''), + project_settings=project_settings + ) + + staging = os.path.dirname(expected_filepath) try: staging = remap_source(staging, anatomy) @@ -611,10 +721,8 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, app = os.environ.get("AYON_HOST_NAME", "") - if isinstance(col, list): - render_file_name = os.path.basename(col[0]) - else: - render_file_name = os.path.basename(col) + render_file_name = os.path.basename(expected_filepath) + aov_patterns = aov_filter preview = match_aov_pattern(app, aov_patterns, render_file_name) @@ -622,9 +730,10 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, new_instance = deepcopy(skeleton) new_instance["productName"] = product_name new_instance["productGroup"] = group_name + new_instance["aov"] = aov # toggle preview on if multipart is on - # Because we cant query the multipartExr data member of each AOV we'll + # Because we can't query the multipartExr data member of each AOV we'll # need to have hardcoded rule of excluding any renders with # "cryptomatte" in the file name from being a multipart EXR. This issue # happens with Redshift that forces Cryptomatte renders to be separate @@ -650,10 +759,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, new_instance["review"] = True # create representation - if isinstance(col, (list, tuple)): - files = [os.path.basename(f) for f in col] - else: - files = os.path.basename(col) + ext = os.path.splitext(render_file_name)[-1].lstrip(".") # Copy render product "colorspace" data to representation. colorspace = "" @@ -708,6 +814,36 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, return instances +def _collect_expected_files_for_aov(files): + """Collect expected files. + + Args: + files (list): List of files. + + Returns: + list or str: Collection of files or single file. + + Raises: + ValueError: If there are multiple collections. + + """ + cols, rem = clique.assemble(files) + # we shouldn't have any reminders. And if we do, it should + # be just one item for single frame renders. + if not cols and rem: + if len(rem) != 1: + raise ValueError("Found multiple non related files " + "to render, don't know what to do " + "with them.") + return rem[0] + else: + # but we really expect only one collection. + # Nothing else make sense. + if len(cols) != 1: + raise ValueError("Only one image sequence type is expected.") # noqa: E501 + return list(cols[0]) + + def get_resources(project_name, version_entity, extension=None): """Get the files from the specific version. diff --git a/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py b/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py index b6636696c1..c83906d7f1 100644 --- a/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py +++ b/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py @@ -138,7 +138,7 @@ def fill_missing_task_entities(self, context, project_name): folder_path_by_id = {} for instance in context: folder_entity = instance.data.get("folderEntity") - # Skip if instnace does not have filled folder entity + # Skip if instance does not have filled folder entity if not folder_entity: continue folder_id = folder_entity["id"] @@ -385,8 +385,19 @@ def fill_anatomy_data(self, context): json.dumps(anatomy_data, indent=4) )) + # make render layer available in anatomy data + render_layer = instance.data.get("renderLayer") + if render_layer: + anatomy_data["renderLayer"] = render_layer + + # make aov name available in anatomy data + aov = instance.data.get("aov") + if aov: + anatomy_data["aov"] = aov + + def _fill_folder_data(self, instance, project_entity, anatomy_data): - # QUESTION should we make sure that all folder data are poped if + # QUESTION: should we make sure that all folder data are popped if # folder data cannot be found? # - 'folder', 'hierarchy', 'parent', 'folder' folder_entity = instance.data.get("folderEntity") @@ -426,7 +437,7 @@ def _fill_folder_data(self, instance, project_entity, anatomy_data): }) def _fill_task_data(self, instance, task_types_by_name, anatomy_data): - # QUESTION should we make sure that all task data are poped if task + # QUESTION: should we make sure that all task data are popped if task # data cannot be resolved? # - 'task' diff --git a/client/ayon_core/plugins/publish/integrate.py b/client/ayon_core/plugins/publish/integrate.py index 69c14465eb..d3f6c04333 100644 --- a/client/ayon_core/plugins/publish/integrate.py +++ b/client/ayon_core/plugins/publish/integrate.py @@ -744,6 +744,11 @@ def prepare_representation( if not is_udim: repre_context["frame"] = first_index_padded + # store renderlayer in context if it exists + # to be later used for example by delivery templates + if instance.data.get("renderlayer"): + repre_context["renderlayer"] = instance.data["renderlayer"] + # Update the destination indexes and padding dst_collection = clique.assemble(dst_filepaths)[0][0] dst_collection.padding = destination_padding diff --git a/server/settings/tools.py b/server/settings/tools.py index 85a66f6a70..3b2c140b3a 100644 --- a/server/settings/tools.py +++ b/server/settings/tools.py @@ -22,6 +22,14 @@ def normalize_value(cls, value): class ProductNameProfile(BaseSettingsModel): _layout = "expanded" + # TODO: change to False in next releases + use_legacy_for_renders: bool = SettingsField( + True, title="Use legacy for renders", + description="Use product naming logic for renders. " + "This is for backwards compatibility enabled by default." + "When enabled, it will ignore any templates for renders " + "that are set in the product name profiles.") + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) From 551d4f2b7065c3c13467aff3ab749e7a9632dc8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Thu, 8 Aug 2024 18:13:47 +0200 Subject: [PATCH 12/67] :fire: remove old python interface file --- .../pipeline/farm/pyblish_functions.pyi | 24 ------------------- 1 file changed, 24 deletions(-) delete mode 100644 client/ayon_core/pipeline/farm/pyblish_functions.pyi diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.pyi b/client/ayon_core/pipeline/farm/pyblish_functions.pyi deleted file mode 100644 index fe0ae57da0..0000000000 --- a/client/ayon_core/pipeline/farm/pyblish_functions.pyi +++ /dev/null @@ -1,24 +0,0 @@ -import pyblish.api -from ayon_core.pipeline import Anatomy -from typing import Tuple, List - - -class TimeData: - start: int - end: int - fps: float | int - step: int - handle_start: int - handle_end: int - - def __init__(self, start: int, end: int, fps: float | int, step: int, handle_start: int, handle_end: int): - ... - ... - -def remap_source(source: str, anatomy: Anatomy): ... -def extend_frames(folder_path: str, product_name: str, start: int, end: int) -> Tuple[int, int]: ... -def get_time_data_from_instance_or_context(instance: pyblish.api.Instance) -> TimeData: ... -def get_transferable_representations(instance: pyblish.api.Instance) -> list: ... -def create_skeleton_instance(instance: pyblish.api.Instance, families_transfer: list = ..., instance_transfer: dict = ...) -> dict: ... -def create_instances_for_aov(instance: pyblish.api.Instance, skeleton: dict, aov_filter: dict) -> List[pyblish.api.Instance]: ... -def attach_instances_to_product(attach_to: list, instances: list) -> list: ... From c50badd51df6dac2987c46111900f7b07d620b70 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 8 Aug 2024 18:34:18 +0200 Subject: [PATCH 13/67] added process time --- .../publish_report_viewer/report_items.py | 3 ++ .../publish_report_viewer/widgets.py | 51 ++++++++++++++----- 2 files changed, 40 insertions(+), 14 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py b/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py index cfc2fbfd67..a3c5a7a2fd 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/report_items.py @@ -20,7 +20,9 @@ def __init__(self, plugin_data): self.families = plugin_data.get("families") errored = False + process_time = 0.0 for instance_data in plugin_data["instances_data"]: + process_time += instance_data["process_time"] for log_item in instance_data["logs"]: errored = log_item["type"] == "error" if errored: @@ -28,6 +30,7 @@ def __init__(self, plugin_data): if errored: break + self.process_time = process_time self.errored = errored @property diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index de24e1f653..c58fae5c87 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -22,6 +22,21 @@ IS_DETAIL_ITEM_ROLE = QtCore.Qt.UserRole + 3 +def get_pretty_milliseconds(value): + if value < 1000: + return f"{value:.3f}ms" + value /= 1000 + if value < 60: + return f"{value:.2f}s" + seconds = int(value % 60) + value /= 60 + if value < 60: + return f"{value:.2f}m {seconds:.2f}s" + minutes = int(value % 60) + value /= 60 + return f"{value:.2f}h {minutes:.2f}m" + + class PluginLoadReportModel(QtGui.QStandardItemModel): def __init__(self): super().__init__() @@ -367,27 +382,31 @@ def __init__(self, plugin_item, parent): form_separator = SeparatorWidget(parent=content_widget) - plugin_families_label = QtWidgets.QLabel("Families:") - plugin_families_widget = QtWidgets.QLabel(content_widget) - plugin_families_widget.setWordWrap(True) + plugin_class_label = QtWidgets.QLabel("Class:") + plugin_class_widget = QtWidgets.QLabel(content_widget) plugin_order_label = QtWidgets.QLabel("Order:") plugin_order_widget = QtWidgets.QLabel(content_widget) - plugin_class_label = QtWidgets.QLabel("Class:") - plugin_class_widget = QtWidgets.QLabel(content_widget) + plugin_families_label = QtWidgets.QLabel("Families:") + plugin_families_widget = QtWidgets.QLabel(content_widget) + plugin_families_widget.setWordWrap(True) plugin_path_label = QtWidgets.QLabel("File Path:") plugin_path_widget = ElideLabel(content_widget) plugin_path_widget.set_elide_mode(QtCore.Qt.ElideLeft) + plugin_time_label = QtWidgets.QLabel("Time:") + plugin_time_widget = QtWidgets.QLabel(content_widget) + # Set interaction flags for label_widget in ( plugin_label_widget, - plugin_families_widget, - plugin_order_widget, - plugin_class_widget, plugin_doc_widget, + plugin_class_widget, + plugin_order_widget, + plugin_families_widget, + plugin_time_widget, ): label_widget.setTextInteractionFlags( QtCore.Qt.TextBrowserInteraction @@ -395,10 +414,11 @@ def __init__(self, plugin_item, parent): # Change style of form labels for label_widget in ( - plugin_families_label, - plugin_order_label, plugin_class_label, + plugin_order_label, + plugin_families_label, plugin_path_label, + plugin_time_label, ): label_widget.setObjectName("PluginFormLabel") @@ -409,12 +429,14 @@ def __init__(self, plugin_item, parent): ) plugin_label_widget.setText(plugin_label) plugin_doc_widget.setText(plugin_item.docstring or "N/A") - plugin_families_widget.setText(str(plugin_item.families or "N/A")) - plugin_order_widget.setText(str(plugin_item.order or "N/A")) plugin_class_widget.setText(plugin_item.name or "N/A") + plugin_order_widget.setText(str(plugin_item.order or "N/A")) + plugin_families_widget.setText(str(plugin_item.families or "N/A")) plugin_path_widget.setText(plugin_item.filepath or "N/A") - # Show full path in tooltip plugin_path_widget.setToolTip(plugin_item.filepath or None) + plugin_time_widget.setText( + get_pretty_milliseconds(plugin_item.process_time) + ) content_layout = QtWidgets.QGridLayout(content_widget) content_layout.setContentsMargins(8, 8, 8, 8) @@ -436,10 +458,11 @@ def __init__(self, plugin_item, parent): row += 1 for label_widget, value_widget in ( - (plugin_families_label, plugin_families_widget), (plugin_class_label, plugin_class_widget), (plugin_order_label, plugin_order_widget), + (plugin_families_label, plugin_families_widget), (plugin_path_label, plugin_path_widget), + (plugin_time_label, plugin_time_widget), ): content_layout.addWidget(label_widget, row, 0) content_layout.addWidget(value_widget, row, 1) From 6608a18bb0c8e83acd43eb577d31357a694f8a98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Thu, 8 Aug 2024 18:38:56 +0200 Subject: [PATCH 14/67] :recycle: make function public --- client/ayon_core/pipeline/farm/pyblish_functions.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index fc769a06bb..4825818980 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -584,7 +584,7 @@ def _get_legacy_product_name_and_group( return resulting_product_name, resulting_group_name -def _get_product_name_and_group_from_template( +def get_product_name_and_group_from_template( task_entity, project_name, host_name, @@ -701,7 +701,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, dynamic_data=dynamic_data) else: - product_name, group_name = _get_product_name_and_group_from_template( + product_name, group_name = get_product_name_and_group_from_template( task_entity=instance.data["taskEntity"], project_name=instance.context.data["projectName"], host_name=instance.context.data["hostName"], From 6acff9e04653930eeb51d83d20af28b8c5746460 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Thu, 8 Aug 2024 19:00:33 +0200 Subject: [PATCH 15/67] :recycle: first shot at group name also removing need for project settings --- client/ayon_core/pipeline/farm/pyblish_functions.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 4825818980..5a00f8e973 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -590,7 +590,6 @@ def get_product_name_and_group_from_template( host_name, product_type, variant, - project_settings, dynamic_data=None): """Get product name and group name from template. @@ -604,7 +603,6 @@ def get_product_name_and_group_from_template( host_name (str): Host name. product_type (str): Product type. variant (str): Variant. - project_settings (dict): Project settings. dynamic_data (dict): Dynamic data (aov, renderlayer, camera, ...). Returns: @@ -619,9 +617,8 @@ def get_product_name_and_group_from_template( product_type=product_type, dynamic_data=dynamic_data, variant=variant, - project_settings=project_settings, ) - return resulting_product_name, "" + return resulting_product_name, f"{product_type}{variant}" def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, @@ -706,8 +703,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, project_name=instance.context.data["projectName"], host_name=instance.context.data["hostName"], product_type=skeleton["productType"], - variant=instance.data.get('variant', ''), - project_settings=project_settings + variant=instance.data.get('variant', source_product_name), ) staging = os.path.dirname(expected_filepath) From 07f697d5a4dea4618fc480cdbe76f37a96ed5396 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Fri, 9 Aug 2024 10:43:05 +0200 Subject: [PATCH 16/67] :recycle: derive group name from templates too --- .../pipeline/farm/pyblish_functions.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 5a00f8e973..0cc3cef879 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -597,6 +597,13 @@ def get_product_name_and_group_from_template( data provided. It is doing similar work as `func::_get_legacy_product_name_and_group` but using templates. + To get group name, template is called without any dynamic data, so + (depending on the template itself) it should be product name without + aov. + + Todo: + Maybe we should introduce templates for the groups themselves. + Args: task_entity (dict): Task entity. project_name (str): Project name. @@ -609,6 +616,16 @@ def get_product_name_and_group_from_template( tuple: product name and group name. """ + + resulting_group_name = get_product_name( + project_name=project_name, + task_name=task_entity["taskName"], + task_type=task_entity["taskType"], + host_name=host_name, + product_type=product_type, + variant=variant, + ) + resulting_product_name = get_product_name( project_name=project_name, task_name=task_entity["taskName"], @@ -618,7 +635,7 @@ def get_product_name_and_group_from_template( dynamic_data=dynamic_data, variant=variant, ) - return resulting_product_name, f"{product_type}{variant}" + return resulting_product_name, resulting_group_name def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, From a394556103dfd6f300e0f1998286fb1d0dfc4f0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Fri, 9 Aug 2024 13:17:20 +0200 Subject: [PATCH 17/67] :bug: fix task name reference --- client/ayon_core/pipeline/farm/pyblish_functions.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 0cc3cef879..54ee081c9f 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -619,7 +619,7 @@ def get_product_name_and_group_from_template( resulting_group_name = get_product_name( project_name=project_name, - task_name=task_entity["taskName"], + task_name=task_entity["name"], task_type=task_entity["taskType"], host_name=host_name, product_type=product_type, @@ -628,7 +628,7 @@ def get_product_name_and_group_from_template( resulting_product_name = get_product_name( project_name=project_name, - task_name=task_entity["taskName"], + task_name=task_entity["name"], task_type=task_entity["taskType"], host_name=host_name, product_type=product_type, From c63d2005cf5cad0941b0097c2c5c00e816ba3f1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Fri, 9 Aug 2024 13:18:16 +0200 Subject: [PATCH 18/67] :recycle: move the setting one level up --- .../ayon_core/pipeline/farm/pyblish_functions.py | 2 +- server/settings/tools.py | 15 ++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 54ee081c9f..aa30aefbd0 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -699,7 +699,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, use_legacy_product_name = True try: - use_legacy_product_name = project_settings["core"]["tools"]["creator"]["product_name_profiles"]["use_legacy_for_renders"] # noqa: E501 + use_legacy_product_name = project_settings["core"]["tools"]["creator"]["use_legacy_product_names_for_renders"] # noqa: E501 except KeyError: warnings.warn( ("use_legacy_for_renders not found in project settings. " diff --git a/server/settings/tools.py b/server/settings/tools.py index 3b2c140b3a..5e9c8e14a0 100644 --- a/server/settings/tools.py +++ b/server/settings/tools.py @@ -22,13 +22,6 @@ def normalize_value(cls, value): class ProductNameProfile(BaseSettingsModel): _layout = "expanded" - # TODO: change to False in next releases - use_legacy_for_renders: bool = SettingsField( - True, title="Use legacy for renders", - description="Use product naming logic for renders. " - "This is for backwards compatibility enabled by default." - "When enabled, it will ignore any templates for renders " - "that are set in the product name profiles.") product_types: list[str] = SettingsField( default_factory=list, title="Product types" @@ -73,6 +66,14 @@ class CreatorToolModel(BaseSettingsModel): title="Create Smart Select" ) ) + # TODO: change to False in next releases + use_legacy_product_names_for_renders: bool = SettingsField( + True, title="Use legacy product names for renders", + description="Use product naming templates for renders. " + "This is for backwards compatibility enabled by default." + "When enabled, it will ignore any templates for renders " + "that are set in the product name profiles.") + product_name_profiles: list[ProductNameProfile] = SettingsField( default_factory=list, title="Product name profiles" From 3350b91cf934aceb0558423e5b7707fd50934315 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Fri, 9 Aug 2024 13:27:34 +0200 Subject: [PATCH 19/67] :bug: fix letter-case typo --- .../plugins/publish/collect_anatomy_instance_data.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py b/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py index c83906d7f1..5b750a5232 100644 --- a/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py +++ b/client/ayon_core/plugins/publish/collect_anatomy_instance_data.py @@ -386,9 +386,9 @@ def fill_anatomy_data(self, context): )) # make render layer available in anatomy data - render_layer = instance.data.get("renderLayer") + render_layer = instance.data.get("renderlayer") if render_layer: - anatomy_data["renderLayer"] = render_layer + anatomy_data["renderlayer"] = render_layer # make aov name available in anatomy data aov = instance.data.get("aov") From eddba580ef29cbe1525a4c1579571afb925bb400 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Fri, 9 Aug 2024 14:17:20 +0200 Subject: [PATCH 20/67] :recycle: explicitly remove `aov` key for group name this solution is a little hack. proper one would be probably introducing product group name templates as mentioned in the code comment --- client/ayon_core/pipeline/farm/pyblish_functions.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index aa30aefbd0..91e155469d 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -616,13 +616,18 @@ def get_product_name_and_group_from_template( tuple: product name and group name. """ - + # remove 'aov' from data used to format group. See todo comment above + # for possible solution. + _dynamic_data = deepcopy(dynamic_data) or {} + if _dynamic_data["aov"]: + del _dynamic_data["aov"] resulting_group_name = get_product_name( project_name=project_name, task_name=task_entity["name"], task_type=task_entity["taskType"], host_name=host_name, product_type=product_type, + dynamic_data=_dynamic_data, variant=variant, ) @@ -721,6 +726,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, host_name=instance.context.data["hostName"], product_type=skeleton["productType"], variant=instance.data.get('variant', source_product_name), + dynamic_data=dynamic_data ) staging = os.path.dirname(expected_filepath) From eaa1b503b7e3e956ed753d83644dad8023765d24 Mon Sep 17 00:00:00 2001 From: robin Date: Wed, 14 Aug 2024 17:52:29 -0400 Subject: [PATCH 21/67] Validate opening and closing brackets on Anatomy keys. --- client/ayon_core/lib/path_templates.py | 30 ++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index 01a6985a25..0a39d05e1d 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -460,6 +460,30 @@ def validate_value_type(value): return True return False + @staticmethod + def validate_key_is_matched(key): + """ + Finds out how balanced an expression is. + With a string containing only brackets. + + >>> is_matched('[]()()(((([])))') + False + >>> is_matched('[](){{{[]}}}') + True + """ + opening = tuple('({[') + closing = tuple(')}]') + mapping = dict(zip(opening, closing)) + queue = [] + + for letter in key: + if letter in opening: + queue.append(mapping[letter]) + elif letter in closing: + if not queue or letter != queue.pop(): + return False + return not queue + def format(self, data, result): """Format the formattings string. @@ -472,6 +496,12 @@ def format(self, data, result): result.add_output(result.realy_used_values[key]) return result + # ensure key is properly formed [({})] properly closed. + if not self.validate_key_is_matched(key): + result.add_missing_key(key) + result.add_output(self.template) + return result + # check if key expects subdictionary keys (e.g. project[name]) existence_check = key key_padding = list(KEY_PADDING_PATTERN.findall(existence_check)) From 44c417fdb0e960c6f8af2bae56309efd70724dc6 Mon Sep 17 00:00:00 2001 From: __robin__ Date: Mon, 19 Aug 2024 08:08:33 -0400 Subject: [PATCH 22/67] Update client/ayon_core/lib/path_templates.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/lib/path_templates.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index 0a39d05e1d..46dd997da2 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -462,14 +462,17 @@ def validate_value_type(value): @staticmethod def validate_key_is_matched(key): - """ - Finds out how balanced an expression is. - With a string containing only brackets. + """Validate that opening has closing at correct place. + + Example: + >>> is_matched("[]()()(((([])))") + False + >>> is_matched("[](){{{[]}}}") + True + + Returns: + bool: Openings and closinga are valid. - >>> is_matched('[]()()(((([])))') - False - >>> is_matched('[](){{{[]}}}') - True """ opening = tuple('({[') closing = tuple(')}]') From 4d884db269de1f8de4b5824bfa9fb5a7b728220f Mon Sep 17 00:00:00 2001 From: __robin__ Date: Mon, 19 Aug 2024 08:08:50 -0400 Subject: [PATCH 23/67] Update client/ayon_core/lib/path_templates.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/lib/path_templates.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index 46dd997da2..edc7478cef 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -474,8 +474,8 @@ def validate_key_is_matched(key): bool: Openings and closinga are valid. """ - opening = tuple('({[') - closing = tuple(')}]') + opening = tuple("({[") + closing = tuple(")}]") mapping = dict(zip(opening, closing)) queue = [] From b0490fd15dbd24534c15e1f80ccf116b5ef2003f Mon Sep 17 00:00:00 2001 From: robin Date: Mon, 19 Aug 2024 08:13:55 -0400 Subject: [PATCH 24/67] Adjust docstring from PR feedback. --- client/ayon_core/lib/path_templates.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index edc7478cef..3e3bdd8f78 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -463,6 +463,7 @@ def validate_value_type(value): @staticmethod def validate_key_is_matched(key): """Validate that opening has closing at correct place. + Future-proof, only square brackets are currently used in keys. Example: >>> is_matched("[]()()(((([])))") @@ -471,7 +472,7 @@ def validate_key_is_matched(key): True Returns: - bool: Openings and closinga are valid. + bool: Openings and closing are valid. """ opening = tuple("({[") From f0cfc968d83294fe8d0a0c93dfca17c61a71c41c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:01:22 +0200 Subject: [PATCH 25/67] Update client/ayon_core/pipeline/create/product_name.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/create/product_name.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/create/product_name.py b/client/ayon_core/pipeline/create/product_name.py index 597c9f4862..3ca6611644 100644 --- a/client/ayon_core/pipeline/create/product_name.py +++ b/client/ayon_core/pipeline/create/product_name.py @@ -182,7 +182,7 @@ def get_product_name( fill_pairs[key] = value try: - return StringTemplate.format_template( + return StringTemplate.format_strict_template( template=template, data=prepare_template_data(fill_pairs) ) From 2e79075fe35430d754e01d98496fc708960bb11c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:17:12 +0200 Subject: [PATCH 26/67] Update server/settings/tools.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- server/settings/tools.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/server/settings/tools.py b/server/settings/tools.py index 5e9c8e14a0..a2785c1edf 100644 --- a/server/settings/tools.py +++ b/server/settings/tools.py @@ -68,7 +68,8 @@ class CreatorToolModel(BaseSettingsModel): ) # TODO: change to False in next releases use_legacy_product_names_for_renders: bool = SettingsField( - True, title="Use legacy product names for renders", + True, + title="Use legacy product names for renders", description="Use product naming templates for renders. " "This is for backwards compatibility enabled by default." "When enabled, it will ignore any templates for renders " From 1f45f8e0a07f91081defcf2e74693d8a005c5fa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:17:29 +0200 Subject: [PATCH 27/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index 91e155469d..fc9371f719 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -563,7 +563,7 @@ def _get_legacy_product_name_and_group( else: resulting_group_name = source_product_name - resulting_product_name = '{}'.format(resulting_group_name) + resulting_product_name = resulting_group_name camera = dynamic_data.get("camera") aov = dynamic_data.get("aov") if camera: From 51c51eeef0415fc65b52d1bc35949926cd996526 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:18:29 +0200 Subject: [PATCH 28/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index fc9371f719..b9a927f02d 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -679,8 +679,9 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, for aov, files in expected_files[0].items(): collected_files = _collect_expected_files_for_aov(files) - expected_filepath = collected_files[0] \ - if isinstance(collected_files, (list, tuple)) else collected_files + expected_filepath = collected_files + if isinstance(collected_files, (list, tuple)): + expected_filepath = collected_files[0] dynamic_data = { "aov": aov, From 009ab46be04be91c3f94e2e93af5c36476175e40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:37:18 +0200 Subject: [PATCH 29/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index b9a927f02d..b61007d0cb 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -619,8 +619,7 @@ def get_product_name_and_group_from_template( # remove 'aov' from data used to format group. See todo comment above # for possible solution. _dynamic_data = deepcopy(dynamic_data) or {} - if _dynamic_data["aov"]: - del _dynamic_data["aov"] + _dynamic_data.pop("aov", None) resulting_group_name = get_product_name( project_name=project_name, task_name=task_entity["name"], From cb4af77a429077bc92ead11bda6b50521e31f2d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:37:29 +0200 Subject: [PATCH 30/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index b61007d0cb..f9ce2d3cf5 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -585,11 +585,11 @@ def _get_legacy_product_name_and_group( def get_product_name_and_group_from_template( - task_entity, project_name, - host_name, + task_entity, product_type, variant, + host_name, dynamic_data=None): """Get product name and group name from template. From e784c0073532414dfb5020af659954ef24c57db6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:38:12 +0200 Subject: [PATCH 31/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index f9ce2d3cf5..e071d46321 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -855,12 +855,11 @@ def _collect_expected_files_for_aov(files): "to render, don't know what to do " "with them.") return rem[0] - else: - # but we really expect only one collection. - # Nothing else make sense. - if len(cols) != 1: - raise ValueError("Only one image sequence type is expected.") # noqa: E501 - return list(cols[0]) + # but we really expect only one collection. + # Nothing else make sense. + if len(cols) != 1: + raise ValueError("Only one image sequence type is expected.") # noqa: E501 + return list(cols[0]) def get_resources(project_name, version_entity, extension=None): From caf674c00827a0338b035a5d9c8b033124a2b25d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= <33513211+antirotor@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:38:28 +0200 Subject: [PATCH 32/67] Update client/ayon_core/pipeline/farm/pyblish_functions.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/pipeline/farm/pyblish_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/farm/pyblish_functions.py b/client/ayon_core/pipeline/farm/pyblish_functions.py index e071d46321..b218dc78e5 100644 --- a/client/ayon_core/pipeline/farm/pyblish_functions.py +++ b/client/ayon_core/pipeline/farm/pyblish_functions.py @@ -725,7 +725,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, project_name=instance.context.data["projectName"], host_name=instance.context.data["hostName"], product_type=skeleton["productType"], - variant=instance.data.get('variant', source_product_name), + variant=instance.data.get("variant", source_product_name), dynamic_data=dynamic_data ) From f752940c1175cfd2bd9665264e218ed0732622c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 19 Aug 2024 16:10:33 +0200 Subject: [PATCH 33/67] :memo: added help for product templates --- .../plugins/publish/help/validate_unique_subsets.xml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/plugins/publish/help/validate_unique_subsets.xml b/client/ayon_core/plugins/publish/help/validate_unique_subsets.xml index e163fc39fe..96b07979b7 100644 --- a/client/ayon_core/plugins/publish/help/validate_unique_subsets.xml +++ b/client/ayon_core/plugins/publish/help/validate_unique_subsets.xml @@ -11,7 +11,11 @@ Multiples instances from your scene are set to publish into the same folder > pr ### How to repair? -Remove the offending instances or rename to have a unique name. +Remove the offending instances or rename to have a unique name. Also, please + check your product name templates to ensure that resolved names are + sufficiently unique. You can find that settings: + + ayon+settings://core/tools/creator/product_name_profiles - \ No newline at end of file + From 5442cacdc346b7ef1c34c5493f116ea82300d531 Mon Sep 17 00:00:00 2001 From: Robin De Lillo Date: Mon, 19 Aug 2024 11:08:44 -0400 Subject: [PATCH 34/67] Update client/ayon_core/lib/path_templates.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/lib/path_templates.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index 3e3bdd8f78..33af503dd5 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -475,9 +475,9 @@ def validate_key_is_matched(key): bool: Openings and closing are valid. """ - opening = tuple("({[") - closing = tuple(")}]") - mapping = dict(zip(opening, closing)) + mapping = dict(zip("({[", ")}]")) + opening = set(mapping.keys()) + closing = set(mapping.values()) queue = [] for letter in key: From 9331187000e18c70d4a1d38f159f0ebc4c483f6b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:09:29 +0200 Subject: [PATCH 35/67] ProcessContext also has information about preparation state --- client/ayon_core/addon/base.py | 41 ++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index 383703e2bc..41ba7d4a0e 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -116,6 +116,47 @@ def __init__( if kwargs: unknown_keys = ", ".join([f'"{key}"' for key in kwargs.keys()]) print(f"Unknown keys in ProcessContext: {unknown_keys}") + self._prepared: bool = False + self._exception: Optional[Exception] = None + + def is_prepared(self) -> bool: + """Preparation of process finished. + + Returns: + bool: Preparation is done. + """ + return self._prepared + + def set_prepared(self): + """Mark process as prepared.""" + self._prepared = True + + def preparation_failed(self) -> bool: + """Preparation failed. + + Returns: + bool: Preparation failed. + + """ + return self._exception is not None + + def get_exception(self) -> Optional[Exception]: + """Get exception that occurred during preparation. + + Returns: + Optional[Exception]: Exception that caused preparation fail. + + """ + return self._exception + + def set_exception(self, exception: Exception): + """Set exception that occurred during preparation. + + Args: + exception (Exception): Exception that caused preparation fail. + + """ + self._exception = exception # Inherit from `object` for Python 2 hosts From 501cacc4b8e5e081d7211ddae7a11ad492348e3c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:09:46 +0200 Subject: [PATCH 36/67] change state of context when is done --- client/ayon_core/addon/utils.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index ac5ff25984..5f6922b924 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -134,6 +134,8 @@ def ensure_addons_are_process_context_ready( failed = True break + process_context.set_prepared() + process_context.set_exception(exception) output_str = output.getvalue() # Print stdout/stderr to console as it was redirected print(output_str) From 8e9c28a84a416d51169ccc160d269481b4a026b0 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:10:02 +0200 Subject: [PATCH 37/67] 'ensure_addons_are_process_ready' returns ProcessContext --- client/ayon_core/addon/utils.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 5f6922b924..b301c70564 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -161,7 +161,7 @@ def ensure_addons_are_process_ready( addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, **kwargs, -) -> Optional[Exception]: +) -> ProcessContext: """Ensure all enabled addons are ready to be used in the given context. Call this method only in AYON launcher process and as first thing @@ -181,6 +181,7 @@ def ensure_addons_are_process_ready( """ context: ProcessContext = ProcessContext(**kwargs) - return ensure_addons_are_process_context_ready( + ensure_addons_are_process_context_ready( context, addons_manager, exit_on_failure ) + return context From f3cccccab73bc58e0b8c9daa53ebd9b37b80e74c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:10:16 +0200 Subject: [PATCH 38/67] do not return exception on fail --- client/ayon_core/addon/utils.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index b301c70564..0481ed4cad 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -72,7 +72,7 @@ def ensure_addons_are_process_context_ready( process_context: ProcessContext, addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, -) -> Optional[Exception]: +): """Ensure all enabled addons are ready to be used in the given context. Call this method only in AYON launcher process and as first thing @@ -152,9 +152,8 @@ def ensure_addons_are_process_context_ready( detail = output_str _handle_error(process_context, message, detail) - if not exit_on_failure: - return exception - sys.exit(1) + if exit_on_failure: + sys.exit(1) def ensure_addons_are_process_ready( From 2b46eee1dd2d074e979923ba313086cbbd90a271 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:19:52 +0200 Subject: [PATCH 39/67] added ProcessContext arguments to 'ensure_addons_are_process_ready' --- client/ayon_core/addon/base.py | 3 ++- client/ayon_core/addon/utils.py | 19 ++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index 41ba7d4a0e..e5b5087423 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -94,7 +94,8 @@ class ProcessContext: project_name (Optional[str]): Project name. Can be filled in case process is triggered for specific project. Some addons can have different behavior based on project. - headless (Optional[bool]): Is process running in headless mode. + headless (Optional[bool]): Is process running in headless mode. Value + is filled with value based on state set in AYON launcher. """ def __init__( diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 0481ed4cad..ad04586019 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -157,6 +157,10 @@ def ensure_addons_are_process_context_ready( def ensure_addons_are_process_ready( + addon_name: Optional[str] = None, + addon_version: Optional[str] = None, + project_name: Optional[str] = None, + headless: Optional[bool] = None, addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, **kwargs, @@ -168,6 +172,13 @@ def ensure_addons_are_process_ready( should not be created. Args: + addon_name (Optional[str]): Addon name which triggered process. + addon_version (Optional[str]): Addon version which triggered process. + project_name (Optional[str]): Project name. Can be filled in case + process is triggered for specific project. Some addons can have + different behavior based on project. + headless (Optional[bool]): Is process running in headless mode. Value + is filled with value based on state set in AYON launcher. addons_manager (Optional[AddonsManager]): The addons manager to use. If not provided, a new one will be created. exit_on_failure (bool, optional): If True, the process will exit @@ -179,7 +190,13 @@ def ensure_addons_are_process_ready( preparation, if any. """ - context: ProcessContext = ProcessContext(**kwargs) + context: ProcessContext = ProcessContext( + addon_name, + addon_version, + project_name, + headless, + **kwargs + ) ensure_addons_are_process_context_ready( context, addons_manager, exit_on_failure ) From d983879ccd7f4215c63d9baa52b4e0b16607c62e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:39:56 +0200 Subject: [PATCH 40/67] added comment to project name --- client/ayon_core/addon/base.py | 2 +- client/ayon_core/addon/utils.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index e5b5087423..5662375c0a 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -93,7 +93,7 @@ class ProcessContext: addon_version (Optional[str]): Addon version which triggered process. project_name (Optional[str]): Project name. Can be filled in case process is triggered for specific project. Some addons can have - different behavior based on project. + different behavior based on project. Value is NOT autofilled. headless (Optional[bool]): Is process running in headless mode. Value is filled with value based on state set in AYON launcher. diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index ad04586019..43118bff7e 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -176,7 +176,7 @@ def ensure_addons_are_process_ready( addon_version (Optional[str]): Addon version which triggered process. project_name (Optional[str]): Project name. Can be filled in case process is triggered for specific project. Some addons can have - different behavior based on project. + different behavior based on project. Value is NOT autofilled. headless (Optional[bool]): Is process running in headless mode. Value is filled with value based on state set in AYON launcher. addons_manager (Optional[AddonsManager]): The addons From eb4407b9efb55bf76bdb5b8040422f943bc2410f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 14:57:56 +0200 Subject: [PATCH 41/67] fix returns in docstrings --- client/ayon_core/addon/utils.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 43118bff7e..f2441e37be 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -87,10 +87,6 @@ def ensure_addons_are_process_context_ready( exit_on_failure (bool, optional): If True, the process will exit if an error occurs. Defaults to True. - Returns: - Optional[Exception]: The exception that occurred during the - preparation, if any. - """ if addons_manager is None: addons_manager = AddonsManager() @@ -186,7 +182,7 @@ def ensure_addons_are_process_ready( kwargs: The keyword arguments to pass to the ProcessContext. Returns: - Optional[Exception]: The exception that occurred during the + ProcessContext: The exception that occurred during the preparation, if any. """ From 92ce331a302c26a6a9a9fd47361269225d07b098 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 18:45:54 +0200 Subject: [PATCH 42/67] added 'is_headless_mode_enabled' function --- client/ayon_core/addon/base.py | 4 ++-- client/ayon_core/lib/__init__.py | 2 ++ client/ayon_core/lib/ayon_info.py | 4 ++++ 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index 5662375c0a..6343166ac8 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -20,6 +20,7 @@ Logger, is_dev_mode_enabled, get_launcher_storage_dir, + is_headless_mode_enabled, ) from ayon_core.settings import get_studio_settings @@ -107,8 +108,7 @@ def __init__( **kwargs, ): if headless is None: - # TODO use lib function to get headless mode - headless = os.getenv("AYON_HEADLESS_MODE") == "1" + headless = is_headless_mode_enabled() self.addon_name: Optional[str] = addon_name self.addon_version: Optional[str] = addon_version self.project_name: Optional[str] = project_name diff --git a/client/ayon_core/lib/__init__.py b/client/ayon_core/lib/__init__.py index d4b161031e..0074c4d2bd 100644 --- a/client/ayon_core/lib/__init__.py +++ b/client/ayon_core/lib/__init__.py @@ -132,6 +132,7 @@ is_in_ayon_launcher_process, is_running_from_build, is_using_ayon_console, + is_headless_mode_enabled, is_staging_enabled, is_dev_mode_enabled, is_in_tests, @@ -245,6 +246,7 @@ "is_in_ayon_launcher_process", "is_running_from_build", "is_using_ayon_console", + "is_headless_mode_enabled", "is_staging_enabled", "is_dev_mode_enabled", "is_in_tests", diff --git a/client/ayon_core/lib/ayon_info.py b/client/ayon_core/lib/ayon_info.py index c4333fab95..7e194a824e 100644 --- a/client/ayon_core/lib/ayon_info.py +++ b/client/ayon_core/lib/ayon_info.py @@ -78,6 +78,10 @@ def is_using_ayon_console(): return "ayon_console" in executable_filename +def is_headless_mode_enabled(): + return os.getenv("AYON_HEADLESS_MODE") == "1" + + def is_staging_enabled(): return os.getenv("AYON_USE_STAGING") == "1" From 3bc993399117f5690d6597a26947603fafa8d206 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:10:57 +0200 Subject: [PATCH 43/67] return bool all the time --- client/ayon_core/addon/utils.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index f2441e37be..31cb128e4b 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -72,7 +72,7 @@ def ensure_addons_are_process_context_ready( process_context: ProcessContext, addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, -): +) -> bool: """Ensure all enabled addons are ready to be used in the given context. Call this method only in AYON launcher process and as first thing @@ -87,6 +87,9 @@ def ensure_addons_are_process_context_ready( exit_on_failure (bool, optional): If True, the process will exit if an error occurs. Defaults to True. + Returns: + bool: True if all addons are ready, False otherwise. + """ if addons_manager is None: addons_manager = AddonsManager() @@ -138,7 +141,7 @@ def ensure_addons_are_process_context_ready( if not failed: if not process_context.headless: _start_tray() - return None + return True detail = None if use_detail: @@ -150,6 +153,7 @@ def ensure_addons_are_process_context_ready( _handle_error(process_context, message, detail) if exit_on_failure: sys.exit(1) + return False def ensure_addons_are_process_ready( @@ -160,7 +164,7 @@ def ensure_addons_are_process_ready( addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, **kwargs, -) -> ProcessContext: +) -> bool: """Ensure all enabled addons are ready to be used in the given context. Call this method only in AYON launcher process and as first thing @@ -182,8 +186,7 @@ def ensure_addons_are_process_ready( kwargs: The keyword arguments to pass to the ProcessContext. Returns: - ProcessContext: The exception that occurred during the - preparation, if any. + bool: True if all addons are ready, False otherwise. """ context: ProcessContext = ProcessContext( @@ -193,7 +196,6 @@ def ensure_addons_are_process_ready( headless, **kwargs ) - ensure_addons_are_process_context_ready( + return ensure_addons_are_process_context_ready( context, addons_manager, exit_on_failure ) - return context From 173b2f27272cb408e4ae496eb5fe40bf3eb4c266 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:14:22 +0200 Subject: [PATCH 44/67] remove ProcessContext methods --- client/ayon_core/addon/base.py | 41 --------------------------------- client/ayon_core/addon/utils.py | 7 +----- 2 files changed, 1 insertion(+), 47 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index 6343166ac8..e627fb2b38 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -117,47 +117,6 @@ def __init__( if kwargs: unknown_keys = ", ".join([f'"{key}"' for key in kwargs.keys()]) print(f"Unknown keys in ProcessContext: {unknown_keys}") - self._prepared: bool = False - self._exception: Optional[Exception] = None - - def is_prepared(self) -> bool: - """Preparation of process finished. - - Returns: - bool: Preparation is done. - """ - return self._prepared - - def set_prepared(self): - """Mark process as prepared.""" - self._prepared = True - - def preparation_failed(self) -> bool: - """Preparation failed. - - Returns: - bool: Preparation failed. - - """ - return self._exception is not None - - def get_exception(self) -> Optional[Exception]: - """Get exception that occurred during preparation. - - Returns: - Optional[Exception]: Exception that caused preparation fail. - - """ - return self._exception - - def set_exception(self, exception: Exception): - """Set exception that occurred during preparation. - - Args: - exception (Exception): Exception that caused preparation fail. - - """ - self._exception = exception # Inherit from `object` for Python 2 hosts diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 31cb128e4b..32b42bf1e2 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -94,7 +94,6 @@ def ensure_addons_are_process_context_ready( if addons_manager is None: addons_manager = AddonsManager() - exception = None message = None failed = False use_detail = False @@ -111,13 +110,11 @@ def ensure_addons_are_process_context_ready( addon.ensure_is_process_ready(process_context) addon_failed = False except ProcessPreparationError as exc: - exception = exc message = str(exc) print(f"Addon preparation failed: '{addon.name}'") print(message) - except BaseException as exc: - exception = exc + except BaseException: use_detail = True message = "An unexpected error occurred." formatted_traceback = "".join(traceback.format_exception( @@ -133,8 +130,6 @@ def ensure_addons_are_process_context_ready( failed = True break - process_context.set_prepared() - process_context.set_exception(exception) output_str = output.getvalue() # Print stdout/stderr to console as it was redirected print(output_str) From 9260a80cb0becbf322a78ad431a7de45b8f29836 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:14:53 +0200 Subject: [PATCH 45/67] require addon name and version --- client/ayon_core/addon/base.py | 29 +++++++++++++++++------------ client/ayon_core/addon/utils.py | 8 ++++---- 2 files changed, 21 insertions(+), 16 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index e627fb2b38..494c0f3da7 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -81,17 +81,22 @@ class ProcessPreparationError(Exception): class ProcessContext: - """Context of child process. + """Hold context of process that is going to be started. - Notes: - This class is used to pass context to child process. It can be used - to use different behavior of addon based on information in - the context. - The context can be enhanced in future versions. + Right now the context is simple, having information about addon that wants + to trigger preparation and possibly project name for which it should + happen. + + Preparation for process can be required for ayon-core or any other addon. + It can be, change of environment variables, or request login to + a project management. + + At the moment of creation is 'ProcessContext' only data holder, but that + might change in future if there will be need. Args: - addon_name (Optional[str]): Addon name which triggered process. - addon_version (Optional[str]): Addon version which triggered process. + addon_name (str): Addon name which triggered process. + addon_version (str): Addon version which triggered process. project_name (Optional[str]): Project name. Can be filled in case process is triggered for specific project. Some addons can have different behavior based on project. Value is NOT autofilled. @@ -101,16 +106,16 @@ class ProcessContext: """ def __init__( self, - addon_name: Optional[str] = None, - addon_version: Optional[str] = None, + addon_name: str = None, + addon_version: str = None, project_name: Optional[str] = None, headless: Optional[bool] = None, **kwargs, ): if headless is None: headless = is_headless_mode_enabled() - self.addon_name: Optional[str] = addon_name - self.addon_version: Optional[str] = addon_version + self.addon_name: str = addon_name + self.addon_version: str = addon_version self.project_name: Optional[str] = project_name self.headless: bool = headless diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 32b42bf1e2..1dea4cc4fe 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -152,8 +152,8 @@ def ensure_addons_are_process_context_ready( def ensure_addons_are_process_ready( - addon_name: Optional[str] = None, - addon_version: Optional[str] = None, + addon_name: str, + addon_version: str, project_name: Optional[str] = None, headless: Optional[bool] = None, addons_manager: Optional[AddonsManager] = None, @@ -167,8 +167,8 @@ def ensure_addons_are_process_ready( should not be created. Args: - addon_name (Optional[str]): Addon name which triggered process. - addon_version (Optional[str]): Addon version which triggered process. + addon_name (str): Addon name which triggered process. + addon_version (str): Addon version which triggered process. project_name (Optional[str]): Project name. Can be filled in case process is triggered for specific project. Some addons can have different behavior based on project. Value is NOT autofilled. From e5eefc81fc10db24c232157eb0ab0b08b5ef5017 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:15:07 +0200 Subject: [PATCH 46/67] added todo --- client/ayon_core/addon/utils.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 1dea4cc4fe..8e8c2bd8d7 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -79,6 +79,10 @@ def ensure_addons_are_process_context_ready( to avoid possible clashes with preparation. For example 'QApplication' should not be created. + Todos: + Run all preparations and allow to "ignore" failed preparations. + Right now single addon can block using certain actions. + Args: process_context (ProcessContext): The context in which the addons should be prepared. From e0339aeb104c13b8aada5a728d67104d3041dc3e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 20 Aug 2024 19:25:45 +0200 Subject: [PATCH 47/67] require addons_manager and exit_on_failure as kwargs --- client/ayon_core/addon/utils.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/addon/utils.py b/client/ayon_core/addon/utils.py index 8e8c2bd8d7..f983e37d3c 100644 --- a/client/ayon_core/addon/utils.py +++ b/client/ayon_core/addon/utils.py @@ -160,6 +160,7 @@ def ensure_addons_are_process_ready( addon_version: str, project_name: Optional[str] = None, headless: Optional[bool] = None, + *, addons_manager: Optional[AddonsManager] = None, exit_on_failure: bool = True, **kwargs, From 723198c2a03be93e4408c5c4179bc48b8724ca5d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 10:19:12 +0200 Subject: [PATCH 48/67] use 'title' instead of 'topic' --- server/settings/publish_plugins.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index a5ea7bd762..8ca96432f4 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -562,12 +562,12 @@ class ExtractBurninDef(BaseSettingsModel): _isGroup = True _layout = "expanded" name: str = SettingsField("") - TOP_LEFT: str = SettingsField("", topic="Top Left") - TOP_CENTERED: str = SettingsField("", topic="Top Centered") - TOP_RIGHT: str = SettingsField("", topic="Top Right") - BOTTOM_LEFT: str = SettingsField("", topic="Bottom Left") - BOTTOM_CENTERED: str = SettingsField("", topic="Bottom Centered") - BOTTOM_RIGHT: str = SettingsField("", topic="Bottom Right") + TOP_LEFT: str = SettingsField("", title="Top Left") + TOP_CENTERED: str = SettingsField("", title="Top Centered") + TOP_RIGHT: str = SettingsField("", title="Top Right") + BOTTOM_LEFT: str = SettingsField("", title="Bottom Left") + BOTTOM_CENTERED: str = SettingsField("", title="Bottom Centered") + BOTTOM_RIGHT: str = SettingsField("", title="Bottom Right") filter: ExtractBurninDefFilter = SettingsField( default_factory=ExtractBurninDefFilter, title="Additional filtering" From 725584a8dbb9b29e7dc1f675cf2c174efc268d9d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 10:29:56 +0200 Subject: [PATCH 49/67] require addon name/version Co-authored-by: Roy Nieterau --- client/ayon_core/addon/base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/addon/base.py b/client/ayon_core/addon/base.py index 494c0f3da7..7f0636ccca 100644 --- a/client/ayon_core/addon/base.py +++ b/client/ayon_core/addon/base.py @@ -106,8 +106,8 @@ class ProcessContext: """ def __init__( self, - addon_name: str = None, - addon_version: str = None, + addon_name: str, + addon_version: str, project_name: Optional[str] = None, headless: Optional[bool] = None, **kwargs, From 8dd1843be107919f01e9fdbd5baf1df297191854 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 10:52:40 +0200 Subject: [PATCH 50/67] implemented helper line edit with options --- client/ayon_core/style/style.css | 25 ++++++ client/ayon_core/tools/utils/widgets.py | 115 ++++++++++++++++++++++++ 2 files changed, 140 insertions(+) diff --git a/client/ayon_core/style/style.css b/client/ayon_core/style/style.css index 607fd1fa31..2c826f16a4 100644 --- a/client/ayon_core/style/style.css +++ b/client/ayon_core/style/style.css @@ -739,6 +739,31 @@ OverlayMessageWidget QWidget { background: transparent; } +/* Hinted Line Edit */ +#HintedLineEditInput { + border-radius: 0.2em; + border-top-right-radius: 0px; + border-bottom-right-radius: 0px; + border: 1px solid {color:border}; +} +#HintedLineEditInput:hover { + border-color: {color:border-hover}; +} +#HintedLineEditInput:focus{ + border-color: {color:border-focus}; +} +#HintedLineEditInput:disabled { + background: {color:bg-inputs-disabled}; +} +#HintedLineEditButton { + border: none; + border-radius: 0.2em; + border-bottom-left-radius: 0px; + border-top-left-radius: 0px; + padding: 0px; + qproperty-iconSize: 11px 11px; +} + /* Password dialog*/ #PasswordBtn { border: none; diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 28331fbc35..2065246190 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -1,4 +1,5 @@ import logging +from typing import Optional, List from qtpy import QtWidgets, QtCore, QtGui import qargparse @@ -104,6 +105,120 @@ def __init__(self, *args, **kwargs): self.setPalette(filter_palette) +def get_down_arrow_icon() -> QtGui.QIcon: + normal_pixmap = QtGui.QPixmap( + get_style_image_path("down_arrow") + ) + on_pixmap = QtGui.QPixmap( + get_style_image_path("down_arrow_on") + ) + disabled_pixmap = QtGui.QPixmap( + get_style_image_path("down_arrow_disabled") + ) + icon = QtGui.QIcon(normal_pixmap) + icon.addPixmap(on_pixmap, QtGui.QIcon.Active) + icon.addPixmap(disabled_pixmap, QtGui.QIcon.Disabled) + return icon + + +class HintedLineEdit(QtWidgets.QWidget): + returnPressed = QtCore.Signal() + textChanged = QtCore.Signal(str) + textEdited = QtCore.Signal(str) + + def __init__( + self, + options: Optional[List[str]] = None, + parent: Optional[QtWidgets.QWidget] = None + ): + super().__init__(parent) + + text_input = PlaceholderLineEdit(self) + options_button = QtWidgets.QPushButton(self) + + text_input.setObjectName("HintedLineEditInput") + options_button.setObjectName("HintedLineEditButton") + options_button.setIcon(get_down_arrow_icon()) + + main_layout = QtWidgets.QHBoxLayout(self) + main_layout.setContentsMargins(0, 0, 0, 0) + main_layout.setSpacing(0) + main_layout.addWidget(text_input, 1) + main_layout.addWidget(options_button, 0) + + # Expand line edit and button vertically so they have same height + for widget in (text_input, options_button): + w_size_policy = widget.sizePolicy() + w_size_policy.setVerticalPolicy( + QtWidgets.QSizePolicy.MinimumExpanding) + widget.setSizePolicy(w_size_policy) + + # Set size hint of this frame to fixed so size hint height is + # used as fixed height + size_policy = self.sizePolicy() + size_policy.setVerticalPolicy(QtWidgets.QSizePolicy.Fixed) + self.setSizePolicy(size_policy) + + text_input.returnPressed.connect(self.returnPressed) + text_input.textChanged.connect(self.textChanged) + text_input.textEdited.connect(self.textEdited) + options_button.clicked.connect(self._on_options_button_clicked) + + self._text_input = text_input + self._options_button = options_button + self._options = None + + # Set default state + self.set_options(options) + + def text(self) -> str: + return self._text_input.text() + + def setText(self, text: str): + self._text_input.setText(text) + + def setPlaceholderText(self, text: str): + self._text_input.setPlaceholderText(text) + + def placeholderText(self) -> str: + return self._text_input.placeholderText() + + def setReadOnly(self, state: bool): + self._text_input.setReadOnly(state) + + def setIcon(self, icon: QtGui.QIcon): + self._options_button.setIcon(icon) + + def set_options(self, options: Optional[List[str]] = None): + self._options = options + self._options_button.setEnabled(bool(options)) + + def sizeHint(self) -> QtCore.QSize: + hint = super().sizeHint() + tsz = self._text_input.sizeHint() + bsz = self._options_button.sizeHint() + hint.setHeight(max(tsz.height(), bsz.height())) + return hint + + def _on_options_button_clicked(self): + if not self._options: + return + + menu = QtWidgets.QMenu(self) + for option in self._options: + action = menu.addAction(option) + action.triggered.connect(self._on_option_action) + + rect = self._options_button.rect() + pos = self._options_button.mapToGlobal(rect.bottomLeft()) + menu.exec_(pos) + + def _on_option_action(self): + action = self.sender() + if action: + self.setText(action.text()) + + class ExpandingTextEdit(QtWidgets.QTextEdit): """QTextEdit which does not have sroll area but expands height.""" From 7e12163c7a78dfd0dd7157d1760232ab0808a7c2 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:25:54 +0200 Subject: [PATCH 51/67] added options to pass separator --- client/ayon_core/tools/utils/widgets.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 2065246190..e3ff42a102 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -1,5 +1,5 @@ import logging -from typing import Optional, List +from typing import Optional, List, Set from qtpy import QtWidgets, QtCore, QtGui import qargparse @@ -122,6 +122,7 @@ def get_down_arrow_icon() -> QtGui.QIcon: class HintedLineEdit(QtWidgets.QWidget): + SEPARATORS: Set[str] = {"---", "---separator---"} returnPressed = QtCore.Signal() textChanged = QtCore.Signal(str) textEdited = QtCore.Signal(str) @@ -206,6 +207,9 @@ def _on_options_button_clicked(self): menu = QtWidgets.QMenu(self) for option in self._options: + if option in self.SEPARATORS: + menu.addSeparator() + continue action = menu.addAction(option) action.triggered.connect(self._on_option_action) From 54665ba72b5732da893712586359f95ee3298ac1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:26:01 +0200 Subject: [PATCH 52/67] handle tooltips --- client/ayon_core/tools/utils/widgets.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index e3ff42a102..8109130c27 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -190,6 +190,12 @@ def setReadOnly(self, state: bool): def setIcon(self, icon: QtGui.QIcon): self._options_button.setIcon(icon) + def setToolTip(self, text: str): + self._text_input.setToolTip(text) + + def set_button_tool_tip(self, text: str): + self._options_button.setToolTip(text) + def set_options(self, options: Optional[List[str]] = None): self._options = options self._options_button.setEnabled(bool(options)) From bf48d9e804f0b66b29ddaa417f28cf0bbb253c50 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:26:16 +0200 Subject: [PATCH 53/67] added 'HintedLineEdit' to utils init file --- client/ayon_core/tools/utils/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/client/ayon_core/tools/utils/__init__.py b/client/ayon_core/tools/utils/__init__.py index 4b5fbeaf67..059ac28b7b 100644 --- a/client/ayon_core/tools/utils/__init__.py +++ b/client/ayon_core/tools/utils/__init__.py @@ -5,6 +5,7 @@ ComboBox, CustomTextComboBox, PlaceholderLineEdit, + HintedLineEdit, ExpandingTextEdit, BaseClickableFrame, ClickableFrame, @@ -88,6 +89,7 @@ "ComboBox", "CustomTextComboBox", "PlaceholderLineEdit", + "HintedLineEdit", "ExpandingTextEdit", "BaseClickableFrame", "ClickableFrame", From 8a9d815278746f5b49cf09b4cb50e8b5647b4a7e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:29:44 +0200 Subject: [PATCH 54/67] use class name over object name for formatting --- client/ayon_core/style/style.css | 10 +++++----- client/ayon_core/tools/utils/widgets.py | 15 ++++++++++----- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/style/style.css b/client/ayon_core/style/style.css index 2c826f16a4..1af355ac7b 100644 --- a/client/ayon_core/style/style.css +++ b/client/ayon_core/style/style.css @@ -740,22 +740,22 @@ OverlayMessageWidget QWidget { } /* Hinted Line Edit */ -#HintedLineEditInput { +HintedLineEditInput { border-radius: 0.2em; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border: 1px solid {color:border}; } -#HintedLineEditInput:hover { +HintedLineEditInput:hover { border-color: {color:border-hover}; } -#HintedLineEditInput:focus{ +HintedLineEditInput:focus{ border-color: {color:border-focus}; } -#HintedLineEditInput:disabled { +HintedLineEditInput:disabled { background: {color:bg-inputs-disabled}; } -#HintedLineEditButton { +HintedLineEditButton { border: none; border-radius: 0.2em; border-bottom-left-radius: 0px; diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 8109130c27..008f48c502 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -121,6 +121,14 @@ def get_down_arrow_icon() -> QtGui.QIcon: return icon +class HintedLineEditInput(PlaceholderLineEdit): + pass + + +class HintedLineEditButton(QtWidgets.QPushButton): + pass + + class HintedLineEdit(QtWidgets.QWidget): SEPARATORS: Set[str] = {"---", "---separator---"} returnPressed = QtCore.Signal() @@ -134,11 +142,8 @@ def __init__( ): super().__init__(parent) - text_input = PlaceholderLineEdit(self) - options_button = QtWidgets.QPushButton(self) - - text_input.setObjectName("HintedLineEditInput") - options_button.setObjectName("HintedLineEditButton") + text_input = HintedLineEditInput(self) + options_button = HintedLineEditButton(self) options_button.setIcon(get_down_arrow_icon()) main_layout = QtWidgets.QHBoxLayout(self) From c8880a87d63fcdd5af69ed1f95ba9910d2970527 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 12:11:58 +0200 Subject: [PATCH 55/67] added option to change style of the widget --- client/ayon_core/tools/utils/widgets.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 008f48c502..184465ee1b 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -1,5 +1,5 @@ import logging -from typing import Optional, List, Set +from typing import Optional, List, Set, Any from qtpy import QtWidgets, QtCore, QtGui import qargparse @@ -12,7 +12,7 @@ ) from ayon_core.lib.attribute_definitions import AbstractAttrDef -from .lib import get_qta_icon_by_name_and_color +from .lib import get_qta_icon_by_name_and_color, set_style_property log = logging.getLogger(__name__) @@ -121,6 +121,7 @@ def get_down_arrow_icon() -> QtGui.QIcon: return icon +# These are placeholders for adding style class HintedLineEditInput(PlaceholderLineEdit): pass @@ -212,6 +213,21 @@ def sizeHint(self) -> QtCore.QSize: hint.setHeight(max(tsz.height(), bsz.height())) return hint + # Adds ability to change style of the widgets + # - because style change of the 'HintedLineEdit' may not propagate + # correctly 'HintedLineEditInput' and 'HintedLineEditButton' + def set_text_widget_object_name(self, name: str): + self._text_input.setObjectName(name) + + def set_text_widget_property(self, name: str, value: Any): + set_style_property(self._text_input, name, value) + + def set_button_widget_object_name(self, name: str): + self._text_input.setObjectName(name) + + def set_button_widget_property(self, name: str, value: Any): + set_style_property(self._options_button, name, value) + def _on_options_button_clicked(self): if not self._options: return From 9524aadeb2db0aa9c8cb37cea68f87521e2cb507 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 12:13:49 +0200 Subject: [PATCH 56/67] use 'HintedLineEdit' in publisher --- client/ayon_core/style/style.css | 11 --- .../tools/publisher/widgets/create_widget.py | 98 +++++-------------- 2 files changed, 22 insertions(+), 87 deletions(-) diff --git a/client/ayon_core/style/style.css b/client/ayon_core/style/style.css index 1af355ac7b..0857bc80c6 100644 --- a/client/ayon_core/style/style.css +++ b/client/ayon_core/style/style.css @@ -994,17 +994,6 @@ PixmapButton:disabled { #PublishLogConsole { font-family: "Noto Sans Mono"; } -#VariantInputsWidget QLineEdit { - border-bottom-right-radius: 0px; - border-top-right-radius: 0px; -} -#VariantInputsWidget QToolButton { - border-bottom-left-radius: 0px; - border-top-left-radius: 0px; - padding-top: 0.5em; - padding-bottom: 0.5em; - width: 0.5em; -} #VariantInput[state="new"], #VariantInput[state="new"]:focus, #VariantInput[state="new"]:hover { border-color: {color:publisher:success}; } diff --git a/client/ayon_core/tools/publisher/widgets/create_widget.py b/client/ayon_core/tools/publisher/widgets/create_widget.py index 479a63ebc9..4c94c5c9b9 100644 --- a/client/ayon_core/tools/publisher/widgets/create_widget.py +++ b/client/ayon_core/tools/publisher/widgets/create_widget.py @@ -19,6 +19,7 @@ INPUTS_LAYOUT_HSPACING, INPUTS_LAYOUT_VSPACING, ) +from ayon_core.tools.utils import HintedLineEdit from .thumbnail_widget import ThumbnailWidget from .widgets import ( @@ -28,8 +29,6 @@ from .create_context_widgets import CreateContextWidget from .precreate_widget import PreCreateWidget -SEPARATORS = ("---separator---", "---") - class ResizeControlWidget(QtWidgets.QWidget): resized = QtCore.Signal() @@ -168,25 +167,9 @@ def __init__(self, controller, parent=None): product_variant_widget = QtWidgets.QWidget(creator_basics_widget) # Variant and product input - variant_widget = ResizeControlWidget(product_variant_widget) - variant_widget.setObjectName("VariantInputsWidget") - - variant_input = QtWidgets.QLineEdit(variant_widget) - variant_input.setObjectName("VariantInput") - variant_input.setToolTip(VARIANT_TOOLTIP) - - variant_hints_btn = QtWidgets.QToolButton(variant_widget) - variant_hints_btn.setArrowType(QtCore.Qt.DownArrow) - variant_hints_btn.setIconSize(QtCore.QSize(12, 12)) - - variant_hints_menu = QtWidgets.QMenu(variant_widget) - variant_hints_group = QtWidgets.QActionGroup(variant_hints_menu) - - variant_layout = QtWidgets.QHBoxLayout(variant_widget) - variant_layout.setContentsMargins(0, 0, 0, 0) - variant_layout.setSpacing(0) - variant_layout.addWidget(variant_input, 1) - variant_layout.addWidget(variant_hints_btn, 0, QtCore.Qt.AlignVCenter) + variant_widget = HintedLineEdit(parent=product_variant_widget) + variant_widget.set_text_widget_object_name("VariantInput") + variant_widget.setToolTip(VARIANT_TOOLTIP) product_name_input = QtWidgets.QLineEdit(product_variant_widget) product_name_input.setEnabled(False) @@ -262,15 +245,12 @@ def __init__(self, controller, parent=None): prereq_timer.timeout.connect(self._invalidate_prereq) create_btn.clicked.connect(self._on_create) - variant_widget.resized.connect(self._on_variant_widget_resize) creator_basics_widget.resized.connect(self._on_creator_basics_resize) - variant_input.returnPressed.connect(self._on_create) - variant_input.textChanged.connect(self._on_variant_change) + variant_widget.returnPressed.connect(self._on_create) + variant_widget.textChanged.connect(self._on_variant_change) creators_view.selectionModel().currentChanged.connect( self._on_creator_item_change ) - variant_hints_btn.clicked.connect(self._on_variant_btn_click) - variant_hints_menu.triggered.connect(self._on_variant_action) context_widget.folder_changed.connect(self._on_folder_change) context_widget.task_changed.connect(self._on_task_change) thumbnail_widget.thumbnail_created.connect(self._on_thumbnail_create) @@ -291,10 +271,7 @@ def __init__(self, controller, parent=None): self.product_name_input = product_name_input - self.variant_input = variant_input - self.variant_hints_btn = variant_hints_btn - self.variant_hints_menu = variant_hints_menu - self.variant_hints_group = variant_hints_group + self._variant_widget = variant_widget self._creators_model = creators_model self._creators_sort_model = creators_sort_model @@ -314,6 +291,7 @@ def __init__(self, controller, parent=None): self._last_current_context_folder_path = None self._last_current_context_task = None self._use_current_context = True + self._current_creator_variant_hints = [] def get_current_folder_path(self): return self._controller.get_current_folder_path() @@ -438,8 +416,7 @@ def _invalidate_prereq(self): self._create_btn.setEnabled(prereq_available) - self.variant_input.setEnabled(prereq_available) - self.variant_hints_btn.setEnabled(prereq_available) + self._variant_widget.setEnabled(prereq_available) tooltip = "" if creator_btn_tooltips: @@ -611,35 +588,15 @@ def _set_creator(self, creator_item): if not default_variant: default_variant = default_variants[0] - for action in tuple(self.variant_hints_menu.actions()): - self.variant_hints_menu.removeAction(action) - action.deleteLater() - - for variant in default_variants: - if variant in SEPARATORS: - self.variant_hints_menu.addSeparator() - elif variant: - self.variant_hints_menu.addAction(variant) + self._current_creator_variant_hints = list(default_variants) + self._variant_widget.set_options(default_variants) variant_text = default_variant or DEFAULT_VARIANT_VALUE # Make sure product name is updated to new plugin - if variant_text == self.variant_input.text(): + if variant_text == self._variant_widget.text(): self._on_variant_change() else: - self.variant_input.setText(variant_text) - - def _on_variant_widget_resize(self): - self.variant_hints_btn.setFixedHeight(self.variant_input.height()) - - def _on_variant_btn_click(self): - pos = self.variant_hints_btn.rect().bottomLeft() - point = self.variant_hints_btn.mapToGlobal(pos) - self.variant_hints_menu.popup(point) - - def _on_variant_action(self, action): - value = action.text() - if self.variant_input.text() != value: - self.variant_input.setText(value) + self._variant_widget.setText(variant_text) def _on_variant_change(self, variant_value=None): if not self._prereq_available: @@ -652,7 +609,7 @@ def _on_variant_change(self, variant_value=None): return if variant_value is None: - variant_value = self.variant_input.text() + variant_value = self._variant_widget.text() if not self._compiled_name_pattern.match(variant_value): self._create_btn.setEnabled(False) @@ -707,20 +664,12 @@ def _validate_product_name(self, product_name, variant_value): if _result: variant_hints |= set(_result.groups()) - # Remove previous hints from menu - for action in tuple(self.variant_hints_group.actions()): - self.variant_hints_group.removeAction(action) - self.variant_hints_menu.removeAction(action) - action.deleteLater() - - # Add separator if there are hints and menu already has actions - if variant_hints and self.variant_hints_menu.actions(): - self.variant_hints_menu.addSeparator() - + options = list(self._current_creator_variant_hints) + if options: + options.append("---") + options.extend(variant_hints) # Add hints to actions - for variant_hint in variant_hints: - action = self.variant_hints_menu.addAction(variant_hint) - self.variant_hints_group.addAction(action) + self._variant_widget.set_options(options) # Indicate product existence if not variant_value: @@ -741,10 +690,7 @@ def _validate_product_name(self, product_name, variant_value): self._create_btn.setEnabled(variant_is_valid) def _set_variant_state_property(self, state): - current_value = self.variant_input.property("state") - if current_value != state: - self.variant_input.setProperty("state", state) - self.variant_input.style().polish(self.variant_input) + self._variant_widget.set_text_widget_property("state", state) def _on_first_show(self): width = self.width() @@ -776,7 +722,7 @@ def _on_create(self): index = indexes[0] creator_identifier = index.data(CREATOR_IDENTIFIER_ROLE) product_type = index.data(PRODUCT_TYPE_ROLE) - variant = self.variant_input.text() + variant = self._variant_widget.text() # Care about product name only if context change is enabled product_name = None folder_path = None @@ -810,7 +756,7 @@ def _on_create(self): if success: self._set_creator(self._selected_creator) - self.variant_input.setText(variant) + self._variant_widget.setText(variant) self._controller.emit_card_message("Creation finished...") self._last_thumbnail_path = None self._thumbnail_widget.set_current_thumbnails() From e54e639b9dd7473d590488fc9506ce3de2f21e45 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:39:23 +0200 Subject: [PATCH 57/67] don't show spent time if did not run yet --- .../tools/publisher/publish_report_viewer/widgets.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 029ce300a8..8227008ff3 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -442,9 +442,14 @@ def __init__(self, plugin_item, parent): plugin_families_widget.setText(str(plugin_item.families or "N/A")) plugin_path_widget.setText(plugin_item.filepath or "N/A") plugin_path_widget.setToolTip(plugin_item.filepath or None) - plugin_time_widget.setText( - get_pretty_milliseconds(plugin_item.process_time) - ) + if plugin_item.passed: + time_label = get_pretty_milliseconds(plugin_item.process_time) + elif plugin_item.skipped: + time_label = "Skipped plugin" + else: + time_label = "Not started" + + plugin_time_widget.setText(time_label) content_layout = QtWidgets.QGridLayout(content_widget) content_layout.setContentsMargins(8, 8, 8, 8) From fd6c6eade49636dbb4604d25c02f235b3711512c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:42:01 +0200 Subject: [PATCH 58/67] details widget is acknowledged about being active --- .../tools/publisher/publish_report_viewer/widgets.py | 8 ++++++++ client/ayon_core/tools/publisher/window.py | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 8227008ff3..af1a7e5281 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -817,6 +817,14 @@ def _on_plugin_view_clicked(self, index): else: self._plugins_view.expand(index) + def set_active(self, active): + for idx in range(self._details_tab_widget.count()): + widget = self._details_tab_widget.widget(idx) + widget.set_active(active and idx == self._current_tab_idx) + + if not active: + self.close_details_popup() + def set_report_data(self, report_data): report = PublishReport(report_data) self.set_report(report) diff --git a/client/ayon_core/tools/publisher/window.py b/client/ayon_core/tools/publisher/window.py index 1218221420..0c6087b41d 100644 --- a/client/ayon_core/tools/publisher/window.py +++ b/client/ayon_core/tools/publisher/window.py @@ -687,13 +687,14 @@ def _on_create_overlay_button_click(self): def _on_tab_change(self, old_tab, new_tab): if old_tab == "details": - self._publish_details_widget.close_details_popup() + self._publish_details_widget.set_active(False) if new_tab == "details": self._content_stacked_layout.setCurrentWidget( self._publish_details_widget ) self._update_publish_details_widget() + self._publish_details_widget.set_active(True) elif new_tab == "report": self._content_stacked_layout.setCurrentWidget( From cf6cf0bf14eba836e575428e476baf99dda38dd1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:54:55 +0200 Subject: [PATCH 59/67] move time label calculation above value changes --- .../publisher/publish_report_viewer/widgets.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index af1a7e5281..b8ddb0ef54 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -435,6 +435,12 @@ def __init__(self, plugin_item, parent): plugin_label += " ({})".format( plugin_item.plugin_type.capitalize() ) + + time_label = "Not started" + if plugin_item.passed: + time_label = get_pretty_milliseconds(plugin_item.process_time) + elif plugin_item.skipped: + time_label = "Skipped plugin" plugin_label_widget.setText(plugin_label) plugin_doc_widget.setText(plugin_item.docstring or "N/A") plugin_class_widget.setText(plugin_item.name or "N/A") @@ -442,13 +448,6 @@ def __init__(self, plugin_item, parent): plugin_families_widget.setText(str(plugin_item.families or "N/A")) plugin_path_widget.setText(plugin_item.filepath or "N/A") plugin_path_widget.setToolTip(plugin_item.filepath or None) - if plugin_item.passed: - time_label = get_pretty_milliseconds(plugin_item.process_time) - elif plugin_item.skipped: - time_label = "Skipped plugin" - else: - time_label = "Not started" - plugin_time_widget.setText(time_label) content_layout = QtWidgets.QGridLayout(content_widget) From f2232f0af15dd6b87323a9d1f5c45fa78f5c7c0c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:55:46 +0200 Subject: [PATCH 60/67] '0' order is not resolved as N/A --- .../tools/publisher/publish_report_viewer/widgets.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index b8ddb0ef54..5e854ae945 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -441,10 +441,14 @@ def __init__(self, plugin_item, parent): time_label = get_pretty_milliseconds(plugin_item.process_time) elif plugin_item.skipped: time_label = "Skipped plugin" + order = plugin_item.order + if order is None: + order = "N/A" + plugin_label_widget.setText(plugin_label) plugin_doc_widget.setText(plugin_item.docstring or "N/A") plugin_class_widget.setText(plugin_item.name or "N/A") - plugin_order_widget.setText(str(plugin_item.order or "N/A")) + plugin_order_widget.setText(order) plugin_families_widget.setText(str(plugin_item.families or "N/A")) plugin_path_widget.setText(plugin_item.filepath or "N/A") plugin_path_widget.setToolTip(plugin_item.filepath or None) From 9fce774a7e545641ab0282e2f71e3e7512d3765d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:56:08 +0200 Subject: [PATCH 61/67] families are joined with comma --- .../tools/publisher/publish_report_viewer/widgets.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 5e854ae945..925547bc1a 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -441,6 +441,11 @@ def __init__(self, plugin_item, parent): time_label = get_pretty_milliseconds(plugin_item.process_time) elif plugin_item.skipped: time_label = "Skipped plugin" + + families = "N/A" + if plugin_item.families: + families = ", ".join(plugin_item.families) + order = plugin_item.order if order is None: order = "N/A" @@ -449,7 +454,7 @@ def __init__(self, plugin_item, parent): plugin_doc_widget.setText(plugin_item.docstring or "N/A") plugin_class_widget.setText(plugin_item.name or "N/A") plugin_order_widget.setText(order) - plugin_families_widget.setText(str(plugin_item.families or "N/A")) + plugin_families_widget.setText(families) plugin_path_widget.setText(plugin_item.filepath or "N/A") plugin_path_widget.setToolTip(plugin_item.filepath or None) plugin_time_widget.setText(time_label) From 4eef7ecadd22185585e4cdb1e7107a69329c455a Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:57:18 +0200 Subject: [PATCH 62/67] hide content widget before adding widgets to it's layout --- .../tools/publisher/publish_report_viewer/widgets.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 925547bc1a..6441667264 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -578,6 +578,11 @@ def _update_widgets(self): self._need_refresh = False + # Hide content widget before updating + # - add widgets to layout can happen without recalculating + # the layout and widget size hints + self._content_widget.setVisible(False) + for plugin_id in self._get_plugin_ids(): widget = self._widgets_by_plugin_id.get(plugin_id) if widget is None: @@ -591,6 +596,7 @@ def _update_widgets(self): or plugin_id in self._plugin_filter ) + self._content_widget.setVisible(True) class DeselectableTreeView(QtWidgets.QTreeView): """A tree view that deselects on clicking on an empty area in the view""" From a819797f21a6a1f287fd7dde789eab457a7b7f05 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:58:25 +0200 Subject: [PATCH 63/67] don't show all details if nothing is selected --- .../tools/publisher/publish_report_viewer/widgets.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index 6441667264..df6cd4b168 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -591,10 +591,7 @@ def _update_widgets(self): self._widgets_by_plugin_id[plugin_id] = widget self._content_layout.addWidget(widget, 0) - widget.setVisible( - not self._plugin_filter - or plugin_id in self._plugin_filter - ) + widget.setVisible(plugin_id in self._plugin_filter) self._content_widget.setVisible(True) From 1e7be786eb69f2c0b265b4e7833aa2e5c097a72e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 14:58:47 +0200 Subject: [PATCH 64/67] added label shown if nothing is selected --- .../publish_report_viewer/widgets.py | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index df6cd4b168..fa4127fe8b 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -505,6 +505,12 @@ def __init__(self, parent): scroll_area.setWidget(scroll_content_widget) + empty_label = QtWidgets.QLabel( + "

Select plugins to view more information...", + scroll_content_widget + ) + empty_label.setAlignment(QtCore.Qt.AlignCenter) + content_widget = QtWidgets.QWidget(scroll_content_widget) content_layout = QtWidgets.QVBoxLayout(content_widget) @@ -513,6 +519,7 @@ def __init__(self, parent): scroll_content_layout = QtWidgets.QVBoxLayout(scroll_content_widget) scroll_content_layout.setContentsMargins(0, 0, 0, 0) + scroll_content_layout.addWidget(empty_label, 0) scroll_content_layout.addWidget(content_widget, 0) scroll_content_layout.addStretch(1) @@ -520,7 +527,10 @@ def __init__(self, parent): main_layout.setContentsMargins(0, 0, 0, 0) main_layout.addWidget(scroll_area, 1) + content_widget.setVisible(False) + self._scroll_area = scroll_area + self._empty_label = empty_label self._content_layout = content_layout self._content_widget = content_widget @@ -583,6 +593,7 @@ def _update_widgets(self): # the layout and widget size hints self._content_widget.setVisible(False) + any_visible = False for plugin_id in self._get_plugin_ids(): widget = self._widgets_by_plugin_id.get(plugin_id) if widget is None: @@ -591,9 +602,14 @@ def _update_widgets(self): self._widgets_by_plugin_id[plugin_id] = widget self._content_layout.addWidget(widget, 0) - widget.setVisible(plugin_id in self._plugin_filter) + is_visible = plugin_id in self._plugin_filter + widget.setVisible(is_visible) + if is_visible: + any_visible = True + + self._content_widget.setVisible(any_visible) + self._empty_label.setVisible(not any_visible) - self._content_widget.setVisible(True) class DeselectableTreeView(QtWidgets.QTreeView): """A tree view that deselects on clicking on an empty area in the view""" From 7e4da0761d558bd42c9f0dcadbdb679d605f1699 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:00:07 +0200 Subject: [PATCH 65/67] order is converted to string --- .../tools/publisher/publish_report_viewer/widgets.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py index fa4127fe8b..5fa1c04dc0 100644 --- a/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py +++ b/client/ayon_core/tools/publisher/publish_report_viewer/widgets.py @@ -446,9 +446,9 @@ def __init__(self, plugin_item, parent): if plugin_item.families: families = ", ".join(plugin_item.families) - order = plugin_item.order - if order is None: - order = "N/A" + order = "N/A" + if plugin_item.order is not None: + order = str(plugin_item.order) plugin_label_widget.setText(plugin_label) plugin_doc_widget.setText(plugin_item.docstring or "N/A") From d8ca5e797cdfaa658c8251e89efbc8270c0d8e98 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:59:25 +0200 Subject: [PATCH 66/67] simplify menu handling --- client/ayon_core/tools/utils/widgets.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 184465ee1b..982b2fd6a6 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -233,21 +233,19 @@ def _on_options_button_clicked(self): return menu = QtWidgets.QMenu(self) + menu.triggered.connect(self._on_option_action) for option in self._options: if option in self.SEPARATORS: menu.addSeparator() - continue - action = menu.addAction(option) - action.triggered.connect(self._on_option_action) + else: + menu.addAction(option) rect = self._options_button.rect() pos = self._options_button.mapToGlobal(rect.bottomLeft()) menu.exec_(pos) - def _on_option_action(self): - action = self.sender() - if action: - self.setText(action.text()) + def _on_option_action(self, action): + self.setText(action.text()) class ExpandingTextEdit(QtWidgets.QTextEdit): From 767ce61208f549a9fb38d1acad9191f092638c52 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 Aug 2024 16:19:09 +0200 Subject: [PATCH 67/67] cache paths --- client/ayon_core/tools/utils/widgets.py | 29 +++++++++++++++---------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/client/ayon_core/tools/utils/widgets.py b/client/ayon_core/tools/utils/widgets.py index 982b2fd6a6..5e4cd75cfe 100644 --- a/client/ayon_core/tools/utils/widgets.py +++ b/client/ayon_core/tools/utils/widgets.py @@ -105,7 +105,14 @@ def __init__(self, *args, **kwargs): self.setPalette(filter_palette) +class _LocalCache: + down_arrow_icon = None + + def get_down_arrow_icon() -> QtGui.QIcon: + if _LocalCache.down_arrow_icon is not None: + return _LocalCache.down_arrow_icon + normal_pixmap = QtGui.QPixmap( get_style_image_path("down_arrow") ) @@ -118,6 +125,7 @@ def get_down_arrow_icon() -> QtGui.QIcon: icon = QtGui.QIcon(normal_pixmap) icon.addPixmap(on_pixmap, QtGui.QIcon.Active) icon.addPixmap(disabled_pixmap, QtGui.QIcon.Disabled) + _LocalCache.down_arrow_icon = icon return icon @@ -350,6 +358,8 @@ class ExpandBtnLabel(QtWidgets.QLabel): """Label showing expand icon meant for ExpandBtn.""" state_changed = QtCore.Signal() + branch_closed_path = get_style_image_path("branch_closed") + branch_open_path = get_style_image_path("branch_open") def __init__(self, parent): super(ExpandBtnLabel, self).__init__(parent) @@ -360,14 +370,10 @@ def __init__(self, parent): self._collapsed = True def _create_collapsed_pixmap(self): - return QtGui.QPixmap( - get_style_image_path("branch_closed") - ) + return QtGui.QPixmap(self.branch_closed_path) def _create_expanded_pixmap(self): - return QtGui.QPixmap( - get_style_image_path("branch_open") - ) + return QtGui.QPixmap(self.branch_open_path) @property def collapsed(self): @@ -435,15 +441,14 @@ def set_collapsed(self, collapsed=None): class ClassicExpandBtnLabel(ExpandBtnLabel): + right_arrow_path = get_style_image_path("right_arrow") + down_arrow_path = get_style_image_path("down_arrow") + def _create_collapsed_pixmap(self): - return QtGui.QPixmap( - get_style_image_path("right_arrow") - ) + return QtGui.QPixmap(self.right_arrow_path) def _create_expanded_pixmap(self): - return QtGui.QPixmap( - get_style_image_path("down_arrow") - ) + return QtGui.QPixmap(self.down_arrow_path) class ClassicExpandBtn(ExpandBtn):