diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9a3571eca6..a5c928273d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,18 +1,69 @@
# Changelog
-## [3.6.2-nightly.1](https://github.com/pypeclub/OpenPype/tree/HEAD)
+## [3.7.0-nightly.2](https://github.com/pypeclub/OpenPype/tree/HEAD)
-[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.6.1...HEAD)
+[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.6.4...HEAD)
**🚀 Enhancements**
+- Ftrack: Synchronize input links [\#2287](https://github.com/pypeclub/OpenPype/pull/2287)
+- StandalonePublisher: Remove unused plugin ExtractHarmonyZip [\#2277](https://github.com/pypeclub/OpenPype/pull/2277)
+- Ftrack: Support multiple reviews [\#2271](https://github.com/pypeclub/OpenPype/pull/2271)
+- Ftrack: Remove unused clean component plugin [\#2269](https://github.com/pypeclub/OpenPype/pull/2269)
+- Royal Render: Support for rr channels in separate dirs [\#2268](https://github.com/pypeclub/OpenPype/pull/2268)
+- Houdini: Add experimental tools action [\#2267](https://github.com/pypeclub/OpenPype/pull/2267)
+
+**🐛 Bug fixes**
+
+- Maya: Deadline - fix limit groups [\#2295](https://github.com/pypeclub/OpenPype/pull/2295)
+- New Publisher: Fix mapping of indexes [\#2285](https://github.com/pypeclub/OpenPype/pull/2285)
+- Alternate site for site sync doesnt work for sequences [\#2284](https://github.com/pypeclub/OpenPype/pull/2284)
+- FFmpeg: Execute ffprobe using list of arguments instead of string command [\#2281](https://github.com/pypeclub/OpenPype/pull/2281)
+- Nuke: Anatomy fill data use task as dictionary [\#2278](https://github.com/pypeclub/OpenPype/pull/2278)
+- Bug: fix variable name \_asset\_id in workfiles application [\#2274](https://github.com/pypeclub/OpenPype/pull/2274)
+
+## [3.6.4](https://github.com/pypeclub/OpenPype/tree/3.6.4) (2021-11-23)
+
+[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.7.0-nightly.1...3.6.4)
+
+**🐛 Bug fixes**
+
+- Nuke: inventory update removes all loaded read nodes [\#2294](https://github.com/pypeclub/OpenPype/pull/2294)
+
+## [3.6.3](https://github.com/pypeclub/OpenPype/tree/3.6.3) (2021-11-19)
+
+[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.6.3-nightly.1...3.6.3)
+
+**🐛 Bug fixes**
+
+- Deadline: Fix publish targets [\#2280](https://github.com/pypeclub/OpenPype/pull/2280)
+
+## [3.6.2](https://github.com/pypeclub/OpenPype/tree/3.6.2) (2021-11-18)
+
+[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.6.2-nightly.2...3.6.2)
+
+**🚀 Enhancements**
+
+- Tools: Assets widget [\#2265](https://github.com/pypeclub/OpenPype/pull/2265)
+- SceneInventory: Choose loader in asset switcher [\#2262](https://github.com/pypeclub/OpenPype/pull/2262)
+- Style: New fonts in OpenPype style [\#2256](https://github.com/pypeclub/OpenPype/pull/2256)
- Tools: SceneInventory in OpenPype [\#2255](https://github.com/pypeclub/OpenPype/pull/2255)
- Tools: Tasks widget [\#2251](https://github.com/pypeclub/OpenPype/pull/2251)
+- Tools: Creator in OpenPype [\#2244](https://github.com/pypeclub/OpenPype/pull/2244)
- Added endpoint for configured extensions [\#2221](https://github.com/pypeclub/OpenPype/pull/2221)
**🐛 Bug fixes**
+- Version handling fixes [\#2272](https://github.com/pypeclub/OpenPype/pull/2272)
+- Tools: Parenting of tools in Nuke and Hiero [\#2266](https://github.com/pypeclub/OpenPype/pull/2266)
+- limiting validator to specific editorial hosts [\#2264](https://github.com/pypeclub/OpenPype/pull/2264)
+- Tools: Select Context dialog attribute fix [\#2261](https://github.com/pypeclub/OpenPype/pull/2261)
+- Maya: Render publishing fails on linux [\#2260](https://github.com/pypeclub/OpenPype/pull/2260)
+- LookAssigner: Fix tool reopen [\#2259](https://github.com/pypeclub/OpenPype/pull/2259)
+- Standalone: editorial not publishing thumbnails on all subsets [\#2258](https://github.com/pypeclub/OpenPype/pull/2258)
- Burnins: Support mxf metadata [\#2247](https://github.com/pypeclub/OpenPype/pull/2247)
+- Maya: Support for configurable AOV separator characters [\#2197](https://github.com/pypeclub/OpenPype/pull/2197)
+- Maya: texture colorspace modes in looks [\#2195](https://github.com/pypeclub/OpenPype/pull/2195)
## [3.6.1](https://github.com/pypeclub/OpenPype/tree/3.6.1) (2021-11-16)
@@ -83,25 +134,6 @@
[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.5.0-nightly.8...3.5.0)
-**🆕 New features**
-
-- Added project and task into context change message in Maya [\#2131](https://github.com/pypeclub/OpenPype/pull/2131)
-- Add ExtractBurnin to photoshop review [\#2124](https://github.com/pypeclub/OpenPype/pull/2124)
-- PYPE-1218 - changed namespace to contain subset name in Maya [\#2114](https://github.com/pypeclub/OpenPype/pull/2114)
-
-**🚀 Enhancements**
-
-- Maya: make rig validators configurable in settings [\#2137](https://github.com/pypeclub/OpenPype/pull/2137)
-- Settings: Updated readme for entity types in settings [\#2132](https://github.com/pypeclub/OpenPype/pull/2132)
-- Nuke: unified clip loader [\#2128](https://github.com/pypeclub/OpenPype/pull/2128)
-
-**🐛 Bug fixes**
-
-- Maya: fix model publishing [\#2130](https://github.com/pypeclub/OpenPype/pull/2130)
-- Fix - oiiotool wasn't recognized even if present [\#2129](https://github.com/pypeclub/OpenPype/pull/2129)
-- General: Disk mapping group [\#2120](https://github.com/pypeclub/OpenPype/pull/2120)
-- Hiero: publishing effect first time makes wrong resources path [\#2115](https://github.com/pypeclub/OpenPype/pull/2115)
-
## [3.4.1](https://github.com/pypeclub/OpenPype/tree/3.4.1) (2021-09-23)
[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.4.1-nightly.1...3.4.1)
diff --git a/igniter/bootstrap_repos.py b/igniter/bootstrap_repos.py
index f7f35824c8..151597e505 100644
--- a/igniter/bootstrap_repos.py
+++ b/igniter/bootstrap_repos.py
@@ -10,6 +10,7 @@ import tempfile
from pathlib import Path
from typing import Union, Callable, List, Tuple
import hashlib
+import platform
from zipfile import ZipFile, BadZipFile
@@ -196,21 +197,23 @@ class OpenPypeVersion(semver.VersionInfo):
return str(self.finalize_version())
@staticmethod
- def version_in_str(string: str) -> Tuple:
+ def version_in_str(string: str) -> Union[None, OpenPypeVersion]:
"""Find OpenPype version in given string.
Args:
string (str): string to search.
Returns:
- tuple: True/False and OpenPypeVersion if found.
+ OpenPypeVersion: of detected or None.
"""
m = re.search(OpenPypeVersion._VERSION_REGEX, string)
if not m:
- return False, None
+ return None
version = OpenPypeVersion.parse(string[m.start():m.end()])
- return True, version
+ if "staging" in string[m.start():m.end()]:
+ version.staging = True
+ return version
@classmethod
def parse(cls, version):
@@ -531,6 +534,7 @@ class BootstrapRepos:
processed_path = file
self._print(f"- processing {processed_path}")
+
checksums.append(
(
sha256sum(file.as_posix()),
@@ -542,7 +546,10 @@ class BootstrapRepos:
checksums_str = ""
for c in checksums:
- checksums_str += "{}:{}\n".format(c[0], c[1])
+ file_str = c[1]
+ if platform.system().lower() == "windows":
+ file_str = c[1].as_posix().replace("\\", "/")
+ checksums_str += "{}:{}\n".format(c[0], file_str)
zip_file.writestr("checksums", checksums_str)
# test if zip is ok
zip_file.testzip()
@@ -563,6 +570,8 @@ class BootstrapRepos:
and string with reason as second.
"""
+ if os.getenv("OPENPYPE_DONT_VALIDATE_VERSION"):
+ return True, "Disabled validation"
if not path.exists():
return False, "Path doesn't exist"
@@ -589,13 +598,16 @@ class BootstrapRepos:
# calculate and compare checksums in the zip file
for file in checksums:
+ file_name = file[1]
+ if platform.system().lower() == "windows":
+ file_name = file_name.replace("/", "\\")
h = hashlib.sha256()
try:
- h.update(zip_file.read(file[1]))
+ h.update(zip_file.read(file_name))
except FileNotFoundError:
- return False, f"Missing file [ {file[1]} ]"
+ return False, f"Missing file [ {file_name} ]"
if h.hexdigest() != file[0]:
- return False, f"Invalid checksum on {file[1]}"
+ return False, f"Invalid checksum on {file_name}"
# get list of files in zip minus `checksums` file itself
# and turn in to set to compare against list of files
@@ -604,7 +616,7 @@ class BootstrapRepos:
files_in_zip = zip_file.namelist()
files_in_zip.remove("checksums")
files_in_zip = set(files_in_zip)
- files_in_checksum = set([file[1] for file in checksums])
+ files_in_checksum = {file[1] for file in checksums}
diff = files_in_zip.difference(files_in_checksum)
if diff:
return False, f"Missing files {diff}"
@@ -628,16 +640,19 @@ class BootstrapRepos:
]
files_in_dir.remove("checksums")
files_in_dir = set(files_in_dir)
- files_in_checksum = set([file[1] for file in checksums])
+ files_in_checksum = {file[1] for file in checksums}
for file in checksums:
+ file_name = file[1]
+ if platform.system().lower() == "windows":
+ file_name = file_name.replace("/", "\\")
try:
- current = sha256sum((path / file[1]).as_posix())
+ current = sha256sum((path / file_name).as_posix())
except FileNotFoundError:
- return False, f"Missing file [ {file[1]} ]"
+ return False, f"Missing file [ {file_name} ]"
if file[0] != current:
- return False, f"Invalid checksum on {file[1]}"
+ return False, f"Invalid checksum on {file_name}"
diff = files_in_dir.difference(files_in_checksum)
if diff:
return False, f"Missing files {diff}"
@@ -1161,9 +1176,9 @@ class BootstrapRepos:
name = item.name if item.is_dir() else item.stem
result = OpenPypeVersion.version_in_str(name)
- if result[0]:
+ if result:
detected_version: OpenPypeVersion
- detected_version = result[1]
+ detected_version = result
if item.is_dir() and not self._is_openpype_in_dir(
item, detected_version
diff --git a/igniter/version.py b/igniter/version.py
index 56d58f7f60..8e7731f6d6 100644
--- a/igniter/version.py
+++ b/igniter/version.py
@@ -1,4 +1,4 @@
# -*- coding: utf-8 -*-
"""Definition of Igniter version."""
-__version__ = "1.0.1"
+__version__ = "1.0.2"
diff --git a/openpype/api.py b/openpype/api.py
index e4bbb104a3..a6529202ff 100644
--- a/openpype/api.py
+++ b/openpype/api.py
@@ -17,6 +17,7 @@ from .lib import (
version_up,
get_asset,
get_hierarchy,
+ get_workdir_data,
get_version_from_path,
get_last_version_from_path,
get_app_environments_for_context,
diff --git a/openpype/cli.py b/openpype/cli.py
index 3194723d4c..4c4dc1a3c6 100644
--- a/openpype/cli.py
+++ b/openpype/cli.py
@@ -384,3 +384,15 @@ def syncserver(debug, active_site):
if debug:
os.environ['OPENPYPE_DEBUG'] = '3'
PypeCommands().syncserver(active_site)
+
+
+@main.command()
+@click.argument("directory")
+def repack_version(directory):
+ """Repack OpenPype version from directory.
+
+ This command will re-create zip file from specified directory,
+ recalculating file checksums. It will try to use version detected in
+ directory name.
+ """
+ PypeCommands().repack_version(directory)
diff --git a/openpype/hosts/harmony/plugins/publish/collect_farm_render.py b/openpype/hosts/harmony/plugins/publish/collect_farm_render.py
index fc80e7c029..31a249591e 100644
--- a/openpype/hosts/harmony/plugins/publish/collect_farm_render.py
+++ b/openpype/hosts/harmony/plugins/publish/collect_farm_render.py
@@ -126,7 +126,8 @@ class CollectFarmRender(openpype.lib.abstract_collect_render.
# because of using 'renderFarm' as a family, replace 'Farm' with
# capitalized task name - issue of avalon-core Creator app
subset_name = node.split("/")[1]
- task_name = context.data["anatomyData"]["task"].capitalize()
+ task_name = context.data["anatomyData"]["task"][
+ "name"].capitalize()
replace_str = ""
if task_name.lower() not in subset_name.lower():
replace_str = task_name
diff --git a/openpype/hosts/harmony/plugins/publish/collect_palettes.py b/openpype/hosts/harmony/plugins/publish/collect_palettes.py
index b8671badb3..e47cbaf17e 100644
--- a/openpype/hosts/harmony/plugins/publish/collect_palettes.py
+++ b/openpype/hosts/harmony/plugins/publish/collect_palettes.py
@@ -28,7 +28,7 @@ class CollectPalettes(pyblish.api.ContextPlugin):
# skip collecting if not in allowed task
if self.allowed_tasks:
- task_name = context.data["anatomyData"]["task"].lower()
+ task_name = context.data["anatomyData"]["task"]["name"].lower()
if (not any([re.search(pattern, task_name)
for pattern in self.allowed_tasks])):
return
diff --git a/openpype/hosts/hiero/api/lib.py b/openpype/hosts/hiero/api/lib.py
index 876fae5da9..af58f5b73e 100644
--- a/openpype/hosts/hiero/api/lib.py
+++ b/openpype/hosts/hiero/api/lib.py
@@ -30,6 +30,7 @@ self = sys.modules[__name__]
self._has_been_setup = False
self._has_menu = False
self._registered_gui = None
+self._parent = None
self.pype_tag_name = "openpypeData"
self.default_sequence_name = "openpypeSequence"
self.default_bin_name = "openpypeBin"
@@ -1029,3 +1030,15 @@ def before_project_save(event):
# also mark old versions of loaded containers
check_inventory_versions()
+
+
+def get_main_window():
+ """Acquire Nuke's main window"""
+ if self._parent is None:
+ top_widgets = QtWidgets.QApplication.topLevelWidgets()
+ name = "Foundry::UI::DockMainWindow"
+ main_window = next(widget for widget in top_widgets if
+ widget.inherits("QMainWindow") and
+ widget.metaObject().className() == name)
+ self._parent = main_window
+ return self._parent
diff --git a/openpype/hosts/hiero/api/menu.py b/openpype/hosts/hiero/api/menu.py
index e3de220777..61b515d719 100644
--- a/openpype/hosts/hiero/api/menu.py
+++ b/openpype/hosts/hiero/api/menu.py
@@ -37,12 +37,16 @@ def menu_install():
Installing menu into Hiero
"""
+ from Qt import QtGui
from . import (
publish, launch_workfiles_app, reload_config,
apply_colorspace_project, apply_colorspace_clips
)
+ from .lib import get_main_window
+
+ main_window = get_main_window()
+
# here is the best place to add menu
- from avalon.vendor.Qt import QtGui
menu_name = os.environ['AVALON_LABEL']
@@ -86,15 +90,21 @@ def menu_install():
creator_action = menu.addAction("Create ...")
creator_action.setIcon(QtGui.QIcon("icons:CopyRectangle.png"))
- creator_action.triggered.connect(host_tools.show_creator)
+ creator_action.triggered.connect(
+ lambda: host_tools.show_creator(parent=main_window)
+ )
loader_action = menu.addAction("Load ...")
loader_action.setIcon(QtGui.QIcon("icons:CopyRectangle.png"))
- loader_action.triggered.connect(host_tools.show_loader)
+ loader_action.triggered.connect(
+ lambda: host_tools.show_loader(parent=main_window)
+ )
sceneinventory_action = menu.addAction("Manage ...")
sceneinventory_action.setIcon(QtGui.QIcon("icons:CopyRectangle.png"))
- sceneinventory_action.triggered.connect(host_tools.show_scene_inventory)
+ sceneinventory_action.triggered.connect(
+ lambda: host_tools.show_scene_inventory(parent=main_window)
+ )
menu.addSeparator()
if os.getenv("OPENPYPE_DEVELOP"):
diff --git a/openpype/hosts/hiero/api/pipeline.py b/openpype/hosts/hiero/api/pipeline.py
index 6f6588e1be..d52cb68ba7 100644
--- a/openpype/hosts/hiero/api/pipeline.py
+++ b/openpype/hosts/hiero/api/pipeline.py
@@ -209,9 +209,11 @@ def update_container(track_item, data=None):
def launch_workfiles_app(*args):
''' Wrapping function for workfiles launcher '''
+ from .lib import get_main_window
+ main_window = get_main_window()
# show workfile gui
- host_tools.show_workfiles()
+ host_tools.show_workfiles(parent=main_window)
def publish(parent):
diff --git a/openpype/hosts/houdini/api/usd.py b/openpype/hosts/houdini/api/usd.py
index 6f808779ea..a992f1d082 100644
--- a/openpype/hosts/houdini/api/usd.py
+++ b/openpype/hosts/houdini/api/usd.py
@@ -3,9 +3,10 @@
import contextlib
import logging
-from Qt import QtCore, QtGui
-from openpype.tools.utils.widgets import AssetWidget
-from avalon import style, io
+from Qt import QtWidgets, QtCore, QtGui
+from avalon import io
+from openpype import style
+from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget
from pxr import Sdf
@@ -13,6 +14,60 @@ from pxr import Sdf
log = logging.getLogger(__name__)
+class SelectAssetDialog(QtWidgets.QWidget):
+ """Frameless assets dialog to select asset with double click.
+
+ Args:
+ parm: Parameter where selected asset name is set.
+ """
+ def __init__(self, parm):
+ self.setWindowTitle("Pick Asset")
+ self.setWindowFlags(QtCore.Qt.FramelessWindowHint | QtCore.Qt.Popup)
+
+ assets_widget = SingleSelectAssetsWidget(io, parent=self)
+
+ layout = QtWidgets.QHBoxLayout(self)
+ layout.addWidget(assets_widget)
+
+ assets_widget.double_clicked.connect(self._set_parameter)
+ self._assets_widget = assets_widget
+ self._parm = parm
+
+ def _set_parameter(self):
+ name = self._assets_widget.get_selected_asset_name()
+ self._parm.set(name)
+ self.close()
+
+ def _on_show(self):
+ pos = QtGui.QCursor.pos()
+ # Select the current asset if there is any
+ select_id = None
+ name = self._parm.eval()
+ if name:
+ db_asset = io.find_one(
+ {"name": name, "type": "asset"},
+ {"_id": True}
+ )
+ if db_asset:
+ select_id = db_asset["_id"]
+
+ # Set stylesheet
+ self.setStyleSheet(style.load_stylesheet())
+ # Refresh assets (is threaded)
+ self._assets_widget.refresh()
+ # Select asset - must be done after refresh
+ if select_id is not None:
+ self._assets_widget.select_asset(select_id)
+
+ # Show cursor (top right of window) near cursor
+ self.resize(250, 400)
+ self.move(self.mapFromGlobal(pos) - QtCore.QPoint(self.width(), 0))
+
+ def showEvent(self, event):
+ super(SelectAssetDialog, self).showEvent(event)
+ self._on_show()
+
+
def pick_asset(node):
"""Show a user interface to select an Asset in the project
@@ -21,43 +76,15 @@ def pick_asset(node):
"""
- pos = QtGui.QCursor.pos()
-
parm = node.parm("asset_name")
if not parm:
log.error("Node has no 'asset' parameter: %s", node)
return
- # Construct the AssetWidget as a frameless popup so it automatically
+ # Construct a frameless popup so it automatically
# closes when clicked outside of it.
global tool
- tool = AssetWidget(io)
- tool.setContentsMargins(5, 5, 5, 5)
- tool.setWindowTitle("Pick Asset")
- tool.setStyleSheet(style.load_stylesheet())
- tool.setWindowFlags(QtCore.Qt.FramelessWindowHint | QtCore.Qt.Popup)
- tool.refresh()
-
- # Select the current asset if there is any
- name = parm.eval()
- if name:
- db_asset = io.find_one({"name": name, "type": "asset"})
- if db_asset:
- silo = db_asset.get("silo")
- if silo:
- tool.set_silo(silo)
- tool.select_assets([name], expand=True)
-
- # Show cursor (top right of window) near cursor
- tool.resize(250, 400)
- tool.move(tool.mapFromGlobal(pos) - QtCore.QPoint(tool.width(), 0))
-
- def set_parameter_callback(index):
- name = index.data(tool.model.DocumentRole)["name"]
- parm.set(name)
- tool.close()
-
- tool.view.doubleClicked.connect(set_parameter_callback)
+ tool = SelectAssetDialog(parm)
tool.show()
diff --git a/openpype/hosts/houdini/startup/MainMenuCommon.xml b/openpype/hosts/houdini/startup/MainMenuCommon.xml
index 2b556a2e75..c34310cf72 100644
--- a/openpype/hosts/houdini/startup/MainMenuCommon.xml
+++ b/openpype/hosts/houdini/startup/MainMenuCommon.xml
@@ -67,6 +67,16 @@ from avalon.houdini import pipeline
pipeline.reload_pipeline()]]>
+
+
+
+
+
+
diff --git a/openpype/hosts/maya/api/lib_renderproducts.py b/openpype/hosts/maya/api/lib_renderproducts.py
index 4983109d58..e8e4b9aaef 100644
--- a/openpype/hosts/maya/api/lib_renderproducts.py
+++ b/openpype/hosts/maya/api/lib_renderproducts.py
@@ -180,6 +180,7 @@ class ARenderProducts:
self.layer = layer
self.render_instance = render_instance
self.multipart = False
+ self.aov_separator = render_instance.data.get("aovSeparator", "_")
# Initialize
self.layer_data = self._get_layer_data()
@@ -676,7 +677,7 @@ class RenderProductsVray(ARenderProducts):
"""
prefix = super(RenderProductsVray, self).get_renderer_prefix()
- prefix = "{}.".format(prefix)
+ prefix = "{}{}".format(prefix, self.aov_separator)
return prefix
def _get_layer_data(self):
diff --git a/openpype/hosts/maya/plugins/create/create_render.py b/openpype/hosts/maya/plugins/create/create_render.py
index 4fd4b9d986..85919d1166 100644
--- a/openpype/hosts/maya/plugins/create/create_render.py
+++ b/openpype/hosts/maya/plugins/create/create_render.py
@@ -21,6 +21,7 @@ from openpype.api import (
from openpype.modules import ModulesManager
from avalon.api import Session
+from avalon.api import CreatorError
class CreateRender(plugin.Creator):
@@ -81,13 +82,21 @@ class CreateRender(plugin.Creator):
}
_image_prefixes = {
- 'mentalray': 'maya///_',
+ 'mentalray': 'maya///{aov_separator}', # noqa
'vray': 'maya///',
- 'arnold': 'maya///_',
- 'renderman': 'maya///_',
- 'redshift': 'maya///_'
+ 'arnold': 'maya///{aov_separator}', # noqa
+ 'renderman': 'maya///{aov_separator}',
+ 'redshift': 'maya///{aov_separator}' # noqa
}
+ _aov_chars = {
+ "dot": ".",
+ "dash": "-",
+ "underscore": "_"
+ }
+
+ _project_settings = None
+
def __init__(self, *args, **kwargs):
"""Constructor."""
super(CreateRender, self).__init__(*args, **kwargs)
@@ -95,12 +104,24 @@ class CreateRender(plugin.Creator):
if not deadline_settings["enabled"]:
self.deadline_servers = {}
return
- project_settings = get_project_settings(Session["AVALON_PROJECT"])
+ self._project_settings = get_project_settings(
+ Session["AVALON_PROJECT"])
+
+ # project_settings/maya/create/CreateRender/aov_separator
+ try:
+ self.aov_separator = self._aov_chars[(
+ self._project_settings["maya"]
+ ["create"]
+ ["CreateRender"]
+ ["aov_separator"]
+ )]
+ except KeyError:
+ self.aov_separator = "_"
+
try:
default_servers = deadline_settings["deadline_urls"]
project_servers = (
- project_settings["deadline"]
- ["deadline_servers"]
+ self._project_settings["deadline"]["deadline_servers"]
)
self.deadline_servers = {
k: default_servers[k]
@@ -409,8 +430,10 @@ class CreateRender(plugin.Creator):
renderer (str): Renderer name.
"""
+ prefix = self._image_prefixes[renderer]
+ prefix = prefix.replace("{aov_separator}", self.aov_separator)
cmds.setAttr(self._image_prefix_nodes[renderer],
- self._image_prefixes[renderer],
+ prefix,
type="string")
asset = get_asset()
@@ -446,37 +469,37 @@ class CreateRender(plugin.Creator):
self._set_global_output_settings()
- @staticmethod
- def _set_renderer_option(renderer_node, arg=None, value=None):
- # type: (str, str, str) -> str
- """Set option on renderer node.
-
- If renderer settings node doesn't exists, it is created first.
-
- Args:
- renderer_node (str): Renderer name.
- arg (str, optional): Argument name.
- value (str, optional): Argument value.
-
- Returns:
- str: Renderer settings node.
-
- """
- settings = cmds.ls(type=renderer_node)
- result = settings[0] if settings else cmds.createNode(renderer_node)
- cmds.setAttr(arg.format(result), value)
- return result
-
def _set_vray_settings(self, asset):
# type: (dict) -> None
"""Sets important settings for Vray."""
- node = self._set_renderer_option(
- "VRaySettingsNode", "{}.fileNameRenderElementSeparator", "_"
- )
+ settings = cmds.ls(type="VRaySettingsNode")
+ node = settings[0] if settings else cmds.createNode("VRaySettingsNode")
+ # set separator
+ # set it in vray menu
+ if cmds.optionMenuGrp("vrayRenderElementSeparator", exists=True,
+ q=True):
+ items = cmds.optionMenuGrp(
+ "vrayRenderElementSeparator", ill=True, query=True)
+
+ separators = [cmds.menuItem(i, label=True, query=True) for i in items] # noqa: E501
+ try:
+ sep_idx = separators.index(self.aov_separator)
+ except ValueError:
+ raise CreatorError(
+ "AOV character {} not in {}".format(
+ self.aov_separator, separators))
+
+ cmds.optionMenuGrp(
+ "vrayRenderElementSeparator", sl=sep_idx + 1, edit=True)
+ cmds.setAttr(
+ "{}.fileNameRenderElementSeparator".format(node),
+ self.aov_separator,
+ type="string"
+ )
# set format to exr
cmds.setAttr(
- "{}.imageFormatStr".format(node), 5)
+ "{}.imageFormatStr".format(node), "exr", type="string")
# animType
cmds.setAttr(
diff --git a/openpype/hosts/maya/plugins/publish/collect_look.py b/openpype/hosts/maya/plugins/publish/collect_look.py
index 9c047b252f..20a9d4ca12 100644
--- a/openpype/hosts/maya/plugins/publish/collect_look.py
+++ b/openpype/hosts/maya/plugins/publish/collect_look.py
@@ -532,7 +532,7 @@ class CollectLook(pyblish.api.InstancePlugin):
color_space = cmds.getAttr(color_space_attr)
except ValueError:
# node doesn't have colorspace attribute
- color_space = "raw"
+ color_space = "Raw"
# Compare with the computed file path, e.g. the one with the
# pattern in it, to generate some logging information about this
# difference
diff --git a/openpype/hosts/maya/plugins/publish/collect_render.py b/openpype/hosts/maya/plugins/publish/collect_render.py
index d2f277329a..580d459a90 100644
--- a/openpype/hosts/maya/plugins/publish/collect_render.py
+++ b/openpype/hosts/maya/plugins/publish/collect_render.py
@@ -41,6 +41,7 @@ Provides:
import re
import os
+import platform
import json
from maya import cmds
@@ -61,6 +62,12 @@ class CollectMayaRender(pyblish.api.ContextPlugin):
label = "Collect Render Layers"
sync_workfile_version = False
+ _aov_chars = {
+ "dot": ".",
+ "dash": "-",
+ "underscore": "_"
+ }
+
def process(self, context):
"""Entry point to collector."""
render_instance = None
@@ -166,6 +173,18 @@ class CollectMayaRender(pyblish.api.ContextPlugin):
if renderer.startswith("renderman"):
renderer = "renderman"
+ try:
+ aov_separator = self._aov_chars[(
+ context.data["project_settings"]
+ ["create"]
+ ["CreateRender"]
+ ["aov_separator"]
+ )]
+ except KeyError:
+ aov_separator = "_"
+
+ render_instance.data["aovSeparator"] = aov_separator
+
# return all expected files for all cameras and aovs in given
# frame range
layer_render_products = get_layer_render_products(
@@ -255,12 +274,28 @@ class CollectMayaRender(pyblish.api.ContextPlugin):
common_publish_meta_path, part)
if part == expected_layer_name:
break
+
+ # TODO: replace this terrible linux hotfix with real solution :)
+ if platform.system().lower() in ["linux", "darwin"]:
+ common_publish_meta_path = "/" + common_publish_meta_path
+
self.log.info(
"Publish meta path: {}".format(common_publish_meta_path))
self.log.info(full_exp_files)
self.log.info("collecting layer: {}".format(layer_name))
# Get layer specific settings, might be overrides
+
+ try:
+ aov_separator = self._aov_chars[(
+ context.data["project_settings"]
+ ["create"]
+ ["CreateRender"]
+ ["aov_separator"]
+ )]
+ except KeyError:
+ aov_separator = "_"
+
data = {
"subset": expected_layer_name,
"attachTo": attach_to,
@@ -302,7 +337,8 @@ class CollectMayaRender(pyblish.api.ContextPlugin):
"convertToScanline") or False,
"useReferencedAovs": render_instance.data.get(
"useReferencedAovs") or render_instance.data.get(
- "vrayUseReferencedAovs") or False
+ "vrayUseReferencedAovs") or False,
+ "aovSeparator": aov_separator
}
if deadline_url:
diff --git a/openpype/hosts/maya/plugins/publish/extract_look.py b/openpype/hosts/maya/plugins/publish/extract_look.py
index e0b85907e9..2407617b6f 100644
--- a/openpype/hosts/maya/plugins/publish/extract_look.py
+++ b/openpype/hosts/maya/plugins/publish/extract_look.py
@@ -332,10 +332,10 @@ class ExtractLook(openpype.api.Extractor):
if do_maketx and files_metadata[filepath]["color_space"].lower() == "srgb": # noqa: E501
linearize = True
# set its file node to 'raw' as tx will be linearized
- files_metadata[filepath]["color_space"] = "raw"
+ files_metadata[filepath]["color_space"] = "Raw"
- if do_maketx:
- color_space = "raw"
+ # if do_maketx:
+ # color_space = "Raw"
source, mode, texture_hash = self._process_texture(
filepath,
@@ -383,11 +383,11 @@ class ExtractLook(openpype.api.Extractor):
color_space = cmds.getAttr(color_space_attr)
except ValueError:
# node doesn't have color space attribute
- color_space = "raw"
+ color_space = "Raw"
else:
- if files_metadata[source]["color_space"] == "raw":
+ if files_metadata[source]["color_space"] == "Raw":
# set color space to raw if we linearized it
- color_space = "raw"
+ color_space = "Raw"
# Remap file node filename to destination
remap[color_space_attr] = color_space
attr = resource["attribute"]
diff --git a/openpype/hosts/maya/plugins/publish/validate_rendersettings.py b/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
index 65ddacfc57..6079d34fbe 100644
--- a/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
+++ b/openpype/hosts/maya/plugins/publish/validate_rendersettings.py
@@ -55,13 +55,19 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
ImagePrefixTokens = {
- 'arnold': 'maya///_',
+ 'arnold': 'maya///{aov_separator}', # noqa
'redshift': 'maya///',
'vray': 'maya///',
- 'renderman': '_..'
+ 'renderman': '{aov_separator}..' # noqa
}
- redshift_AOV_prefix = "/_"
+ _aov_chars = {
+ "dot": ".",
+ "dash": "-",
+ "underscore": "_"
+ }
+
+ redshift_AOV_prefix = "/{aov_separator}" # noqa: E501
# WARNING: There is bug? in renderman, translating token
# to something left behind mayas default image prefix. So instead
@@ -107,6 +113,9 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
anim_override = lib.get_attr_in_layer("defaultRenderGlobals.animation",
layer=layer)
+
+ prefix = prefix.replace(
+ "{aov_separator}", instance.data.get("aovSeparator", "_"))
if not anim_override:
invalid = True
cls.log.error("Animation needs to be enabled. Use the same "
@@ -138,12 +147,16 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
else:
node = vray_settings[0]
- if cmds.getAttr(
- "{}.fileNameRenderElementSeparator".format(node)) != "_":
- invalid = False
+ scene_sep = cmds.getAttr(
+ "{}.fileNameRenderElementSeparator".format(node))
+ if scene_sep != instance.data.get("aovSeparator", "_"):
cls.log.error("AOV separator is not set correctly.")
+ invalid = True
if renderer == "redshift":
+ redshift_AOV_prefix = cls.redshift_AOV_prefix.replace(
+ "{aov_separator}", instance.data.get("aovSeparator", "_")
+ )
if re.search(cls.R_AOV_TOKEN, prefix):
invalid = True
cls.log.error(("Do not use AOV token [ {} ] - "
@@ -155,7 +168,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
for aov in rs_aovs:
aov_prefix = cmds.getAttr("{}.filePrefix".format(aov))
# check their image prefix
- if aov_prefix != cls.redshift_AOV_prefix:
+ if aov_prefix != redshift_AOV_prefix:
cls.log.error(("AOV ({}) image prefix is not set "
"correctly {} != {}").format(
cmds.getAttr("{}.name".format(aov)),
@@ -181,7 +194,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
file_prefix = cmds.getAttr("rmanGlobals.imageFileFormat")
dir_prefix = cmds.getAttr("rmanGlobals.imageOutputDir")
- if file_prefix.lower() != cls.ImagePrefixTokens[renderer].lower():
+ if file_prefix.lower() != prefix.lower():
invalid = True
cls.log.error("Wrong image prefix [ {} ]".format(file_prefix))
@@ -198,18 +211,20 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
cls.log.error("Wrong image prefix [ {} ] - "
"You can't use '' token "
"with merge AOVs turned on".format(prefix))
- else:
- if not re.search(cls.R_AOV_TOKEN, prefix):
- invalid = True
- cls.log.error("Wrong image prefix [ {} ] - "
- "doesn't have: '' or "
- "token".format(prefix))
+ elif not re.search(cls.R_AOV_TOKEN, prefix):
+ invalid = True
+ cls.log.error("Wrong image prefix [ {} ] - "
+ "doesn't have: '' or "
+ "token".format(prefix))
# prefix check
- if prefix.lower() != cls.ImagePrefixTokens[renderer].lower():
+ default_prefix = cls.ImagePrefixTokens[renderer]
+ default_prefix = default_prefix.replace(
+ "{aov_separator}", instance.data.get("aovSeparator", "_"))
+ if prefix.lower() != default_prefix.lower():
cls.log.warning("warning: prefix differs from "
"recommended {}".format(
- cls.ImagePrefixTokens[renderer]))
+ default_prefix))
if padding != cls.DEFAULT_PADDING:
invalid = True
@@ -257,9 +272,14 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
@classmethod
def repair(cls, instance):
-
renderer = instance.data['renderer']
layer_node = instance.data['setMembers']
+ redshift_AOV_prefix = cls.redshift_AOV_prefix.replace(
+ "{aov_separator}", instance.data.get("aovSeparator", "_")
+ )
+ default_prefix = cls.ImagePrefixTokens[renderer].replace(
+ "{aov_separator}", instance.data.get("aovSeparator", "_")
+ )
with lib.renderlayer(layer_node):
default = lib.RENDER_ATTRS['default']
@@ -270,7 +290,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
node = render_attrs["node"]
prefix_attr = render_attrs["prefix"]
- fname_prefix = cls.ImagePrefixTokens[renderer]
+ fname_prefix = default_prefix
cmds.setAttr("{}.{}".format(node, prefix_attr),
fname_prefix, type="string")
@@ -281,7 +301,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
else:
# renderman handles stuff differently
cmds.setAttr("rmanGlobals.imageFileFormat",
- cls.ImagePrefixTokens[renderer],
+ default_prefix,
type="string")
cmds.setAttr("rmanGlobals.imageOutputDir",
cls.RendermanDirPrefix,
@@ -294,10 +314,13 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
else:
node = vray_settings[0]
+ cmds.optionMenuGrp("vrayRenderElementSeparator",
+ v=instance.data.get("aovSeparator", "_"))
cmds.setAttr(
"{}.fileNameRenderElementSeparator".format(
node),
- "_"
+ instance.data.get("aovSeparator", "_"),
+ type="string"
)
if renderer == "redshift":
@@ -306,7 +329,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
for aov in rs_aovs:
# fix AOV prefixes
cmds.setAttr(
- "{}.filePrefix".format(aov), cls.redshift_AOV_prefix)
+ "{}.filePrefix".format(aov), redshift_AOV_prefix)
# fix AOV file format
default_ext = cmds.getAttr(
"redshiftOptions.imageFormat", asString=True)
diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py
index 6d593ca588..e36a5aa5ba 100644
--- a/openpype/hosts/nuke/api/lib.py
+++ b/openpype/hosts/nuke/api/lib.py
@@ -18,7 +18,7 @@ from openpype.api import (
BuildWorkfile,
get_version_from_path,
get_anatomy_settings,
- get_hierarchy,
+ get_workdir_data,
get_asset,
get_current_project_settings,
ApplicationManager
@@ -41,6 +41,10 @@ opnl.workfiles_launched = False
opnl._node_tab_name = "{}".format(os.getenv("AVALON_LABEL") or "Avalon")
+def get_nuke_imageio_settings():
+ return get_anatomy_settings(opnl.project_name)["imageio"]["nuke"]
+
+
def get_created_node_imageio_setting(**kwarg):
''' Get preset data for dataflow (fileType, compression, bitDepth)
'''
@@ -51,8 +55,7 @@ def get_created_node_imageio_setting(**kwarg):
assert any([creator, nodeclass]), nuke.message(
"`{}`: Missing mandatory kwargs `host`, `cls`".format(__file__))
- imageio = get_anatomy_settings(opnl.project_name)["imageio"]
- imageio_nodes = imageio["nuke"]["nodes"]["requiredNodes"]
+ imageio_nodes = get_nuke_imageio_settings()["nodes"]["requiredNodes"]
imageio_node = None
for node in imageio_nodes:
@@ -70,8 +73,7 @@ def get_imageio_input_colorspace(filename):
''' Get input file colorspace based on regex in settings.
'''
imageio_regex_inputs = (
- get_anatomy_settings(opnl.project_name)
- ["imageio"]["nuke"]["regexInputs"]["inputs"])
+ get_nuke_imageio_settings()["regexInputs"]["inputs"])
preset_clrsp = None
for regexInput in imageio_regex_inputs:
@@ -268,15 +270,21 @@ def format_anatomy(data):
if not version:
file = script_name()
data["version"] = get_version_from_path(file)
- project_document = io.find_one({"type": "project"})
+
+ project_doc = io.find_one({"type": "project"})
+ asset_doc = io.find_one({
+ "type": "asset",
+ "name": data["avalon"]["asset"]
+ })
+ task_name = os.environ["AVALON_TASK"]
+ host_name = os.environ["AVALON_APP"]
+ context_data = get_workdir_data(
+ project_doc, asset_doc, task_name, host_name
+ )
+ data.update(context_data)
data.update({
"subset": data["avalon"]["subset"],
- "asset": data["avalon"]["asset"],
- "task": os.environ["AVALON_TASK"],
"family": data["avalon"]["family"],
- "project": {"name": project_document["name"],
- "code": project_document["data"].get("code", '')},
- "hierarchy": get_hierarchy(),
"frame": "#" * padding,
})
return anatomy.format(data)
@@ -547,8 +555,7 @@ def add_rendering_knobs(node, farm=True):
Return:
node (obj): with added knobs
'''
- knob_options = [
- "Use existing frames", "Local"]
+ knob_options = ["Use existing frames", "Local"]
if farm:
knob_options.append("On farm")
@@ -906,8 +913,7 @@ class WorkfileSettings(object):
''' Setting colorpace following presets
'''
# get imageio
- imageio = get_anatomy_settings(opnl.project_name)["imageio"]
- nuke_colorspace = imageio["nuke"]
+ nuke_colorspace = get_nuke_imageio_settings()
try:
self.set_root_colorspace(nuke_colorspace["workfile"])
@@ -1164,386 +1170,6 @@ def get_write_node_template_attr(node):
return anlib.fix_data_for_node_create(correct_data)
-class ExporterReview:
- """
- Base class object for generating review data from Nuke
-
- Args:
- klass (pyblish.plugin): pyblish plugin parent
- instance (pyblish.instance): instance of pyblish context
-
- """
- _temp_nodes = []
- data = dict({
- "representations": list()
- })
-
- def __init__(self,
- klass,
- instance
- ):
-
- self.log = klass.log
- self.instance = instance
- self.path_in = self.instance.data.get("path", None)
- self.staging_dir = self.instance.data["stagingDir"]
- self.collection = self.instance.data.get("collection", None)
-
- def get_file_info(self):
- if self.collection:
- self.log.debug("Collection: `{}`".format(self.collection))
- # get path
- self.fname = os.path.basename(self.collection.format(
- "{head}{padding}{tail}"))
- self.fhead = self.collection.format("{head}")
-
- # get first and last frame
- self.first_frame = min(self.collection.indexes)
- self.last_frame = max(self.collection.indexes)
- if "slate" in self.instance.data["families"]:
- self.first_frame += 1
- else:
- self.fname = os.path.basename(self.path_in)
- self.fhead = os.path.splitext(self.fname)[0] + "."
- self.first_frame = self.instance.data.get("frameStartHandle", None)
- self.last_frame = self.instance.data.get("frameEndHandle", None)
-
- if "#" in self.fhead:
- self.fhead = self.fhead.replace("#", "")[:-1]
-
- def get_representation_data(self, tags=None, range=False):
- add_tags = []
- if tags:
- add_tags = tags
-
- repre = {
- 'name': self.name,
- 'ext': self.ext,
- 'files': self.file,
- "stagingDir": self.staging_dir,
- "tags": [self.name.replace("_", "-")] + add_tags
- }
-
- if range:
- repre.update({
- "frameStart": self.first_frame,
- "frameEnd": self.last_frame,
- })
-
- self.data["representations"].append(repre)
-
- def get_view_process_node(self):
- """
- Will get any active view process.
-
- Arguments:
- self (class): in object definition
-
- Returns:
- nuke.Node: copy node of Input Process node
- """
- anlib.reset_selection()
- ipn_orig = None
- for v in nuke.allNodes(filter="Viewer"):
- ip = v['input_process'].getValue()
- ipn = v['input_process_node'].getValue()
- if "VIEWER_INPUT" not in ipn and ip:
- ipn_orig = nuke.toNode(ipn)
- ipn_orig.setSelected(True)
-
- if ipn_orig:
- # copy selected to clipboard
- nuke.nodeCopy('%clipboard%')
- # reset selection
- anlib.reset_selection()
- # paste node and selection is on it only
- nuke.nodePaste('%clipboard%')
- # assign to variable
- ipn = nuke.selectedNode()
-
- return ipn
-
- def clean_nodes(self):
- for node in self._temp_nodes:
- nuke.delete(node)
- self._temp_nodes = []
- self.log.info("Deleted nodes...")
-
-
-class ExporterReviewLut(ExporterReview):
- """
- Generator object for review lut from Nuke
-
- Args:
- klass (pyblish.plugin): pyblish plugin parent
- instance (pyblish.instance): instance of pyblish context
-
-
- """
-
- def __init__(self,
- klass,
- instance,
- name=None,
- ext=None,
- cube_size=None,
- lut_size=None,
- lut_style=None):
- # initialize parent class
- ExporterReview.__init__(self, klass, instance)
- self._temp_nodes = []
-
- # deal with now lut defined in viewer lut
- if hasattr(klass, "viewer_lut_raw"):
- self.viewer_lut_raw = klass.viewer_lut_raw
- else:
- self.viewer_lut_raw = False
-
- self.name = name or "baked_lut"
- self.ext = ext or "cube"
- self.cube_size = cube_size or 32
- self.lut_size = lut_size or 1024
- self.lut_style = lut_style or "linear"
-
- # set frame start / end and file name to self
- self.get_file_info()
-
- self.log.info("File info was set...")
-
- self.file = self.fhead + self.name + ".{}".format(self.ext)
- self.path = os.path.join(
- self.staging_dir, self.file).replace("\\", "/")
-
- def generate_lut(self):
- # ---------- start nodes creation
-
- # CMSTestPattern
- cms_node = nuke.createNode("CMSTestPattern")
- cms_node["cube_size"].setValue(self.cube_size)
- # connect
- self._temp_nodes.append(cms_node)
- self.previous_node = cms_node
- self.log.debug("CMSTestPattern... `{}`".format(self._temp_nodes))
-
- # Node View Process
- ipn = self.get_view_process_node()
- if ipn is not None:
- # connect
- ipn.setInput(0, self.previous_node)
- self._temp_nodes.append(ipn)
- self.previous_node = ipn
- self.log.debug("ViewProcess... `{}`".format(self._temp_nodes))
-
- if not self.viewer_lut_raw:
- # OCIODisplay
- dag_node = nuke.createNode("OCIODisplay")
- # connect
- dag_node.setInput(0, self.previous_node)
- self._temp_nodes.append(dag_node)
- self.previous_node = dag_node
- self.log.debug("OCIODisplay... `{}`".format(self._temp_nodes))
-
- # GenerateLUT
- gen_lut_node = nuke.createNode("GenerateLUT")
- gen_lut_node["file"].setValue(self.path)
- gen_lut_node["file_type"].setValue(".{}".format(self.ext))
- gen_lut_node["lut1d"].setValue(self.lut_size)
- gen_lut_node["style1d"].setValue(self.lut_style)
- # connect
- gen_lut_node.setInput(0, self.previous_node)
- self._temp_nodes.append(gen_lut_node)
- self.log.debug("GenerateLUT... `{}`".format(self._temp_nodes))
-
- # ---------- end nodes creation
-
- # Export lut file
- nuke.execute(
- gen_lut_node.name(),
- int(self.first_frame),
- int(self.first_frame))
-
- self.log.info("Exported...")
-
- # ---------- generate representation data
- self.get_representation_data()
-
- self.log.debug("Representation... `{}`".format(self.data))
-
- # ---------- Clean up
- self.clean_nodes()
-
- return self.data
-
-
-class ExporterReviewMov(ExporterReview):
- """
- Metaclass for generating review mov files
-
- Args:
- klass (pyblish.plugin): pyblish plugin parent
- instance (pyblish.instance): instance of pyblish context
-
- """
-
- def __init__(self,
- klass,
- instance,
- name=None,
- ext=None,
- ):
- # initialize parent class
- ExporterReview.__init__(self, klass, instance)
-
- # passing presets for nodes to self
- if hasattr(klass, "nodes"):
- self.nodes = klass.nodes
- else:
- self.nodes = {}
-
- # deal with now lut defined in viewer lut
- self.viewer_lut_raw = klass.viewer_lut_raw
- self.bake_colorspace_fallback = klass.bake_colorspace_fallback
- self.bake_colorspace_main = klass.bake_colorspace_main
- self.write_colorspace = instance.data["colorspace"]
-
- self.name = name or "baked"
- self.ext = ext or "mov"
-
- # set frame start / end and file name to self
- self.get_file_info()
-
- self.log.info("File info was set...")
-
- self.file = self.fhead + self.name + ".{}".format(self.ext)
- self.path = os.path.join(
- self.staging_dir, self.file).replace("\\", "/")
-
- def render(self, render_node_name):
- self.log.info("Rendering... ")
- # Render Write node
- nuke.execute(
- render_node_name,
- int(self.first_frame),
- int(self.last_frame))
-
- self.log.info("Rendered...")
-
- def save_file(self):
- import shutil
- with anlib.maintained_selection():
- self.log.info("Saving nodes as file... ")
- # create nk path
- path = os.path.splitext(self.path)[0] + ".nk"
- # save file to the path
- shutil.copyfile(self.instance.context.data["currentFile"], path)
-
- self.log.info("Nodes exported...")
- return path
-
- def generate_mov(self, farm=False):
- # ---------- start nodes creation
-
- # Read node
- r_node = nuke.createNode("Read")
- r_node["file"].setValue(self.path_in)
- r_node["first"].setValue(self.first_frame)
- r_node["origfirst"].setValue(self.first_frame)
- r_node["last"].setValue(self.last_frame)
- r_node["origlast"].setValue(self.last_frame)
- r_node["colorspace"].setValue(self.write_colorspace)
-
- # connect
- self._temp_nodes.append(r_node)
- self.previous_node = r_node
- self.log.debug("Read... `{}`".format(self._temp_nodes))
-
- # View Process node
- ipn = self.get_view_process_node()
- if ipn is not None:
- # connect
- ipn.setInput(0, self.previous_node)
- self._temp_nodes.append(ipn)
- self.previous_node = ipn
- self.log.debug("ViewProcess... `{}`".format(self._temp_nodes))
-
- if not self.viewer_lut_raw:
- colorspaces = [
- self.bake_colorspace_main, self.bake_colorspace_fallback
- ]
-
- if any(colorspaces):
- # OCIOColorSpace with controled output
- dag_node = nuke.createNode("OCIOColorSpace")
- self._temp_nodes.append(dag_node)
- for c in colorspaces:
- test = dag_node["out_colorspace"].setValue(str(c))
- if test:
- self.log.info(
- "Baking in colorspace... `{}`".format(c))
- break
-
- if not test:
- dag_node = nuke.createNode("OCIODisplay")
- else:
- # OCIODisplay
- dag_node = nuke.createNode("OCIODisplay")
-
- # connect
- dag_node.setInput(0, self.previous_node)
- self._temp_nodes.append(dag_node)
- self.previous_node = dag_node
- self.log.debug("OCIODisplay... `{}`".format(self._temp_nodes))
-
- # Write node
- write_node = nuke.createNode("Write")
- self.log.debug("Path: {}".format(self.path))
- write_node["file"].setValue(self.path)
- write_node["file_type"].setValue(self.ext)
-
- # Knobs `meta_codec` and `mov64_codec` are not available on centos.
- # TODO change this to use conditions, if possible.
- try:
- write_node["meta_codec"].setValue("ap4h")
- except Exception:
- self.log.info("`meta_codec` knob was not found")
-
- try:
- write_node["mov64_codec"].setValue("ap4h")
- except Exception:
- self.log.info("`mov64_codec` knob was not found")
- write_node["mov64_write_timecode"].setValue(1)
- write_node["raw"].setValue(1)
- # connect
- write_node.setInput(0, self.previous_node)
- self._temp_nodes.append(write_node)
- self.log.debug("Write... `{}`".format(self._temp_nodes))
- # ---------- end nodes creation
-
- # ---------- render or save to nk
- if farm:
- nuke.scriptSave()
- path_nk = self.save_file()
- self.data.update({
- "bakeScriptPath": path_nk,
- "bakeWriteNodeName": write_node.name(),
- "bakeRenderPath": self.path
- })
- else:
- self.render(write_node.name())
- # ---------- generate representation data
- self.get_representation_data(
- tags=["review", "delete"],
- range=True
- )
-
- self.log.debug("Representation... `{}`".format(self.data))
-
- # ---------- Clean up
- self.clean_nodes()
- nuke.scriptSave()
- return self.data
-
-
def get_dependent_nodes(nodes):
"""Get all dependent nodes connected to the list of nodes.
@@ -1654,6 +1280,8 @@ def launch_workfiles_app():
from openpype.lib import (
env_value_to_bool
)
+ from avalon.nuke.pipeline import get_main_window
+
# get all imortant settings
open_at_start = env_value_to_bool(
env_key="OPENPYPE_WORKFILE_TOOL_ON_START",
@@ -1665,7 +1293,8 @@ def launch_workfiles_app():
if not opnl.workfiles_launched:
opnl.workfiles_launched = True
- host_tools.show_workfiles()
+ main_window = get_main_window()
+ host_tools.show_workfiles(parent=main_window)
def process_workfile_builder():
diff --git a/openpype/hosts/nuke/api/menu.py b/openpype/hosts/nuke/api/menu.py
index 3e74893589..4636098604 100644
--- a/openpype/hosts/nuke/api/menu.py
+++ b/openpype/hosts/nuke/api/menu.py
@@ -1,16 +1,21 @@
import os
import nuke
from avalon.api import Session
+from avalon.nuke.pipeline import get_main_window
from .lib import WorkfileSettings
from openpype.api import Logger, BuildWorkfile, get_current_project_settings
from openpype.tools.utils import host_tools
+from avalon.nuke.pipeline import get_main_window
+
log = Logger().get_logger(__name__)
menu_label = os.environ["AVALON_LABEL"]
+
def install():
+ main_window = get_main_window()
menubar = nuke.menu("Nuke")
menu = menubar.findItem(menu_label)
@@ -25,7 +30,7 @@ def install():
menu.removeItem(rm_item[1].name())
menu.addCommand(
name,
- host_tools.show_workfiles,
+ lambda: host_tools.show_workfiles(parent=main_window),
index=2
)
menu.addSeparator(index=3)
@@ -88,7 +93,7 @@ def install():
menu.addSeparator()
menu.addCommand(
"Experimental tools...",
- host_tools.show_experimental_tools_dialog
+ lambda: host_tools.show_experimental_tools_dialog(parent=main_window)
)
# adding shortcuts
diff --git a/openpype/hosts/nuke/api/plugin.py b/openpype/hosts/nuke/api/plugin.py
index 62eadecaf4..e53b97e297 100644
--- a/openpype/hosts/nuke/api/plugin.py
+++ b/openpype/hosts/nuke/api/plugin.py
@@ -1,3 +1,4 @@
+import os
import random
import string
@@ -49,8 +50,11 @@ def get_review_presets_config():
class NukeLoader(api.Loader):
container_id_knob = "containerId"
- container_id = ''.join(random.choice(
- string.ascii_uppercase + string.digits) for _ in range(10))
+ container_id = None
+
+ def reset_container_id(self):
+ self.container_id = ''.join(random.choice(
+ string.ascii_uppercase + string.digits) for _ in range(10))
def get_container_id(self, node):
id_knob = node.knobs().get(self.container_id_knob)
@@ -67,13 +71,16 @@ class NukeLoader(api.Loader):
source_id = self.get_container_id(node)
if source_id:
- node[self.container_id_knob].setValue(self.container_id)
+ node[self.container_id_knob].setValue(source_id)
else:
HIDEN_FLAG = 0x00040000
_knob = anlib.Knobby(
"String_Knob",
self.container_id,
- flags=[nuke.READ_ONLY, HIDEN_FLAG])
+ flags=[
+ nuke.READ_ONLY,
+ HIDEN_FLAG
+ ])
knob = _knob.create(self.container_id_knob)
node.addKnob(knob)
@@ -94,3 +101,415 @@ class NukeLoader(api.Loader):
nuke.delete(member)
return dependent_nodes
+
+
+class ExporterReview(object):
+ """
+ Base class object for generating review data from Nuke
+
+ Args:
+ klass (pyblish.plugin): pyblish plugin parent
+ instance (pyblish.instance): instance of pyblish context
+
+ """
+ data = None
+
+ def __init__(self,
+ klass,
+ instance
+ ):
+
+ self.log = klass.log
+ self.instance = instance
+ self.path_in = self.instance.data.get("path", None)
+ self.staging_dir = self.instance.data["stagingDir"]
+ self.collection = self.instance.data.get("collection", None)
+ self.data = dict({
+ "representations": list()
+ })
+
+ def get_file_info(self):
+ if self.collection:
+ self.log.debug("Collection: `{}`".format(self.collection))
+ # get path
+ self.fname = os.path.basename(self.collection.format(
+ "{head}{padding}{tail}"))
+ self.fhead = self.collection.format("{head}")
+
+ # get first and last frame
+ self.first_frame = min(self.collection.indexes)
+ self.last_frame = max(self.collection.indexes)
+ if "slate" in self.instance.data["families"]:
+ self.first_frame += 1
+ else:
+ self.fname = os.path.basename(self.path_in)
+ self.fhead = os.path.splitext(self.fname)[0] + "."
+ self.first_frame = self.instance.data.get("frameStartHandle", None)
+ self.last_frame = self.instance.data.get("frameEndHandle", None)
+
+ if "#" in self.fhead:
+ self.fhead = self.fhead.replace("#", "")[:-1]
+
+ def get_representation_data(self, tags=None, range=False):
+ add_tags = tags or []
+
+ repre = {
+ 'outputName': self.name,
+ 'name': self.name,
+ 'ext': self.ext,
+ 'files': self.file,
+ "stagingDir": self.staging_dir,
+ "tags": [self.name.replace("_", "-")] + add_tags
+ }
+
+ if range:
+ repre.update({
+ "frameStart": self.first_frame,
+ "frameEnd": self.last_frame,
+ })
+
+ self.data["representations"].append(repre)
+
+ def get_view_input_process_node(self):
+ """
+ Will get any active view process.
+
+ Arguments:
+ self (class): in object definition
+
+ Returns:
+ nuke.Node: copy node of Input Process node
+ """
+ anlib.reset_selection()
+ ipn_orig = None
+ for v in nuke.allNodes(filter="Viewer"):
+ ip = v['input_process'].getValue()
+ ipn = v['input_process_node'].getValue()
+ if "VIEWER_INPUT" not in ipn and ip:
+ ipn_orig = nuke.toNode(ipn)
+ ipn_orig.setSelected(True)
+
+ if ipn_orig:
+ # copy selected to clipboard
+ nuke.nodeCopy('%clipboard%')
+ # reset selection
+ anlib.reset_selection()
+ # paste node and selection is on it only
+ nuke.nodePaste('%clipboard%')
+ # assign to variable
+ ipn = nuke.selectedNode()
+
+ return ipn
+
+ def get_imageio_baking_profile(self):
+ from . import lib as opnlib
+ nuke_imageio = opnlib.get_nuke_imageio_settings()
+
+ # TODO: this is only securing backward compatibility lets remove
+ # this once all projects's anotomy are upated to newer config
+ if "baking" in nuke_imageio.keys():
+ return nuke_imageio["baking"]["viewerProcess"]
+ else:
+ return nuke_imageio["viewer"]["viewerProcess"]
+
+
+
+
+class ExporterReviewLut(ExporterReview):
+ """
+ Generator object for review lut from Nuke
+
+ Args:
+ klass (pyblish.plugin): pyblish plugin parent
+ instance (pyblish.instance): instance of pyblish context
+
+
+ """
+ _temp_nodes = []
+
+ def __init__(self,
+ klass,
+ instance,
+ name=None,
+ ext=None,
+ cube_size=None,
+ lut_size=None,
+ lut_style=None):
+ # initialize parent class
+ super(ExporterReviewLut, self).__init__(klass, instance)
+
+ # deal with now lut defined in viewer lut
+ if hasattr(klass, "viewer_lut_raw"):
+ self.viewer_lut_raw = klass.viewer_lut_raw
+ else:
+ self.viewer_lut_raw = False
+
+ self.name = name or "baked_lut"
+ self.ext = ext or "cube"
+ self.cube_size = cube_size or 32
+ self.lut_size = lut_size or 1024
+ self.lut_style = lut_style or "linear"
+
+ # set frame start / end and file name to self
+ self.get_file_info()
+
+ self.log.info("File info was set...")
+
+ self.file = self.fhead + self.name + ".{}".format(self.ext)
+ self.path = os.path.join(
+ self.staging_dir, self.file).replace("\\", "/")
+
+ def clean_nodes(self):
+ for node in self._temp_nodes:
+ nuke.delete(node)
+ self._temp_nodes = []
+ self.log.info("Deleted nodes...")
+
+ def generate_lut(self):
+ bake_viewer_process = kwargs["bake_viewer_process"]
+ bake_viewer_input_process_node = kwargs[
+ "bake_viewer_input_process"]
+
+ # ---------- start nodes creation
+
+ # CMSTestPattern
+ cms_node = nuke.createNode("CMSTestPattern")
+ cms_node["cube_size"].setValue(self.cube_size)
+ # connect
+ self._temp_nodes.append(cms_node)
+ self.previous_node = cms_node
+ self.log.debug("CMSTestPattern... `{}`".format(self._temp_nodes))
+
+ if bake_viewer_process:
+ # Node View Process
+ if bake_viewer_input_process_node:
+ ipn = self.get_view_input_process_node()
+ if ipn is not None:
+ # connect
+ ipn.setInput(0, self.previous_node)
+ self._temp_nodes.append(ipn)
+ self.previous_node = ipn
+ self.log.debug(
+ "ViewProcess... `{}`".format(self._temp_nodes))
+
+ if not self.viewer_lut_raw:
+ # OCIODisplay
+ dag_node = nuke.createNode("OCIODisplay")
+ # connect
+ dag_node.setInput(0, self.previous_node)
+ self._temp_nodes.append(dag_node)
+ self.previous_node = dag_node
+ self.log.debug("OCIODisplay... `{}`".format(self._temp_nodes))
+
+ # GenerateLUT
+ gen_lut_node = nuke.createNode("GenerateLUT")
+ gen_lut_node["file"].setValue(self.path)
+ gen_lut_node["file_type"].setValue(".{}".format(self.ext))
+ gen_lut_node["lut1d"].setValue(self.lut_size)
+ gen_lut_node["style1d"].setValue(self.lut_style)
+ # connect
+ gen_lut_node.setInput(0, self.previous_node)
+ self._temp_nodes.append(gen_lut_node)
+ self.log.debug("GenerateLUT... `{}`".format(self._temp_nodes))
+
+ # ---------- end nodes creation
+
+ # Export lut file
+ nuke.execute(
+ gen_lut_node.name(),
+ int(self.first_frame),
+ int(self.first_frame))
+
+ self.log.info("Exported...")
+
+ # ---------- generate representation data
+ self.get_representation_data()
+
+ self.log.debug("Representation... `{}`".format(self.data))
+
+ # ---------- Clean up
+ self.clean_nodes()
+
+ return self.data
+
+
+class ExporterReviewMov(ExporterReview):
+ """
+ Metaclass for generating review mov files
+
+ Args:
+ klass (pyblish.plugin): pyblish plugin parent
+ instance (pyblish.instance): instance of pyblish context
+
+ """
+ _temp_nodes = {}
+
+ def __init__(self,
+ klass,
+ instance,
+ name=None,
+ ext=None,
+ ):
+ # initialize parent class
+ super(ExporterReviewMov, self).__init__(klass, instance)
+ # passing presets for nodes to self
+ self.nodes = klass.nodes if hasattr(klass, "nodes") else {}
+
+ # deal with now lut defined in viewer lut
+ self.viewer_lut_raw = klass.viewer_lut_raw
+ self.write_colorspace = instance.data["colorspace"]
+
+ self.name = name or "baked"
+ self.ext = ext or "mov"
+
+ # set frame start / end and file name to self
+ self.get_file_info()
+
+ self.log.info("File info was set...")
+
+ self.file = self.fhead + self.name + ".{}".format(self.ext)
+ self.path = os.path.join(
+ self.staging_dir, self.file).replace("\\", "/")
+
+ def clean_nodes(self, node_name):
+ for node in self._temp_nodes[node_name]:
+ nuke.delete(node)
+ self._temp_nodes[node_name] = []
+ self.log.info("Deleted nodes...")
+
+ def render(self, render_node_name):
+ self.log.info("Rendering... ")
+ # Render Write node
+ nuke.execute(
+ render_node_name,
+ int(self.first_frame),
+ int(self.last_frame))
+
+ self.log.info("Rendered...")
+
+ def save_file(self):
+ import shutil
+ with anlib.maintained_selection():
+ self.log.info("Saving nodes as file... ")
+ # create nk path
+ path = os.path.splitext(self.path)[0] + ".nk"
+ # save file to the path
+ shutil.copyfile(self.instance.context.data["currentFile"], path)
+
+ self.log.info("Nodes exported...")
+ return path
+
+ def generate_mov(self, farm=False, **kwargs):
+ bake_viewer_process = kwargs["bake_viewer_process"]
+ bake_viewer_input_process_node = kwargs[
+ "bake_viewer_input_process"]
+ viewer_process_override = kwargs[
+ "viewer_process_override"]
+
+ baking_view_profile = (
+ viewer_process_override or self.get_imageio_baking_profile())
+
+ fps = self.instance.context.data["fps"]
+
+ self.log.debug(">> baking_view_profile `{}`".format(
+ baking_view_profile))
+
+ add_tags = kwargs.get("add_tags", [])
+
+ self.log.info(
+ "__ add_tags: `{0}`".format(add_tags))
+
+ subset = self.instance.data["subset"]
+ self._temp_nodes[subset] = []
+ # ---------- start nodes creation
+
+ # Read node
+ r_node = nuke.createNode("Read")
+ r_node["file"].setValue(self.path_in)
+ r_node["first"].setValue(self.first_frame)
+ r_node["origfirst"].setValue(self.first_frame)
+ r_node["last"].setValue(self.last_frame)
+ r_node["origlast"].setValue(self.last_frame)
+ r_node["colorspace"].setValue(self.write_colorspace)
+
+ # connect
+ self._temp_nodes[subset].append(r_node)
+ self.previous_node = r_node
+ self.log.debug("Read... `{}`".format(self._temp_nodes[subset]))
+
+ # only create colorspace baking if toggled on
+ if bake_viewer_process:
+ if bake_viewer_input_process_node:
+ # View Process node
+ ipn = self.get_view_input_process_node()
+ if ipn is not None:
+ # connect
+ ipn.setInput(0, self.previous_node)
+ self._temp_nodes[subset].append(ipn)
+ self.previous_node = ipn
+ self.log.debug(
+ "ViewProcess... `{}`".format(
+ self._temp_nodes[subset]))
+
+ if not self.viewer_lut_raw:
+ # OCIODisplay
+ dag_node = nuke.createNode("OCIODisplay")
+ dag_node["view"].setValue(str(baking_view_profile))
+
+ # connect
+ dag_node.setInput(0, self.previous_node)
+ self._temp_nodes[subset].append(dag_node)
+ self.previous_node = dag_node
+ self.log.debug("OCIODisplay... `{}`".format(
+ self._temp_nodes[subset]))
+
+ # Write node
+ write_node = nuke.createNode("Write")
+ self.log.debug("Path: {}".format(self.path))
+ write_node["file"].setValue(str(self.path))
+ write_node["file_type"].setValue(str(self.ext))
+
+ # Knobs `meta_codec` and `mov64_codec` are not available on centos.
+ # TODO should't this come from settings on outputs?
+ try:
+ write_node["meta_codec"].setValue("ap4h")
+ except Exception:
+ self.log.info("`meta_codec` knob was not found")
+
+ try:
+ write_node["mov64_codec"].setValue("ap4h")
+ write_node["mov64_fps"].setValue(float(fps))
+ except Exception:
+ self.log.info("`mov64_codec` knob was not found")
+
+ write_node["mov64_write_timecode"].setValue(1)
+ write_node["raw"].setValue(1)
+ # connect
+ write_node.setInput(0, self.previous_node)
+ self._temp_nodes[subset].append(write_node)
+ self.log.debug("Write... `{}`".format(self._temp_nodes[subset]))
+ # ---------- end nodes creation
+
+ # ---------- render or save to nk
+ if farm:
+ nuke.scriptSave()
+ path_nk = self.save_file()
+ self.data.update({
+ "bakeScriptPath": path_nk,
+ "bakeWriteNodeName": write_node.name(),
+ "bakeRenderPath": self.path
+ })
+ else:
+ self.render(write_node.name())
+ # ---------- generate representation data
+ self.get_representation_data(
+ tags=["review", "delete"] + add_tags,
+ range=True
+ )
+
+ self.log.debug("Representation... `{}`".format(self.data))
+
+ self.clean_nodes(subset)
+ nuke.scriptSave()
+
+ return self.data
diff --git a/openpype/hosts/nuke/plugins/load/load_backdrop.py b/openpype/hosts/nuke/plugins/load/load_backdrop.py
index e615af51ff..9148260e9e 100644
--- a/openpype/hosts/nuke/plugins/load/load_backdrop.py
+++ b/openpype/hosts/nuke/plugins/load/load_backdrop.py
@@ -4,7 +4,6 @@ import nukescripts
from openpype.hosts.nuke.api import lib as pnlib
from avalon.nuke import lib as anlib
from avalon.nuke import containerise, update_container
-reload(pnlib)
class LoadBackdropNodes(api.Loader):
"""Loading Published Backdrop nodes (workfile, nukenodes)"""
diff --git a/openpype/hosts/nuke/plugins/load/load_clip.py b/openpype/hosts/nuke/plugins/load/load_clip.py
index f8fc5e3928..4ad2246e21 100644
--- a/openpype/hosts/nuke/plugins/load/load_clip.py
+++ b/openpype/hosts/nuke/plugins/load/load_clip.py
@@ -67,6 +67,9 @@ class LoadClip(plugin.NukeLoader):
def load(self, context, name, namespace, options):
+ # reste container id so it is always unique for each instance
+ self.reset_container_id()
+
is_sequence = len(context["representation"]["files"]) > 1
file = self.fname.replace("\\", "/")
@@ -251,8 +254,7 @@ class LoadClip(plugin.NukeLoader):
"handleStart": str(self.handle_start),
"handleEnd": str(self.handle_end),
"fps": str(version_data.get("fps")),
- "author": version_data.get("author"),
- "outputDir": version_data.get("outputDir"),
+ "author": version_data.get("author")
}
# change color of read_node
diff --git a/openpype/hosts/nuke/plugins/load/load_image.py b/openpype/hosts/nuke/plugins/load/load_image.py
index 2af44d6eba..02a5b55c18 100644
--- a/openpype/hosts/nuke/plugins/load/load_image.py
+++ b/openpype/hosts/nuke/plugins/load/load_image.py
@@ -217,8 +217,7 @@ class LoadImage(api.Loader):
"colorspace": version_data.get("colorspace"),
"source": version_data.get("source"),
"fps": str(version_data.get("fps")),
- "author": version_data.get("author"),
- "outputDir": version_data.get("outputDir"),
+ "author": version_data.get("author")
})
# change color of node
diff --git a/openpype/hosts/nuke/plugins/load/load_script_precomp.py b/openpype/hosts/nuke/plugins/load/load_script_precomp.py
index 310157f099..7444dd6e96 100644
--- a/openpype/hosts/nuke/plugins/load/load_script_precomp.py
+++ b/openpype/hosts/nuke/plugins/load/load_script_precomp.py
@@ -135,8 +135,7 @@ class LinkAsGroup(api.Loader):
"source": version["data"].get("source"),
"handles": version["data"].get("handles"),
"fps": version["data"].get("fps"),
- "author": version["data"].get("author"),
- "outputDir": version["data"].get("outputDir"),
+ "author": version["data"].get("author")
})
# Update the imprinted representation
diff --git a/openpype/hosts/nuke/plugins/publish/extract_backdrop.py b/openpype/hosts/nuke/plugins/publish/extract_backdrop.py
index 13f8656005..0747c15ea7 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_backdrop.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_backdrop.py
@@ -4,7 +4,6 @@ from openpype.hosts.nuke.api import lib as pnlib
import nuke
import os
import openpype
-reload(pnlib)
class ExtractBackdropNode(openpype.api.Extractor):
"""Extracting content of backdrop nodes
diff --git a/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py b/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
index a0f1c9a087..8ba746a3c4 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_review_data_lut.py
@@ -1,16 +1,9 @@
import os
import pyblish.api
from avalon.nuke import lib as anlib
-from openpype.hosts.nuke.api import lib as pnlib
+from openpype.hosts.nuke.api import plugin
import openpype
-try:
- from __builtin__ import reload
-except ImportError:
- from importlib import reload
-
-reload(pnlib)
-
class ExtractReviewDataLut(openpype.api.Extractor):
"""Extracts movie and thumbnail with baked in luts
@@ -45,7 +38,7 @@ class ExtractReviewDataLut(openpype.api.Extractor):
# generate data
with anlib.maintained_selection():
- exporter = pnlib.ExporterReviewLut(
+ exporter = plugin.ExporterReviewLut(
self, instance
)
data = exporter.generate_lut()
diff --git a/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py b/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
index f4fbc2d0e4..b5890b5c51 100644
--- a/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
+++ b/openpype/hosts/nuke/plugins/publish/extract_review_data_mov.py
@@ -1,16 +1,9 @@
import os
import pyblish.api
from avalon.nuke import lib as anlib
-from openpype.hosts.nuke.api import lib as pnlib
+from openpype.hosts.nuke.api import plugin
import openpype
-try:
- from __builtin__ import reload
-except ImportError:
- from importlib import reload
-
-reload(pnlib)
-
class ExtractReviewDataMov(openpype.api.Extractor):
"""Extracts movie and thumbnail with baked in luts
@@ -27,15 +20,15 @@ class ExtractReviewDataMov(openpype.api.Extractor):
# presets
viewer_lut_raw = None
- bake_colorspace_fallback = None
- bake_colorspace_main = None
+ outputs = {}
def process(self, instance):
families = instance.data["families"]
+ task_type = instance.context.data["taskType"]
self.log.info("Creating staging dir...")
if "representations" not in instance.data:
- instance.data["representations"] = list()
+ instance.data["representations"] = []
staging_dir = os.path.normpath(
os.path.dirname(instance.data['path']))
@@ -45,28 +38,80 @@ class ExtractReviewDataMov(openpype.api.Extractor):
self.log.info(
"StagingDir `{0}`...".format(instance.data["stagingDir"]))
+ self.log.info(self.outputs)
+
# generate data
with anlib.maintained_selection():
- exporter = pnlib.ExporterReviewMov(
- self, instance)
+ for o_name, o_data in self.outputs.items():
+ f_families = o_data["filter"]["families"]
+ f_task_types = o_data["filter"]["task_types"]
- if "render.farm" in families:
- instance.data["families"].remove("review")
- data = exporter.generate_mov(farm=True)
+ # test if family found in context
+ test_families = any([
+ # first if exact family set is mathing
+ # make sure only interesetion of list is correct
+ bool(set(families).intersection(f_families)),
+ # and if famiies are set at all
+ # if not then return True because we want this preset
+ # to be active if nothig is set
+ bool(not f_families)
+ ])
- self.log.debug(
- "_ data: {}".format(data))
+ # test task types from filter
+ test_task_types = any([
+ # check if actual task type is defined in task types
+ # set in preset's filter
+ bool(task_type in f_task_types),
+ # and if taskTypes are defined in preset filter
+ # if not then return True, because we want this filter
+ # to be active if no taskType is set
+ bool(not f_task_types)
+ ])
- instance.data.update({
- "bakeRenderPath": data.get("bakeRenderPath"),
- "bakeScriptPath": data.get("bakeScriptPath"),
- "bakeWriteNodeName": data.get("bakeWriteNodeName")
- })
- else:
- data = exporter.generate_mov()
+ # we need all filters to be positive for this
+ # preset to be activated
+ test_all = all([
+ test_families,
+ test_task_types
+ ])
- # assign to representations
- instance.data["representations"] += data["representations"]
+ # if it is not positive then skip this preset
+ if not test_all:
+ continue
+
+ self.log.info(
+ "Baking output `{}` with settings: {}".format(
+ o_name, o_data))
+
+ # create exporter instance
+ exporter = plugin.ExporterReviewMov(
+ self, instance, o_name, o_data["extension"])
+
+ if "render.farm" in families:
+ if "review" in instance.data["families"]:
+ instance.data["families"].remove("review")
+
+ data = exporter.generate_mov(farm=True, **o_data)
+
+ self.log.debug(
+ "_ data: {}".format(data))
+
+ if not instance.data.get("bakingNukeScripts"):
+ instance.data["bakingNukeScripts"] = []
+
+ instance.data["bakingNukeScripts"].append({
+ "bakeRenderPath": data.get("bakeRenderPath"),
+ "bakeScriptPath": data.get("bakeScriptPath"),
+ "bakeWriteNodeName": data.get("bakeWriteNodeName")
+ })
+ else:
+ data = exporter.generate_mov(**o_data)
+
+ self.log.info(data["representations"])
+
+ # assign to representations
+ instance.data["representations"] += data["representations"]
self.log.debug(
- "_ representations: {}".format(instance.data["representations"]))
+ "_ representations: {}".format(
+ instance.data["representations"]))
diff --git a/openpype/hosts/standalonepublisher/plugins/publish/collect_editorial_resources.py b/openpype/hosts/standalonepublisher/plugins/publish/collect_editorial_resources.py
index ffa24cfd93..36bacceb1c 100644
--- a/openpype/hosts/standalonepublisher/plugins/publish/collect_editorial_resources.py
+++ b/openpype/hosts/standalonepublisher/plugins/publish/collect_editorial_resources.py
@@ -238,7 +238,7 @@ class CollectInstanceResources(pyblish.api.InstancePlugin):
})
# exception for mp4 preview
- if ".mp4" in _reminding_file:
+ if ext in ["mp4", "mov"]:
frame_start = 0
frame_end = (
(instance_data["frameEnd"] - instance_data["frameStart"])
@@ -255,6 +255,7 @@ class CollectInstanceResources(pyblish.api.InstancePlugin):
"step": 1,
"fps": self.context.data.get("fps"),
"name": "review",
+ "thumbnail": True,
"tags": ["review", "ftrackreview", "delete"],
})
diff --git a/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_scenes.py b/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_scenes.py
index a4fed3bc3f..48c36aa067 100644
--- a/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_scenes.py
+++ b/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_scenes.py
@@ -49,10 +49,22 @@ class CollectHarmonyScenes(pyblish.api.InstancePlugin):
# fix anatomy data
anatomy_data_new = copy.deepcopy(anatomy_data)
+
+ project_entity = context.data["projectEntity"]
+ asset_entity = context.data["assetEntity"]
+
+ task_type = asset_entity["data"]["tasks"].get(task, {}).get("type")
+ project_task_types = project_entity["config"]["tasks"]
+ task_code = project_task_types.get(task_type, {}).get("short_name")
+
# updating hierarchy data
anatomy_data_new.update({
"asset": asset_data["name"],
- "task": task,
+ "task": {
+ "name": task,
+ "type": task_type,
+ "short": task_code,
+ },
"subset": subset_name
})
diff --git a/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_zips.py b/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_zips.py
index 93eff85486..40a969f8df 100644
--- a/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_zips.py
+++ b/openpype/hosts/standalonepublisher/plugins/publish/collect_harmony_zips.py
@@ -27,6 +27,7 @@ class CollectHarmonyZips(pyblish.api.InstancePlugin):
anatomy_data = instance.context.data["anatomyData"]
repres = instance.data["representations"]
files = repres[0]["files"]
+ project_entity = context.data["projectEntity"]
if files.endswith(".zip"):
# A zip file was dropped
@@ -45,14 +46,24 @@ class CollectHarmonyZips(pyblish.api.InstancePlugin):
self.log.info("Copied data: {}".format(new_instance.data))
+ task_type = asset_data["data"]["tasks"].get(task, {}).get("type")
+ project_task_types = project_entity["config"]["tasks"]
+ task_code = project_task_types.get(task_type, {}).get("short_name")
+
# fix anatomy data
anatomy_data_new = copy.deepcopy(anatomy_data)
# updating hierarchy data
- anatomy_data_new.update({
- "asset": asset_data["name"],
- "task": task,
- "subset": subset_name
- })
+ anatomy_data_new.update(
+ {
+ "asset": asset_data["name"],
+ "task": {
+ "name": task,
+ "type": task_type,
+ "short": task_code,
+ },
+ "subset": subset_name
+ }
+ )
new_instance.data["label"] = f"{instance_name}"
new_instance.data["subset"] = subset_name
diff --git a/openpype/hosts/standalonepublisher/plugins/publish/extract_harmony_zip.py b/openpype/hosts/standalonepublisher/plugins/publish/extract_harmony_zip.py
deleted file mode 100644
index adbac6ef09..0000000000
--- a/openpype/hosts/standalonepublisher/plugins/publish/extract_harmony_zip.py
+++ /dev/null
@@ -1,415 +0,0 @@
-# -*- coding: utf-8 -*-
-"""Extract Harmony scene from zip file."""
-import glob
-import os
-import shutil
-import six
-import sys
-import tempfile
-import zipfile
-
-import pyblish.api
-from avalon import api, io
-import openpype.api
-from openpype.lib import get_workfile_template_key_from_context
-
-
-class ExtractHarmonyZip(openpype.api.Extractor):
- """Extract Harmony zip."""
-
- # Pyblish settings
- label = "Extract Harmony zip"
- order = pyblish.api.ExtractorOrder + 0.02
- hosts = ["standalonepublisher"]
- families = ["scene"]
-
- # Properties
- session = None
- task_types = None
- task_statuses = None
- assetversion_statuses = None
-
- # Presets
- create_workfile = True
- default_task = "harmonyIngest"
- default_task_type = "Ingest"
- default_task_status = "Ingested"
- assetversion_status = "Ingested"
-
- def process(self, instance):
- """Plugin entry point."""
- context = instance.context
- self.session = context.data["ftrackSession"]
- asset_doc = context.data["assetEntity"]
- # asset_name = instance.data["asset"]
- subset_name = instance.data["subset"]
- instance_name = instance.data["name"]
- family = instance.data["family"]
- task = context.data["anatomyData"]["task"] or self.default_task
- project_entity = instance.context.data["projectEntity"]
- ftrack_id = asset_doc["data"]["ftrackId"]
- repres = instance.data["representations"]
- submitted_staging_dir = repres[0]["stagingDir"]
- submitted_files = repres[0]["files"]
-
- # Get all the ftrack entities needed
-
- # Asset Entity
- query = 'AssetBuild where id is "{}"'.format(ftrack_id)
- asset_entity = self.session.query(query).first()
-
- # Project Entity
- query = 'Project where full_name is "{}"'.format(
- project_entity["name"]
- )
- project_entity = self.session.query(query).one()
-
- # Get Task types and Statuses for creation if needed
- self.task_types = self._get_all_task_types(project_entity)
- self.task_statuses = self._get_all_task_statuses(project_entity)
-
- # Get Statuses of AssetVersions
- self.assetversion_statuses = self._get_all_assetversion_statuses(
- project_entity
- )
-
- # Setup the status that we want for the AssetVersion
- if self.assetversion_status:
- instance.data["assetversion_status"] = self.assetversion_status
-
- # Create the default_task if it does not exist
- if task == self.default_task:
- existing_tasks = []
- entity_children = asset_entity.get('children', [])
- for child in entity_children:
- if child.entity_type.lower() == 'task':
- existing_tasks.append(child['name'].lower())
-
- if task.lower() in existing_tasks:
- print("Task {} already exists".format(task))
-
- else:
- self.create_task(
- name=task,
- task_type=self.default_task_type,
- task_status=self.default_task_status,
- parent=asset_entity,
- )
-
- # Find latest version
- latest_version = self._find_last_version(subset_name, asset_doc)
- version_number = 1
- if latest_version is not None:
- version_number += latest_version
-
- self.log.info(
- "Next version of instance \"{}\" will be {}".format(
- instance_name, version_number
- )
- )
-
- # update instance info
- instance.data["task"] = task
- instance.data["version_name"] = "{}_{}".format(subset_name, task)
- instance.data["family"] = family
- instance.data["subset"] = subset_name
- instance.data["version"] = version_number
- instance.data["latestVersion"] = latest_version
- instance.data["anatomyData"].update({
- "subset": subset_name,
- "family": family,
- "version": version_number
- })
-
- # Copy `families` and check if `family` is not in current families
- families = instance.data.get("families") or list()
- if families:
- families = list(set(families))
-
- instance.data["families"] = families
-
- # Prepare staging dir for new instance and zip + sanitize scene name
- staging_dir = tempfile.mkdtemp(prefix="pyblish_tmp_")
-
- # Handle if the representation is a .zip and not an .xstage
- pre_staged = False
- if submitted_files.endswith(".zip"):
- submitted_zip_file = os.path.join(submitted_staging_dir,
- submitted_files
- ).replace("\\", "/")
-
- pre_staged = self.sanitize_prezipped_project(instance,
- submitted_zip_file,
- staging_dir)
-
- # Get the file to work with
- source_dir = str(repres[0]["stagingDir"])
- source_file = str(repres[0]["files"])
-
- staging_scene_dir = os.path.join(staging_dir, "scene")
- staging_scene = os.path.join(staging_scene_dir, source_file)
-
- # If the file is an .xstage / directory, we must stage it
- if not pre_staged:
- shutil.copytree(source_dir, staging_scene_dir)
-
- # Rename this latest file as 'scene.xstage'
- # This is is determined in the collector from the latest scene in a
- # submitted directory / directory the submitted .xstage is in.
- # In the case of a zip file being submitted, this is determined within
- # the self.sanitize_project() method in this extractor.
- os.rename(staging_scene,
- os.path.join(staging_scene_dir, "scene.xstage")
- )
-
- # Required to set the current directory where the zip will end up
- os.chdir(staging_dir)
-
- # Create the zip file
- zip_filepath = shutil.make_archive(os.path.basename(source_dir),
- "zip",
- staging_scene_dir
- )
-
- zip_filename = os.path.basename(zip_filepath)
-
- self.log.info("Zip file: {}".format(zip_filepath))
-
- # Setup representation
- new_repre = {
- "name": "zip",
- "ext": "zip",
- "files": zip_filename,
- "stagingDir": staging_dir
- }
-
- self.log.debug(
- "Creating new representation: {}".format(new_repre)
- )
- instance.data["representations"] = [new_repre]
-
- self.log.debug("Completed prep of zipped Harmony scene: {}"
- .format(zip_filepath)
- )
-
- # If this extractor is setup to also extract a workfile...
- if self.create_workfile:
- workfile_path = self.extract_workfile(instance,
- staging_scene
- )
-
- self.log.debug("Extracted Workfile to: {}".format(workfile_path))
-
- def extract_workfile(self, instance, staging_scene):
- """Extract a valid workfile for this corresponding publish.
-
- Args:
- instance (:class:`pyblish.api.Instance`): Instance data.
- staging_scene (str): path of staging scene.
-
- Returns:
- str: Path to workdir.
-
- """
- # Since the staging scene was renamed to "scene.xstage" for publish
- # rename the staging scene in the temp stagingdir
- staging_scene = os.path.join(os.path.dirname(staging_scene),
- "scene.xstage")
-
- # Setup the data needed to form a valid work path filename
- anatomy = openpype.api.Anatomy()
- project_entity = instance.context.data["projectEntity"]
-
- data = {
- "root": api.registered_root(),
- "project": {
- "name": project_entity["name"],
- "code": project_entity["data"].get("code", '')
- },
- "asset": instance.data["asset"],
- "hierarchy": openpype.api.get_hierarchy(instance.data["asset"]),
- "family": instance.data["family"],
- "task": instance.data.get("task"),
- "subset": instance.data["subset"],
- "version": 1,
- "ext": "zip",
- }
- host_name = "harmony"
- template_name = get_workfile_template_key_from_context(
- instance.data["asset"],
- instance.data.get("task"),
- host_name,
- project_name=project_entity["name"],
- dbcon=io
- )
-
- # Get a valid work filename first with version 1
- file_template = anatomy.templates[template_name]["file"]
- anatomy_filled = anatomy.format(data)
- work_path = anatomy_filled[template_name]["path"]
-
- # Get the final work filename with the proper version
- data["version"] = api.last_workfile_with_version(
- os.path.dirname(work_path),
- file_template,
- data,
- api.HOST_WORKFILE_EXTENSIONS[host_name]
- )[1]
-
- base_name = os.path.splitext(os.path.basename(work_path))[0]
-
- staging_work_path = os.path.join(os.path.dirname(staging_scene),
- base_name + ".xstage"
- )
-
- # Rename this latest file after the workfile path filename
- os.rename(staging_scene, staging_work_path)
-
- # Required to set the current directory where the zip will end up
- os.chdir(os.path.dirname(os.path.dirname(staging_scene)))
-
- # Create the zip file
- zip_filepath = shutil.make_archive(base_name,
- "zip",
- os.path.dirname(staging_scene)
- )
- self.log.info(staging_scene)
- self.log.info(work_path)
- self.log.info(staging_work_path)
- self.log.info(os.path.dirname(os.path.dirname(staging_scene)))
- self.log.info(base_name)
- self.log.info(zip_filepath)
-
- # Create the work path on disk if it does not exist
- os.makedirs(os.path.dirname(work_path), exist_ok=True)
- shutil.copy(zip_filepath, work_path)
-
- return work_path
-
- def sanitize_prezipped_project(
- self, instance, zip_filepath, staging_dir):
- """Fix when a zip contains a folder.
-
- Handle zip file root contains folder instead of the project.
-
- Args:
- instance (:class:`pyblish.api.Instance`): Instance data.
- zip_filepath (str): Path to zip.
- staging_dir (str): Path to staging directory.
-
- """
- zip = zipfile.ZipFile(zip_filepath)
- zip_contents = zipfile.ZipFile.namelist(zip)
-
- # Determine if any xstage file is in root of zip
- project_in_root = [pth for pth in zip_contents
- if "/" not in pth and pth.endswith(".xstage")]
-
- staging_scene_dir = os.path.join(staging_dir, "scene")
-
- # The project is nested, so we must extract and move it
- if not project_in_root:
-
- staging_tmp_dir = os.path.join(staging_dir, "tmp")
-
- with zipfile.ZipFile(zip_filepath, "r") as zip_ref:
- zip_ref.extractall(staging_tmp_dir)
-
- nested_project_folder = os.path.join(staging_tmp_dir,
- zip_contents[0]
- )
-
- shutil.copytree(nested_project_folder, staging_scene_dir)
-
- else:
- # The project is not nested, so we just extract to scene folder
- with zipfile.ZipFile(zip_filepath, "r") as zip_ref:
- zip_ref.extractall(staging_scene_dir)
-
- latest_file = max(glob.iglob(staging_scene_dir + "/*.xstage"),
- key=os.path.getctime).replace("\\", "/")
-
- instance.data["representations"][0]["stagingDir"] = staging_scene_dir
- instance.data["representations"][0]["files"] = os.path.basename(
- latest_file)
-
- # We have staged the scene already so return True
- return True
-
- def _find_last_version(self, subset_name, asset_doc):
- """Find last version of subset."""
- subset_doc = io.find_one({
- "type": "subset",
- "name": subset_name,
- "parent": asset_doc["_id"]
- })
-
- if subset_doc is None:
- self.log.debug("Subset entity does not exist yet.")
- else:
- version_doc = io.find_one(
- {
- "type": "version",
- "parent": subset_doc["_id"]
- },
- sort=[("name", -1)]
- )
- if version_doc:
- return int(version_doc["name"])
- return None
-
- def _get_all_task_types(self, project):
- """Get all task types."""
- tasks = {}
- proj_template = project['project_schema']
- temp_task_types = proj_template['_task_type_schema']['types']
-
- for type in temp_task_types:
- if type['name'] not in tasks:
- tasks[type['name']] = type
-
- return tasks
-
- def _get_all_task_statuses(self, project):
- """Get all statuses of tasks."""
- statuses = {}
- proj_template = project['project_schema']
- temp_task_statuses = proj_template.get_statuses("Task")
-
- for status in temp_task_statuses:
- if status['name'] not in statuses:
- statuses[status['name']] = status
-
- return statuses
-
- def _get_all_assetversion_statuses(self, project):
- """Get statuses of all asset versions."""
- statuses = {}
- proj_template = project['project_schema']
- temp_task_statuses = proj_template.get_statuses("AssetVersion")
-
- for status in temp_task_statuses:
- if status['name'] not in statuses:
- statuses[status['name']] = status
-
- return statuses
-
- def _create_task(self, name, task_type, parent, task_status):
- """Create task."""
- task_data = {
- 'name': name,
- 'parent': parent,
- }
- self.log.info(task_type)
- task_data['type'] = self.task_types[task_type]
- task_data['status'] = self.task_statuses[task_status]
- self.log.info(task_data)
- task = self.session.create('Task', task_data)
- try:
- self.session.commit()
- except Exception:
- tp, value, tb = sys.exc_info()
- self.session.rollback()
- six.reraise(tp, value, tb)
-
- return task
diff --git a/openpype/hosts/tvpaint/lib.py b/openpype/hosts/tvpaint/lib.py
new file mode 100644
index 0000000000..513bb2d952
--- /dev/null
+++ b/openpype/hosts/tvpaint/lib.py
@@ -0,0 +1,682 @@
+import os
+import shutil
+import collections
+from PIL import Image, ImageDraw
+
+
+def backwards_id_conversion(data_by_layer_id):
+ """Convert layer ids to strings from integers."""
+ for key in tuple(data_by_layer_id.keys()):
+ if not isinstance(key, str):
+ data_by_layer_id[str(key)] = data_by_layer_id.pop(key)
+
+
+def get_frame_filename_template(frame_end, filename_prefix=None, ext=None):
+ """Get file template with frame key for rendered files.
+
+ This is simple template contains `{frame}{ext}` for sequential outputs
+ and `single_file{ext}` for single file output. Output is rendered to
+ temporary folder so filename should not matter as integrator change
+ them.
+ """
+ frame_padding = 4
+ frame_end_str_len = len(str(frame_end))
+ if frame_end_str_len > frame_padding:
+ frame_padding = frame_end_str_len
+
+ ext = ext or ".png"
+ filename_prefix = filename_prefix or ""
+
+ return "{}{{frame:0>{}}}{}".format(filename_prefix, frame_padding, ext)
+
+
+def get_layer_pos_filename_template(range_end, filename_prefix=None, ext=None):
+ filename_prefix = filename_prefix or ""
+ new_filename_prefix = filename_prefix + "pos_{pos}."
+ return get_frame_filename_template(range_end, new_filename_prefix, ext)
+
+
+def _calculate_pre_behavior_copy(
+ range_start, exposure_frames, pre_beh,
+ layer_frame_start, layer_frame_end,
+ output_idx_by_frame_idx
+):
+ """Calculate frames before first exposure frame based on pre behavior.
+
+ Function may skip whole processing if first exposure frame is before
+ layer's first frame. In that case pre behavior does not make sense.
+
+ Args:
+ range_start(int): First frame of range which should be rendered.
+ exposure_frames(list): List of all exposure frames on layer.
+ pre_beh(str): Pre behavior of layer (enum of 4 strings).
+ layer_frame_start(int): First frame of layer.
+ layer_frame_end(int): Last frame of layer.
+ output_idx_by_frame_idx(dict): References to already prepared frames
+ and where result will be stored.
+ """
+ # Check if last layer frame is after range end
+ if layer_frame_start < range_start:
+ return
+
+ first_exposure_frame = min(exposure_frames)
+ # Skip if last exposure frame is after range end
+ if first_exposure_frame < range_start:
+ return
+
+ # Calculate frame count of layer
+ frame_count = layer_frame_end - layer_frame_start + 1
+
+ if pre_beh == "none":
+ # Just fill all frames from last exposure frame to range end with None
+ for frame_idx in range(range_start, layer_frame_start):
+ output_idx_by_frame_idx[frame_idx] = None
+
+ elif pre_beh == "hold":
+ # Keep first frame for whole time
+ for frame_idx in range(range_start, layer_frame_start):
+ output_idx_by_frame_idx[frame_idx] = first_exposure_frame
+
+ elif pre_beh in ("loop", "repeat"):
+ # Loop backwards from last frame of layer
+ for frame_idx in reversed(range(range_start, layer_frame_start)):
+ eq_frame_idx_offset = (
+ (layer_frame_end - frame_idx) % frame_count
+ )
+ eq_frame_idx = layer_frame_end - eq_frame_idx_offset
+ output_idx_by_frame_idx[frame_idx] = eq_frame_idx
+
+ elif pre_beh == "pingpong":
+ half_seq_len = frame_count - 1
+ seq_len = half_seq_len * 2
+ for frame_idx in reversed(range(range_start, layer_frame_start)):
+ eq_frame_idx_offset = (layer_frame_start - frame_idx) % seq_len
+ if eq_frame_idx_offset > half_seq_len:
+ eq_frame_idx_offset = (seq_len - eq_frame_idx_offset)
+ eq_frame_idx = layer_frame_start + eq_frame_idx_offset
+ output_idx_by_frame_idx[frame_idx] = eq_frame_idx
+
+
+def _calculate_post_behavior_copy(
+ range_end, exposure_frames, post_beh,
+ layer_frame_start, layer_frame_end,
+ output_idx_by_frame_idx
+):
+ """Calculate frames after last frame of layer based on post behavior.
+
+ Function may skip whole processing if last layer frame is after range_end.
+ In that case post behavior does not make sense.
+
+ Args:
+ range_end(int): Last frame of range which should be rendered.
+ exposure_frames(list): List of all exposure frames on layer.
+ post_beh(str): Post behavior of layer (enum of 4 strings).
+ layer_frame_start(int): First frame of layer.
+ layer_frame_end(int): Last frame of layer.
+ output_idx_by_frame_idx(dict): References to already prepared frames
+ and where result will be stored.
+ """
+ # Check if last layer frame is after range end
+ if layer_frame_end >= range_end:
+ return
+
+ last_exposure_frame = max(exposure_frames)
+ # Skip if last exposure frame is after range end
+ # - this is probably irrelevant with layer frame end check?
+ if last_exposure_frame >= range_end:
+ return
+
+ # Calculate frame count of layer
+ frame_count = layer_frame_end - layer_frame_start + 1
+
+ if post_beh == "none":
+ # Just fill all frames from last exposure frame to range end with None
+ for frame_idx in range(layer_frame_end + 1, range_end + 1):
+ output_idx_by_frame_idx[frame_idx] = None
+
+ elif post_beh == "hold":
+ # Keep last exposure frame to the end
+ for frame_idx in range(layer_frame_end + 1, range_end + 1):
+ output_idx_by_frame_idx[frame_idx] = last_exposure_frame
+
+ elif post_beh in ("loop", "repeat"):
+ # Loop backwards from last frame of layer
+ for frame_idx in range(layer_frame_end + 1, range_end + 1):
+ eq_frame_idx = frame_idx % frame_count
+ output_idx_by_frame_idx[frame_idx] = eq_frame_idx
+
+ elif post_beh == "pingpong":
+ half_seq_len = frame_count - 1
+ seq_len = half_seq_len * 2
+ for frame_idx in range(layer_frame_end + 1, range_end + 1):
+ eq_frame_idx_offset = (frame_idx - layer_frame_end) % seq_len
+ if eq_frame_idx_offset > half_seq_len:
+ eq_frame_idx_offset = seq_len - eq_frame_idx_offset
+ eq_frame_idx = layer_frame_end - eq_frame_idx_offset
+ output_idx_by_frame_idx[frame_idx] = eq_frame_idx
+
+
+def _calculate_in_range_frames(
+ range_start, range_end,
+ exposure_frames, layer_frame_end,
+ output_idx_by_frame_idx
+):
+ """Calculate frame references in defined range.
+
+ Function may skip whole processing if last layer frame is after range_end.
+ In that case post behavior does not make sense.
+
+ Args:
+ range_start(int): First frame of range which should be rendered.
+ range_end(int): Last frame of range which should be rendered.
+ exposure_frames(list): List of all exposure frames on layer.
+ layer_frame_end(int): Last frame of layer.
+ output_idx_by_frame_idx(dict): References to already prepared frames
+ and where result will be stored.
+ """
+ # Calculate in range frames
+ in_range_frames = []
+ for frame_idx in exposure_frames:
+ if range_start <= frame_idx <= range_end:
+ output_idx_by_frame_idx[frame_idx] = frame_idx
+ in_range_frames.append(frame_idx)
+
+ if in_range_frames:
+ first_in_range_frame = min(in_range_frames)
+ # Calculate frames from first exposure frames to range end or last
+ # frame of layer (post behavior should be calculated since that time)
+ previous_exposure = first_in_range_frame
+ for frame_idx in range(first_in_range_frame, range_end + 1):
+ if frame_idx > layer_frame_end:
+ break
+
+ if frame_idx in exposure_frames:
+ previous_exposure = frame_idx
+ else:
+ output_idx_by_frame_idx[frame_idx] = previous_exposure
+
+ # There can be frames before first exposure frame in range
+ # First check if we don't alreade have first range frame filled
+ if range_start in output_idx_by_frame_idx:
+ return
+
+ first_exposure_frame = max(exposure_frames)
+ last_exposure_frame = max(exposure_frames)
+ # Check if is first exposure frame smaller than defined range
+ # if not then skip
+ if first_exposure_frame >= range_start:
+ return
+
+ # Check is if last exposure frame is also before range start
+ # in that case we can't use fill frames before out range
+ if last_exposure_frame < range_start:
+ return
+
+ closest_exposure_frame = first_exposure_frame
+ for frame_idx in exposure_frames:
+ if frame_idx >= range_start:
+ break
+ if frame_idx > closest_exposure_frame:
+ closest_exposure_frame = frame_idx
+
+ output_idx_by_frame_idx[closest_exposure_frame] = closest_exposure_frame
+ for frame_idx in range(range_start, range_end + 1):
+ if frame_idx in output_idx_by_frame_idx:
+ break
+ output_idx_by_frame_idx[frame_idx] = closest_exposure_frame
+
+
+def _cleanup_frame_references(output_idx_by_frame_idx):
+ """Cleanup frame references to frame reference.
+
+ Cleanup not direct references to rendered frame.
+ ```
+ // Example input
+ {
+ 1: 1,
+ 2: 1,
+ 3: 2
+ }
+ // Result
+ {
+ 1: 1,
+ 2: 1,
+ 3: 1 // Changed reference to final rendered frame
+ }
+ ```
+ Result is dictionary where keys leads to frame that should be rendered.
+ """
+ for frame_idx in tuple(output_idx_by_frame_idx.keys()):
+ reference_idx = output_idx_by_frame_idx[frame_idx]
+ # Skip transparent frames
+ if reference_idx is None or reference_idx == frame_idx:
+ continue
+
+ real_reference_idx = reference_idx
+ _tmp_reference_idx = reference_idx
+ while True:
+ _temp = output_idx_by_frame_idx[_tmp_reference_idx]
+ if _temp == _tmp_reference_idx:
+ real_reference_idx = _tmp_reference_idx
+ break
+ _tmp_reference_idx = _temp
+
+ if real_reference_idx != reference_idx:
+ output_idx_by_frame_idx[frame_idx] = real_reference_idx
+
+
+def _cleanup_out_range_frames(output_idx_by_frame_idx, range_start, range_end):
+ """Cleanup frame references to frames out of passed range.
+
+ First available frame in range is used
+ ```
+ // Example input. Range 2-3
+ {
+ 1: 1,
+ 2: 1,
+ 3: 1
+ }
+ // Result
+ {
+ 2: 2, // Redirect to self as is first that refence out range
+ 3: 2 // Redirect to first redirected frame
+ }
+ ```
+ Result is dictionary where keys leads to frame that should be rendered.
+ """
+ in_range_frames_by_out_frames = collections.defaultdict(set)
+ out_range_frames = set()
+ for frame_idx in tuple(output_idx_by_frame_idx.keys()):
+ # Skip frames that are already out of range
+ if frame_idx < range_start or frame_idx > range_end:
+ out_range_frames.add(frame_idx)
+ continue
+
+ reference_idx = output_idx_by_frame_idx[frame_idx]
+ # Skip transparent frames
+ if reference_idx is None:
+ continue
+
+ # Skip references in range
+ if reference_idx < range_start or reference_idx > range_end:
+ in_range_frames_by_out_frames[reference_idx].add(frame_idx)
+
+ for reference_idx in tuple(in_range_frames_by_out_frames.keys()):
+ frame_indexes = in_range_frames_by_out_frames.pop(reference_idx)
+ new_reference = None
+ for frame_idx in frame_indexes:
+ if new_reference is None:
+ new_reference = frame_idx
+ output_idx_by_frame_idx[frame_idx] = new_reference
+
+ # Finally remove out of range frames
+ for frame_idx in out_range_frames:
+ output_idx_by_frame_idx.pop(frame_idx)
+
+
+def calculate_layer_frame_references(
+ range_start, range_end,
+ layer_frame_start,
+ layer_frame_end,
+ exposure_frames,
+ pre_beh, post_beh
+):
+ """Calculate frame references for one layer based on it's data.
+
+ Output is dictionary where key is frame index referencing to rendered frame
+ index. If frame index should be rendered then is referencing to self.
+
+ ```
+ // Example output
+ {
+ 1: 1, // Reference to self - will be rendered
+ 2: 1, // Reference to frame 1 - will be copied
+ 3: 1, // Reference to frame 1 - will be copied
+ 4: 4, // Reference to self - will be rendered
+ ...
+ 20: 4 // Reference to frame 4 - will be copied
+ 21: None // Has reference to None - transparent image
+ }
+ ```
+
+ Args:
+ range_start(int): First frame of range which should be rendered.
+ range_end(int): Last frame of range which should be rendered.
+ layer_frame_start(int)L First frame of layer.
+ layer_frame_end(int): Last frame of layer.
+ exposure_frames(list): List of all exposure frames on layer.
+ pre_beh(str): Pre behavior of layer (enum of 4 strings).
+ post_beh(str): Post behavior of layer (enum of 4 strings).
+ """
+ # Output variable
+ output_idx_by_frame_idx = {}
+ # Skip if layer does not have any exposure frames
+ if not exposure_frames:
+ return output_idx_by_frame_idx
+
+ # First calculate in range frames
+ _calculate_in_range_frames(
+ range_start, range_end,
+ exposure_frames, layer_frame_end,
+ output_idx_by_frame_idx
+ )
+ # Calculate frames by pre behavior of layer
+ _calculate_pre_behavior_copy(
+ range_start, exposure_frames, pre_beh,
+ layer_frame_start, layer_frame_end,
+ output_idx_by_frame_idx
+ )
+ # Calculate frames by post behavior of layer
+ _calculate_post_behavior_copy(
+ range_end, exposure_frames, post_beh,
+ layer_frame_start, layer_frame_end,
+ output_idx_by_frame_idx
+ )
+ # Cleanup of referenced frames
+ _cleanup_frame_references(output_idx_by_frame_idx)
+
+ # Remove frames out of range
+ _cleanup_out_range_frames(output_idx_by_frame_idx, range_start, range_end)
+
+ return output_idx_by_frame_idx
+
+
+def calculate_layers_extraction_data(
+ layers_data,
+ exposure_frames_by_layer_id,
+ behavior_by_layer_id,
+ range_start,
+ range_end,
+ skip_not_visible=True,
+ filename_prefix=None,
+ ext=None
+):
+ """Calculate extraction data for passed layers data.
+
+ ```
+ {
+ : {
+ "frame_references": {...},
+ "filenames_by_frame_index": {...}
+ },
+ ...
+ }
+ ```
+
+ Frame references contains frame index reference to rendered frame index.
+
+ Filename by frame index represents filename under which should be frame
+ stored. Directory is not handled here because each usage may need different
+ approach.
+
+ Args:
+ layers_data(list): Layers data loaded from TVPaint.
+ exposure_frames_by_layer_id(dict): Exposure frames of layers stored by
+ layer id.
+ behavior_by_layer_id(dict): Pre and Post behavior of layers stored by
+ layer id.
+ range_start(int): First frame of rendered range.
+ range_end(int): Last frame of rendered range.
+ skip_not_visible(bool): Skip calculations for hidden layers (Skipped
+ by default).
+ filename_prefix(str): Prefix before filename.
+ ext(str): Extension which filenames will have ('.png' is default).
+
+ Returns:
+ dict: Prepared data for rendering by layer position.
+ """
+ # Make sure layer ids are strings
+ # backwards compatibility when layer ids were integers
+ backwards_id_conversion(exposure_frames_by_layer_id)
+ backwards_id_conversion(behavior_by_layer_id)
+
+ layer_template = get_layer_pos_filename_template(
+ range_end, filename_prefix, ext
+ )
+ output = {}
+ for layer_data in layers_data:
+ if skip_not_visible and not layer_data["visible"]:
+ continue
+
+ orig_layer_id = layer_data["layer_id"]
+ layer_id = str(orig_layer_id)
+
+ # Skip if does not have any exposure frames (empty layer)
+ exposure_frames = exposure_frames_by_layer_id[layer_id]
+ if not exposure_frames:
+ continue
+
+ layer_position = layer_data["position"]
+ layer_frame_start = layer_data["frame_start"]
+ layer_frame_end = layer_data["frame_end"]
+
+ layer_behavior = behavior_by_layer_id[layer_id]
+
+ pre_behavior = layer_behavior["pre"]
+ post_behavior = layer_behavior["post"]
+
+ frame_references = calculate_layer_frame_references(
+ range_start, range_end,
+ layer_frame_start,
+ layer_frame_end,
+ exposure_frames,
+ pre_behavior, post_behavior
+ )
+ # All values in 'frame_references' reference to a frame that must be
+ # rendered out
+ frames_to_render = set(frame_references.values())
+ # Remove 'None' reference (transparent image)
+ if None in frames_to_render:
+ frames_to_render.remove(None)
+
+ # Skip layer if has nothing to render
+ if not frames_to_render:
+ continue
+
+ # All filenames that should be as output (not final output)
+ filename_frames = (
+ set(range(range_start, range_end + 1))
+ | frames_to_render
+ )
+ filenames_by_frame_index = {}
+ for frame_idx in filename_frames:
+ filenames_by_frame_index[frame_idx] = layer_template.format(
+ pos=layer_position,
+ frame=frame_idx
+ )
+
+ # Store objects under the layer id
+ output[orig_layer_id] = {
+ "frame_references": frame_references,
+ "filenames_by_frame_index": filenames_by_frame_index
+ }
+ return output
+
+
+def create_transparent_image_from_source(src_filepath, dst_filepath):
+ """Create transparent image of same type and size as source image."""
+ img_obj = Image.open(src_filepath)
+ painter = ImageDraw.Draw(img_obj)
+ painter.rectangle((0, 0, *img_obj.size), fill=(0, 0, 0, 0))
+ img_obj.save(dst_filepath)
+
+
+def fill_reference_frames(frame_references, filepaths_by_frame):
+ # Store path to first transparent image if there is any
+ for frame_idx, ref_idx in frame_references.items():
+ # Frame referencing to self should be rendered and used as source
+ # and reference indexes with None can't be filled
+ if ref_idx is None or frame_idx == ref_idx:
+ continue
+
+ # Get destination filepath
+ src_filepath = filepaths_by_frame[ref_idx]
+ dst_filepath = filepaths_by_frame[frame_idx]
+
+ if hasattr(os, "link"):
+ os.link(src_filepath, dst_filepath)
+ else:
+ shutil.copy(src_filepath, dst_filepath)
+
+
+def copy_render_file(src_path, dst_path):
+ """Create copy file of an image."""
+ if hasattr(os, "link"):
+ os.link(src_path, dst_path)
+ else:
+ shutil.copy(src_path, dst_path)
+
+
+def cleanup_rendered_layers(filepaths_by_layer_id):
+ """Delete all files for each individual layer files after compositing."""
+ # Collect all filepaths from data
+ all_filepaths = []
+ for filepaths_by_frame in filepaths_by_layer_id.values():
+ all_filepaths.extend(filepaths_by_frame.values())
+
+ # Loop over loop
+ for filepath in set(all_filepaths):
+ if filepath is not None and os.path.exists(filepath):
+ os.remove(filepath)
+
+
+def composite_rendered_layers(
+ layers_data, filepaths_by_layer_id,
+ range_start, range_end,
+ dst_filepaths_by_frame, cleanup=True
+):
+ """Composite multiple rendered layers by their position.
+
+ Result is single frame sequence with transparency matching content
+ created in TVPaint. Missing source filepaths are replaced with transparent
+ images but at least one image must be rendered and exist.
+
+ Function can be used even if single layer was created to fill transparent
+ filepaths.
+
+ Args:
+ layers_data(list): Layers data loaded from TVPaint.
+ filepaths_by_layer_id(dict): Rendered filepaths stored by frame index
+ per layer id. Used as source for compositing.
+ range_start(int): First frame of rendered range.
+ range_end(int): Last frame of rendered range.
+ dst_filepaths_by_frame(dict): Output filepaths by frame where final
+ image after compositing will be stored. Path must not clash with
+ source filepaths.
+ cleanup(bool): Remove all source filepaths when done with compositing.
+ """
+ # Prepare layers by their position
+ # - position tells in which order will compositing happen
+ layer_ids_by_position = {}
+ for layer in layers_data:
+ layer_position = layer["position"]
+ layer_ids_by_position[layer_position] = layer["layer_id"]
+
+ # Sort layer positions
+ sorted_positions = tuple(sorted(layer_ids_by_position.keys()))
+ # Prepare variable where filepaths without any rendered content
+ # - transparent will be created
+ transparent_filepaths = set()
+ # Store first final filepath
+ first_dst_filepath = None
+ for frame_idx in range(range_start, range_end + 1):
+ dst_filepath = dst_filepaths_by_frame[frame_idx]
+ src_filepaths = []
+ for layer_position in sorted_positions:
+ layer_id = layer_ids_by_position[layer_position]
+ filepaths_by_frame = filepaths_by_layer_id[layer_id]
+ src_filepath = filepaths_by_frame.get(frame_idx)
+ if src_filepath is not None:
+ src_filepaths.append(src_filepath)
+
+ if not src_filepaths:
+ transparent_filepaths.add(dst_filepath)
+ continue
+
+ # Store first destionation filepath to be used for transparent images
+ if first_dst_filepath is None:
+ first_dst_filepath = dst_filepath
+
+ if len(src_filepaths) == 1:
+ src_filepath = src_filepaths[0]
+ if cleanup:
+ os.rename(src_filepath, dst_filepath)
+ else:
+ copy_render_file(src_filepath, dst_filepath)
+
+ else:
+ composite_images(src_filepaths, dst_filepath)
+
+ # Store first transparent filepath to be able copy it
+ transparent_filepath = None
+ for dst_filepath in transparent_filepaths:
+ if transparent_filepath is None:
+ create_transparent_image_from_source(
+ first_dst_filepath, dst_filepath
+ )
+ transparent_filepath = dst_filepath
+ else:
+ copy_render_file(transparent_filepath, dst_filepath)
+
+ # Remove all files that were used as source for compositing
+ if cleanup:
+ cleanup_rendered_layers(filepaths_by_layer_id)
+
+
+def composite_images(input_image_paths, output_filepath):
+ """Composite images in order from passed list.
+
+ Raises:
+ ValueError: When entered list is empty.
+ """
+ if not input_image_paths:
+ raise ValueError("Nothing to composite.")
+
+ img_obj = None
+ for image_filepath in input_image_paths:
+ _img_obj = Image.open(image_filepath)
+ if img_obj is None:
+ img_obj = _img_obj
+ else:
+ img_obj.alpha_composite(_img_obj)
+ img_obj.save(output_filepath)
+
+
+def rename_filepaths_by_frame_start(
+ filepaths_by_frame, range_start, range_end, new_frame_start
+):
+ """Change frames in filenames of finished images to new frame start."""
+ # Skip if source first frame is same as destination first frame
+ if range_start == new_frame_start:
+ return
+
+ # Calculate frame end
+ new_frame_end = range_end + (new_frame_start - range_start)
+ # Create filename template
+ filename_template = get_frame_filename_template(
+ max(range_end, new_frame_end)
+ )
+
+ # Use differnet ranges based on Mark In and output Frame Start values
+ # - this is to make sure that filename renaming won't affect files that
+ # are not renamed yet
+ if range_start < new_frame_start:
+ source_range = range(range_end, range_start - 1, -1)
+ output_range = range(new_frame_end, new_frame_start - 1, -1)
+ else:
+ # This is less possible situation as frame start will be in most
+ # cases higher than Mark In.
+ source_range = range(range_start, range_end + 1)
+ output_range = range(new_frame_start, new_frame_end + 1)
+
+ new_dst_filepaths = {}
+ for src_frame, dst_frame in zip(source_range, output_range):
+ src_filepath = filepaths_by_frame[src_frame]
+ src_dirpath = os.path.dirname(src_filepath)
+ dst_filename = filename_template.format(frame=dst_frame)
+ dst_filepath = os.path.join(src_dirpath, dst_filename)
+
+ os.rename(src_filepath, dst_filepath)
+
+ new_dst_filepaths[dst_frame] = dst_filepath
+ return new_dst_filepaths
diff --git a/openpype/hosts/tvpaint/plugins/load/load_workfile.py b/openpype/hosts/tvpaint/plugins/load/load_workfile.py
new file mode 100644
index 0000000000..f410a1ab9d
--- /dev/null
+++ b/openpype/hosts/tvpaint/plugins/load/load_workfile.py
@@ -0,0 +1,102 @@
+import getpass
+import os
+
+from avalon.tvpaint import lib, pipeline, get_current_workfile_context
+from avalon import api, io
+from openpype.lib import (
+ get_workfile_template_key_from_context,
+ get_workdir_data
+)
+from openpype.api import Anatomy
+
+
+class LoadWorkfile(pipeline.Loader):
+ """Load workfile."""
+
+ families = ["workfile"]
+ representations = ["tvpp"]
+
+ label = "Load Workfile"
+
+ def load(self, context, name, namespace, options):
+ # Load context of current workfile as first thing
+ # - which context and extension has
+ host = api.registered_host()
+ current_file = host.current_file()
+
+ context = get_current_workfile_context()
+
+ filepath = self.fname.replace("\\", "/")
+
+ if not os.path.exists(filepath):
+ raise FileExistsError(
+ "The loaded file does not exist. Try downloading it first."
+ )
+
+ george_script = "tv_LoadProject '\"'\"{}\"'\"'".format(
+ filepath
+ )
+ lib.execute_george_through_file(george_script)
+
+ # Save workfile.
+ host_name = "tvpaint"
+ asset_name = context.get("asset")
+ task_name = context.get("task")
+ # Far cases when there is workfile without context
+ if not asset_name:
+ asset_name = io.Session["AVALON_ASSET"]
+ task_name = io.Session["AVALON_TASK"]
+
+ project_doc = io.find_one({
+ "type": "project"
+ })
+ asset_doc = io.find_one({
+ "type": "asset",
+ "name": asset_name
+ })
+ project_name = project_doc["name"]
+
+ template_key = get_workfile_template_key_from_context(
+ asset_name,
+ task_name,
+ host_name,
+ project_name=project_name,
+ dbcon=io
+ )
+ anatomy = Anatomy(project_name)
+
+ data = get_workdir_data(project_doc, asset_doc, task_name, host_name)
+ data["root"] = anatomy.roots
+ data["user"] = getpass.getuser()
+
+ template = anatomy.templates[template_key]["file"]
+
+ # Define saving file extension
+ if current_file:
+ # Match the extension of current file
+ _, extension = os.path.splitext(current_file)
+ else:
+ # Fall back to the first extension supported for this host.
+ extension = host.file_extensions()[0]
+
+ data["ext"] = extension
+
+ work_root = api.format_template_with_optional_keys(
+ data, anatomy.templates[template_key]["folder"]
+ )
+ version = api.last_workfile_with_version(
+ work_root, template, data, host.file_extensions()
+ )[1]
+
+ if version is None:
+ version = 1
+ else:
+ version += 1
+
+ data["version"] = version
+
+ path = os.path.join(
+ work_root,
+ api.format_template_with_optional_keys(data, template)
+ )
+ host.save_file(path)
diff --git a/openpype/hosts/tvpaint/plugins/publish/extract_sequence.py b/openpype/hosts/tvpaint/plugins/publish/extract_sequence.py
index c45ff53c3c..6235b6211d 100644
--- a/openpype/hosts/tvpaint/plugins/publish/extract_sequence.py
+++ b/openpype/hosts/tvpaint/plugins/publish/extract_sequence.py
@@ -1,12 +1,18 @@
import os
-import shutil
import copy
import tempfile
import pyblish.api
from avalon.tvpaint import lib
from openpype.hosts.tvpaint.api.lib import composite_images
-from PIL import Image, ImageDraw
+from openpype.hosts.tvpaint.lib import (
+ calculate_layers_extraction_data,
+ get_frame_filename_template,
+ fill_reference_frames,
+ composite_rendered_layers,
+ rename_filepaths_by_frame_start
+)
+from PIL import Image
class ExtractSequence(pyblish.api.Extractor):
@@ -111,14 +117,6 @@ class ExtractSequence(pyblish.api.Extractor):
# -------------------------------------------------------------------
- filename_template = self._get_filename_template(
- # Use the biggest number
- max(mark_out, frame_end)
- )
- ext = os.path.splitext(filename_template)[1].replace(".", "")
-
- self.log.debug("Using file template \"{}\"".format(filename_template))
-
# Save to staging dir
output_dir = instance.data.get("stagingDir")
if not output_dir:
@@ -133,30 +131,30 @@ class ExtractSequence(pyblish.api.Extractor):
)
if instance.data["family"] == "review":
- output_filenames, thumbnail_fullpath = self.render_review(
- filename_template, output_dir, mark_in, mark_out,
- scene_bg_color
+ result = self.render_review(
+ output_dir, mark_in, mark_out, scene_bg_color
)
else:
# Render output
- output_filenames, thumbnail_fullpath = self.render(
- filename_template, output_dir,
- mark_in, mark_out,
- filtered_layers
+ result = self.render(
+ output_dir, mark_in, mark_out, filtered_layers
)
+ output_filepaths_by_frame_idx, thumbnail_fullpath = result
+
# Change scene frame Start back to previous value
lib.execute_george("tv_startframe {}".format(scene_start_frame))
# Sequence of one frame
- if not output_filenames:
+ if not output_filepaths_by_frame_idx:
self.log.warning("Extractor did not create any output.")
return
repre_files = self._rename_output_files(
- filename_template, output_dir,
- mark_in, mark_out,
- output_frame_start, output_frame_end
+ output_filepaths_by_frame_idx,
+ mark_in,
+ mark_out,
+ output_frame_start
)
# Fill tags and new families
@@ -169,9 +167,11 @@ class ExtractSequence(pyblish.api.Extractor):
if single_file:
repre_files = repre_files[0]
+ # Extension is harcoded
+ # - changing extension would require change code
new_repre = {
- "name": ext,
- "ext": ext,
+ "name": "png",
+ "ext": "png",
"files": repre_files,
"stagingDir": output_dir,
"tags": tags
@@ -206,69 +206,28 @@ class ExtractSequence(pyblish.api.Extractor):
}
instance.data["representations"].append(thumbnail_repre)
- def _get_filename_template(self, frame_end):
- """Get filetemplate for rendered files.
-
- This is simple template contains `{frame}{ext}` for sequential outputs
- and `single_file{ext}` for single file output. Output is rendered to
- temporary folder so filename should not matter as integrator change
- them.
- """
- frame_padding = 4
- frame_end_str_len = len(str(frame_end))
- if frame_end_str_len > frame_padding:
- frame_padding = frame_end_str_len
-
- return "{{frame:0>{}}}".format(frame_padding) + ".png"
-
def _rename_output_files(
- self, filename_template, output_dir,
- mark_in, mark_out, output_frame_start, output_frame_end
+ self, filepaths_by_frame, mark_in, mark_out, output_frame_start
):
- # Use differnet ranges based on Mark In and output Frame Start values
- # - this is to make sure that filename renaming won't affect files that
- # are not renamed yet
- mark_start_is_less = bool(mark_in < output_frame_start)
- if mark_start_is_less:
- marks_range = range(mark_out, mark_in - 1, -1)
- frames_range = range(output_frame_end, output_frame_start - 1, -1)
- else:
- # This is less possible situation as frame start will be in most
- # cases higher than Mark In.
- marks_range = range(mark_in, mark_out + 1)
- frames_range = range(output_frame_start, output_frame_end + 1)
+ new_filepaths_by_frame = rename_filepaths_by_frame_start(
+ filepaths_by_frame, mark_in, mark_out, output_frame_start
+ )
- repre_filepaths = []
- for mark, frame in zip(marks_range, frames_range):
- new_filename = filename_template.format(frame=frame)
- new_filepath = os.path.join(output_dir, new_filename)
+ repre_filenames = []
+ for filepath in new_filepaths_by_frame.values():
+ repre_filenames.append(os.path.basename(filepath))
- repre_filepaths.append(new_filepath)
+ if mark_in < output_frame_start:
+ repre_filenames = list(reversed(repre_filenames))
- if mark != frame:
- old_filename = filename_template.format(frame=mark)
- old_filepath = os.path.join(output_dir, old_filename)
- os.rename(old_filepath, new_filepath)
-
- # Reverse repre files order if output
- if mark_start_is_less:
- repre_filepaths = list(reversed(repre_filepaths))
-
- return [
- os.path.basename(path)
- for path in repre_filepaths
- ]
+ return repre_filenames
def render_review(
- self, filename_template, output_dir, mark_in, mark_out, scene_bg_color
+ self, output_dir, mark_in, mark_out, scene_bg_color
):
""" Export images from TVPaint using `tv_savesequence` command.
Args:
- filename_template (str): Filename template of an output. Template
- should already contain extension. Template may contain only
- keyword argument `{frame}` or index argument (for same value).
- Extension in template must match `save_mode`.
output_dir (str): Directory where files will be stored.
mark_in (int): Starting frame index from which export will begin.
mark_out (int): On which frame index export will end.
@@ -279,6 +238,8 @@ class ExtractSequence(pyblish.api.Extractor):
tuple: With 2 items first is list of filenames second is path to
thumbnail.
"""
+ filename_template = get_frame_filename_template(mark_out)
+
self.log.debug("Preparing data for rendering.")
first_frame_filepath = os.path.join(
output_dir,
@@ -313,12 +274,13 @@ class ExtractSequence(pyblish.api.Extractor):
lib.execute_george_through_file("\n".join(george_script_lines))
first_frame_filepath = None
- output_filenames = []
- for frame in range(mark_in, mark_out + 1):
- filename = filename_template.format(frame=frame)
- output_filenames.append(filename)
-
+ output_filepaths_by_frame_idx = {}
+ for frame_idx in range(mark_in, mark_out + 1):
+ filename = filename_template.format(frame=frame_idx)
filepath = os.path.join(output_dir, filename)
+
+ output_filepaths_by_frame_idx[frame_idx] = filepath
+
if not os.path.exists(filepath):
raise AssertionError(
"Output was not rendered. File was not found {}".format(
@@ -337,16 +299,12 @@ class ExtractSequence(pyblish.api.Extractor):
source_img = source_img.convert("RGB")
source_img.save(thumbnail_filepath)
- return output_filenames, thumbnail_filepath
+ return output_filepaths_by_frame_idx, thumbnail_filepath
- def render(self, filename_template, output_dir, mark_in, mark_out, layers):
+ def render(self, output_dir, mark_in, mark_out, layers):
""" Export images from TVPaint.
Args:
- filename_template (str): Filename template of an output. Template
- should already contain extension. Template may contain only
- keyword argument `{frame}` or index argument (for same value).
- Extension in template must match `save_mode`.
output_dir (str): Directory where files will be stored.
mark_in (int): Starting frame index from which export will begin.
mark_out (int): On which frame index export will end.
@@ -360,12 +318,15 @@ class ExtractSequence(pyblish.api.Extractor):
# Map layers by position
layers_by_position = {}
+ layers_by_id = {}
layer_ids = []
for layer in layers:
+ layer_id = layer["layer_id"]
position = layer["position"]
layers_by_position[position] = layer
+ layers_by_id[layer_id] = layer
- layer_ids.append(layer["layer_id"])
+ layer_ids.append(layer_id)
# Sort layer positions in reverse order
sorted_positions = list(reversed(sorted(layers_by_position.keys())))
@@ -374,59 +335,45 @@ class ExtractSequence(pyblish.api.Extractor):
self.log.debug("Collecting pre/post behavior of individual layers.")
behavior_by_layer_id = lib.get_layers_pre_post_behavior(layer_ids)
-
- tmp_filename_template = "pos_{pos}." + filename_template
-
- files_by_position = {}
- for position in sorted_positions:
- layer = layers_by_position[position]
- behavior = behavior_by_layer_id[layer["layer_id"]]
-
- files_by_frames = self._render_layer(
- layer,
- tmp_filename_template,
- output_dir,
- behavior,
- mark_in,
- mark_out
- )
- if files_by_frames:
- files_by_position[position] = files_by_frames
- else:
- self.log.warning((
- "Skipped layer \"{}\". Probably out of Mark In/Out range."
- ).format(layer["name"]))
-
- if not files_by_position:
- layer_names = set(layer["name"] for layer in layers)
- joined_names = ", ".join(
- ["\"{}\"".format(name) for name in layer_names]
- )
- self.log.warning(
- "Layers {} do not have content in range {} - {}".format(
- joined_names, mark_in, mark_out
- )
- )
- return [], None
-
- output_filepaths = self._composite_files(
- files_by_position,
- mark_in,
- mark_out,
- filename_template,
- output_dir
+ exposure_frames_by_layer_id = lib.get_layers_exposure_frames(
+ layer_ids, layers
)
- self._cleanup_tmp_files(files_by_position)
-
- output_filenames = [
- os.path.basename(filepath)
- for filepath in output_filepaths
- ]
+ extraction_data_by_layer_id = calculate_layers_extraction_data(
+ layers,
+ exposure_frames_by_layer_id,
+ behavior_by_layer_id,
+ mark_in,
+ mark_out
+ )
+ # Render layers
+ filepaths_by_layer_id = {}
+ for layer_id, render_data in extraction_data_by_layer_id.items():
+ layer = layers_by_id[layer_id]
+ filepaths_by_layer_id[layer_id] = self._render_layer(
+ render_data, layer, output_dir
+ )
+ # Prepare final filepaths where compositing should store result
+ output_filepaths_by_frame = {}
thumbnail_src_filepath = None
- if output_filepaths:
- thumbnail_src_filepath = output_filepaths[0]
+ finale_template = get_frame_filename_template(mark_out)
+ for frame_idx in range(mark_in, mark_out + 1):
+ filename = finale_template.format(frame=frame_idx)
+ filepath = os.path.join(output_dir, filename)
+ output_filepaths_by_frame[frame_idx] = filepath
+
+ if thumbnail_src_filepath is None:
+ thumbnail_src_filepath = filepath
+
+ self.log.info("Started compositing of layer frames.")
+ composite_rendered_layers(
+ layers, filepaths_by_layer_id,
+ mark_in, mark_out,
+ output_filepaths_by_frame
+ )
+
+ self.log.info("Compositing finished")
thumbnail_filepath = None
if thumbnail_src_filepath and os.path.exists(thumbnail_src_filepath):
source_img = Image.open(thumbnail_src_filepath)
@@ -449,7 +396,7 @@ class ExtractSequence(pyblish.api.Extractor):
).format(source_img.mode))
source_img.save(thumbnail_filepath)
- return output_filenames, thumbnail_filepath
+ return output_filepaths_by_frame, thumbnail_filepath
def _get_review_bg_color(self):
red = green = blue = 255
@@ -460,338 +407,43 @@ class ExtractSequence(pyblish.api.Extractor):
red, green, blue = self.review_bg
return (red, green, blue)
- def _render_layer(
- self,
- layer,
- tmp_filename_template,
- output_dir,
- behavior,
- mark_in_index,
- mark_out_index
- ):
+ def _render_layer(self, render_data, layer, output_dir):
+ frame_references = render_data["frame_references"]
+ filenames_by_frame_index = render_data["filenames_by_frame_index"]
+
layer_id = layer["layer_id"]
- frame_start_index = layer["frame_start"]
- frame_end_index = layer["frame_end"]
-
- pre_behavior = behavior["pre"]
- post_behavior = behavior["post"]
-
- # Check if layer is before mark in
- if frame_end_index < mark_in_index:
- # Skip layer if post behavior is "none"
- if post_behavior == "none":
- return {}
-
- # Check if layer is after mark out
- elif frame_start_index > mark_out_index:
- # Skip layer if pre behavior is "none"
- if pre_behavior == "none":
- return {}
-
- exposure_frames = lib.get_exposure_frames(
- layer_id, frame_start_index, frame_end_index
- )
-
- if frame_start_index not in exposure_frames:
- exposure_frames.append(frame_start_index)
-
- layer_files_by_frame = {}
george_script_lines = [
+ "tv_layerset {}".format(layer_id),
"tv_SaveMode \"PNG\""
]
- layer_position = layer["position"]
- for frame_idx in exposure_frames:
- filename = tmp_filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
+ filepaths_by_frame = {}
+ frames_to_render = []
+ for frame_idx, ref_idx in frame_references.items():
+ # None reference is skipped because does not have source
+ if ref_idx is None:
+ filepaths_by_frame[frame_idx] = None
+ continue
+ filename = filenames_by_frame_index[frame_idx]
dst_path = "/".join([output_dir, filename])
- layer_files_by_frame[frame_idx] = os.path.normpath(dst_path)
+ filepaths_by_frame[frame_idx] = dst_path
+ if frame_idx != ref_idx:
+ continue
+ frames_to_render.append(str(frame_idx))
# Go to frame
george_script_lines.append("tv_layerImage {}".format(frame_idx))
# Store image to output
george_script_lines.append("tv_saveimage \"{}\"".format(dst_path))
self.log.debug("Rendering Exposure frames {} of layer {} ({})".format(
- str(exposure_frames), layer_id, layer["name"]
+ ",".join(frames_to_render), layer_id, layer["name"]
))
# Let TVPaint render layer's image
lib.execute_george_through_file("\n".join(george_script_lines))
# Fill frames between `frame_start_index` and `frame_end_index`
- self.log.debug((
- "Filling frames between first and last frame of layer ({} - {})."
- ).format(frame_start_index + 1, frame_end_index + 1))
+ self.log.debug("Filling frames not rendered frames.")
+ fill_reference_frames(frame_references, filepaths_by_frame)
- _debug_filled_frames = []
- prev_filepath = None
- for frame_idx in range(frame_start_index, frame_end_index + 1):
- if frame_idx in layer_files_by_frame:
- prev_filepath = layer_files_by_frame[frame_idx]
- continue
-
- if prev_filepath is None:
- raise ValueError("BUG: First frame of layer was not rendered!")
- _debug_filled_frames.append(frame_idx)
- filename = tmp_filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(prev_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- self.log.debug("Filled frames {}".format(str(_debug_filled_frames)))
-
- # Fill frames by pre/post behavior of layer
- self.log.debug((
- "Completing image sequence of layer by pre/post behavior."
- " PRE: {} | POST: {}"
- ).format(pre_behavior, post_behavior))
-
- # Pre behavior
- self._fill_frame_by_pre_behavior(
- layer,
- pre_behavior,
- mark_in_index,
- layer_files_by_frame,
- tmp_filename_template,
- output_dir
- )
- self._fill_frame_by_post_behavior(
- layer,
- post_behavior,
- mark_out_index,
- layer_files_by_frame,
- tmp_filename_template,
- output_dir
- )
- return layer_files_by_frame
-
- def _fill_frame_by_pre_behavior(
- self,
- layer,
- pre_behavior,
- mark_in_index,
- layer_files_by_frame,
- filename_template,
- output_dir
- ):
- layer_position = layer["position"]
- frame_start_index = layer["frame_start"]
- frame_end_index = layer["frame_end"]
- frame_count = frame_end_index - frame_start_index + 1
- if mark_in_index >= frame_start_index:
- self.log.debug((
- "Skipping pre-behavior."
- " All frames after Mark In are rendered."
- ))
- return
-
- if pre_behavior == "none":
- # Empty frames are handled during `_composite_files`
- pass
-
- elif pre_behavior == "hold":
- # Keep first frame for whole time
- eq_frame_filepath = layer_files_by_frame[frame_start_index]
- for frame_idx in range(mark_in_index, frame_start_index):
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- elif pre_behavior in ("loop", "repeat"):
- # Loop backwards from last frame of layer
- for frame_idx in reversed(range(mark_in_index, frame_start_index)):
- eq_frame_idx_offset = (
- (frame_end_index - frame_idx) % frame_count
- )
- eq_frame_idx = frame_end_index - eq_frame_idx_offset
- eq_frame_filepath = layer_files_by_frame[eq_frame_idx]
-
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- elif pre_behavior == "pingpong":
- half_seq_len = frame_count - 1
- seq_len = half_seq_len * 2
- for frame_idx in reversed(range(mark_in_index, frame_start_index)):
- eq_frame_idx_offset = (frame_start_index - frame_idx) % seq_len
- if eq_frame_idx_offset > half_seq_len:
- eq_frame_idx_offset = (seq_len - eq_frame_idx_offset)
- eq_frame_idx = frame_start_index + eq_frame_idx_offset
-
- eq_frame_filepath = layer_files_by_frame[eq_frame_idx]
-
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- def _fill_frame_by_post_behavior(
- self,
- layer,
- post_behavior,
- mark_out_index,
- layer_files_by_frame,
- filename_template,
- output_dir
- ):
- layer_position = layer["position"]
- frame_start_index = layer["frame_start"]
- frame_end_index = layer["frame_end"]
- frame_count = frame_end_index - frame_start_index + 1
- if mark_out_index <= frame_end_index:
- self.log.debug((
- "Skipping post-behavior."
- " All frames up to Mark Out are rendered."
- ))
- return
-
- if post_behavior == "none":
- # Empty frames are handled during `_composite_files`
- pass
-
- elif post_behavior == "hold":
- # Keep first frame for whole time
- eq_frame_filepath = layer_files_by_frame[frame_end_index]
- for frame_idx in range(frame_end_index + 1, mark_out_index + 1):
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- elif post_behavior in ("loop", "repeat"):
- # Loop backwards from last frame of layer
- for frame_idx in range(frame_end_index + 1, mark_out_index + 1):
- eq_frame_idx = frame_idx % frame_count
- eq_frame_filepath = layer_files_by_frame[eq_frame_idx]
-
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- elif post_behavior == "pingpong":
- half_seq_len = frame_count - 1
- seq_len = half_seq_len * 2
- for frame_idx in range(frame_end_index + 1, mark_out_index + 1):
- eq_frame_idx_offset = (frame_idx - frame_end_index) % seq_len
- if eq_frame_idx_offset > half_seq_len:
- eq_frame_idx_offset = seq_len - eq_frame_idx_offset
- eq_frame_idx = frame_end_index - eq_frame_idx_offset
-
- eq_frame_filepath = layer_files_by_frame[eq_frame_idx]
-
- filename = filename_template.format(
- pos=layer_position,
- frame=frame_idx
- )
- new_filepath = "/".join([output_dir, filename])
- self._copy_image(eq_frame_filepath, new_filepath)
- layer_files_by_frame[frame_idx] = new_filepath
-
- def _composite_files(
- self, files_by_position, frame_start, frame_end,
- filename_template, output_dir
- ):
- """Composite frames when more that one layer was exported.
-
- This method is used when more than one layer is rendered out so and
- output should be composition of each frame of rendered layers.
- Missing frames are filled with transparent images.
- """
- self.log.debug("Preparing files for compisiting.")
- # Prepare paths to images by frames into list where are stored
- # in order of compositing.
- images_by_frame = {}
- for frame_idx in range(frame_start, frame_end + 1):
- images_by_frame[frame_idx] = []
- for position in sorted(files_by_position.keys(), reverse=True):
- position_data = files_by_position[position]
- if frame_idx in position_data:
- filepath = position_data[frame_idx]
- images_by_frame[frame_idx].append(filepath)
-
- output_filepaths = []
- missing_frame_paths = []
- random_frame_path = None
- for frame_idx in sorted(images_by_frame.keys()):
- image_filepaths = images_by_frame[frame_idx]
- output_filename = filename_template.format(frame=frame_idx)
- output_filepath = os.path.join(output_dir, output_filename)
- output_filepaths.append(output_filepath)
-
- # Store information about missing frame and skip
- if not image_filepaths:
- missing_frame_paths.append(output_filepath)
- continue
-
- # Just rename the file if is no need of compositing
- if len(image_filepaths) == 1:
- os.rename(image_filepaths[0], output_filepath)
-
- # Composite images
- else:
- composite_images(image_filepaths, output_filepath)
-
- # Store path of random output image that will 100% exist after all
- # multiprocessing as mockup for missing frames
- if random_frame_path is None:
- random_frame_path = output_filepath
-
- self.log.debug(
- "Creating transparent images for frames without render {}.".format(
- str(missing_frame_paths)
- )
- )
- # Fill the sequence with transparent frames
- transparent_filepath = None
- for filepath in missing_frame_paths:
- if transparent_filepath is None:
- img_obj = Image.open(random_frame_path)
- painter = ImageDraw.Draw(img_obj)
- painter.rectangle((0, 0, *img_obj.size), fill=(0, 0, 0, 0))
- img_obj.save(filepath)
- transparent_filepath = filepath
- else:
- self._copy_image(transparent_filepath, filepath)
- return output_filepaths
-
- def _cleanup_tmp_files(self, files_by_position):
- """Remove temporary files that were used for compositing."""
- for data in files_by_position.values():
- for filepath in data.values():
- if os.path.exists(filepath):
- os.remove(filepath)
-
- def _copy_image(self, src_path, dst_path):
- """Create a copy of an image.
-
- This was added to be able easier change copy method.
- """
- # Create hardlink of image instead of copying if possible
- if hasattr(os, "link"):
- os.link(src_path, dst_path)
- else:
- shutil.copy(src_path, dst_path)
+ return filepaths_by_frame
diff --git a/openpype/hosts/tvpaint/worker/__init__.py b/openpype/hosts/tvpaint/worker/__init__.py
new file mode 100644
index 0000000000..69208a7566
--- /dev/null
+++ b/openpype/hosts/tvpaint/worker/__init__.py
@@ -0,0 +1,21 @@
+from .worker_job import (
+ JobFailed,
+ ExecuteSimpleGeorgeScript,
+ ExecuteGeorgeScript,
+ CollectSceneData,
+ SenderTVPaintCommands,
+ ProcessTVPaintCommands
+)
+
+from .worker import main
+
+__all__ = (
+ "JobFailed",
+ "ExecuteSimpleGeorgeScript",
+ "ExecuteGeorgeScript",
+ "CollectSceneData",
+ "SenderTVPaintCommands",
+ "ProcessTVPaintCommands",
+
+ "main"
+)
diff --git a/openpype/hosts/tvpaint/worker/worker.py b/openpype/hosts/tvpaint/worker/worker.py
new file mode 100644
index 0000000000..738656fa91
--- /dev/null
+++ b/openpype/hosts/tvpaint/worker/worker.py
@@ -0,0 +1,133 @@
+import signal
+import time
+import asyncio
+
+from avalon.tvpaint.communication_server import (
+ BaseCommunicator,
+ CommunicationWrapper
+)
+from openpype_modules.job_queue.job_workers import WorkerJobsConnection
+
+from .worker_job import ProcessTVPaintCommands
+
+
+class TVPaintWorkerCommunicator(BaseCommunicator):
+ """Modified commuicator which cares about processing jobs.
+
+ Received jobs are send to TVPaint by parsing 'ProcessTVPaintCommands'.
+ """
+ def __init__(self, server_url):
+ super().__init__()
+
+ self.return_code = 1
+ self._server_url = server_url
+ self._worker_connection = None
+
+ def _start_webserver(self):
+ """Create connection to workers server before TVPaint server."""
+ loop = self.websocket_server.loop
+ self._worker_connection = WorkerJobsConnection(
+ self._server_url, "tvpaint", loop
+ )
+ asyncio.ensure_future(
+ self._worker_connection.main_loop(register_worker=False),
+ loop=loop
+ )
+
+ super()._start_webserver()
+
+ def _on_client_connect(self, *args, **kwargs):
+ super()._on_client_connect(*args, **kwargs)
+ # Register as "ready to work" worker
+ self._worker_connection.register_as_worker()
+
+ def stop(self):
+ """Stop worker connection and TVPaint server."""
+ self._worker_connection.stop()
+ self.return_code = 0
+ super().stop()
+
+ @property
+ def current_job(self):
+ """Retrieve job which should be processed."""
+ if self._worker_connection:
+ return self._worker_connection.current_job
+ return None
+
+ def _check_process(self):
+ if self.process is None:
+ return True
+
+ if self.process.poll() is not None:
+ asyncio.ensure_future(
+ self._worker_connection.disconnect(),
+ loop=self.websocket_server.loop
+ )
+ self._exit()
+ return False
+ return True
+
+ def _process_job(self):
+ job = self.current_job
+ if job is None:
+ return
+
+ # Prepare variables used for sendig
+ success = False
+ message = "Unknown function"
+ data = None
+ job_data = job["data"]
+ workfile = job_data["workfile"]
+ # Currently can process only "commands" function
+ if job_data.get("function") == "commands":
+ try:
+ commands = ProcessTVPaintCommands(
+ workfile, job_data["commands"], self
+ )
+ commands.execute()
+ data = commands.response_data()
+ success = True
+ message = "Executed"
+
+ except Exception as exc:
+ message = "Error on worker: {}".format(str(exc))
+
+ self._worker_connection.finish_job(success, message, data)
+
+ def main_loop(self):
+ """Main loop where jobs are processed.
+
+ Server is stopped by killing this process or TVPaint process.
+ """
+ while self.server_is_running:
+ if self._check_process():
+ self._process_job()
+ time.sleep(1)
+
+ return self.return_code
+
+
+def _start_tvpaint(tvpaint_executable_path, server_url):
+ communicator = TVPaintWorkerCommunicator(server_url)
+ CommunicationWrapper.set_communicator(communicator)
+ communicator.launch([tvpaint_executable_path])
+
+
+def main(tvpaint_executable_path, server_url):
+ # Register terminal signal handler
+ def signal_handler(*_args):
+ print("Termination signal received. Stopping.")
+ if CommunicationWrapper.communicator is not None:
+ CommunicationWrapper.communicator.stop()
+
+ signal.signal(signal.SIGINT, signal_handler)
+ signal.signal(signal.SIGTERM, signal_handler)
+
+ _start_tvpaint(tvpaint_executable_path, server_url)
+
+ communicator = CommunicationWrapper.communicator
+ if communicator is None:
+ print("Communicator is not set")
+ return 1
+
+ return communicator.main_loop()
diff --git a/openpype/hosts/tvpaint/worker/worker_job.py b/openpype/hosts/tvpaint/worker/worker_job.py
new file mode 100644
index 0000000000..c3893b6f2e
--- /dev/null
+++ b/openpype/hosts/tvpaint/worker/worker_job.py
@@ -0,0 +1,537 @@
+import os
+import tempfile
+import inspect
+import copy
+import json
+import time
+from uuid import uuid4
+from abc import ABCMeta, abstractmethod, abstractproperty
+
+import six
+
+from openpype.api import PypeLogger
+from openpype.modules import ModulesManager
+
+
+TMP_FILE_PREFIX = "opw_tvp_"
+
+
+class JobFailed(Exception):
+ """Raised when job was sent and finished unsuccessfully."""
+ def __init__(self, job_status):
+ job_state = job_status["state"]
+ job_message = job_status["message"] or "Unknown issue"
+ error_msg = (
+ "Job didn't finish properly."
+ " Job state: \"{}\" | Job message: \"{}\""
+ ).format(job_state, job_message)
+
+ self.job_status = job_status
+
+ super().__init__(error_msg)
+
+
+@six.add_metaclass(ABCMeta)
+class BaseCommand:
+ """Abstract TVPaint command which can be executed through worker.
+
+ Each command must have unique name and implemented 'execute' and
+ 'from_existing' methods.
+
+ Command also have id which is created on command creation.
+
+ The idea is that command is just a data container on sender side send
+ througth server to a worker where is replicated one by one, executed and
+ result sent back to sender through server.
+ """
+ @abstractproperty
+ def name(self):
+ """Command name (must be unique)."""
+ pass
+
+ def __init__(self, data=None):
+ if data is None:
+ data = {}
+ else:
+ data = copy.deepcopy(data)
+
+ # Use 'id' from data when replicating on process side
+ command_id = data.get("id")
+ if command_id is None:
+ command_id = str(uuid4())
+ data["id"] = command_id
+ data["command"] = self.name
+
+ self._parent = None
+ self._result = None
+ self._command_data = data
+ self._done = False
+
+ def job_queue_root(self):
+ """Access to job queue root.
+
+ Job queue root is shared access point to files shared across senders
+ and workers.
+ """
+ if self._parent is None:
+ return None
+ return self._parent.job_queue_root()
+
+ def set_parent(self, parent):
+ self._parent = parent
+
+ @property
+ def id(self):
+ """Command id."""
+ return self._command_data["id"]
+
+ @property
+ def parent(self):
+ """Parent of command expected type of 'TVPaintCommands'."""
+ return self._parent
+
+ @property
+ def communicator(self):
+ """TVPaint communicator.
+
+ Available only on worker side.
+ """
+ return self._parent.communicator
+
+ @property
+ def done(self):
+ """Is command done."""
+ return self._done
+
+ def set_done(self):
+ """Change state of done."""
+ self._done = True
+
+ def set_result(self, result):
+ """Set result of executed command."""
+ self._result = result
+
+ def result(self):
+ """Result of command."""
+ return copy.deepcopy(self._result)
+
+ def response_data(self):
+ """Data send as response to sender."""
+ return {
+ "id": self.id,
+ "result": self._result,
+ "done": self._done
+ }
+
+ def command_data(self):
+ """Raw command data."""
+ return copy.deepcopy(self._command_data)
+
+ @abstractmethod
+ def execute(self):
+ """Execute command on worker side."""
+ pass
+
+ @classmethod
+ @abstractmethod
+ def from_existing(cls, data):
+ """Recreate object based on passed data."""
+ pass
+
+ def execute_george(self, george_script):
+ """Execute george script in TVPaint."""
+ return self.parent.execute_george(george_script)
+
+ def execute_george_through_file(self, george_script):
+ """Execute george script through temp file in TVPaint."""
+ return self.parent.execute_george_through_file(george_script)
+
+
+class ExecuteSimpleGeorgeScript(BaseCommand):
+ """Execute simple george script in TVPaint.
+
+ Args:
+ script(str): Script that will be executed.
+ """
+ name = "execute_george_simple"
+
+ def __init__(self, script, data=None):
+ data = data or {}
+ data["script"] = script
+ self._script = script
+ super().__init__(data)
+
+ def execute(self):
+ self._result = self.execute_george(self._script)
+
+ @classmethod
+ def from_existing(cls, data):
+ script = data.pop("script")
+ return cls(script, data)
+
+
+class ExecuteGeorgeScript(BaseCommand):
+ """Execute multiline george script in TVPaint.
+
+ Args:
+ script_lines(list): Lines that will be executed in george script
+ through temp george file.
+ tmp_file_keys(list): List of formatting keys in george script that
+ require replacement with path to a temp file where result will be
+ stored. The content of file is stored to result by the key.
+ root_dir_key(str): Formatting key that will be replaced in george
+ script with job queue root which can be different on worker side.
+ data(dict): Raw data about command.
+ """
+ name = "execute_george_through_file"
+
+ def __init__(
+ self, script_lines, tmp_file_keys=None, root_dir_key=None, data=None
+ ):
+ data = data or {}
+ if not tmp_file_keys:
+ tmp_file_keys = data.get("tmp_file_keys") or []
+
+ data["script_lines"] = script_lines
+ data["tmp_file_keys"] = tmp_file_keys
+ data["root_dir_key"] = root_dir_key
+ self._script_lines = script_lines
+ self._tmp_file_keys = tmp_file_keys
+ self._root_dir_key = root_dir_key
+ super().__init__(data)
+
+ def execute(self):
+ filepath_by_key = {}
+ script = self._script_lines
+ if isinstance(script, list):
+ script = "\n".join(script)
+
+ # Replace temporary files in george script
+ for key in self._tmp_file_keys:
+ output_file = tempfile.NamedTemporaryFile(
+ mode="w", prefix=TMP_FILE_PREFIX, suffix=".txt", delete=False
+ )
+ output_file.close()
+ format_key = "{" + key + "}"
+ output_path = output_file.name.replace("\\", "/")
+ script = script.replace(format_key, output_path)
+ filepath_by_key[key] = output_path
+
+ # Replace job queue root in script
+ if self._root_dir_key:
+ job_queue_root = self.job_queue_root()
+ format_key = "{" + self._root_dir_key + "}"
+ script = script.replace(
+ format_key, job_queue_root.replace("\\", "/")
+ )
+
+ # Execute the script
+ self.execute_george_through_file(script)
+
+ # Store result of temporary files
+ result = {}
+ for key, filepath in filepath_by_key.items():
+ with open(filepath, "r") as stream:
+ data = stream.read()
+ result[key] = data
+ os.remove(filepath)
+
+ self._result = result
+
+ @classmethod
+ def from_existing(cls, data):
+ """Recreate the object from data."""
+ script_lines = data.pop("script_lines")
+ tmp_file_keys = data.pop("tmp_file_keys", None)
+ root_dir_key = data.pop("root_dir_key", None)
+ return cls(script_lines, tmp_file_keys, root_dir_key, data)
+
+
+class CollectSceneData(BaseCommand):
+ """Helper command which will collect all usefull info about workfile.
+
+ Result is dictionary with all layers data, exposure frames by layer ids
+ pre/post behavior of layers by their ids, group information and scene data.
+ """
+ name = "collect_scene_data"
+
+ def execute(self):
+ from avalon.tvpaint.lib import (
+ get_layers_data,
+ get_groups_data,
+ get_layers_pre_post_behavior,
+ get_layers_exposure_frames,
+ get_scene_data
+ )
+
+ groups_data = get_groups_data(communicator=self.communicator)
+ layers_data = get_layers_data(communicator=self.communicator)
+ layer_ids = [
+ layer_data["layer_id"]
+ for layer_data in layers_data
+ ]
+ pre_post_beh_by_layer_id = get_layers_pre_post_behavior(
+ layer_ids, communicator=self.communicator
+ )
+ exposure_frames_by_layer_id = get_layers_exposure_frames(
+ layer_ids, layers_data, communicator=self.communicator
+ )
+
+ self._result = {
+ "layers_data": layers_data,
+ "exposure_frames_by_layer_id": exposure_frames_by_layer_id,
+ "pre_post_beh_by_layer_id": pre_post_beh_by_layer_id,
+ "groups_data": groups_data,
+ "scene_data": get_scene_data(self.communicator)
+ }
+
+ @classmethod
+ def from_existing(cls, data):
+ return cls(data)
+
+
+@six.add_metaclass(ABCMeta)
+class TVPaintCommands:
+ """Wrapper around TVPaint commands to be able send multiple commands.
+
+ Commands may send one or multiple commands at once. Also gives api access
+ for commands info.
+
+ Base for sender and receiver which are extending the logic for their
+ purposes. One of differences is preparation of workfile path.
+
+ Args:
+ workfile(str): Path to workfile.
+ job_queue_module(JobQueueModule): Object of OpenPype module JobQueue.
+ """
+ def __init__(self, workfile, job_queue_module=None):
+ self._log = None
+ self._commands = []
+ self._command_classes_by_name = None
+ if job_queue_module is None:
+ manager = ModulesManager()
+ job_queue_module = manager.modules_by_name["job_queue"]
+ self._job_queue_module = job_queue_module
+
+ self._workfile = self._prepare_workfile(workfile)
+
+ @abstractmethod
+ def _prepare_workfile(self, workfile):
+ """Modification of workfile path on initialization to match platorm."""
+ pass
+
+ def job_queue_root(self):
+ """Job queue root for current platform using current settings."""
+ return self._job_queue_module.get_jobs_root_from_settings()
+
+ @property
+ def log(self):
+ """Access to logger object."""
+ if self._log is None:
+ self._log = PypeLogger.get_logger(self.__class__.__name__)
+ return self._log
+
+ @property
+ def classes_by_name(self):
+ """Prepare commands classes for validation and recreation of commands.
+
+ It is expected that all commands are defined in this python file so
+ we're looking for all implementation of BaseCommand in globals.
+ """
+ if self._command_classes_by_name is None:
+ command_classes_by_name = {}
+ for attr in globals().values():
+ if (
+ not inspect.isclass(attr)
+ or not issubclass(attr, BaseCommand)
+ or attr is BaseCommand
+ ):
+ continue
+
+ if inspect.isabstract(attr):
+ self.log.debug(
+ "Skipping abstract class {}".format(attr.__name__)
+ )
+ command_classes_by_name[attr.name] = attr
+ self._command_classes_by_name = command_classes_by_name
+
+ return self._command_classes_by_name
+
+ def add_command(self, command):
+ """Add command to process."""
+ command.set_parent(self)
+ self._commands.append(command)
+
+ def result(self):
+ """Result of commands in list in which they were processed."""
+ return [
+ command.result()
+ for command in self._commands
+ ]
+
+ def response_data(self):
+ """Data which should be send from worker."""
+ return [
+ command.response_data()
+ for command in self._commands
+ ]
+
+
+class SenderTVPaintCommands(TVPaintCommands):
+ """Sender implementation of TVPaint Commands."""
+ def _prepare_workfile(self, workfile):
+ """Remove job queue root from workfile path.
+
+ It is expected that worker will add it's root before passed workfile.
+ """
+ new_workfile = workfile.replace("\\", "/")
+ job_queue_root = self.job_queue_root().replace("\\", "/")
+ if job_queue_root not in new_workfile:
+ raise ValueError((
+ "Workfile is not located in JobQueue root."
+ " Workfile path: \"{}\". JobQueue root: \"{}\""
+ ).format(workfile, job_queue_root))
+ return new_workfile.replace(job_queue_root, "")
+
+ def commands_data(self):
+ """Commands data to be able recreate them."""
+ return [
+ command.command_data()
+ for command in self._commands
+ ]
+
+ def to_job_data(self):
+ """Convert commands to job data before sending to workers server."""
+ return {
+ "workfile": self._workfile,
+ "function": "commands",
+ "commands": self.commands_data()
+ }
+
+ def set_result(self, result):
+ commands_by_id = {
+ command.id: command
+ for command in self._commands
+ }
+
+ for item in result:
+ command = commands_by_id[item["id"]]
+ command.set_result(item["result"])
+ command.set_done()
+
+ def _send_job(self):
+ """Send job to a workers server."""
+ # Send job data to job queue server
+ job_data = self.to_job_data()
+ self.log.debug("Sending job to JobQueue server.\n{}".format(
+ json.dumps(job_data, indent=4)
+ ))
+ job_id = self._job_queue_module.send_job("tvpaint", job_data)
+ self.log.info((
+ "Job sent to JobQueue server and got id \"{}\"."
+ " Waiting for finishing the job."
+ ).format(job_id))
+
+ return job_id
+
+ def send_job_and_wait(self):
+ """Send job to workers server and wait for response.
+
+ Result of job is stored into the object.
+
+ Raises:
+ JobFailed: When job was finished but not successfully.
+ """
+ job_id = self._send_job()
+ while True:
+ job_status = self._job_queue_module.get_job_status(job_id)
+ if job_status["done"]:
+ break
+ time.sleep(1)
+
+ # Check if job state is done
+ if job_status["state"] != "done":
+ raise JobFailed(job_status)
+
+ self.set_result(job_status["result"])
+
+ self.log.debug("Job is done and result is stored.")
+
+
+class ProcessTVPaintCommands(TVPaintCommands):
+ """Worker side of TVPaint Commands.
+
+ It is expected this object is created only on worker's side from existing
+ data loaded from job.
+
+ Workfile path logic is based on 'SenderTVPaintCommands'.
+ """
+ def __init__(self, workfile, commands, communicator):
+ super(ProcessTVPaintCommands, self).__init__(workfile)
+
+ self._communicator = communicator
+
+ self.commands_from_data(commands)
+
+ def _prepare_workfile(self, workfile):
+ """Preprend job queue root before passed workfile."""
+ workfile = workfile.replace("\\", "/")
+ job_queue_root = self.job_queue_root().replace("\\", "/")
+ new_workfile = "/".join([job_queue_root, workfile])
+ while "//" in new_workfile:
+ new_workfile = new_workfile.replace("//", "/")
+ return os.path.normpath(new_workfile)
+
+ @property
+ def communicator(self):
+ """Access to TVPaint communicator."""
+ return self._communicator
+
+ def commands_from_data(self, commands_data):
+ """Recreate command from passed data."""
+ for command_data in commands_data:
+ command_name = command_data["command"]
+
+ klass = self.classes_by_name[command_name]
+ command = klass.from_existing(command_data)
+ self.add_command(command)
+
+ def execute_george(self, george_script):
+ """Helper method to execute george script."""
+ return self.communicator.execute_george(george_script)
+
+ def execute_george_through_file(self, george_script):
+ """Helper method to execute george script through temp file."""
+ temporary_file = tempfile.NamedTemporaryFile(
+ mode="w", prefix=TMP_FILE_PREFIX, suffix=".grg", delete=False
+ )
+ temporary_file.write(george_script)
+ temporary_file.close()
+ temp_file_path = temporary_file.name.replace("\\", "/")
+ self.execute_george("tv_runscript {}".format(temp_file_path))
+ os.remove(temp_file_path)
+
+ def _open_workfile(self):
+ """Open workfile in TVPaint."""
+ workfile = self._workfile
+ print("Opening workfile {}".format(workfile))
+ george_script = "tv_LoadProject '\"'\"{}\"'\"'".format(workfile)
+ self.execute_george_through_file(george_script)
+
+ def _close_workfile(self):
+ """Close workfile in TVPaint."""
+ print("Closing workfile")
+ self.execute_george_through_file("tv_projectclose")
+
+ def execute(self):
+ """Execute commands."""
+ # First open the workfile
+ self._open_workfile()
+ # Execute commands one by one
+ # TODO maybe stop processing when command fails?
+ print("Commands execution started ({})".format(len(self._commands)))
+ for command in self._commands:
+ command.execute()
+ command.set_done()
+ # Finally close workfile
+ self._close_workfile()
diff --git a/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_instances.py b/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_instances.py
new file mode 100644
index 0000000000..c533403e5f
--- /dev/null
+++ b/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_instances.py
@@ -0,0 +1,255 @@
+"""
+Requires:
+ CollectTVPaintWorkfileData
+
+Provides:
+ Instances
+"""
+import os
+import re
+import copy
+import pyblish.api
+
+from openpype.lib import get_subset_name_with_asset_doc
+
+
+class CollectTVPaintInstances(pyblish.api.ContextPlugin):
+ label = "Collect TVPaint Instances"
+ order = pyblish.api.CollectorOrder + 0.2
+ hosts = ["webpublisher"]
+ targets = ["tvpaint_worker"]
+
+ workfile_family = "workfile"
+ workfile_variant = ""
+ review_family = "review"
+ review_variant = "Main"
+ render_pass_family = "renderPass"
+ render_layer_family = "renderLayer"
+ render_layer_pass_name = "beauty"
+
+ # Set by settings
+ # Regex must constain 'layer' and 'variant' groups which are extracted from
+ # name when instances are created
+ layer_name_regex = r"(?PL[0-9]{3}_\w+)_(?P.+)"
+
+ def process(self, context):
+ # Prepare compiled regex
+ layer_name_regex = re.compile(self.layer_name_regex)
+
+ layers_data = context.data["layersData"]
+
+ host_name = "tvpaint"
+ task_name = context.data.get("task")
+ asset_doc = context.data["assetEntity"]
+ project_doc = context.data["projectEntity"]
+ project_name = project_doc["name"]
+
+ new_instances = []
+
+ # Workfile instance
+ workfile_subset_name = get_subset_name_with_asset_doc(
+ self.workfile_family,
+ self.workfile_variant,
+ task_name,
+ asset_doc,
+ project_name,
+ host_name
+ )
+ workfile_instance = self._create_workfile_instance(
+ context, workfile_subset_name
+ )
+ new_instances.append(workfile_instance)
+
+ # Review instance
+ review_subset_name = get_subset_name_with_asset_doc(
+ self.review_family,
+ self.review_variant,
+ task_name,
+ asset_doc,
+ project_name,
+ host_name
+ )
+ review_instance = self._create_review_instance(
+ context, review_subset_name
+ )
+ new_instances.append(review_instance)
+
+ # Get render layers and passes from TVPaint layers
+ # - it's based on regex extraction
+ layers_by_layer_and_pass = {}
+ for layer in layers_data:
+ # Filter only visible layers
+ if not layer["visible"]:
+ continue
+
+ result = layer_name_regex.search(layer["name"])
+ # Layer name not matching layer name regex
+ # should raise an exception?
+ if result is None:
+ continue
+ render_layer = result.group("layer")
+ render_pass = result.group("pass")
+
+ render_pass_maping = layers_by_layer_and_pass.get(
+ render_layer
+ )
+ if render_pass_maping is None:
+ render_pass_maping = {}
+ layers_by_layer_and_pass[render_layer] = render_pass_maping
+
+ if render_pass not in render_pass_maping:
+ render_pass_maping[render_pass] = []
+ render_pass_maping[render_pass].append(copy.deepcopy(layer))
+
+ layers_by_render_layer = {}
+ for render_layer, render_passes in layers_by_layer_and_pass.items():
+ render_layer_layers = []
+ layers_by_render_layer[render_layer] = render_layer_layers
+ for render_pass, layers in render_passes.items():
+ render_layer_layers.extend(copy.deepcopy(layers))
+ dynamic_data = {
+ "render_pass": render_pass,
+ "render_layer": render_layer,
+ # Override family for subset name
+ "family": "render"
+ }
+
+ subset_name = get_subset_name_with_asset_doc(
+ self.render_pass_family,
+ render_pass,
+ task_name,
+ asset_doc,
+ project_name,
+ host_name,
+ dynamic_data=dynamic_data
+ )
+
+ instance = self._create_render_pass_instance(
+ context, layers, subset_name
+ )
+ new_instances.append(instance)
+
+ for render_layer, layers in layers_by_render_layer.items():
+ variant = render_layer
+ dynamic_data = {
+ "render_pass": self.render_layer_pass_name,
+ "render_layer": render_layer,
+ # Override family for subset name
+ "family": "render"
+ }
+ subset_name = get_subset_name_with_asset_doc(
+ self.render_pass_family,
+ variant,
+ task_name,
+ asset_doc,
+ project_name,
+ host_name,
+ dynamic_data=dynamic_data
+ )
+ instance = self._create_render_layer_instance(
+ context, layers, subset_name
+ )
+ new_instances.append(instance)
+
+ # Set data same for all instances
+ frame_start = context.data.get("frameStart")
+ frame_end = context.data.get("frameEnd")
+
+ for instance in new_instances:
+ if (
+ instance.data.get("frameStart") is None
+ or instance.data.get("frameEnd") is None
+ ):
+ instance.data["frameStart"] = frame_start
+ instance.data["frameEnd"] = frame_end
+
+ if instance.data.get("asset") is None:
+ instance.data["asset"] = asset_doc["name"]
+
+ if instance.data.get("task") is None:
+ instance.data["task"] = task_name
+
+ if "representations" not in instance.data:
+ instance.data["representations"] = []
+
+ if "source" not in instance.data:
+ instance.data["source"] = "webpublisher"
+
+ def _create_workfile_instance(self, context, subset_name):
+ workfile_path = context.data["workfilePath"]
+ staging_dir = os.path.dirname(workfile_path)
+ filename = os.path.basename(workfile_path)
+ ext = os.path.splitext(filename)[-1]
+
+ return context.create_instance(**{
+ "name": subset_name,
+ "label": subset_name,
+ "subset": subset_name,
+ "family": self.workfile_family,
+ "families": [],
+ "stagingDir": staging_dir,
+ "representations": [{
+ "name": ext.lstrip("."),
+ "ext": ext.lstrip("."),
+ "files": filename,
+ "stagingDir": staging_dir
+ }]
+ })
+
+ def _create_review_instance(self, context, subset_name):
+ staging_dir = self._create_staging_dir(context, subset_name)
+ layers_data = context.data["layersData"]
+ # Filter hidden layers
+ filtered_layers_data = [
+ copy.deepcopy(layer)
+ for layer in layers_data
+ if layer["visible"]
+ ]
+ return context.create_instance(**{
+ "name": subset_name,
+ "label": subset_name,
+ "subset": subset_name,
+ "family": self.review_family,
+ "families": [],
+ "layers": filtered_layers_data,
+ "stagingDir": staging_dir
+ })
+
+ def _create_render_pass_instance(self, context, layers, subset_name):
+ staging_dir = self._create_staging_dir(context, subset_name)
+ # Global instance data modifications
+ # Fill families
+ return context.create_instance(**{
+ "name": subset_name,
+ "subset": subset_name,
+ "label": subset_name,
+ "family": self.render_pass_family,
+ # Add `review` family for thumbnail integration
+ "families": [self.render_pass_family, "review"],
+ "representations": [],
+ "layers": layers,
+ "stagingDir": staging_dir
+ })
+
+ def _create_render_layer_instance(self, context, layers, subset_name):
+ staging_dir = self._create_staging_dir(context, subset_name)
+ # Global instance data modifications
+ # Fill families
+ return context.create_instance(**{
+ "name": subset_name,
+ "subset": subset_name,
+ "label": subset_name,
+ "family": self.render_pass_family,
+ # Add `review` family for thumbnail integration
+ "families": [self.render_pass_family, "review"],
+ "representations": [],
+ "layers": layers,
+ "stagingDir": staging_dir
+ })
+
+ def _create_staging_dir(self, context, subset_name):
+ context_staging_dir = context.data["contextStagingDir"]
+ staging_dir = os.path.join(context_staging_dir, subset_name)
+ if not os.path.exists(staging_dir):
+ os.makedirs(staging_dir)
+ return staging_dir
diff --git a/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_workfile_data.py b/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_workfile_data.py
new file mode 100644
index 0000000000..f0f29260a2
--- /dev/null
+++ b/openpype/hosts/webpublisher/plugins/publish/collect_tvpaint_workfile_data.py
@@ -0,0 +1,142 @@
+"""
+Requires:
+ CollectPublishedFiles
+ CollectModules
+
+Provides:
+ workfilePath - Path to tvpaint workfile
+ sceneData - Scene data loaded from the workfile
+ groupsData -
+ layersData
+ layersExposureFrames
+ layersPrePostBehavior
+"""
+import os
+import uuid
+import json
+import shutil
+import pyblish.api
+from openpype.lib.plugin_tools import parse_json
+from openpype.hosts.tvpaint.worker import (
+ SenderTVPaintCommands,
+ CollectSceneData
+)
+
+
+class CollectTVPaintWorkfileData(pyblish.api.ContextPlugin):
+ label = "Collect TVPaint Workfile data"
+ order = pyblish.api.CollectorOrder - 0.4
+ hosts = ["webpublisher"]
+ targets = ["tvpaint_worker"]
+
+ def process(self, context):
+ # Get JobQueue module
+ modules = context.data["openPypeModules"]
+ job_queue_module = modules["job_queue"]
+ jobs_root = job_queue_module.get_jobs_root()
+ if not jobs_root:
+ raise ValueError("Job Queue root is not set.")
+
+ context.data["jobsRoot"] = jobs_root
+
+ context_staging_dir = self._create_context_staging_dir(jobs_root)
+ workfile_path = self._extract_workfile_path(
+ context, context_staging_dir
+ )
+ context.data["contextStagingDir"] = context_staging_dir
+ context.data["workfilePath"] = workfile_path
+
+ # Prepare tvpaint command
+ collect_scene_data_command = CollectSceneData()
+ # Create TVPaint sender commands
+ commands = SenderTVPaintCommands(workfile_path, job_queue_module)
+ commands.add_command(collect_scene_data_command)
+
+ # Send job and wait for answer
+ commands.send_job_and_wait()
+
+ collected_data = collect_scene_data_command.result()
+ layers_data = collected_data["layers_data"]
+ groups_data = collected_data["groups_data"]
+ scene_data = collected_data["scene_data"]
+ exposure_frames_by_layer_id = (
+ collected_data["exposure_frames_by_layer_id"]
+ )
+ pre_post_beh_by_layer_id = (
+ collected_data["pre_post_beh_by_layer_id"]
+ )
+
+ # Store results
+ # scene data store the same way as TVPaint collector
+ scene_data = {
+ "sceneWidth": scene_data["width"],
+ "sceneHeight": scene_data["height"],
+ "scenePixelAspect": scene_data["pixel_aspect"],
+ "sceneFps": scene_data["fps"],
+ "sceneFieldOrder": scene_data["field_order"],
+ "sceneMarkIn": scene_data["mark_in"],
+ # scene_data["mark_in_state"],
+ "sceneMarkInState": scene_data["mark_in_set"],
+ "sceneMarkOut": scene_data["mark_out"],
+ # scene_data["mark_out_state"],
+ "sceneMarkOutState": scene_data["mark_out_set"],
+ "sceneStartFrame": scene_data["start_frame"],
+ "sceneBgColor": scene_data["bg_color"]
+ }
+ context.data["sceneData"] = scene_data
+ # Store only raw data
+ context.data["groupsData"] = groups_data
+ context.data["layersData"] = layers_data
+ context.data["layersExposureFrames"] = exposure_frames_by_layer_id
+ context.data["layersPrePostBehavior"] = pre_post_beh_by_layer_id
+
+ self.log.debug(
+ (
+ "Collected data"
+ "\nScene data: {}"
+ "\nLayers data: {}"
+ "\nExposure frames: {}"
+ "\nPre/Post behavior: {}"
+ ).format(
+ json.dumps(scene_data, indent=4),
+ json.dumps(layers_data, indent=4),
+ json.dumps(exposure_frames_by_layer_id, indent=4),
+ json.dumps(pre_post_beh_by_layer_id, indent=4)
+ )
+ )
+
+ def _create_context_staging_dir(self, jobs_root):
+ if not os.path.exists(jobs_root):
+ os.makedirs(jobs_root)
+
+ random_folder_name = str(uuid.uuid4())
+ full_path = os.path.join(jobs_root, random_folder_name)
+ if not os.path.exists(full_path):
+ os.makedirs(full_path)
+ return full_path
+
+ def _extract_workfile_path(self, context, context_staging_dir):
+ """Find first TVPaint file in tasks and use it."""
+ batch_dir = context.data["batchDir"]
+ batch_data = context.data["batchData"]
+ src_workfile_path = None
+ for task_id in batch_data["tasks"]:
+ if src_workfile_path is not None:
+ break
+ task_dir = os.path.join(batch_dir, task_id)
+ task_manifest_path = os.path.join(task_dir, "manifest.json")
+ task_data = parse_json(task_manifest_path)
+ task_files = task_data["files"]
+ for filename in task_files:
+ _, ext = os.path.splitext(filename)
+ if ext.lower() == ".tvpp":
+ src_workfile_path = os.path.join(task_dir, filename)
+ break
+
+ # Copy workfile to job queue work root
+ new_workfile_path = os.path.join(
+ context_staging_dir, os.path.basename(src_workfile_path)
+ )
+ shutil.copy(src_workfile_path, new_workfile_path)
+
+ return new_workfile_path
diff --git a/openpype/hosts/webpublisher/plugins/publish/extract_tvpaint_workfile.py b/openpype/hosts/webpublisher/plugins/publish/extract_tvpaint_workfile.py
new file mode 100644
index 0000000000..85c8526c83
--- /dev/null
+++ b/openpype/hosts/webpublisher/plugins/publish/extract_tvpaint_workfile.py
@@ -0,0 +1,535 @@
+import os
+import copy
+
+from openpype.hosts.tvpaint.worker import (
+ SenderTVPaintCommands,
+ ExecuteSimpleGeorgeScript,
+ ExecuteGeorgeScript
+)
+
+import pyblish.api
+from openpype.hosts.tvpaint.lib import (
+ calculate_layers_extraction_data,
+ get_frame_filename_template,
+ fill_reference_frames,
+ composite_rendered_layers,
+ rename_filepaths_by_frame_start
+)
+from PIL import Image
+
+
+class ExtractTVPaintSequences(pyblish.api.Extractor):
+ label = "Extract TVPaint Sequences"
+ hosts = ["webpublisher"]
+ targets = ["tvpaint_worker"]
+
+ # Context plugin does not have families filtering
+ families_filter = ["review", "renderPass", "renderLayer"]
+
+ job_queue_root_key = "jobs_root"
+
+ # Modifiable with settings
+ review_bg = [255, 255, 255, 255]
+
+ def process(self, context):
+ # Get workfle path
+ workfile_path = context.data["workfilePath"]
+ jobs_root = context.data["jobsRoot"]
+ jobs_root_slashed = jobs_root.replace("\\", "/")
+
+ # Prepare scene data
+ scene_data = context.data["sceneData"]
+ scene_mark_in = scene_data["sceneMarkIn"]
+ scene_mark_out = scene_data["sceneMarkOut"]
+ scene_start_frame = scene_data["sceneStartFrame"]
+ scene_bg_color = scene_data["sceneBgColor"]
+
+ # Prepare layers behavior
+ behavior_by_layer_id = context.data["layersPrePostBehavior"]
+ exposure_frames_by_layer_id = context.data["layersExposureFrames"]
+
+ # Handles are not stored per instance but on Context
+ handle_start = context.data["handleStart"]
+ handle_end = context.data["handleEnd"]
+
+ # Get JobQueue module
+ modules = context.data["openPypeModules"]
+ job_queue_module = modules["job_queue"]
+
+ tvpaint_commands = SenderTVPaintCommands(
+ workfile_path, job_queue_module
+ )
+
+ # Change scene Start Frame to 0 to prevent frame index issues
+ # - issue is that TVPaint versions deal with frame indexes in a
+ # different way when Start Frame is not `0`
+ # NOTE It will be set back after rendering
+ tvpaint_commands.add_command(
+ ExecuteSimpleGeorgeScript("tv_startframe 0")
+ )
+
+ root_key_replacement = "{" + self.job_queue_root_key + "}"
+ after_render_instances = []
+ for instance in context:
+ instance_families = set(instance.data.get("families", []))
+ instance_families.add(instance.data["family"])
+ valid = False
+ for family in instance_families:
+ if family in self.families_filter:
+ valid = True
+ break
+
+ if not valid:
+ continue
+
+ self.log.info("* Preparing commands for instance \"{}\"".format(
+ instance.data["label"]
+ ))
+ # Get all layers and filter out not visible
+ layers = instance.data["layers"]
+ filtered_layers = [layer for layer in layers if layer["visible"]]
+ if not filtered_layers:
+ self.log.info(
+ "None of the layers from the instance"
+ " are visible. Extraction skipped."
+ )
+ continue
+
+ joined_layer_names = ", ".join([
+ "\"{}\"".format(str(layer["name"]))
+ for layer in filtered_layers
+ ])
+ self.log.debug(
+ "Instance has {} layers with names: {}".format(
+ len(filtered_layers), joined_layer_names
+ )
+ )
+
+ # Staging dir must be created during collection
+ staging_dir = instance.data["stagingDir"].replace("\\", "/")
+
+ job_root_template = staging_dir.replace(
+ jobs_root_slashed, root_key_replacement
+ )
+
+ # Frame start/end may be stored as float
+ frame_start = int(instance.data["frameStart"])
+ frame_end = int(instance.data["frameEnd"])
+
+ # Prepare output frames
+ output_frame_start = frame_start - handle_start
+ output_frame_end = frame_end + handle_end
+
+ # Change output frame start to 0 if handles cause it's negative
+ # number
+ if output_frame_start < 0:
+ self.log.warning((
+ "Frame start with handles has negative value."
+ " Changed to \"0\". Frames start: {}, Handle Start: {}"
+ ).format(frame_start, handle_start))
+ output_frame_start = 0
+
+ # Create copy of scene Mark In/Out
+ mark_in, mark_out = scene_mark_in, scene_mark_out
+
+ # Fix possible changes of output frame
+ mark_out, output_frame_end = self._fix_range_changes(
+ mark_in, mark_out, output_frame_start, output_frame_end
+ )
+ filename_template = get_frame_filename_template(
+ max(scene_mark_out, output_frame_end)
+ )
+
+ # -----------------------------------------------------------------
+ self.log.debug(
+ "Files will be rendered to folder: {}".format(staging_dir)
+ )
+
+ output_filepaths_by_frame_idx = {}
+ for frame_idx in range(mark_in, mark_out + 1):
+ filename = filename_template.format(frame=frame_idx)
+ filepath = os.path.join(staging_dir, filename)
+ output_filepaths_by_frame_idx[frame_idx] = filepath
+
+ # Prepare data for post render processing
+ post_render_data = {
+ "output_dir": staging_dir,
+ "layers": filtered_layers,
+ "output_filepaths_by_frame_idx": output_filepaths_by_frame_idx,
+ "instance": instance,
+ "is_layers_render": False,
+ "output_frame_start": output_frame_start,
+ "output_frame_end": output_frame_end
+ }
+ # Store them to list
+ after_render_instances.append(post_render_data)
+
+ # Review rendering
+ if instance.data["family"] == "review":
+ self.add_render_review_command(
+ tvpaint_commands, mark_in, mark_out, scene_bg_color,
+ job_root_template, filename_template
+ )
+ continue
+
+ # Layers rendering
+ extraction_data_by_layer_id = calculate_layers_extraction_data(
+ filtered_layers,
+ exposure_frames_by_layer_id,
+ behavior_by_layer_id,
+ mark_in,
+ mark_out
+ )
+ filepaths_by_layer_id = self.add_render_command(
+ tvpaint_commands,
+ job_root_template,
+ staging_dir,
+ filtered_layers,
+ extraction_data_by_layer_id
+ )
+ # Add more data to post render processing
+ post_render_data.update({
+ "is_layers_render": True,
+ "extraction_data_by_layer_id": extraction_data_by_layer_id,
+ "filepaths_by_layer_id": filepaths_by_layer_id
+ })
+
+ # Change scene frame Start back to previous value
+ tvpaint_commands.add_command(
+ ExecuteSimpleGeorgeScript(
+ "tv_startframe {}".format(scene_start_frame)
+ )
+ )
+ self.log.info("Sending the job and waiting for response...")
+ tvpaint_commands.send_job_and_wait()
+ self.log.info("Render job finished")
+
+ for post_render_data in after_render_instances:
+ self._post_render_processing(post_render_data, mark_in, mark_out)
+
+ def _fix_range_changes(
+ self, mark_in, mark_out, output_frame_start, output_frame_end
+ ):
+ # Check Marks range and output range
+ output_range = output_frame_end - output_frame_start
+ marks_range = mark_out - mark_in
+
+ # Lower Mark Out if mark range is bigger than output
+ # - do not rendered not used frames
+ if output_range < marks_range:
+ new_mark_out = mark_out - (marks_range - output_range)
+ self.log.warning((
+ "Lowering render range to {} frames. Changed Mark Out {} -> {}"
+ ).format(marks_range + 1, mark_out, new_mark_out))
+ # Assign new mark out to variable
+ mark_out = new_mark_out
+
+ # Lower output frame end so representation has right `frameEnd` value
+ elif output_range > marks_range:
+ new_output_frame_end = (
+ output_frame_end - (output_range - marks_range)
+ )
+ self.log.warning((
+ "Lowering representation range to {} frames."
+ " Changed frame end {} -> {}"
+ ).format(output_range + 1, mark_out, new_output_frame_end))
+ output_frame_end = new_output_frame_end
+ return mark_out, output_frame_end
+
+ def _post_render_processing(self, post_render_data, mark_in, mark_out):
+ # Unpack values
+ instance = post_render_data["instance"]
+ output_filepaths_by_frame_idx = (
+ post_render_data["output_filepaths_by_frame_idx"]
+ )
+ is_layers_render = post_render_data["is_layers_render"]
+ output_dir = post_render_data["output_dir"]
+ layers = post_render_data["layers"]
+ output_frame_start = post_render_data["output_frame_start"]
+ output_frame_end = post_render_data["output_frame_end"]
+
+ # Trigger post processing of layers rendering
+ # - only few frames were rendered this will complete the sequence
+ # - multiple layers can be in single instance they must be composite
+ # over each other
+ if is_layers_render:
+ self._finish_layer_render(
+ layers,
+ post_render_data["extraction_data_by_layer_id"],
+ post_render_data["filepaths_by_layer_id"],
+ mark_in,
+ mark_out,
+ output_filepaths_by_frame_idx
+ )
+
+ # Create thumbnail
+ thumbnail_filepath = os.path.join(output_dir, "thumbnail.jpg")
+ thumbnail_src_path = output_filepaths_by_frame_idx[mark_in]
+ self._create_thumbnail(thumbnail_src_path, thumbnail_filepath)
+
+ # Rename filepaths to final frames
+ repre_files = self._rename_output_files(
+ output_filepaths_by_frame_idx,
+ mark_in,
+ mark_out,
+ output_frame_start
+ )
+
+ # Fill tags and new families
+ family_lowered = instance.data["family"].lower()
+ tags = []
+ if family_lowered in ("review", "renderlayer"):
+ tags.append("review")
+
+ # Sequence of one frame
+ single_file = len(repre_files) == 1
+ if single_file:
+ repre_files = repre_files[0]
+
+ # Extension is harcoded
+ # - changing extension would require change code
+ new_repre = {
+ "name": "png",
+ "ext": "png",
+ "files": repre_files,
+ "stagingDir": output_dir,
+ "tags": tags
+ }
+
+ if not single_file:
+ new_repre["frameStart"] = output_frame_start
+ new_repre["frameEnd"] = output_frame_end
+
+ self.log.debug("Creating new representation: {}".format(new_repre))
+
+ instance.data["representations"].append(new_repre)
+
+ if family_lowered in ("renderpass", "renderlayer"):
+ # Change family to render
+ instance.data["family"] = "render"
+
+ thumbnail_ext = os.path.splitext(thumbnail_filepath)[1]
+ # Create thumbnail representation
+ thumbnail_repre = {
+ "name": "thumbnail",
+ "ext": thumbnail_ext.replace(".", ""),
+ "outputName": "thumb",
+ "files": os.path.basename(thumbnail_filepath),
+ "stagingDir": output_dir,
+ "tags": ["thumbnail"]
+ }
+ instance.data["representations"].append(thumbnail_repre)
+
+ def _rename_output_files(
+ self, filepaths_by_frame, mark_in, mark_out, output_frame_start
+ ):
+ new_filepaths_by_frame = rename_filepaths_by_frame_start(
+ filepaths_by_frame, mark_in, mark_out, output_frame_start
+ )
+
+ repre_filenames = []
+ for filepath in new_filepaths_by_frame.values():
+ repre_filenames.append(os.path.basename(filepath))
+
+ if mark_in < output_frame_start:
+ repre_filenames = list(reversed(repre_filenames))
+
+ return repre_filenames
+
+ def add_render_review_command(
+ self,
+ tvpaint_commands,
+ mark_in,
+ mark_out,
+ scene_bg_color,
+ job_root_template,
+ filename_template
+ ):
+ """ Export images from TVPaint using `tv_savesequence` command.
+
+ Args:
+ output_dir (str): Directory where files will be stored.
+ mark_in (int): Starting frame index from which export will begin.
+ mark_out (int): On which frame index export will end.
+ scene_bg_color (list): Bg color set in scene. Result of george
+ script command `tv_background`.
+ """
+ self.log.debug("Preparing data for rendering.")
+ bg_color = self._get_review_bg_color()
+ first_frame_filepath = "/".join([
+ job_root_template,
+ filename_template.format(frame=mark_in)
+ ])
+
+ george_script_lines = [
+ # Change bg color to color from settings
+ "tv_background \"color\" {} {} {}".format(*bg_color),
+ "tv_SaveMode \"PNG\"",
+ "export_path = \"{}\"".format(
+ first_frame_filepath.replace("\\", "/")
+ ),
+ "tv_savesequence '\"'export_path'\"' {} {}".format(
+ mark_in, mark_out
+ )
+ ]
+ if scene_bg_color:
+ # Change bg color back to previous scene bg color
+ _scene_bg_color = copy.deepcopy(scene_bg_color)
+ bg_type = _scene_bg_color.pop(0)
+ orig_color_command = [
+ "tv_background",
+ "\"{}\"".format(bg_type)
+ ]
+ orig_color_command.extend(_scene_bg_color)
+
+ george_script_lines.append(" ".join(orig_color_command))
+
+ tvpaint_commands.add_command(
+ ExecuteGeorgeScript(
+ george_script_lines,
+ root_dir_key=self.job_queue_root_key
+ )
+ )
+
+ def add_render_command(
+ self,
+ tvpaint_commands,
+ job_root_template,
+ staging_dir,
+ layers,
+ extraction_data_by_layer_id
+ ):
+ """ Export images from TVPaint.
+
+ Args:
+ output_dir (str): Directory where files will be stored.
+ mark_in (int): Starting frame index from which export will begin.
+ mark_out (int): On which frame index export will end.
+ layers (list): List of layers to be exported.
+
+ Retruns:
+ tuple: With 2 items first is list of filenames second is path to
+ thumbnail.
+ """
+ # Map layers by position
+ layers_by_id = {
+ layer["layer_id"]: layer
+ for layer in layers
+ }
+
+ # Render layers
+ filepaths_by_layer_id = {}
+ for layer_id, render_data in extraction_data_by_layer_id.items():
+ layer = layers_by_id[layer_id]
+ frame_references = render_data["frame_references"]
+ filenames_by_frame_index = render_data["filenames_by_frame_index"]
+
+ filepaths_by_frame = {}
+ command_filepath_by_frame = {}
+ for frame_idx, ref_idx in frame_references.items():
+ # None reference is skipped because does not have source
+ if ref_idx is None:
+ filepaths_by_frame[frame_idx] = None
+ continue
+ filename = filenames_by_frame_index[frame_idx]
+
+ filepaths_by_frame[frame_idx] = os.path.join(
+ staging_dir, filename
+ )
+ if frame_idx == ref_idx:
+ command_filepath_by_frame[frame_idx] = "/".join(
+ [job_root_template, filename]
+ )
+
+ self._add_render_layer_command(
+ tvpaint_commands, layer, command_filepath_by_frame
+ )
+ filepaths_by_layer_id[layer_id] = filepaths_by_frame
+
+ return filepaths_by_layer_id
+
+ def _add_render_layer_command(
+ self, tvpaint_commands, layer, filepaths_by_frame
+ ):
+ george_script_lines = [
+ # Set current layer by position
+ "tv_layergetid {}".format(layer["position"]),
+ "layer_id = result",
+ "tv_layerset layer_id",
+ "tv_SaveMode \"PNG\""
+ ]
+
+ for frame_idx, filepath in filepaths_by_frame.items():
+ if filepath is None:
+ continue
+
+ # Go to frame
+ george_script_lines.append("tv_layerImage {}".format(frame_idx))
+ # Store image to output
+ george_script_lines.append(
+ "tv_saveimage \"{}\"".format(filepath.replace("\\", "/"))
+ )
+
+ tvpaint_commands.add_command(
+ ExecuteGeorgeScript(
+ george_script_lines,
+ root_dir_key=self.job_queue_root_key
+ )
+ )
+
+ def _finish_layer_render(
+ self,
+ layers,
+ extraction_data_by_layer_id,
+ filepaths_by_layer_id,
+ mark_in,
+ mark_out,
+ output_filepaths_by_frame_idx
+ ):
+ # Fill frames between `frame_start_index` and `frame_end_index`
+ self.log.debug("Filling frames not rendered frames.")
+ for layer_id, render_data in extraction_data_by_layer_id.items():
+ frame_references = render_data["frame_references"]
+ filepaths_by_frame = filepaths_by_layer_id[layer_id]
+ fill_reference_frames(frame_references, filepaths_by_frame)
+
+ # Prepare final filepaths where compositing should store result
+ self.log.info("Started compositing of layer frames.")
+ composite_rendered_layers(
+ layers, filepaths_by_layer_id,
+ mark_in, mark_out,
+ output_filepaths_by_frame_idx
+ )
+
+ def _create_thumbnail(self, thumbnail_src_path, thumbnail_filepath):
+ if not os.path.exists(thumbnail_src_path):
+ return
+
+ source_img = Image.open(thumbnail_src_path)
+
+ # Composite background only on rgba images
+ # - just making sure
+ if source_img.mode.lower() == "rgba":
+ bg_color = self._get_review_bg_color()
+ self.log.debug("Adding thumbnail background color {}.".format(
+ " ".join([str(val) for val in bg_color])
+ ))
+ bg_image = Image.new("RGBA", source_img.size, bg_color)
+ thumbnail_obj = Image.alpha_composite(bg_image, source_img)
+ thumbnail_obj.convert("RGB").save(thumbnail_filepath)
+
+ else:
+ self.log.info((
+ "Source for thumbnail has mode \"{}\" (Expected: RGBA)."
+ " Can't use thubmanail background color."
+ ).format(source_img.mode))
+ source_img.save(thumbnail_filepath)
+
+ def _get_review_bg_color(self):
+ red = green = blue = 255
+ if self.review_bg:
+ if len(self.review_bg) == 4:
+ red, green, blue, _ = self.review_bg
+ elif len(self.review_bg) == 3:
+ red, green, blue = self.review_bg
+ return (red, green, blue)
diff --git a/openpype/hosts/webpublisher/plugins/publish/others_cleanup_job_root.py b/openpype/hosts/webpublisher/plugins/publish/others_cleanup_job_root.py
new file mode 100644
index 0000000000..fc5cd1ea9a
--- /dev/null
+++ b/openpype/hosts/webpublisher/plugins/publish/others_cleanup_job_root.py
@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+"""Cleanup leftover files from publish."""
+import os
+import shutil
+import pyblish.api
+
+
+class CleanUpJobRoot(pyblish.api.ContextPlugin):
+ """Cleans up the job root directory after a successful publish.
+
+ Remove all files in job root as all of them should be published.
+ """
+
+ order = pyblish.api.IntegratorOrder + 1
+ label = "Clean Up Job Root"
+ optional = True
+ active = True
+
+ def process(self, context):
+ context_staging_dir = context.data.get("contextStagingDir")
+ if not context_staging_dir:
+ self.log.info("Key 'contextStagingDir' is empty.")
+
+ elif not os.path.exists(context_staging_dir):
+ self.log.info((
+ "Job root directory for this publish does not"
+ " exists anymore \"{}\"."
+ ).format(context_staging_dir))
+ else:
+ self.log.info("Deleting job root with all files.")
+ shutil.rmtree(context_staging_dir)
diff --git a/openpype/hosts/webpublisher/plugins/publish/validate_tvpaint_workfile_data.py b/openpype/hosts/webpublisher/plugins/publish/validate_tvpaint_workfile_data.py
new file mode 100644
index 0000000000..eec6ef1004
--- /dev/null
+++ b/openpype/hosts/webpublisher/plugins/publish/validate_tvpaint_workfile_data.py
@@ -0,0 +1,35 @@
+import pyblish.api
+
+
+class ValidateWorkfileData(pyblish.api.ContextPlugin):
+ """Validate mark in and out are enabled and it's duration.
+
+ Mark In/Out does not have to match frameStart and frameEnd but duration is
+ important.
+ """
+
+ label = "Validate Workfile Data"
+ order = pyblish.api.ValidatorOrder
+
+ def process(self, context):
+ # Data collected in `CollectAvalonEntities`
+ frame_start = context.data["frameStart"]
+ frame_end = context.data["frameEnd"]
+ handle_start = context.data["handleStart"]
+ handle_end = context.data["handleEnd"]
+
+ scene_data = context.data["sceneData"]
+ scene_mark_in = scene_data["sceneMarkIn"]
+ scene_mark_out = scene_data["sceneMarkOut"]
+
+ expected_range = (
+ (frame_end - frame_start + 1)
+ + handle_start
+ + handle_end
+ )
+ marks_range = scene_mark_out - scene_mark_in + 1
+ if expected_range != marks_range:
+ raise AssertionError((
+ "Wrong Mark In/Out range."
+ " Expected range is {} frames got {} frames"
+ ).format(expected_range, marks_range))
diff --git a/openpype/hosts/webpublisher/webserver_service/webpublish_routes.py b/openpype/hosts/webpublisher/webserver_service/webpublish_routes.py
index d474c96ff9..30399a6ba7 100644
--- a/openpype/hosts/webpublisher/webserver_service/webpublish_routes.py
+++ b/openpype/hosts/webpublisher/webserver_service/webpublish_routes.py
@@ -198,6 +198,15 @@ class WebpublisherBatchPublishEndpoint(_RestApiEndpoint):
# - filter defines command and can extend arguments dictionary
# This is used only if 'studio_processing' is enabled on batch
studio_processing_filters = [
+ # TVPaint filter
+ {
+ "extensions": [".tvpp"],
+ "command": "remotepublish",
+ "arguments": {
+ "targets": ["tvpaint_worker"]
+ },
+ "add_to_queue": False
+ },
# Photoshop filter
{
"extensions": [".psd", ".psb"],
diff --git a/openpype/lib/anatomy.py b/openpype/lib/anatomy.py
index 7a4a55363c..aaf10479fd 100644
--- a/openpype/lib/anatomy.py
+++ b/openpype/lib/anatomy.py
@@ -989,6 +989,14 @@ class Templates:
invalid_required = []
missing_required = []
replace_keys = []
+
+ task_data = data.get("task")
+ if (
+ isinstance(task_data, StringType)
+ and "{task[name]}" in orig_template
+ ):
+ data["task"] = {"name": task_data}
+
for group in self.key_pattern.findall(template):
orig_key = group[1:-1]
key = str(orig_key)
@@ -1074,6 +1082,10 @@ class Templates:
output = collections.defaultdict(dict)
for key, orig_value in templates.items():
if isinstance(orig_value, StringType):
+ # Replace {task} by '{task[name]}' for backward compatibility
+ if '{task}' in orig_value:
+ orig_value = orig_value.replace('{task}', '{task[name]}')
+
output[key] = self._format(orig_value, data)
continue
diff --git a/openpype/lib/applications.py b/openpype/lib/applications.py
index b9bcecd3a0..30be92e886 100644
--- a/openpype/lib/applications.py
+++ b/openpype/lib/applications.py
@@ -1280,23 +1280,12 @@ def prepare_context_environments(data):
anatomy = data["anatomy"]
- asset_tasks = asset_doc.get("data", {}).get("tasks") or {}
- task_info = asset_tasks.get(task_name) or {}
- task_type = task_info.get("type")
+ task_type = workdir_data["task"]["type"]
# Temp solution how to pass task type to `_prepare_last_workfile`
data["task_type"] = task_type
- workfile_template_key = get_workfile_template_key(
- task_type,
- app.host_name,
- project_name=project_name,
- project_settings=project_settings
- )
-
try:
- workdir = get_workdir_with_workdir_data(
- workdir_data, anatomy, template_key=workfile_template_key
- )
+ workdir = get_workdir_with_workdir_data(workdir_data, anatomy)
except Exception as exc:
raise ApplicationLaunchFailed(
@@ -1329,10 +1318,10 @@ def prepare_context_environments(data):
)
data["env"].update(context_env)
- _prepare_last_workfile(data, workdir, workfile_template_key)
+ _prepare_last_workfile(data, workdir)
-def _prepare_last_workfile(data, workdir, workfile_template_key):
+def _prepare_last_workfile(data, workdir):
"""last workfile workflow preparation.
Function check if should care about last workfile workflow and tries
@@ -1395,6 +1384,10 @@ def _prepare_last_workfile(data, workdir, workfile_template_key):
anatomy = data["anatomy"]
# Find last workfile
file_template = anatomy.templates["work"]["file"]
+ # Replace {task} by '{task[name]}' for backward compatibility
+ if '{task}' in file_template:
+ file_template = file_template.replace('{task}', '{task[name]}')
+
workdir_data.update({
"version": 1,
"user": get_openpype_username(),
diff --git a/openpype/lib/avalon_context.py b/openpype/lib/avalon_context.py
index b043cbfdb4..3e0e0c6ea6 100644
--- a/openpype/lib/avalon_context.py
+++ b/openpype/lib/avalon_context.py
@@ -7,6 +7,7 @@ import platform
import logging
import collections
import functools
+import getpass
from openpype.settings import get_project_settings
from .anatomy import Anatomy
@@ -257,19 +258,40 @@ def get_hierarchy(asset_name=None):
return "/".join(hierarchy_items)
-@with_avalon
-def get_linked_assets(asset_entity):
- """Return linked assets for `asset_entity` from DB
+def get_linked_asset_ids(asset_doc):
+ """Return linked asset ids for `asset_doc` from DB
- Args:
- asset_entity (dict): asset document from DB
+ Args:
+ asset_doc (dict): Asset document from DB.
- Returns:
- (list) of MongoDB documents
+ Returns:
+ (list): MongoDB ids of input links.
"""
- inputs = asset_entity["data"].get("inputs", [])
- inputs = [avalon.io.find_one({"_id": x}) for x in inputs]
- return inputs
+ output = []
+ if not asset_doc:
+ return output
+
+ input_links = asset_doc["data"].get("inputsLinks") or []
+ if input_links:
+ output = [item["_id"] for item in input_links]
+ return output
+
+
+@with_avalon
+def get_linked_assets(asset_doc):
+ """Return linked assets for `asset_doc` from DB
+
+ Args:
+ asset_doc (dict): Asset document from DB
+
+ Returns:
+ (list) Asset documents of input links for passed asset doc.
+ """
+ link_ids = get_linked_asset_ids(asset_doc)
+ if not link_ids:
+ return []
+
+ return list(avalon.io.find({"_id": {"$in": link_ids}}))
@with_avalon
@@ -464,6 +486,7 @@ def get_workfile_template_key(
return default
+# TODO rename function as is not just "work" specific
def get_workdir_data(project_doc, asset_doc, task_name, host_name):
"""Prepare data for workdir template filling from entered information.
@@ -479,22 +502,31 @@ def get_workdir_data(project_doc, asset_doc, task_name, host_name):
"""
hierarchy = "/".join(asset_doc["data"]["parents"])
+ task_type = asset_doc['data']['tasks'].get(task_name, {}).get('type')
+
+ project_task_types = project_doc["config"]["tasks"]
+ task_code = project_task_types.get(task_type, {}).get("short_name")
+
data = {
"project": {
"name": project_doc["name"],
"code": project_doc["data"].get("code")
},
- "task": task_name,
+ "task": {
+ "name": task_name,
+ "type": task_type,
+ "short": task_code,
+ },
"asset": asset_doc["name"],
"app": host_name,
- "hierarchy": hierarchy
+ "user": getpass.getuser(),
+ "hierarchy": hierarchy,
}
return data
def get_workdir_with_workdir_data(
- workdir_data, anatomy=None, project_name=None,
- template_key=None, dbcon=None
+ workdir_data, anatomy=None, project_name=None, template_key=None
):
"""Fill workdir path from entered data and project's anatomy.
@@ -529,12 +561,10 @@ def get_workdir_with_workdir_data(
anatomy = Anatomy(project_name)
if not template_key:
- template_key = get_workfile_template_key_from_context(
- workdir_data["asset"],
- workdir_data["task"],
+ template_key = get_workfile_template_key(
+ workdir_data["task"]["type"],
workdir_data["app"],
- project_name=workdir_data["project"]["name"],
- dbcon=dbcon
+ project_name=workdir_data["project"]["name"]
)
anatomy_filled = anatomy.format(workdir_data)
@@ -648,7 +678,7 @@ def create_workfile_doc(asset_doc, task_name, filename, workdir, dbcon=None):
anatomy = Anatomy(project_doc["name"])
# Get workdir path (result is anatomy.TemplateResult)
template_workdir = get_workdir_with_workdir_data(
- workdir_data, anatomy, dbcon=dbcon
+ workdir_data, anatomy
)
template_workdir_path = str(template_workdir).replace("\\", "/")
diff --git a/openpype/lib/execute.py b/openpype/lib/execute.py
index a1111fba29..ad77b2f899 100644
--- a/openpype/lib/execute.py
+++ b/openpype/lib/execute.py
@@ -124,7 +124,7 @@ def run_subprocess(*args, **kwargs):
if full_output:
full_output += "\n"
full_output += _stderr
- logger.warning(_stderr)
+ logger.info(_stderr)
if proc.returncode != 0:
exc_msg = "Executing arguments was not successful: \"{}\"".format(args)
diff --git a/openpype/lib/plugin_tools.py b/openpype/lib/plugin_tools.py
index aa9e0c9b57..891163e3ae 100644
--- a/openpype/lib/plugin_tools.py
+++ b/openpype/lib/plugin_tools.py
@@ -531,12 +531,20 @@ def should_decompress(file_url):
and we can decompress (oiiotool supported)
"""
if oiio_supported():
- output = run_subprocess([
- get_oiio_tools_path(),
- "--info", "-v", file_url])
- return "compression: \"dwaa\"" in output or \
- "compression: \"dwab\"" in output
-
+ try:
+ output = run_subprocess([
+ get_oiio_tools_path(),
+ "--info", "-v", file_url])
+ return "compression: \"dwaa\"" in output or \
+ "compression: \"dwab\"" in output
+ except RuntimeError:
+ _name, ext = os.path.splitext(file_url)
+ # TODO: should't the list of allowed extensions be
+ # taken from an OIIO variable of supported formats
+ if ext not in [".mxf"]:
+ # Reraise exception
+ raise
+ return False
return False
diff --git a/openpype/lib/vendor_bin_utils.py b/openpype/lib/vendor_bin_utils.py
index a8c75c20da..42f2b34bb2 100644
--- a/openpype/lib/vendor_bin_utils.py
+++ b/openpype/lib/vendor_bin_utils.py
@@ -71,18 +71,24 @@ def ffprobe_streams(path_to_file, logger=None):
"Getting information about input \"{}\".".format(path_to_file)
)
args = [
- "\"{}\"".format(get_ffmpeg_tool_path("ffprobe")),
- "-v quiet",
- "-print_format json",
+ get_ffmpeg_tool_path("ffprobe"),
+ "-hide_banner",
+ "-loglevel", "fatal",
+ "-show_error",
"-show_format",
"-show_streams",
- "\"{}\"".format(path_to_file)
+ "-show_programs",
+ "-show_chapters",
+ "-show_private_data",
+ "-print_format", "json",
+ path_to_file
]
- command = " ".join(args)
- logger.debug("FFprobe command: \"{}\"".format(command))
+
+ logger.debug("FFprobe command: {}".format(
+ subprocess.list2cmdline(args)
+ ))
popen = subprocess.Popen(
- command,
- shell=True,
+ args,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
)
diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py b/openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py
index 2d43b0d085..e6c42374ca 100644
--- a/openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py
+++ b/openpype/modules/default_modules/deadline/plugins/publish/submit_maya_deadline.py
@@ -288,6 +288,22 @@ class MayaSubmitDeadline(pyblish.api.InstancePlugin):
"pluginInfo", {})
)
+ self.limit_groups = (
+ context.data["project_settings"].get(
+ "deadline", {}).get(
+ "publish", {}).get(
+ "MayaSubmitDeadline", {}).get(
+ "limit", [])
+ )
+
+ self.group = (
+ context.data["project_settings"].get(
+ "deadline", {}).get(
+ "publish", {}).get(
+ "MayaSubmitDeadline", {}).get(
+ "group", "none")
+ )
+
context = instance.context
workspace = context.data["workspaceDir"]
anatomy = context.data['anatomy']
diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py
index 4cba35963c..a064a0aa86 100644
--- a/openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py
+++ b/openpype/modules/default_modules/deadline/plugins/publish/submit_nuke_deadline.py
@@ -94,24 +94,27 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin):
render_path).replace("\\", "/")
instance.data["publishJobState"] = "Suspended"
- if instance.data.get("bakeScriptPath"):
- render_path = instance.data.get("bakeRenderPath")
- script_path = instance.data.get("bakeScriptPath")
- exe_node_name = instance.data.get("bakeWriteNodeName")
+ if instance.data.get("bakingNukeScripts"):
+ for baking_script in instance.data["bakingNukeScripts"]:
+ render_path = baking_script["bakeRenderPath"]
+ script_path = baking_script["bakeScriptPath"]
+ exe_node_name = baking_script["bakeWriteNodeName"]
- # exception for slate workflow
- if "slate" in instance.data["families"]:
- self._frame_start += 1
+ # exception for slate workflow
+ if "slate" in instance.data["families"]:
+ self._frame_start += 1
- resp = self.payload_submit(instance,
- script_path,
- render_path,
- exe_node_name,
- response.json()
- )
- # Store output dir for unified publisher (filesequence)
- instance.data["deadlineSubmissionJob"] = resp.json()
- instance.data["publishJobState"] = "Suspended"
+ resp = self.payload_submit(
+ instance,
+ script_path,
+ render_path,
+ exe_node_name,
+ response.json()
+ )
+
+ # Store output dir for unified publisher (filesequence)
+ instance.data["deadlineSubmissionJob"] = resp.json()
+ instance.data["publishJobState"] = "Suspended"
# redefinition of families
if "render.farm" in families:
diff --git a/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py
index 6b07749819..7f7cedf4e7 100644
--- a/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py
+++ b/openpype/modules/default_modules/deadline/plugins/publish/submit_publish_job.py
@@ -104,7 +104,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
families = ["render.farm", "prerender.farm",
"renderlayer", "imagesequence", "vrayscene"]
- aov_filter = {"maya": [r".*(?:\.|_)*([Bb]eauty)(?:\.|_)*.*"],
+ aov_filter = {"maya": [r".*(?:[\._-])*([Bb]eauty)(?:[\.|_])*.*"],
"aftereffects": [r".*"], # for everything from AE
"harmony": [r".*"], # for everything from AE
"celaction": [r".*"]}
@@ -142,8 +142,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
instance_transfer = {
"slate": ["slateFrame"],
"review": ["lutPath"],
- "render2d": ["bakeScriptPath", "bakeRenderPath",
- "bakeWriteNodeName", "version"],
+ "render2d": ["bakingNukeScripts", "version"],
"renderlayer": ["convertToScanline"]
}
@@ -231,7 +230,8 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
args = [
'publish',
roothless_metadata_path,
- "--targets {}".format("deadline")
+ "--targets", "deadline",
+ "--targets", "filesequence"
]
# Generate the payload for Deadline submission
@@ -505,9 +505,9 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
"""
representations = []
collections, remainders = clique.assemble(exp_files)
- bake_render_path = instance.get("bakeRenderPath", [])
+ bake_renders = instance.get("bakingNukeScripts", [])
- # create representation for every collected sequence
+ # create representation for every collected sequento ce
for collection in collections:
ext = collection.tail.lstrip(".")
preview = False
@@ -523,7 +523,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
preview = True
break
- if bake_render_path:
+ if bake_renders:
preview = False
staging = os.path.dirname(list(collection)[0])
@@ -595,7 +595,8 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
})
self._solve_families(instance, True)
- if remainder in bake_render_path:
+ if (bake_renders
+ and remainder in bake_renders[0]["bakeRenderPath"]):
rep.update({
"fps": instance.get("fps"),
"tags": ["review", "delete"]
diff --git a/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_links.py b/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_links.py
new file mode 100644
index 0000000000..8c3d858a96
--- /dev/null
+++ b/openpype/modules/default_modules/ftrack/event_handlers_server/event_sync_links.py
@@ -0,0 +1,147 @@
+from pymongo import UpdateOne
+from bson.objectid import ObjectId
+
+from avalon.api import AvalonMongoDB
+
+from openpype_modules.ftrack.lib import (
+ CUST_ATTR_ID_KEY,
+ query_custom_attributes,
+
+ BaseEvent
+)
+
+
+class SyncLinksToAvalon(BaseEvent):
+ """Synchronize inpug linkts to avalon documents."""
+ # Run after sync to avalon event handler
+ priority = 110
+
+ def __init__(self, session):
+ self.dbcon = AvalonMongoDB()
+
+ super(SyncLinksToAvalon, self).__init__(session)
+
+ def launch(self, session, event):
+ # Try to commit and if any error happen then recreate session
+ entities_info = event["data"]["entities"]
+ dependency_changes = []
+ removed_entities = set()
+ for entity_info in entities_info:
+ action = entity_info.get("action")
+ entityType = entity_info.get("entityType")
+ if action not in ("remove", "add"):
+ continue
+
+ if entityType == "task":
+ removed_entities.add(entity_info["entityId"])
+ elif entityType == "dependency":
+ dependency_changes.append(entity_info)
+
+ # Care only about dependency changes
+ if not dependency_changes:
+ return
+
+ project_id = None
+ for entity_info in dependency_changes:
+ for parent_info in entity_info["parents"]:
+ if parent_info["entityType"] == "show":
+ project_id = parent_info["entityId"]
+ if project_id is not None:
+ break
+
+ changed_to_ids = set()
+ for entity_info in dependency_changes:
+ to_id_change = entity_info["changes"]["to_id"]
+ if to_id_change["new"] is not None:
+ changed_to_ids.add(to_id_change["new"])
+
+ if to_id_change["old"] is not None:
+ changed_to_ids.add(to_id_change["old"])
+
+ self._update_in_links(session, changed_to_ids, project_id)
+
+ def _update_in_links(self, session, ftrack_ids, project_id):
+ if not ftrack_ids or project_id is None:
+ return
+
+ attr_def = session.query((
+ "select id from CustomAttributeConfiguration where key is \"{}\""
+ ).format(CUST_ATTR_ID_KEY)).first()
+ if attr_def is None:
+ return
+
+ project_entity = session.query((
+ "select full_name from Project where id is \"{}\""
+ ).format(project_id)).first()
+ if not project_entity:
+ return
+
+ project_name = project_entity["full_name"]
+ mongo_id_by_ftrack_id = self._get_mongo_ids_by_ftrack_ids(
+ session, attr_def["id"], ftrack_ids
+ )
+
+ filtered_ftrack_ids = tuple(mongo_id_by_ftrack_id.keys())
+ context_links = session.query((
+ "select from_id, to_id from TypedContextLink where to_id in ({})"
+ ).format(self.join_query_keys(filtered_ftrack_ids))).all()
+
+ mapping_by_to_id = {
+ ftrack_id: set()
+ for ftrack_id in filtered_ftrack_ids
+ }
+ all_from_ids = set()
+ for context_link in context_links:
+ to_id = context_link["to_id"]
+ from_id = context_link["from_id"]
+ if from_id == to_id:
+ continue
+ all_from_ids.add(from_id)
+ mapping_by_to_id[to_id].add(from_id)
+
+ mongo_id_by_ftrack_id.update(self._get_mongo_ids_by_ftrack_ids(
+ session, attr_def["id"], all_from_ids
+ ))
+ self.log.info(mongo_id_by_ftrack_id)
+ bulk_writes = []
+ for to_id, from_ids in mapping_by_to_id.items():
+ dst_mongo_id = mongo_id_by_ftrack_id[to_id]
+ links = []
+ for ftrack_id in from_ids:
+ link_mongo_id = mongo_id_by_ftrack_id.get(ftrack_id)
+ if link_mongo_id is None:
+ continue
+
+ links.append({
+ "_id": ObjectId(link_mongo_id),
+ "linkedBy": "ftrack",
+ "type": "breakdown"
+ })
+
+ bulk_writes.append(UpdateOne(
+ {"_id": ObjectId(dst_mongo_id)},
+ {"$set": {"data.inputLinks": links}}
+ ))
+
+ if bulk_writes:
+ self.dbcon.database[project_name].bulk_write(bulk_writes)
+
+ def _get_mongo_ids_by_ftrack_ids(self, session, attr_id, ftrack_ids):
+ output = query_custom_attributes(
+ session, [attr_id], ftrack_ids
+ )
+ mongo_id_by_ftrack_id = {}
+ for item in output:
+ mongo_id = item["value"]
+ if not mongo_id:
+ continue
+
+ ftrack_id = item["entity_id"]
+
+ mongo_id_by_ftrack_id[ftrack_id] = mongo_id
+ return mongo_id_by_ftrack_id
+
+
+def register(session):
+ '''Register plugin. Called when used as an plugin.'''
+ SyncLinksToAvalon(session).register()
diff --git a/openpype/modules/default_modules/ftrack/lib/avalon_sync.py b/openpype/modules/default_modules/ftrack/lib/avalon_sync.py
index 1667031f29..9e22f80b1c 100644
--- a/openpype/modules/default_modules/ftrack/lib/avalon_sync.py
+++ b/openpype/modules/default_modules/ftrack/lib/avalon_sync.py
@@ -22,7 +22,7 @@ from .custom_attributes import get_openpype_attr
from bson.objectid import ObjectId
from bson.errors import InvalidId
-from pymongo import UpdateOne
+from pymongo import UpdateOne, ReplaceOne
import ftrack_api
log = Logger.get_logger(__name__)
@@ -328,7 +328,7 @@ class SyncEntitiesFactory:
server_url=self._server_url,
api_key=self._api_key,
api_user=self._api_user,
- auto_connect_event_hub=True
+ auto_connect_event_hub=False
)
self.duplicates = {}
@@ -341,6 +341,7 @@ class SyncEntitiesFactory:
}
self.create_list = []
+ self.unarchive_list = []
self.updates = collections.defaultdict(dict)
self.avalon_project = None
@@ -1169,16 +1170,43 @@ class SyncEntitiesFactory:
entity
)
+ def _get_input_links(self, ftrack_ids):
+ tupled_ids = tuple(ftrack_ids)
+ mapping_by_to_id = {
+ ftrack_id: set()
+ for ftrack_id in tupled_ids
+ }
+ ids_len = len(tupled_ids)
+ chunk_size = int(5000 / ids_len)
+ all_links = []
+ for idx in range(0, ids_len, chunk_size):
+ entity_ids_joined = join_query_keys(
+ tupled_ids[idx:idx + chunk_size]
+ )
+
+ all_links.extend(self.session.query((
+ "select from_id, to_id from"
+ " TypedContextLink where to_id in ({})"
+ ).format(entity_ids_joined)).all())
+
+ for context_link in all_links:
+ to_id = context_link["to_id"]
+ from_id = context_link["from_id"]
+ if from_id == to_id:
+ continue
+ mapping_by_to_id[to_id].add(from_id)
+ return mapping_by_to_id
+
def prepare_ftrack_ent_data(self):
not_set_ids = []
- for id, entity_dict in self.entities_dict.items():
+ for ftrack_id, entity_dict in self.entities_dict.items():
entity = entity_dict["entity"]
if entity is None:
- not_set_ids.append(id)
+ not_set_ids.append(ftrack_id)
continue
- self.entities_dict[id]["final_entity"] = {}
- self.entities_dict[id]["final_entity"]["name"] = (
+ self.entities_dict[ftrack_id]["final_entity"] = {}
+ self.entities_dict[ftrack_id]["final_entity"]["name"] = (
entity_dict["name"]
)
data = {}
@@ -1191,58 +1219,59 @@ class SyncEntitiesFactory:
for key, val in entity_dict.get("hier_attrs", []).items():
data[key] = val
- if id == self.ft_project_id:
- project_name = entity["full_name"]
- data["code"] = entity["name"]
- self.entities_dict[id]["final_entity"]["data"] = data
- self.entities_dict[id]["final_entity"]["type"] = "project"
+ if ftrack_id != self.ft_project_id:
+ ent_path_items = [ent["name"] for ent in entity["link"]]
+ parents = ent_path_items[1:len(ent_path_items) - 1:]
- proj_schema = entity["project_schema"]
- task_types = proj_schema["_task_type_schema"]["types"]
- proj_apps, warnings = get_project_apps(
- data.pop("applications", [])
- )
- for msg, items in warnings.items():
- if not msg or not items:
- continue
- self.report_items["warning"][msg] = items
-
- current_project_anatomy_data = get_anatomy_settings(
- project_name, exclude_locals=True
- )
- anatomy_tasks = current_project_anatomy_data["tasks"]
- tasks = {}
- default_type_data = {
- "short_name": ""
- }
- for task_type in task_types:
- task_type_name = task_type["name"]
- tasks[task_type_name] = copy.deepcopy(
- anatomy_tasks.get(task_type_name)
- or default_type_data
- )
-
- project_config = {
- "tasks": tasks,
- "apps": proj_apps
- }
- for key, value in current_project_anatomy_data.items():
- if key in project_config or key == "attributes":
- continue
- project_config[key] = value
-
- self.entities_dict[id]["final_entity"]["config"] = (
- project_config
- )
+ data["parents"] = parents
+ data["tasks"] = self.entities_dict[ftrack_id].pop("tasks", {})
+ self.entities_dict[ftrack_id]["final_entity"]["data"] = data
+ self.entities_dict[ftrack_id]["final_entity"]["type"] = "asset"
continue
+ project_name = entity["full_name"]
+ data["code"] = entity["name"]
+ self.entities_dict[ftrack_id]["final_entity"]["data"] = data
+ self.entities_dict[ftrack_id]["final_entity"]["type"] = (
+ "project"
+ )
- ent_path_items = [ent["name"] for ent in entity["link"]]
- parents = ent_path_items[1:len(ent_path_items) - 1:]
+ proj_schema = entity["project_schema"]
+ task_types = proj_schema["_task_type_schema"]["types"]
+ proj_apps, warnings = get_project_apps(
+ data.pop("applications", [])
+ )
+ for msg, items in warnings.items():
+ if not msg or not items:
+ continue
+ self.report_items["warning"][msg] = items
- data["parents"] = parents
- data["tasks"] = self.entities_dict[id].pop("tasks", {})
- self.entities_dict[id]["final_entity"]["data"] = data
- self.entities_dict[id]["final_entity"]["type"] = "asset"
+ current_project_anatomy_data = get_anatomy_settings(
+ project_name, exclude_locals=True
+ )
+ anatomy_tasks = current_project_anatomy_data["tasks"]
+ tasks = {}
+ default_type_data = {
+ "short_name": ""
+ }
+ for task_type in task_types:
+ task_type_name = task_type["name"]
+ tasks[task_type_name] = copy.deepcopy(
+ anatomy_tasks.get(task_type_name)
+ or default_type_data
+ )
+
+ project_config = {
+ "tasks": tasks,
+ "apps": proj_apps
+ }
+ for key, value in current_project_anatomy_data.items():
+ if key in project_config or key == "attributes":
+ continue
+ project_config[key] = value
+
+ self.entities_dict[ftrack_id]["final_entity"]["config"] = (
+ project_config
+ )
if not_set_ids:
self.log.debug((
@@ -1433,6 +1462,28 @@ class SyncEntitiesFactory:
for child_id in entity_dict["children"]:
children_queue.append(child_id)
+ def set_input_links(self):
+ ftrack_ids = set(self.create_ftrack_ids) | set(self.update_ftrack_ids)
+
+ input_links_by_ftrack_id = self._get_input_links(ftrack_ids)
+
+ for ftrack_id in ftrack_ids:
+ input_links = []
+ final_entity = self.entities_dict[ftrack_id]["final_entity"]
+ final_entity["data"]["inputLinks"] = input_links
+ link_ids = input_links_by_ftrack_id[ftrack_id]
+ if not link_ids:
+ continue
+
+ for ftrack_link_id in link_ids:
+ mongo_id = self.ftrack_avalon_mapper.get(ftrack_link_id)
+ if mongo_id is not None:
+ input_links.append({
+ "_id": ObjectId(mongo_id),
+ "linkedBy": "ftrack",
+ "type": "breakdown"
+ })
+
def prepare_changes(self):
self.log.debug("* Preparing changes for avalon/ftrack")
hierarchy_changing_ids = []
@@ -1806,9 +1857,28 @@ class SyncEntitiesFactory:
for ftrack_id in self.create_ftrack_ids:
# CHECK it is possible that entity was already created
# because is parent of another entity which was processed first
- if ftrack_id in self.ftrack_avalon_mapper:
- continue
- self.create_avalon_entity(ftrack_id)
+ if ftrack_id not in self.ftrack_avalon_mapper:
+ self.create_avalon_entity(ftrack_id)
+
+ self.set_input_links()
+
+ unarchive_writes = []
+ for item in self.unarchive_list:
+ mongo_id = item["_id"]
+ unarchive_writes.append(ReplaceOne(
+ {"_id": mongo_id},
+ item
+ ))
+ av_ent_path_items = item["data"]["parents"]
+ av_ent_path_items.append(item["name"])
+ av_ent_path = "/".join(av_ent_path_items)
+ self.log.debug(
+ "Entity was unarchived <{}>".format(av_ent_path)
+ )
+ self.remove_from_archived(mongo_id)
+
+ if unarchive_writes:
+ self.dbcon.bulk_write(unarchive_writes)
if len(self.create_list) > 0:
self.dbcon.insert_many(self.create_list)
@@ -1899,14 +1969,8 @@ class SyncEntitiesFactory:
if unarchive is False:
self.create_list.append(item)
- return
- # If unarchive then replace entity data in database
- self.dbcon.replace_one({"_id": new_id}, item)
- self.remove_from_archived(mongo_id)
- av_ent_path_items = item["data"]["parents"]
- av_ent_path_items.append(item["name"])
- av_ent_path = "/".join(av_ent_path_items)
- self.log.debug("Entity was unarchived <{}>".format(av_ent_path))
+ else:
+ self.unarchive_list.append(item)
def check_unarchivation(self, ftrack_id, mongo_id, name):
archived_by_id = self.avalon_archived_by_id.get(mongo_id)
diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py b/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py
index a5187dd52b..7ea1c1f323 100644
--- a/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py
+++ b/openpype/modules/default_modules/ftrack/plugins/publish/collect_username.py
@@ -27,7 +27,7 @@ class CollectUsername(pyblish.api.ContextPlugin):
order = pyblish.api.CollectorOrder - 0.488
label = "Collect ftrack username"
hosts = ["webpublisher", "photoshop"]
- targets = ["remotepublish", "filespublish"]
+ targets = ["remotepublish", "filespublish", "tvpaint_worker"]
_context = None
diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py b/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py
index 93a07a9fae..8399e19184 100644
--- a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py
+++ b/openpype/modules/default_modules/ftrack/plugins/publish/integrate_ftrack_instances.py
@@ -1,208 +1,266 @@
-import pyblish.api
-import json
import os
+import json
+import copy
+import pyblish.api
class IntegrateFtrackInstance(pyblish.api.InstancePlugin):
- """Collect ftrack component data
+ """Collect ftrack component data (not integrate yet).
Add ftrack component list to instance.
-
-
"""
order = pyblish.api.IntegratorOrder + 0.48
- label = 'Integrate Ftrack Component'
+ label = "Integrate Ftrack Component"
families = ["ftrack"]
- family_mapping = {'camera': 'cam',
- 'look': 'look',
- 'mayaascii': 'scene',
- 'model': 'geo',
- 'rig': 'rig',
- 'setdress': 'setdress',
- 'pointcache': 'cache',
- 'render': 'render',
- 'render2d': 'render',
- 'nukescript': 'comp',
- 'write': 'render',
- 'review': 'mov',
- 'plate': 'img',
- 'audio': 'audio',
- 'workfile': 'scene',
- 'animation': 'cache',
- 'image': 'img',
- 'reference': 'reference'
- }
+ family_mapping = {
+ "camera": "cam",
+ "look": "look",
+ "mayaascii": "scene",
+ "model": "geo",
+ "rig": "rig",
+ "setdress": "setdress",
+ "pointcache": "cache",
+ "render": "render",
+ "render2d": "render",
+ "nukescript": "comp",
+ "write": "render",
+ "review": "mov",
+ "plate": "img",
+ "audio": "audio",
+ "workfile": "scene",
+ "animation": "cache",
+ "image": "img",
+ "reference": "reference"
+ }
def process(self, instance):
- self.ftrack_locations = {}
- self.log.debug('instance {}'.format(instance))
+ self.log.debug("instance {}".format(instance))
- if instance.data.get('version'):
- version_number = int(instance.data.get('version'))
- else:
+ instance_version = instance.data.get("version")
+ if instance_version is None:
raise ValueError("Instance version not set")
- family = instance.data['family'].lower()
+ version_number = int(instance_version)
+
+ family = instance.data["family"]
+ family_low = instance.data["family"].lower()
asset_type = instance.data.get("ftrackFamily")
- if not asset_type and family in self.family_mapping:
- asset_type = self.family_mapping[family]
+ if not asset_type and family_low in self.family_mapping:
+ asset_type = self.family_mapping[family_low]
# Ignore this instance if neither "ftrackFamily" or a family mapping is
# found.
if not asset_type:
+ self.log.info((
+ "Family \"{}\" does not match any asset type mapping"
+ ).format(family))
return
- componentList = []
+ instance_repres = instance.data.get("representations")
+ if not instance_repres:
+ self.log.info((
+ "Skipping instance. Does not have any representations {}"
+ ).format(str(instance)))
+ return
+
+ # Prepare FPS
+ instance_fps = instance.data.get("fps")
+ if instance_fps is None:
+ instance_fps = instance.context.data["fps"]
+
+ # Base of component item data
+ # - create a copy of this object when want to use it
+ base_component_item = {
+ "assettype_data": {
+ "short": asset_type,
+ },
+ "asset_data": {
+ "name": instance.data["subset"],
+ },
+ "assetversion_data": {
+ "version": version_number,
+ "comment": instance.context.data.get("comment") or ""
+ },
+ "component_overwrite": False,
+ # This can be change optionally
+ "thumbnail": False,
+ # These must be changed for each component
+ "component_data": None,
+ "component_path": None,
+ "component_location": None
+ }
+
ft_session = instance.context.data["ftrackSession"]
- for comp in instance.data['representations']:
- self.log.debug('component {}'.format(comp))
+ # Filter types of representations
+ review_representations = []
+ thumbnail_representations = []
+ other_representations = []
+ for repre in instance_repres:
+ self.log.debug("Representation {}".format(repre))
+ repre_tags = repre.get("tags") or []
+ if repre.get("thumbnail") or "thumbnail" in repre_tags:
+ thumbnail_representations.append(repre)
- if comp.get('thumbnail') or ("thumbnail" in comp.get('tags', [])):
- location = self.get_ftrack_location(
- 'ftrack.server', ft_session
- )
- component_data = {
- "name": "thumbnail" # Default component name is "main".
- }
- comp['thumbnail'] = True
- comp_files = comp["files"]
+ elif "ftrackreview" in repre_tags:
+ review_representations.append(repre)
+
+ else:
+ other_representations.append(repre)
+
+ # Prepare ftrack locations
+ unmanaged_location = ft_session.query(
+ "Location where name is \"ftrack.unmanaged\""
+ ).one()
+ ftrack_server_location = ft_session.query(
+ "Location where name is \"ftrack.server\""
+ ).one()
+
+ # Components data
+ component_list = []
+ # Components that will be duplicated to unmanaged location
+ src_components_to_add = []
+
+ # Create thumbnail components
+ # TODO what if there is multiple thumbnails?
+ first_thumbnail_component = None
+ for repre in thumbnail_representations:
+ published_path = repre.get("published_path")
+ if not published_path:
+ comp_files = repre["files"]
if isinstance(comp_files, (tuple, list, set)):
filename = comp_files[0]
else:
filename = comp_files
- comp['published_path'] = os.path.join(
- comp['stagingDir'], filename
- )
-
- elif comp.get('ftrackreview') or ("ftrackreview" in comp.get('tags', [])):
- '''
- Ftrack bug requirement:
- - Start frame must be 0
- - End frame must be {duration}
- EXAMPLE: When mov has 55 frames:
- - Start frame should be 0
- - End frame should be 55 (do not ask why please!)
- '''
- start_frame = 0
- end_frame = 1
- if 'frameEndFtrack' in comp and 'frameStartFtrack' in comp:
- end_frame += (
- comp['frameEndFtrack'] - comp['frameStartFtrack']
- )
- else:
- end_frame += (
- instance.data["frameEnd"] - instance.data["frameStart"]
- )
-
- fps = comp.get('fps')
- if fps is None:
- fps = instance.data.get(
- "fps", instance.context.data['fps']
- )
-
- comp['fps'] = fps
-
- location = self.get_ftrack_location(
- 'ftrack.server', ft_session
+ published_path = os.path.join(
+ repre["stagingDir"], filename
)
- component_data = {
- # Default component name is "main".
- "name": "ftrackreview-mp4",
- "metadata": {'ftr_meta': json.dumps({
- 'frameIn': int(start_frame),
- 'frameOut': int(end_frame),
- 'frameRate': float(comp['fps'])})}
- }
- comp['thumbnail'] = False
- else:
- component_data = {
- "name": comp['name']
- }
- location = self.get_ftrack_location(
- 'ftrack.unmanaged', ft_session
- )
- comp['thumbnail'] = False
+ if not os.path.exists(published_path):
+ continue
+ repre["published_path"] = published_path
- self.log.debug('location {}'.format(location))
-
- component_item = {
- "assettype_data": {
- "short": asset_type,
- },
- "asset_data": {
- "name": instance.data["subset"],
- },
- "assetversion_data": {
- "version": version_number,
- "comment": instance.context.data.get("comment", "")
- },
- "component_data": component_data,
- "component_path": comp['published_path'],
- 'component_location': location,
- "component_overwrite": False,
- "thumbnail": comp['thumbnail']
+ # Create copy of base comp item and append it
+ thumbnail_item = copy.deepcopy(base_component_item)
+ thumbnail_item["component_path"] = repre["published_path"]
+ thumbnail_item["component_data"] = {
+ "name": "thumbnail"
}
+ thumbnail_item["thumbnail"] = True
+ # Create copy of item before setting location
+ src_components_to_add.append(copy.deepcopy(thumbnail_item))
+ # Create copy of first thumbnail
+ if first_thumbnail_component is None:
+ first_thumbnail_component = copy.deepcopy(thumbnail_item)
+ # Set location
+ thumbnail_item["component_location"] = ftrack_server_location
+ # Add item to component list
+ component_list.append(thumbnail_item)
- # Add custom attributes for AssetVersion
- assetversion_cust_attrs = {}
- intent_val = instance.context.data.get("intent")
- if intent_val and isinstance(intent_val, dict):
- intent_val = intent_val.get("value")
+ # Create review components
+ # Change asset name of each new component for review
+ is_first_review_repre = True
+ not_first_components = []
+ for repre in review_representations:
+ frame_start = repre.get("frameStartFtrack")
+ frame_end = repre.get("frameEndFtrack")
+ if frame_start is None or frame_end is None:
+ frame_start = instance.data["frameStart"]
+ frame_end = instance.data["frameEnd"]
- if intent_val:
- assetversion_cust_attrs["intent"] = intent_val
+ # Frame end of uploaded video file should be duration in frames
+ # - frame start is always 0
+ # - frame end is duration in frames
+ duration = frame_end - frame_start + 1
- component_item["assetversion_data"]["custom_attributes"] = (
- assetversion_cust_attrs
- )
+ fps = repre.get("fps")
+ if fps is None:
+ fps = instance_fps
- componentList.append(component_item)
- # Create copy with ftrack.unmanaged location if thumb or prev
- if comp.get('thumbnail') or comp.get('preview') \
- or ("preview" in comp.get('tags', [])) \
- or ("review" in comp.get('tags', [])) \
- or ("thumbnail" in comp.get('tags', [])):
- unmanaged_loc = self.get_ftrack_location(
- 'ftrack.unmanaged', ft_session
- )
-
- component_data_src = component_data.copy()
- name = component_data['name'] + '_src'
- component_data_src['name'] = name
-
- component_item_src = {
- "assettype_data": {
- "short": asset_type,
- },
- "asset_data": {
- "name": instance.data["subset"],
- },
- "assetversion_data": {
- "version": version_number,
- },
- "component_data": component_data_src,
- "component_path": comp['published_path'],
- 'component_location': unmanaged_loc,
- "component_overwrite": False,
- "thumbnail": False
+ # Create copy of base comp item and append it
+ review_item = copy.deepcopy(base_component_item)
+ # Change location
+ review_item["component_path"] = repre["published_path"]
+ # Change component data
+ review_item["component_data"] = {
+ # Default component name is "main".
+ "name": "ftrackreview-mp4",
+ "metadata": {
+ "ftr_meta": json.dumps({
+ "frameIn": 0,
+ "frameOut": int(duration),
+ "frameRate": float(fps)
+ })
}
+ }
+ # Create copy of item before setting location or changing asset
+ src_components_to_add.append(copy.deepcopy(review_item))
+ if is_first_review_repre:
+ is_first_review_repre = False
+ else:
+ # Add representation name to asset name of "not first" review
+ asset_name = review_item["asset_data"]["name"]
+ review_item["asset_data"]["name"] = "_".join(
+ (asset_name, repre["name"])
+ )
+ not_first_components.append(review_item)
- componentList.append(component_item_src)
+ # Set location
+ review_item["component_location"] = ftrack_server_location
+ # Add item to component list
+ component_list.append(review_item)
- self.log.debug('componentsList: {}'.format(str(componentList)))
- instance.data["ftrackComponentsList"] = componentList
+ # Duplicate thumbnail component for all not first reviews
+ if first_thumbnail_component is not None:
+ for component_item in not_first_components:
+ asset_name = component_item["asset_data"]["name"]
+ new_thumbnail_component = copy.deepcopy(
+ first_thumbnail_component
+ )
+ new_thumbnail_component["asset_data"]["name"] = asset_name
+ new_thumbnail_component["component_location"] = (
+ ftrack_server_location
+ )
+ component_list.append(new_thumbnail_component)
- def get_ftrack_location(self, name, session):
- if name in self.ftrack_locations:
- return self.ftrack_locations[name]
+ # Add source components for review and thubmnail components
+ for copy_src_item in src_components_to_add:
+ # Make sure thumbnail is disabled
+ copy_src_item["thumbnail"] = False
+ # Set location
+ copy_src_item["component_location"] = unmanaged_location
+ # Modify name of component to have suffix "_src"
+ component_data = copy_src_item["component_data"]
+ component_name = component_data["name"]
+ component_data["name"] = component_name + "_src"
+ component_list.append(copy_src_item)
- location = session.query(
- 'Location where name is "{}"'.format(name)
- ).one()
- self.ftrack_locations[name] = location
- return location
+ # Add others representations as component
+ for repre in other_representations:
+ published_path = repre.get("published_path")
+ if not published_path:
+ continue
+ # Create copy of base comp item and append it
+ other_item = copy.deepcopy(base_component_item)
+ other_item["component_data"] = {
+ "name": repre["name"]
+ }
+ other_item["component_location"] = unmanaged_location
+ other_item["component_path"] = published_path
+ component_list.append(other_item)
+
+ def json_obj_parser(obj):
+ return str(obj)
+
+ self.log.debug("Components list: {}".format(
+ json.dumps(
+ component_list,
+ sort_keys=True,
+ indent=4,
+ default=json_obj_parser
+ )
+ ))
+ instance.data["ftrackComponentsList"] = component_list
diff --git a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_remove_components.py b/openpype/modules/default_modules/ftrack/plugins/publish/integrate_remove_components.py
deleted file mode 100644
index 26cac0f1ae..0000000000
--- a/openpype/modules/default_modules/ftrack/plugins/publish/integrate_remove_components.py
+++ /dev/null
@@ -1,30 +0,0 @@
-import pyblish.api
-import os
-
-
-class IntegrateCleanComponentData(pyblish.api.InstancePlugin):
- """
- Cleaning up thumbnail an mov files after they have been integrated
- """
-
- order = pyblish.api.IntegratorOrder + 0.5
- label = 'Clean component data'
- families = ["ftrack"]
- optional = True
- active = False
-
- def process(self, instance):
-
- for comp in instance.data['representations']:
- self.log.debug('component {}'.format(comp))
-
- if "%" in comp['published_path'] or "#" in comp['published_path']:
- continue
-
- if comp.get('thumbnail') or ("thumbnail" in comp.get('tags', [])):
- os.remove(comp['published_path'])
- self.log.info('Thumbnail image was erased')
-
- elif comp.get('preview') or ("preview" in comp.get('tags', [])):
- os.remove(comp['published_path'])
- self.log.info('Preview mov file was erased')
diff --git a/openpype/modules/default_modules/job_queue/__init__.py b/openpype/modules/default_modules/job_queue/__init__.py
new file mode 100644
index 0000000000..6f2cec1b97
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/__init__.py
@@ -0,0 +1,6 @@
+from .module import JobQueueModule
+
+
+__all__ = (
+ "JobQueueModule",
+)
diff --git a/openpype/modules/default_modules/job_queue/job_server/__init__.py b/openpype/modules/default_modules/job_queue/job_server/__init__.py
new file mode 100644
index 0000000000..c73d830257
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/__init__.py
@@ -0,0 +1,8 @@
+from .server import WebServerManager
+from .utils import main
+
+
+__all__ = (
+ "WebServerManager",
+ "main"
+)
diff --git a/openpype/modules/default_modules/job_queue/job_server/job_queue_route.py b/openpype/modules/default_modules/job_queue/job_server/job_queue_route.py
new file mode 100644
index 0000000000..8929e64dc5
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/job_queue_route.py
@@ -0,0 +1,62 @@
+import json
+
+from aiohttp.web_response import Response
+
+
+class JobQueueResource:
+ def __init__(self, job_queue, server_manager):
+ self.server_manager = server_manager
+
+ self._prefix = "/api"
+
+ self._job_queue = job_queue
+
+ self.endpoint_defs = (
+ ("POST", "/jobs", self.post_job),
+ ("GET", "/jobs", self.get_jobs),
+ ("GET", "/jobs/{job_id}", self.get_job)
+ )
+
+ self.register()
+
+ def register(self):
+ for methods, url, callback in self.endpoint_defs:
+ final_url = self._prefix + url
+ self.server_manager.add_route(
+ methods, final_url, callback
+ )
+
+ async def get_jobs(self, request):
+ jobs_data = []
+ for job in self._job_queue.get_jobs():
+ jobs_data.append(job.status())
+ return Response(status=200, body=self.encode(jobs_data))
+
+ async def post_job(self, request):
+ data = await request.json()
+ host_name = data.get("host_name")
+ if not host_name:
+ return Response(
+ status=400, message="Key \"host_name\" not filled."
+ )
+
+ job = self._job_queue.create_job(host_name, data)
+ return Response(status=201, text=job.id)
+
+ async def get_job(self, request):
+ job_id = request.match_info["job_id"]
+ content = self._job_queue.get_job_status(job_id)
+ if content is None:
+ content = {}
+ return Response(
+ status=200,
+ body=self.encode(content),
+ content_type="application/json"
+ )
+
+ @classmethod
+ def encode(cls, data):
+ return json.dumps(
+ data,
+ indent=4
+ ).encode("utf-8")
diff --git a/openpype/modules/default_modules/job_queue/job_server/jobs.py b/openpype/modules/default_modules/job_queue/job_server/jobs.py
new file mode 100644
index 0000000000..0fc3c381d4
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/jobs.py
@@ -0,0 +1,240 @@
+import datetime
+import collections
+from uuid import uuid4
+
+
+class Job:
+ """Job related to specific host name.
+
+ Data must contain everything needed to finish the job.
+ """
+ # Remove done jobs each n days to clear memory
+ keep_in_memory_days = 3
+
+ def __init__(self, host_name, data, job_id=None, created_time=None):
+ if job_id is None:
+ job_id = str(uuid4())
+ self._id = job_id
+ if created_time is None:
+ created_time = datetime.datetime.now()
+ self._created_time = created_time
+ self._started_time = None
+ self._done_time = None
+ self.host_name = host_name
+ self.data = data
+ self._result_data = None
+
+ self._started = False
+ self._done = False
+ self._errored = False
+ self._message = None
+ self._deleted = False
+
+ self._worker = None
+
+ def keep_in_memory(self):
+ if self._done_time is None:
+ return True
+
+ now = datetime.datetime.now()
+ delta = now - self._done_time
+ return delta.days < self.keep_in_memory_days
+
+ @property
+ def id(self):
+ return self._id
+
+ @property
+ def done(self):
+ return self._done
+
+ def reset(self):
+ self._started = False
+ self._started_time = None
+ self._done = False
+ self._done_time = None
+ self._errored = False
+ self._message = None
+
+ self._worker = None
+
+ @property
+ def started(self):
+ return self._started
+
+ @property
+ def deleted(self):
+ return self._deleted
+
+ def set_deleted(self):
+ self._deleted = True
+ self.set_worker(None)
+
+ def set_worker(self, worker):
+ if worker is self._worker:
+ return
+
+ if self._worker is not None:
+ self._worker.set_current_job(None)
+
+ self._worker = worker
+ if worker is not None:
+ worker.set_current_job(self)
+
+ def set_started(self):
+ self._started_time = datetime.datetime.now()
+ self._started = True
+
+ def set_done(self, success=True, message=None, data=None):
+ self._done = True
+ self._done_time = datetime.datetime.now()
+ self._errored = not success
+ self._message = message
+ self._result_data = data
+ if self._worker is not None:
+ self._worker.set_current_job(None)
+
+ def status(self):
+ worker_id = None
+ if self._worker is not None:
+ worker_id = self._worker.id
+ output = {
+ "id": self.id,
+ "worker_id": worker_id,
+ "done": self._done
+ }
+ output["message"] = self._message or None
+
+ state = "waiting"
+ if self._deleted:
+ state = "deleted"
+ elif self._errored:
+ state = "error"
+ elif self._done:
+ state = "done"
+ elif self._started:
+ state = "started"
+
+ output["result"] = self._result_data
+
+ output["state"] = state
+
+ return output
+
+
+class JobQueue:
+ """Queue holds jobs that should be done and workers that can do them.
+
+ Also asign jobs to a worker.
+ """
+ old_jobs_check_minutes_interval = 30
+
+ def __init__(self):
+ self._last_old_jobs_check = datetime.datetime.now()
+ self._jobs_by_id = {}
+ self._job_queue_by_host_name = collections.defaultdict(
+ collections.deque
+ )
+ self._workers_by_id = {}
+ self._workers_by_host_name = collections.defaultdict(list)
+
+ def workers(self):
+ """All currently registered workers."""
+ return self._workers_by_id.values()
+
+ def add_worker(self, worker):
+ host_name = worker.host_name
+ print("Added new worker for \"{}\"".format(host_name))
+ self._workers_by_id[worker.id] = worker
+ self._workers_by_host_name[host_name].append(worker)
+
+ def get_worker(self, worker_id):
+ return self._workers_by_id.get(worker_id)
+
+ def remove_worker(self, worker):
+ # Look if worker had assigned job to do
+ job = worker.current_job
+ if job is not None and not job.done:
+ # Reset job
+ job.set_worker(None)
+ job.reset()
+ # Add job back to queue
+ self._job_queue_by_host_name[job.host_name].appendleft(job)
+
+ # Remove worker from registered workers
+ self._workers_by_id.pop(worker.id, None)
+ host_name = worker.host_name
+ if worker in self._workers_by_host_name[host_name]:
+ self._workers_by_host_name[host_name].remove(worker)
+
+ print("Removed worker for \"{}\"".format(host_name))
+
+ def assign_jobs(self):
+ """Try to assign job for each idle worker.
+
+ Error all jobs without needed worker.
+ """
+ available_host_names = set()
+ for worker in self._workers_by_id.values():
+ host_name = worker.host_name
+ available_host_names.add(host_name)
+ if worker.is_idle():
+ jobs = self._job_queue_by_host_name[host_name]
+ while jobs:
+ job = jobs.popleft()
+ if not job.deleted:
+ worker.set_current_job(job)
+ break
+
+ for host_name in tuple(self._job_queue_by_host_name.keys()):
+ if host_name in available_host_names:
+ continue
+
+ jobs_deque = self._job_queue_by_host_name[host_name]
+ message = ("Not available workers for \"{}\"").format(host_name)
+ while jobs_deque:
+ job = jobs_deque.popleft()
+ if not job.deleted:
+ job.set_done(False, message)
+ self._remove_old_jobs()
+
+ def get_jobs(self):
+ return self._jobs_by_id.values()
+
+ def get_job(self, job_id):
+ """Job by it's id."""
+ return self._jobs_by_id.get(job_id)
+
+ def create_job(self, host_name, job_data):
+ """Create new job from passed data and add it to queue."""
+ job = Job(host_name, job_data)
+ self._jobs_by_id[job.id] = job
+ self._job_queue_by_host_name[host_name].append(job)
+ return job
+
+ def _remove_old_jobs(self):
+ """Once in specific time look if should remove old finished jobs."""
+ delta = datetime.datetime.now() - self._last_old_jobs_check
+ if delta.seconds < self.old_jobs_check_minutes_interval:
+ return
+
+ for job_id in tuple(self._jobs_by_id.keys()):
+ job = self._jobs_by_id[job_id]
+ if not job.keep_in_memory():
+ self._jobs_by_id.pop(job_id)
+
+ def remove_job(self, job_id):
+ """Delete job and eventually stop it."""
+ job = self._jobs_by_id.get(job_id)
+ if job is None:
+ return
+
+ job.set_deleted()
+ self._jobs_by_id.pop(job.id)
+
+ def get_job_status(self, job_id):
+ """Job's status based on id."""
+ job = self._jobs_by_id.get(job_id)
+ if job is None:
+ return {}
+ return job.status()
diff --git a/openpype/modules/default_modules/job_queue/job_server/server.py b/openpype/modules/default_modules/job_queue/job_server/server.py
new file mode 100644
index 0000000000..cc0968b6b6
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/server.py
@@ -0,0 +1,154 @@
+import threading
+import asyncio
+import logging
+
+from aiohttp import web
+
+from .jobs import JobQueue
+from .job_queue_route import JobQueueResource
+from .workers_rpc_route import WorkerRpc
+
+log = logging.getLogger(__name__)
+
+
+class WebServerManager:
+ """Manger that care about web server thread."""
+ def __init__(self, port, host, loop=None):
+ self.port = port
+ self.host = host
+ self.app = web.Application()
+ if loop is None:
+ loop = asyncio.new_event_loop()
+
+ # add route with multiple methods for single "external app"
+ self.webserver_thread = WebServerThread(self, loop)
+
+ @property
+ def url(self):
+ return "http://{}:{}".format(self.host, self.port)
+
+ def add_route(self, *args, **kwargs):
+ self.app.router.add_route(*args, **kwargs)
+
+ def add_static(self, *args, **kwargs):
+ self.app.router.add_static(*args, **kwargs)
+
+ def start_server(self):
+ if self.webserver_thread and not self.webserver_thread.is_alive():
+ self.webserver_thread.start()
+
+ def stop_server(self):
+ if not self.is_running:
+ return
+
+ try:
+ log.debug("Stopping Web server")
+ self.webserver_thread.stop()
+
+ except Exception as exc:
+ print("Errored", str(exc))
+ log.warning(
+ "Error has happened during Killing Web server",
+ exc_info=True
+ )
+
+ @property
+ def is_running(self):
+ if self.webserver_thread is not None:
+ return self.webserver_thread.is_running
+ return False
+
+
+class WebServerThread(threading.Thread):
+ """ Listener for requests in thread."""
+ def __init__(self, manager, loop):
+ super(WebServerThread, self).__init__()
+
+ self._is_running = False
+ self._stopped = False
+ self.manager = manager
+ self.loop = loop
+ self.runner = None
+ self.site = None
+
+ job_queue = JobQueue()
+ self.job_queue_route = JobQueueResource(job_queue, manager)
+ self.workers_route = WorkerRpc(job_queue, manager, loop=loop)
+
+ @property
+ def port(self):
+ return self.manager.port
+
+ @property
+ def host(self):
+ return self.manager.host
+
+ @property
+ def stopped(self):
+ return self._stopped
+
+ @property
+ def is_running(self):
+ return self._is_running
+
+ def run(self):
+ self._is_running = True
+
+ try:
+ log.info("Starting WebServer server")
+ asyncio.set_event_loop(self.loop)
+ self.loop.run_until_complete(self.start_server())
+
+ asyncio.ensure_future(self.check_shutdown(), loop=self.loop)
+ self.loop.run_forever()
+
+ except Exception:
+ log.warning(
+ "Web Server service has failed", exc_info=True
+ )
+ finally:
+ self.loop.close()
+
+ self._is_running = False
+ log.info("Web server stopped")
+
+ async def start_server(self):
+ """ Starts runner and TCPsite """
+ self.runner = web.AppRunner(self.manager.app)
+ await self.runner.setup()
+ self.site = web.TCPSite(self.runner, self.host, self.port)
+ await self.site.start()
+
+ def stop(self):
+ """Sets _stopped flag to True, 'check_shutdown' shuts server down"""
+ self._stopped = True
+
+ async def check_shutdown(self):
+ """ Future that is running and checks if server should be running
+ periodically.
+ """
+ while not self._stopped:
+ await asyncio.sleep(0.5)
+
+ print("Starting shutdown")
+ if self.workers_route:
+ await self.workers_route.stop()
+
+ print("Stopping site")
+ await self.site.stop()
+ print("Site stopped")
+ await self.runner.cleanup()
+
+ print("Runner stopped")
+ tasks = [
+ task
+ for task in asyncio.all_tasks()
+ if task is not asyncio.current_task()
+ ]
+ list(map(lambda task: task.cancel(), tasks)) # cancel all the tasks
+ results = await asyncio.gather(*tasks, return_exceptions=True)
+ log.debug(f'Finished awaiting cancelled tasks, results: {results}...')
+ await self.loop.shutdown_asyncgens()
+ # to really make sure everything else has time to stop
+ await asyncio.sleep(0.07)
+ self.loop.stop()
diff --git a/openpype/modules/default_modules/job_queue/job_server/utils.py b/openpype/modules/default_modules/job_queue/job_server/utils.py
new file mode 100644
index 0000000000..127ca5f090
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/utils.py
@@ -0,0 +1,51 @@
+import sys
+import signal
+import time
+import socket
+
+from .server import WebServerManager
+
+
+class SharedObjects:
+ stopped = False
+
+ @classmethod
+ def stop(cls):
+ cls.stopped = True
+
+
+def main(port=None, host=None):
+ def signal_handler(sig, frame):
+ print("Signal to kill process received. Termination starts.")
+ SharedObjects.stop()
+
+ signal.signal(signal.SIGINT, signal_handler)
+ signal.signal(signal.SIGTERM, signal_handler)
+
+ port = int(port or 8079)
+ host = str(host or "localhost")
+
+ with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as con:
+ result_of_check = con.connect_ex((host, port))
+
+ if result_of_check == 0:
+ print((
+ "Server {}:{} is already running or address is occupied."
+ ).format(host, port))
+ return 1
+
+ print("Running server {}:{}".format(host, port))
+ manager = WebServerManager(port, host)
+ manager.start_server()
+
+ stopped = False
+ while manager.is_running:
+ if not stopped and SharedObjects.stopped:
+ stopped = True
+ manager.stop_server()
+ time.sleep(0.1)
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(main())
diff --git a/openpype/modules/default_modules/job_queue/job_server/workers.py b/openpype/modules/default_modules/job_queue/job_server/workers.py
new file mode 100644
index 0000000000..28ca649c03
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/workers.py
@@ -0,0 +1,122 @@
+import asyncio
+from uuid import uuid4
+from aiohttp import WSCloseCode
+from aiohttp_json_rpc.protocol import encode_request
+
+
+class WorkerState:
+ IDLE = object()
+ JOB_ASSIGNED = object()
+ JOB_SENT = object()
+
+
+class Worker:
+ """Worker that can handle jobs of specific host."""
+ def __init__(self, host_name, http_request):
+ self._id = None
+ self.host_name = host_name
+ self._http_request = http_request
+ self._state = WorkerState.IDLE
+ self._job = None
+
+ # Give ability to send requests to worker
+ http_request.request_id = str(uuid4())
+ http_request.pending_requests = {}
+
+ async def send_job(self):
+ if self._job is not None:
+ data = {
+ "job_id": self._job.id,
+ "worker_id": self.id,
+ "data": self._job.data
+ }
+ return await self.call("start_job", data)
+ return False
+
+ async def call(self, method, params=None, timeout=None):
+ """Call method on worker's side."""
+ request_id = self._http_request.request_id
+ self._http_request.request_id = str(uuid4())
+ pending_requests = self._http_request.pending_requests
+ pending_requests[request_id] = asyncio.Future()
+
+ request = encode_request(method, id=request_id, params=params)
+
+ await self._http_request.ws.send_str(request)
+
+ if timeout:
+ await asyncio.wait_for(
+ pending_requests[request_id],
+ timeout=timeout
+ )
+
+ else:
+ await pending_requests[request_id]
+
+ result = pending_requests[request_id].result()
+ del pending_requests[request_id]
+
+ return result
+
+ async def close(self):
+ return await self.ws.close(
+ code=WSCloseCode.GOING_AWAY,
+ message="Server shutdown"
+ )
+
+ @property
+ def id(self):
+ if self._id is None:
+ self._id = str(uuid4())
+ return self._id
+
+ @property
+ def state(self):
+ return self._state
+
+ @property
+ def current_job(self):
+ return self._job
+
+ @property
+ def http_request(self):
+ return self._http_request
+
+ @property
+ def ws(self):
+ return self.http_request.ws
+
+ def connection_is_alive(self):
+ if self.ws.closed or self.ws._writer.transport.is_closing():
+ return False
+ return True
+
+ def is_idle(self):
+ return self._state is WorkerState.IDLE
+
+ def job_assigned(self):
+ return (
+ self._state is WorkerState.JOB_ASSIGNED
+ or self._state is WorkerState.JOB_SENT
+ )
+
+ def is_working(self):
+ return self._state is WorkerState.JOB_SENT
+
+ def set_current_job(self, job):
+ if job is self._job:
+ return
+
+ self._job = job
+ if job is None:
+ self._set_idle()
+ else:
+ self._state = WorkerState.JOB_ASSIGNED
+ job.set_worker(self)
+
+ def _set_idle(self):
+ self._job = None
+ self._state = WorkerState.IDLE
+
+ def set_working(self):
+ self._state = WorkerState.JOB_SENT
diff --git a/openpype/modules/default_modules/job_queue/job_server/workers_rpc_route.py b/openpype/modules/default_modules/job_queue/job_server/workers_rpc_route.py
new file mode 100644
index 0000000000..0800ca0d4d
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_server/workers_rpc_route.py
@@ -0,0 +1,124 @@
+import asyncio
+
+import aiohttp
+from aiohttp_json_rpc import JsonRpc
+from aiohttp_json_rpc.protocol import (
+ encode_error, decode_msg, JsonRpcMsgTyp
+)
+from aiohttp_json_rpc.exceptions import RpcError
+from .workers import Worker
+
+
+class WorkerRpc(JsonRpc):
+ def __init__(self, job_queue, manager, **kwargs):
+ super().__init__(**kwargs)
+
+ self._job_queue = job_queue
+ self._manager = manager
+
+ self._stopped = False
+
+ # Register methods
+ self.add_methods(
+ ("", self.register_worker),
+ ("", self.job_done)
+ )
+ asyncio.ensure_future(self._rpc_loop(), loop=self.loop)
+
+ self._manager.add_route(
+ "*", "/ws", self.handle_request
+ )
+
+ # Panel routes for tools
+ async def register_worker(self, request, host_name):
+ worker = Worker(host_name, request.http_request)
+ self._job_queue.add_worker(worker)
+ return worker.id
+
+ async def _rpc_loop(self):
+ while self.loop.is_running():
+ if self._stopped:
+ break
+
+ for worker in tuple(self._job_queue.workers()):
+ if not worker.connection_is_alive():
+ self._job_queue.remove_worker(worker)
+ self._job_queue.assign_jobs()
+
+ await self.send_jobs()
+ await asyncio.sleep(5)
+
+ async def job_done(self, worker_id, job_id, success, message, data):
+ worker = self._job_queue.get_worker(worker_id)
+ if worker is not None:
+ worker.set_current_job(None)
+
+ job = self._job_queue.get_job(job_id)
+ if job is not None:
+ job.set_done(success, message, data)
+ return True
+
+ async def send_jobs(self):
+ invalid_workers = []
+ for worker in self._job_queue.workers():
+ if worker.job_assigned() and not worker.is_working():
+ try:
+ await worker.send_job()
+
+ except ConnectionResetError:
+ invalid_workers.append(worker)
+
+ for worker in invalid_workers:
+ self._job_queue.remove_worker(worker)
+
+ async def handle_websocket_request(self, http_request):
+ """Overide this method to catch CLOSING messages."""
+ http_request.msg_id = 0
+ http_request.pending = {}
+
+ # prepare and register websocket
+ ws = aiohttp.web_ws.WebSocketResponse()
+ await ws.prepare(http_request)
+ http_request.ws = ws
+ self.clients.append(http_request)
+
+ while not ws.closed:
+ self.logger.debug('waiting for messages')
+ raw_msg = await ws.receive()
+
+ if raw_msg.type == aiohttp.WSMsgType.TEXT:
+ self.logger.debug('raw msg received: %s', raw_msg.data)
+ self.loop.create_task(
+ self._handle_rpc_msg(http_request, raw_msg)
+ )
+
+ elif raw_msg.type == aiohttp.WSMsgType.CLOSING:
+ break
+
+ self.clients.remove(http_request)
+ return ws
+
+ async def _handle_rpc_msg(self, http_request, raw_msg):
+ # This is duplicated code from super but there is no way how to do it
+ # to be able handle server->client requests
+ try:
+ _raw_message = raw_msg.data
+ msg = decode_msg(_raw_message)
+
+ except RpcError as error:
+ await self._ws_send_str(http_request, encode_error(error))
+ return
+
+ if msg.type in (JsonRpcMsgTyp.RESULT, JsonRpcMsgTyp.ERROR):
+ request_id = msg.data["id"]
+ if request_id in http_request.pending_requests:
+ future = http_request.pending_requests[request_id]
+ future.set_result(msg.data["result"])
+ return
+
+ return await super()._handle_rpc_msg(http_request, raw_msg)
+
+ async def stop(self):
+ self._stopped = True
+ for worker in tuple(self._job_queue.workers()):
+ await worker.close()
diff --git a/openpype/modules/default_modules/job_queue/job_workers/__init__.py b/openpype/modules/default_modules/job_queue/job_workers/__init__.py
new file mode 100644
index 0000000000..f771797aea
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_workers/__init__.py
@@ -0,0 +1,5 @@
+from .base_worker import WorkerJobsConnection
+
+__all__ = (
+ "WorkerJobsConnection",
+)
diff --git a/openpype/modules/default_modules/job_queue/job_workers/base_worker.py b/openpype/modules/default_modules/job_queue/job_workers/base_worker.py
new file mode 100644
index 0000000000..85506565f4
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/job_workers/base_worker.py
@@ -0,0 +1,190 @@
+import sys
+import datetime
+import asyncio
+import traceback
+
+from aiohttp_json_rpc import JsonRpcClient
+
+
+class WorkerClient(JsonRpcClient):
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+
+ self.add_methods(
+ ("", self.start_job),
+ )
+ self.current_job = None
+ self._id = None
+
+ def set_id(self, worker_id):
+ self._id = worker_id
+
+ async def start_job(self, job_data):
+ if self.current_job is not None:
+ return False
+
+ print("Got new job {}".format(str(job_data)))
+ self.current_job = job_data
+ return True
+
+ def finish_job(self, success, message, data):
+ asyncio.ensure_future(
+ self._finish_job(success, message, data),
+ loop=self._loop
+ )
+
+ async def _finish_job(self, success, message, data):
+ print("Current job", self.current_job)
+ job_id = self.current_job["job_id"]
+ self.current_job = None
+
+ return await self.call(
+ "job_done", [self._id, job_id, success, message, data]
+ )
+
+
+class WorkerJobsConnection:
+ """WS connection to Job server.
+
+ Helper class to create a connection to process jobs from job server.
+
+ To be able receive jobs is needed to create a connection and then register
+ as worker for specific host.
+ """
+ retry_time_seconds = 5
+
+ def __init__(self, server_url, host_name, loop=None):
+ self.client = None
+ self._loop = loop
+
+ self._host_name = host_name
+ self._server_url = server_url
+
+ self._is_running = False
+ self._connecting = False
+ self._connected = False
+ self._stopped = False
+
+ def stop(self):
+ print("Stopping worker")
+ self._stopped = True
+
+ @property
+ def is_running(self):
+ return self._is_running
+
+ @property
+ def current_job(self):
+ if self.client is not None:
+ return self.client.current_job
+ return None
+
+ def finish_job(self, success=True, message=None, data=None):
+ """Worker finished job and sets the result which is send to server."""
+ if self.client is None:
+ print((
+ "Couldn't sent job status to server because"
+ " client is not connected."
+ ))
+ else:
+ self.client.finish_job(success, message, data)
+
+ async def main_loop(self, register_worker=True):
+ """Main loop of connection which keep connection to server alive."""
+ self._is_running = True
+
+ while not self._stopped:
+ start_time = datetime.datetime.now()
+ await self._connection_loop(register_worker)
+ delta = datetime.datetime.now() - start_time
+ print("Connection loop took {}s".format(str(delta)))
+ # Check if was stopped and stop while loop in that case
+ if self._stopped:
+ break
+
+ if delta.seconds < 60:
+ print((
+ "Can't connect to server will try in {} seconds."
+ ).format(self.retry_time_seconds))
+
+ await asyncio.sleep(self.retry_time_seconds)
+ self._is_running = False
+
+ async def _connect(self):
+ self.client = WorkerClient()
+ print("Connecting to {}".format(self._server_url))
+ try:
+ await self.client.connect_url(self._server_url)
+ except KeyboardInterrupt:
+ raise
+ except Exception:
+ traceback.print_exception(*sys.exc_info())
+
+ async def _connection_loop(self, register_worker):
+ self._connecting = True
+ future = asyncio.run_coroutine_threadsafe(
+ self._connect(), loop=self._loop
+ )
+
+ while self._connecting:
+ if not future.done():
+ await asyncio.sleep(0.07)
+ continue
+
+ session = getattr(self.client, "_session", None)
+ ws = getattr(self.client, "_ws", None)
+ if session is not None:
+ if session.closed:
+ self._connecting = False
+ self._connected = False
+ break
+
+ elif ws is not None:
+ self._connecting = False
+ self._connected = True
+
+ if self._stopped:
+ break
+
+ await asyncio.sleep(0.07)
+
+ if not self._connected:
+ self.client = None
+ return
+
+ print("Connected to job queue server")
+ if register_worker:
+ self.register_as_worker()
+
+ while self._connected and self._loop.is_running():
+ if self._stopped or ws.closed:
+ break
+
+ await asyncio.sleep(0.3)
+
+ await self._stop_cleanup()
+
+ def register_as_worker(self):
+ """Register as worker ready to work on server side."""
+ asyncio.ensure_future(self._register_as_worker(), loop=self._loop)
+
+ async def _register_as_worker(self):
+ worker_id = await self.client.call(
+ "register_worker", [self._host_name]
+ )
+ self.client.set_id(worker_id)
+ print(
+ "Registered as worker with id {}".format(worker_id)
+ )
+
+ async def disconnect(self):
+ await self._stop_cleanup()
+
+ async def _stop_cleanup(self):
+ print("Cleanup after stop")
+ if self.client is not None and hasattr(self.client, "_ws"):
+ await self.client.disconnect()
+
+ self.client = None
+ self._connecting = False
+ self._connected = False
diff --git a/openpype/modules/default_modules/job_queue/module.py b/openpype/modules/default_modules/job_queue/module.py
new file mode 100644
index 0000000000..719d7c8f38
--- /dev/null
+++ b/openpype/modules/default_modules/job_queue/module.py
@@ -0,0 +1,241 @@
+"""Job queue OpenPype module was created for remote execution of commands.
+
+## Why is needed
+Primarily created for hosts which are not easilly controlled from command line
+or in headless mode and is easier to keep one process of host running listening
+for jobs to do.
+
+### Example
+One of examples is TVPaint which does not have headless mode, can run only one
+process at one time and it's impossible to know what should be executed inside
+TVPaint before we know all data about the file that should be processed.
+
+## Idea
+Idea is that there is a server, workers and workstation/s which need to process
+something on a worker.
+
+Workers and workstation/s must have access to server through adress to it's
+running instance. Workers use WebSockets and workstations are using HTTP calls.
+Also both of them must have access to job queue root which is set in
+settings. Root is used as temp where files needed for job can be stored before
+sending the job or where result files are stored when job is done.
+
+Server's address must be set in settings when is running so workers and
+workstations know where to send or receive jobs.
+
+## Command line commands
+### start_server
+- start server which is handles jobs
+- it is possible to specify port and host address (default is localhost:8079)
+
+### start_worker
+- start worker which will process jobs
+- has required possitional argument which is application name from OpenPype
+ settings e.g. 'tvpaint/11-5' ('tvpaint' is group '11-5' is variant)
+- it is possible to specify server url but url from settings is used when not
+ passed (this is added mainly for developing purposes)
+"""
+
+import sys
+import json
+import copy
+import platform
+
+import click
+from openpype.modules import OpenPypeModule
+from openpype.api import get_system_settings
+
+
+class JobQueueModule(OpenPypeModule):
+ name = "job_queue"
+
+ def initialize(self, modules_settings):
+ server_url = modules_settings.get("server_url") or ""
+
+ self._server_url = self.url_conversion(server_url)
+ jobs_root_mapping = self._roots_mapping_conversion(
+ modules_settings.get("jobs_root")
+ )
+
+ self._jobs_root_mapping = jobs_root_mapping
+
+ # Is always enabled
+ # - the module does nothing until is used
+ self.enabled = True
+
+ @classmethod
+ def _root_conversion(cls, root_path):
+ """Make sure root path does not end with slash."""
+ # Return empty string if path is invalid
+ if not root_path:
+ return ""
+
+ # Remove all slashes
+ while root_path.endswith("/") or root_path.endswith("\\"):
+ root_path = root_path[:-1]
+ return root_path
+
+ @classmethod
+ def _roots_mapping_conversion(cls, roots_mapping):
+ roots_mapping = roots_mapping or {}
+ for platform_name in ("windows", "linux", "darwin"):
+ roots_mapping[platform_name] = cls._root_conversion(
+ roots_mapping.get(platform_name)
+ )
+ return roots_mapping
+
+ @staticmethod
+ def url_conversion(url, ws=False):
+ if sys.version_info[0] == 2:
+ from urlparse import urlsplit, urlunsplit
+ else:
+ from urllib.parse import urlsplit, urlunsplit
+
+ if not url:
+ return url
+
+ url_parts = list(urlsplit(url))
+ scheme = url_parts[0]
+ if not scheme:
+ if ws:
+ url = "ws://{}".format(url)
+ else:
+ url = "http://{}".format(url)
+ url_parts = list(urlsplit(url))
+
+ elif ws:
+ if scheme not in ("ws", "wss"):
+ if scheme == "https":
+ url_parts[0] = "wss"
+ else:
+ url_parts[0] = "ws"
+
+ elif scheme not in ("http", "https"):
+ if scheme == "wss":
+ url_parts[0] = "https"
+ else:
+ url_parts[0] = "http"
+
+ return urlunsplit(url_parts)
+
+ def get_jobs_root_mapping(self):
+ return copy.deepcopy(self._jobs_root_mapping)
+
+ def get_jobs_root(self):
+ return self._jobs_root_mapping.get(platform.system().lower())
+
+ @classmethod
+ def get_jobs_root_from_settings(cls):
+ module_settings = get_system_settings()["modules"]
+ jobs_root_mapping = module_settings.get(cls.name, {}).get("jobs_root")
+ converted_mapping = cls._roots_mapping_conversion(jobs_root_mapping)
+
+ return converted_mapping[platform.system().lower()]
+
+ @property
+ def server_url(self):
+ return self._server_url
+
+ def send_job(self, host_name, job_data):
+ import requests
+
+ job_data = job_data or {}
+ job_data["host_name"] = host_name
+ api_path = "{}/api/jobs".format(self._server_url)
+ post_request = requests.post(api_path, data=json.dumps(job_data))
+ return str(post_request.content.decode())
+
+ def get_job_status(self, job_id):
+ import requests
+
+ api_path = "{}/api/jobs/{}".format(self._server_url, job_id)
+ return requests.get(api_path).json()
+
+ def cli(self, click_group):
+ click_group.add_command(cli_main)
+
+ @classmethod
+ def get_server_url_from_settings(cls):
+ module_settings = get_system_settings()["modules"]
+ return cls.url_conversion(
+ module_settings
+ .get(cls.name, {})
+ .get("server_url")
+ )
+
+ @classmethod
+ def start_server(cls, port=None, host=None):
+ from .job_server import main
+
+ return main(port, host)
+
+ @classmethod
+ def start_worker(cls, app_name, server_url=None):
+ import requests
+ from openpype.lib import ApplicationManager
+
+ if not server_url:
+ server_url = cls.get_server_url_from_settings()
+
+ if not server_url:
+ raise ValueError("Server url is not set.")
+
+ http_server_url = cls.url_conversion(server_url)
+
+ # Validate url
+ requests.get(http_server_url)
+
+ ws_server_url = cls.url_conversion(server_url) + "/ws"
+
+ app_manager = ApplicationManager()
+ app = app_manager.applications.get(app_name)
+ if app is None:
+ raise ValueError(
+ "Didn't find application \"{}\" in settings.".format(app_name)
+ )
+
+ if app.host_name == "tvpaint":
+ return cls._start_tvpaint_worker(app, ws_server_url)
+ raise ValueError("Unknown host \"{}\"".format(app.host_name))
+
+ @classmethod
+ def _start_tvpaint_worker(cls, app, server_url):
+ from openpype.hosts.tvpaint.worker import main
+
+ executable = app.find_executable()
+ if not executable:
+ raise ValueError((
+ "Executable for app \"{}\" is not set"
+ " or accessible on this workstation."
+ ).format(app.full_name))
+
+ return main(str(executable), server_url)
+
+
+@click.group(
+ JobQueueModule.name,
+ help="Application job server. Can be used as render farm."
+)
+def cli_main():
+ pass
+
+
+@cli_main.command(
+ "start_server",
+ help="Start server handling workers and their jobs."
+)
+@click.option("--port", help="Server port")
+@click.option("--host", help="Server host (ip address)")
+def cli_start_server(port, host):
+ JobQueueModule.start_server(port, host)
+
+
+@cli_main.command(
+ "start_worker", help=(
+ "Start a worker for a specific application. (e.g. \"tvpaint/11.5\")"
+ )
+)
+@click.argument("app_name")
+@click.option("--server_url", help="Server url which handle workers and jobs.")
+def cli_start_worker(app_name, server_url):
+ JobQueueModule.start_worker(app_name, server_url)
diff --git a/openpype/modules/default_modules/python_console_interpreter/window/widgets.py b/openpype/modules/default_modules/python_console_interpreter/window/widgets.py
index 0e8dd2fb9b..ecf41eaf3e 100644
--- a/openpype/modules/default_modules/python_console_interpreter/window/widgets.py
+++ b/openpype/modules/default_modules/python_console_interpreter/window/widgets.py
@@ -176,6 +176,7 @@ class PythonCodeEditor(QtWidgets.QPlainTextEdit):
class PythonTabWidget(QtWidgets.QWidget):
+ add_tab_requested = QtCore.Signal()
before_execute = QtCore.Signal(str)
def __init__(self, parent):
@@ -185,11 +186,15 @@ class PythonTabWidget(QtWidgets.QWidget):
self.setFocusProxy(code_input)
+ add_tab_btn = QtWidgets.QPushButton("Add tab...", self)
+ add_tab_btn.setToolTip("Add new tab")
+
execute_btn = QtWidgets.QPushButton("Execute", self)
execute_btn.setToolTip("Execute command (Ctrl + Enter)")
btns_layout = QtWidgets.QHBoxLayout()
btns_layout.setContentsMargins(0, 0, 0, 0)
+ btns_layout.addWidget(add_tab_btn)
btns_layout.addStretch(1)
btns_layout.addWidget(execute_btn)
@@ -198,12 +203,16 @@ class PythonTabWidget(QtWidgets.QWidget):
layout.addWidget(code_input, 1)
layout.addLayout(btns_layout, 0)
+ add_tab_btn.clicked.connect(self._on_add_tab_clicked)
execute_btn.clicked.connect(self._on_execute_clicked)
code_input.execute_requested.connect(self.execute)
self._code_input = code_input
self._interpreter = InteractiveInterpreter()
+ def _on_add_tab_clicked(self):
+ self.add_tab_requested.emit()
+
def _on_execute_clicked(self):
self.execute()
@@ -352,9 +361,6 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
tab_widget.setTabsClosable(False)
tab_widget.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
- add_tab_btn = QtWidgets.QPushButton("+", tab_widget)
- tab_widget.setCornerWidget(add_tab_btn, QtCore.Qt.TopLeftCorner)
-
widgets_splitter = QtWidgets.QSplitter(self)
widgets_splitter.setOrientation(QtCore.Qt.Vertical)
widgets_splitter.addWidget(output_widget)
@@ -371,14 +377,12 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
line_check_timer.setInterval(200)
line_check_timer.timeout.connect(self._on_timer_timeout)
- add_tab_btn.clicked.connect(self._on_add_clicked)
tab_bar.right_clicked.connect(self._on_tab_right_click)
tab_bar.double_clicked.connect(self._on_tab_double_click)
tab_bar.mid_clicked.connect(self._on_tab_mid_click)
tab_widget.tabCloseRequested.connect(self._on_tab_close_req)
self._widgets_splitter = widgets_splitter
- self._add_tab_btn = add_tab_btn
self._output_widget = output_widget
self._tab_widget = tab_widget
self._line_check_timer = line_check_timer
@@ -459,14 +463,41 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
return
menu = QtWidgets.QMenu(self._tab_widget)
- menu.addAction("Rename")
+
+ add_tab_action = QtWidgets.QAction("Add tab...", menu)
+ add_tab_action.setToolTip("Add new tab")
+
+ rename_tab_action = QtWidgets.QAction("Rename...", menu)
+ rename_tab_action.setToolTip("Rename tab")
+
+ duplicate_tab_action = QtWidgets.QAction("Duplicate...", menu)
+ duplicate_tab_action.setToolTip("Duplicate code to new tab")
+
+ close_tab_action = QtWidgets.QAction("Close", menu)
+ close_tab_action.setToolTip("Close tab and lose content")
+ close_tab_action.setEnabled(self._tab_widget.tabsClosable())
+
+ menu.addAction(add_tab_action)
+ menu.addAction(rename_tab_action)
+ menu.addAction(duplicate_tab_action)
+ menu.addAction(close_tab_action)
+
result = menu.exec_(global_point)
if result is None:
return
- if result.text() == "Rename":
+ if result is rename_tab_action:
self._rename_tab_req(tab_idx)
+ elif result is add_tab_action:
+ self._on_add_requested()
+
+ elif result is duplicate_tab_action:
+ self._duplicate_requested(tab_idx)
+
+ elif result is close_tab_action:
+ self._on_tab_close_req(tab_idx)
+
def _rename_tab_req(self, tab_idx):
dialog = TabNameDialog(self)
dialog.set_tab_name(self._tab_widget.tabText(tab_idx))
@@ -475,6 +506,16 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
if tab_name:
self._tab_widget.setTabText(tab_idx, tab_name)
+ def _duplicate_requested(self, tab_idx=None):
+ if tab_idx is None:
+ tab_idx = self._tab_widget.currentIndex()
+
+ src_widget = self._tab_widget.widget(tab_idx)
+ dst_widget = self._add_tab()
+ if dst_widget is None:
+ return
+ dst_widget.set_code(src_widget.get_code())
+
def _on_tab_mid_click(self, global_point):
point = self._tab_widget.mapFromGlobal(global_point)
tab_bar = self._tab_widget.tabBar()
@@ -525,12 +566,17 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
lines.append(self.ansi_escape.sub("", line))
self._append_lines(lines)
- def _on_add_clicked(self):
+ def _on_add_requested(self):
+ self._add_tab()
+
+ def _add_tab(self):
dialog = TabNameDialog(self)
dialog.exec_()
tab_name = dialog.result()
if tab_name:
- self.add_tab(tab_name)
+ return self.add_tab(tab_name)
+
+ return None
def _on_before_execute(self, code_text):
at_max = self._output_widget.vertical_scroll_at_max()
@@ -562,6 +608,7 @@ class PythonInterpreterWidget(QtWidgets.QWidget):
def add_tab(self, tab_name, index=None):
widget = PythonTabWidget(self)
widget.before_execute.connect(self._on_before_execute)
+ widget.add_tab_requested.connect(self._on_add_requested)
if index is None:
if self._tab_widget.count() > 0:
index = self._tab_widget.currentIndex() + 1
diff --git a/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py b/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py
index 17e4fb38d1..290f26a44a 100644
--- a/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py
+++ b/openpype/modules/default_modules/royal_render/rr_root/plugins/control_job/perjob/m50__openpype_publish_render.py
@@ -148,12 +148,27 @@ class OpenPypeContextSelector:
for k, v in env.items():
print(" {}: {}".format(k, v))
+ publishing_paths = [os.path.join(self.job.imageDir,
+ os.path.dirname(
+ self.job.imageFileName))]
+
+ # add additional channels
+ channel_idx = 0
+ channel = self.job.channelFileName(channel_idx)
+ while channel:
+ channel_path = os.path.dirname(
+ os.path.join(self.job.imageDir, channel))
+ if channel_path not in publishing_paths:
+ publishing_paths.append(channel_path)
+ channel_idx += 1
+ channel = self.job.channelFileName(channel_idx)
+
args = [os.path.join(self.openpype_root, self.openpype_executable),
- 'publish', '-t', "rr_control", "--gui",
- os.path.join(self.job.imageDir,
- os.path.dirname(self.job.imageFileName))
+ 'publish', '-t', "rr_control", "--gui"
]
+ args += publishing_paths
+
print(">>> running {}".format(" ".join(args)))
orig = os.environ.copy()
orig.update(env)
diff --git a/openpype/modules/default_modules/sync_server/providers/sftp.py b/openpype/modules/default_modules/sync_server/providers/sftp.py
index 4f505ae016..1585b326bd 100644
--- a/openpype/modules/default_modules/sync_server/providers/sftp.py
+++ b/openpype/modules/default_modules/sync_server/providers/sftp.py
@@ -192,7 +192,7 @@ class SFTPHandler(AbstractProvider):
Format is importing for usage of python's format ** approach
"""
# roots cannot be locally overridden
- return self.presets['roots']
+ return self.presets['root']
def get_tree(self):
"""
@@ -421,7 +421,8 @@ class SFTPHandler(AbstractProvider):
try:
return pysftp.Connection(**conn_params)
- except paramiko.ssh_exception.SSHException:
+ except (paramiko.ssh_exception.SSHException,
+ pysftp.exceptions.ConnectionException):
log.warning("Couldn't connect", exc_info=True)
def _mark_progress(self, collection, file, representation, server, site,
diff --git a/openpype/modules/default_modules/sync_server/sync_server_module.py b/openpype/modules/default_modules/sync_server/sync_server_module.py
index cd29d93384..500203f3fc 100644
--- a/openpype/modules/default_modules/sync_server/sync_server_module.py
+++ b/openpype/modules/default_modules/sync_server/sync_server_module.py
@@ -1574,6 +1574,7 @@ class SyncServerModule(OpenPypeModule, ITrayModule):
Use 'force' to remove existing or raises ValueError
"""
+ reseted_existing = False
for repre_file in representation.pop().get("files"):
if file_id and file_id != repre_file["_id"]:
continue
@@ -1584,12 +1585,15 @@ class SyncServerModule(OpenPypeModule, ITrayModule):
self._reset_site_for_file(collection, query,
elem, repre_file["_id"],
site_name)
- return
+ reseted_existing = True
else:
msg = "Site {} already present".format(site_name)
log.info(msg)
raise ValueError(msg)
+ if reseted_existing:
+ return
+
if not file_id:
update = {
"$push": {"files.$[].sites": elem}
diff --git a/openpype/pipeline/create/__init__.py b/openpype/pipeline/create/__init__.py
index 610ef6d8e2..948b719851 100644
--- a/openpype/pipeline/create/__init__.py
+++ b/openpype/pipeline/create/__init__.py
@@ -1,3 +1,6 @@
+from .constants import (
+ SUBSET_NAME_ALLOWED_SYMBOLS
+)
from .creator_plugins import (
CreatorError,
@@ -13,6 +16,8 @@ from .context import (
__all__ = (
+ "SUBSET_NAME_ALLOWED_SYMBOLS",
+
"CreatorError",
"BaseCreator",
diff --git a/openpype/pipeline/create/constants.py b/openpype/pipeline/create/constants.py
new file mode 100644
index 0000000000..bfbbccfd12
--- /dev/null
+++ b/openpype/pipeline/create/constants.py
@@ -0,0 +1,6 @@
+SUBSET_NAME_ALLOWED_SYMBOLS = "a-zA-Z0-9_."
+
+
+__all__ = (
+ "SUBSET_NAME_ALLOWED_SYMBOLS",
+)
diff --git a/openpype/plugins/publish/collect_anatomy_context_data.py b/openpype/plugins/publish/collect_anatomy_context_data.py
index ec88d5669d..6b95979b76 100644
--- a/openpype/plugins/publish/collect_anatomy_context_data.py
+++ b/openpype/plugins/publish/collect_anatomy_context_data.py
@@ -54,6 +54,12 @@ class CollectAnatomyContextData(pyblish.api.ContextPlugin):
if hierarchy_items:
hierarchy = os.path.join(*hierarchy_items)
+ asset_tasks = asset_entity["data"]["tasks"]
+ task_type = asset_tasks.get(task_name, {}).get("type")
+
+ project_task_types = project_entity["config"]["tasks"]
+ task_code = project_task_types.get(task_type, {}).get("short_name")
+
context_data = {
"project": {
"name": project_entity["name"],
@@ -61,7 +67,11 @@ class CollectAnatomyContextData(pyblish.api.ContextPlugin):
},
"asset": asset_entity["name"],
"hierarchy": hierarchy.replace("\\", "/"),
- "task": task_name,
+ "task": {
+ "name": task_name,
+ "type": task_type,
+ "short": task_code,
+ },
"username": context.data["user"],
"app": context.data["hostName"]
}
diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py
index e0eb1618b5..da6a2195ee 100644
--- a/openpype/plugins/publish/collect_anatomy_instance_data.py
+++ b/openpype/plugins/publish/collect_anatomy_instance_data.py
@@ -214,6 +214,8 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
project_doc = context.data["projectEntity"]
context_asset_doc = context.data["assetEntity"]
+ project_task_types = project_doc["config"]["tasks"]
+
for instance in context:
if self.follow_workfile_version:
version_number = context.data('version')
@@ -245,7 +247,18 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin):
# Task
task_name = instance.data.get("task")
if task_name:
- anatomy_updates["task"] = task_name
+ asset_tasks = asset_doc["data"]["tasks"]
+ task_type = asset_tasks.get(task_name, {}).get("type")
+ task_code = (
+ project_task_types
+ .get(task_type, {})
+ .get("short_name")
+ )
+ anatomy_updates["task"] = {
+ "name": task_name,
+ "type": task_type,
+ "short": task_code
+ }
# Additional data
resolution_width = instance.data.get("resolutionWidth")
diff --git a/openpype/plugins/publish/collect_modules.py b/openpype/plugins/publish/collect_modules.py
index bec0c2b436..2f6cb1ef0e 100644
--- a/openpype/plugins/publish/collect_modules.py
+++ b/openpype/plugins/publish/collect_modules.py
@@ -7,7 +7,7 @@ import pyblish.api
class CollectModules(pyblish.api.ContextPlugin):
"""Collect OpenPype modules."""
- order = pyblish.api.CollectorOrder
+ order = pyblish.api.CollectorOrder - 0.45
label = "OpenPype Modules"
def process(self, context):
diff --git a/openpype/plugins/publish/collect_scene_loaded_versions.py b/openpype/plugins/publish/collect_scene_loaded_versions.py
new file mode 100644
index 0000000000..c26b322df2
--- /dev/null
+++ b/openpype/plugins/publish/collect_scene_loaded_versions.py
@@ -0,0 +1,55 @@
+
+import pyblish.api
+from avalon import api, io
+
+
+class CollectSceneLoadedVersions(pyblish.api.ContextPlugin):
+
+ order = pyblish.api.CollectorOrder + 0.0001
+ label = "Collect Versions Loaded in Scene"
+ hosts = [
+ "aftereffects",
+ "blender",
+ "celaction",
+ "fusion",
+ "harmony",
+ "hiero",
+ "houdini",
+ "maya",
+ "nuke",
+ "photoshop",
+ "resolve",
+ "tvpaint"
+ ]
+
+ def process(self, context):
+ host = api.registered_host()
+ if host is None:
+ self.log.warn("No registered host.")
+ return
+
+ if not hasattr(host, "ls"):
+ host_name = host.__name__
+ self.log.warn("Host %r doesn't have ls() implemented." % host_name)
+ return
+
+ loaded_versions = []
+ _containers = list(host.ls())
+ _repr_ids = [io.ObjectId(c["representation"]) for c in _containers]
+ version_by_repr = {
+ str(doc["_id"]): doc["parent"] for doc in
+ io.find({"_id": {"$in": _repr_ids}}, projection={"parent": 1})
+ }
+
+ for con in _containers:
+ # NOTE:
+ # may have more then one representation that are same version
+ version = {
+ "objectName": con["objectName"], # container node name
+ "subsetName": con["name"],
+ "representation": io.ObjectId(con["representation"]),
+ "version": version_by_repr[con["representation"]], # _id
+ }
+ loaded_versions.append(version)
+
+ context.data["loadedVersions"] = loaded_versions
diff --git a/openpype/plugins/publish/collect_scene_version.py b/openpype/plugins/publish/collect_scene_version.py
index ca12f2900c..8ed6e25e66 100644
--- a/openpype/plugins/publish/collect_scene_version.py
+++ b/openpype/plugins/publish/collect_scene_version.py
@@ -10,7 +10,7 @@ class CollectSceneVersion(pyblish.api.ContextPlugin):
"""
order = pyblish.api.CollectorOrder
- label = 'Collect Version'
+ label = 'Collect Scene Version'
hosts = [
"aftereffects",
"blender",
diff --git a/openpype/plugins/publish/extract_burnin.py b/openpype/plugins/publish/extract_burnin.py
index 06eb85c593..35d9e4b2f2 100644
--- a/openpype/plugins/publish/extract_burnin.py
+++ b/openpype/plugins/publish/extract_burnin.py
@@ -110,6 +110,9 @@ class ExtractBurnin(openpype.api.Extractor):
).format(host_name, family, task_name))
return
+ self.log.debug("profile: {}".format(
+ profile))
+
# Pre-filter burnin definitions by instance families
burnin_defs = self.filter_burnins_defs(profile, instance)
if not burnin_defs:
@@ -126,18 +129,41 @@ class ExtractBurnin(openpype.api.Extractor):
anatomy = instance.context.data["anatomy"]
scriptpath = self.burnin_script_path()
+
# Executable args that will execute the script
# [pype executable, *pype script, "run"]
executable_args = get_pype_execute_args("run", scriptpath)
for idx, repre in enumerate(tuple(instance.data["representations"])):
self.log.debug("repre ({}): `{}`".format(idx + 1, repre["name"]))
+
+ repre_burnin_links = repre.get("burnins", [])
+
if not self.repres_is_valid(repre):
continue
+ self.log.debug("repre_burnin_links: {}".format(
+ repre_burnin_links))
+
+ self.log.debug("burnin_defs.keys(): {}".format(
+ burnin_defs.keys()))
+
+ # Filter output definition by `burnin` represetation key
+ repre_linked_burnins = {
+ name: output for name, output in burnin_defs.items()
+ if name in repre_burnin_links
+ }
+ self.log.debug("repre_linked_burnins: {}".format(
+ repre_linked_burnins))
+
+ # if any match then replace burnin defs and follow tag filtering
+ _burnin_defs = copy.deepcopy(burnin_defs)
+ if repre_linked_burnins:
+ _burnin_defs = repre_linked_burnins
+
# Filter output definition by representation tags (optional)
repre_burnin_defs = self.filter_burnins_by_tags(
- burnin_defs, repre["tags"]
+ _burnin_defs, repre["tags"]
)
if not repre_burnin_defs:
self.log.info((
@@ -184,7 +210,9 @@ class ExtractBurnin(openpype.api.Extractor):
for key in self.positions:
value = burnin_def.get(key)
if value:
- burnin_values[key] = value
+ burnin_values[key] = value.replace(
+ "{task}", "{task[name]}"
+ )
# Remove "delete" tag from new representation
if "delete" in new_repre["tags"]:
@@ -281,6 +309,8 @@ class ExtractBurnin(openpype.api.Extractor):
# NOTE we maybe can keep source representation if necessary
instance.data["representations"].remove(repre)
+ self.log.debug("Files to delete: {}".format(files_to_delete))
+
# Delete input files
for filepath in files_to_delete:
if os.path.exists(filepath):
diff --git a/openpype/plugins/publish/extract_review.py b/openpype/plugins/publish/extract_review.py
index 264b362558..ba6ef17072 100644
--- a/openpype/plugins/publish/extract_review.py
+++ b/openpype/plugins/publish/extract_review.py
@@ -180,6 +180,9 @@ class ExtractReview(pyblish.api.InstancePlugin):
if "tags" not in output_def:
output_def["tags"] = []
+ if "burnins" not in output_def:
+ output_def["burnins"] = []
+
# Create copy of representation
new_repre = copy.deepcopy(repre)
@@ -192,8 +195,20 @@ class ExtractReview(pyblish.api.InstancePlugin):
if tag not in new_repre["tags"]:
new_repre["tags"].append(tag)
+ # Add burnin link from output definition to representation
+ for burnin in output_def["burnins"]:
+ if burnin not in new_repre.get("burnins", []):
+ if not new_repre.get("burnins"):
+ new_repre["burnins"] = []
+ new_repre["burnins"].append(str(burnin))
+
self.log.debug(
- "New representation tags: `{}`".format(new_repre["tags"])
+ "Linked burnins: `{}`".format(new_repre.get("burnins"))
+ )
+
+ self.log.debug(
+ "New representation tags: `{}`".format(
+ new_repre.get("tags"))
)
temp_data = self.prepare_temp_data(
@@ -232,12 +247,16 @@ class ExtractReview(pyblish.api.InstancePlugin):
for f in files_to_clean:
os.unlink(f)
- output_name = output_def["filename_suffix"]
+ output_name = new_repre.get("outputName", "")
+ output_ext = new_repre["ext"]
+ if output_name:
+ output_name += "_"
+ output_name += output_def["filename_suffix"]
if temp_data["without_handles"]:
output_name += "_noHandles"
new_repre.update({
- "name": output_def["filename_suffix"],
+ "name": "{}_{}".format(output_name, output_ext),
"outputName": output_name,
"outputDef": output_def,
"frameStartFtrack": temp_data["output_frame_start"],
diff --git a/openpype/plugins/publish/integrate_inputlinks.py b/openpype/plugins/publish/integrate_inputlinks.py
new file mode 100644
index 0000000000..e8a8b2296c
--- /dev/null
+++ b/openpype/plugins/publish/integrate_inputlinks.py
@@ -0,0 +1,130 @@
+
+from collections import OrderedDict
+from avalon import io
+import pyblish.api
+
+
+class IntegrateInputLinks(pyblish.api.ContextPlugin):
+ """Connecting version level dependency links"""
+
+ order = pyblish.api.IntegratorOrder + 0.2
+ label = "Connect Dependency InputLinks"
+
+ def process(self, context):
+ """Connect dependency links for all instances, globally
+
+ Code steps:
+ * filter out instances that has "versionEntity" entry in data
+ * find workfile instance within context
+ * if workfile found:
+ - link all `loadedVersions` as input of the workfile
+ - link workfile as input of all publishing instances
+ * else:
+ - show "no workfile" warning
+ * link instances' inputs if it's data has "inputVersions" entry
+ * Write into database
+
+ inputVersions:
+ The "inputVersions" in instance.data should be a list of
+ version document's Id (str or ObjectId), which are the
+ dependencies of the publishing instance that should be
+ extracted from working scene by the DCC specific publish
+ plugin.
+
+ """
+ workfile = None
+ publishing = []
+
+ for instance in context:
+ if not instance.data.get("publish", True):
+ # Skip inactive instances
+ continue
+
+ version_doc = instance.data.get("versionEntity")
+ if not version_doc:
+ self.log.debug("Instance %s doesn't have version." % instance)
+ continue
+
+ version_data = version_doc.get("data", {})
+ families = version_data.get("families", [])
+
+ if "workfile" in families:
+ workfile = instance
+ else:
+ publishing.append(instance)
+
+ if workfile is None:
+ self.log.warn("No workfile in this publish session.")
+ else:
+ workfile_version_doc = workfile.data["versionEntity"]
+ # link all loaded versions in scene into workfile
+ for version in context.data.get("loadedVersions", []):
+ self.add_link(
+ link_type="reference",
+ input_id=version["version"],
+ version_doc=workfile_version_doc,
+ )
+ # link workfile to all publishing versions
+ for instance in publishing:
+ self.add_link(
+ link_type="generative",
+ input_id=workfile_version_doc["_id"],
+ version_doc=instance.data["versionEntity"],
+ )
+
+ # link versions as dependencies to the instance
+ for instance in publishing:
+ for input_version in instance.data.get("inputVersions") or []:
+ self.add_link(
+ link_type="generative",
+ input_id=input_version,
+ version_doc=instance.data["versionEntity"],
+ )
+
+ publishing.append(workfile)
+ self.write_links_to_database(publishing)
+
+ def add_link(self, link_type, input_id, version_doc):
+ """Add dependency link data into version document
+
+ Args:
+ link_type (str): Type of link, one of 'reference' or 'generative'
+ input_id (str or ObjectId): Document Id of input version
+ version_doc (dict): The version document that takes the input
+
+ Returns:
+ None
+
+ """
+ # NOTE:
+ # using OrderedDict() here is just for ensuring field order between
+ # python versions, if we ever need to use mongodb operation '$addToSet'
+ # to update and avoid duplicating elements in 'inputLinks' array in the
+ # future.
+ link = OrderedDict()
+ link["type"] = link_type
+ link["input"] = io.ObjectId(input_id)
+ link["linkedBy"] = "publish"
+
+ if "inputLinks" not in version_doc["data"]:
+ version_doc["data"]["inputLinks"] = []
+ version_doc["data"]["inputLinks"].append(link)
+
+ def write_links_to_database(self, instances):
+ """Iter instances in context to update database
+
+ If `versionEntity.data.inputLinks` not None in `instance.data`, doc
+ in database will be updated.
+
+ """
+ for instance in instances:
+ version_doc = instance.data.get("versionEntity")
+ if version_doc is None:
+ continue
+
+ input_links = version_doc["data"].get("inputLinks")
+ if input_links is None:
+ continue
+
+ io.update_one({"_id": version_doc["_id"]},
+ {"$set": {"data.inputLinks": input_links}})
diff --git a/openpype/plugins/publish/integrate_new.py b/openpype/plugins/publish/integrate_new.py
index 7ff7466a2a..1b0b8da2ff 100644
--- a/openpype/plugins/publish/integrate_new.py
+++ b/openpype/plugins/publish/integrate_new.py
@@ -172,21 +172,26 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
anatomy_data["hierarchy"] = hierarchy
# Make sure task name in anatomy data is same as on instance.data
- task_name = instance.data.get("task")
- if task_name:
- anatomy_data["task"] = task_name
- else:
- # Just set 'task_name' variable to context task
- task_name = anatomy_data["task"]
-
- # Find task type for current task name
- # - this should be already prepared on instance
asset_tasks = (
asset_entity.get("data", {}).get("tasks")
) or {}
- task_info = asset_tasks.get(task_name) or {}
- task_type = task_info.get("type")
- instance.data["task_type"] = task_type
+ task_name = instance.data.get("task")
+ if task_name:
+ task_info = asset_tasks.get(task_name) or {}
+ task_type = task_info.get("type")
+
+ project_task_types = project_entity["config"]["tasks"]
+ task_code = project_task_types.get(task_type, {}).get("short_name")
+ anatomy_data["task"] = {
+ "name": task_name,
+ "type": task_type,
+ "short": task_code
+ }
+
+ else:
+ # Just set 'task_name' variable to context task
+ task_name = anatomy_data["task"]["name"]
+ task_type = anatomy_data["task"]["type"]
# Fill family in anatomy data
anatomy_data["family"] = instance.data.get("family")
@@ -804,11 +809,8 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
# - is there a chance that task name is not filled in anatomy
# data?
# - should we use context task in that case?
- task_name = (
- instance.data["anatomyData"]["task"]
- or io.Session["AVALON_TASK"]
- )
- task_type = instance.data["task_type"]
+ task_name = instance.data["anatomyData"]["task"]["name"]
+ task_type = instance.data["anatomyData"]["task"]["type"]
filtering_criteria = {
"families": instance.data["family"],
"hosts": instance.context.data["hostName"],
@@ -1069,10 +1071,12 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
already_attached_sites[meta["name"]] = meta["created_dt"]
if sync_project_presets and sync_project_presets["enabled"]:
- # add remote
- meta = {"name": remote_site.strip()}
- rec["sites"].append(meta)
- already_attached_sites[meta["name"]] = None
+ if remote_site and \
+ remote_site not in already_attached_sites.keys():
+ # add remote
+ meta = {"name": remote_site.strip()}
+ rec["sites"].append(meta)
+ already_attached_sites[meta["name"]] = None
# add skeleton for site where it should be always synced to
for always_on_site in always_accesible:
@@ -1100,8 +1104,6 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
local_site = local_site_id
remote_site = sync_project_presets["config"].get("remote_site")
- if remote_site == local_site:
- remote_site = None
if remote_site == 'local':
remote_site = local_site_id
diff --git a/openpype/plugins/publish/validate_editorial_asset_name.py b/openpype/plugins/publish/validate_editorial_asset_name.py
index eebba61af3..7359ccf360 100644
--- a/openpype/plugins/publish/validate_editorial_asset_name.py
+++ b/openpype/plugins/publish/validate_editorial_asset_name.py
@@ -12,6 +12,12 @@ class ValidateEditorialAssetName(pyblish.api.ContextPlugin):
order = pyblish.api.ValidatorOrder
label = "Validate Editorial Asset Name"
+ hosts = [
+ "hiero",
+ "standalonepublisher",
+ "resolve",
+ "flame"
+ ]
def process(self, context):
diff --git a/openpype/pype_commands.py b/openpype/pype_commands.py
index f0ba9a997e..519e7c285b 100644
--- a/openpype/pype_commands.py
+++ b/openpype/pype_commands.py
@@ -392,3 +392,10 @@ class PypeCommands:
import time
while True:
time.sleep(1.0)
+
+ def repack_version(self, directory):
+ """Repacking OpenPype version."""
+ from openpype.tools.repack_version import VersionRepacker
+
+ version_packer = VersionRepacker(directory)
+ version_packer.process()
diff --git a/openpype/settings/defaults/project_anatomy/imageio.json b/openpype/settings/defaults/project_anatomy/imageio.json
index fc34ef6813..09ab398c37 100644
--- a/openpype/settings/defaults/project_anatomy/imageio.json
+++ b/openpype/settings/defaults/project_anatomy/imageio.json
@@ -28,6 +28,9 @@
"viewer": {
"viewerProcess": "sRGB"
},
+ "baking": {
+ "viewerProcess": "rec709"
+ },
"workfile": {
"colorManagement": "Nuke",
"OCIO_config": "nuke-default",
diff --git a/openpype/settings/defaults/project_anatomy/templates.json b/openpype/settings/defaults/project_anatomy/templates.json
index 53abd35ed5..9a03b893bf 100644
--- a/openpype/settings/defaults/project_anatomy/templates.json
+++ b/openpype/settings/defaults/project_anatomy/templates.json
@@ -6,8 +6,8 @@
"frame": "{frame:0>{@frame_padding}}"
},
"work": {
- "folder": "{root[work]}/{project[name]}/{hierarchy}/{asset}/work/{task}",
- "file": "{project[code]}_{asset}_{task}_{@version}<_{comment}>.{ext}",
+ "folder": "{root[work]}/{project[name]}/{hierarchy}/{asset}/work/{task[name]}",
+ "file": "{project[code]}_{asset}_{task[name]}_{@version}<_{comment}>.{ext}",
"path": "{@folder}/{@file}"
},
"render": {
diff --git a/openpype/settings/defaults/project_settings/global.json b/openpype/settings/defaults/project_settings/global.json
index 9622f85a8e..55732f80ce 100644
--- a/openpype/settings/defaults/project_settings/global.json
+++ b/openpype/settings/defaults/project_settings/global.json
@@ -52,6 +52,7 @@
"burnin",
"ftrackreview"
],
+ "burnins": [],
"ffmpeg_args": {
"video_filters": [],
"audio_filters": [],
diff --git a/openpype/settings/defaults/project_settings/maya.json b/openpype/settings/defaults/project_settings/maya.json
index 689d6418ba..73c75ef3ee 100644
--- a/openpype/settings/defaults/project_settings/maya.json
+++ b/openpype/settings/defaults/project_settings/maya.json
@@ -42,7 +42,8 @@
"enabled": true,
"defaults": [
"Main"
- ]
+ ],
+ "aov_separator": "underscore"
},
"CreateAnimation": {
"enabled": true,
diff --git a/openpype/settings/defaults/project_settings/nuke.json b/openpype/settings/defaults/project_settings/nuke.json
index 069994d0e8..c3e229b8e8 100644
--- a/openpype/settings/defaults/project_settings/nuke.json
+++ b/openpype/settings/defaults/project_settings/nuke.json
@@ -110,7 +110,20 @@
},
"ExtractReviewDataMov": {
"enabled": true,
- "viewer_lut_raw": false
+ "viewer_lut_raw": false,
+ "outputs": {
+ "baking": {
+ "filter": {
+ "task_types": [],
+ "families": []
+ },
+ "extension": "mov",
+ "viewer_process_override": "",
+ "bake_viewer_process": true,
+ "bake_viewer_input_process": true,
+ "add_tags": []
+ }
+ }
},
"ExtractSlateFrame": {
"viewer_lut_raw": false
diff --git a/openpype/settings/defaults/project_settings/standalonepublisher.json b/openpype/settings/defaults/project_settings/standalonepublisher.json
index 50c1e34366..6858c4f34d 100644
--- a/openpype/settings/defaults/project_settings/standalonepublisher.json
+++ b/openpype/settings/defaults/project_settings/standalonepublisher.json
@@ -173,9 +173,9 @@
"workfile_families": [],
"texture_families": [],
"color_space": [
- "linsRGB",
- "raw",
- "acesg"
+ "sRGB",
+ "Raw",
+ "ACEScg"
],
"input_naming_patterns": {
"workfile": [
diff --git a/openpype/settings/defaults/project_settings/webpublisher.json b/openpype/settings/defaults/project_settings/webpublisher.json
index f57b79a609..9db98acd5a 100644
--- a/openpype/settings/defaults/project_settings/webpublisher.json
+++ b/openpype/settings/defaults/project_settings/webpublisher.json
@@ -115,6 +115,9 @@
"default_task_type": "Default task type"
}
}
+ },
+ "CollectTVPaintInstances": {
+ "layer_name_regex": "(?PL[0-9]{3}_\\w+)_(?P.+)"
}
}
}
\ No newline at end of file
diff --git a/openpype/settings/defaults/system_settings/modules.json b/openpype/settings/defaults/system_settings/modules.json
index 9c72598ff2..f0caa153de 100644
--- a/openpype/settings/defaults/system_settings/modules.json
+++ b/openpype/settings/defaults/system_settings/modules.json
@@ -188,5 +188,13 @@
},
"slack": {
"enabled": false
+ },
+ "job_queue": {
+ "server_url": "",
+ "jobs_root": {
+ "windows": "",
+ "darwin": "",
+ "linux": ""
+ }
}
}
\ No newline at end of file
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_webpublisher.json b/openpype/settings/entities/schemas/projects_schema/schema_project_webpublisher.json
index 91337da2b2..78f38f111d 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_webpublisher.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_webpublisher.json
@@ -62,8 +62,25 @@
}
}
]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "CollectTVPaintInstances",
+ "label": "Collect TVPaint Instances",
+ "children": [
+ {
+ "type": "label",
+ "label": "Regex helps to extract render layer and pass names from TVPaint layer name.
The regex must contain named groups 'layer' and 'pass' which are used for creation of RenderPass instances.
Example layer name: \"L001_Person_Hand\"
Example regex: \"(?P<layer>L[0-9]{3}_\\w+)_(?P<pass>.+)\"
Extracted layer: \"L001_Person\"
Extracted pass: \"Hand\""
+ },
+ {
+ "type": "text",
+ "key": "layer_name_regex",
+ "label": "Layer name regex"
+ }
+ ]
}
]
}
]
-}
\ No newline at end of file
+}
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json
index 7423d6fd3e..380ea4a83d 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_imageio.json
@@ -131,6 +131,19 @@
}
]
},
+ {
+ "key": "baking",
+ "type": "dict",
+ "label": "Extract-review baking profile",
+ "collapsible": false,
+ "children": [
+ {
+ "type": "text",
+ "key": "viewerProcess",
+ "label": "Viewer Process"
+ }
+ ]
+ },
{
"key": "workfile",
"type": "dict",
@@ -363,7 +376,7 @@
"key": "maya",
"type": "dict",
"label": "Maya",
- "children": [
+ "children": [
{
"key": "colorManagementPreference",
"type": "dict",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_templates.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_templates.json
index a8534e7e29..e208069e6f 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_templates.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_anatomy_templates.json
@@ -11,6 +11,10 @@
"type": "dict",
"key": "defaults",
"children": [
+ {
+ "type": "label",
+ "label": "The list of existing placeholders is available here:
https://openpype.io/docs/admin_settings_project_anatomy/#available-template-keys "
+ },
{
"type": "number",
"key": "version_padding",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json
index 375f0c26da..d146f3cf15 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_publish.json
@@ -212,6 +212,12 @@
"type": "schema",
"name": "schema_representation_tags"
},
+ {
+ "key": "burnins",
+ "label": "Link to a burnin by name",
+ "type": "list",
+ "object_type": "text"
+ },
{
"key": "ffmpeg_args",
"label": "FFmpeg arguments",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
index 44a35af7c1..e50357cc40 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_create.json
@@ -46,6 +46,18 @@
"key": "defaults",
"label": "Default Subsets",
"object_type": "text"
+ },
+ {
+ "key": "aov_separator",
+ "label": "AOV Separator character",
+ "type": "enum",
+ "multiselection": false,
+ "default": "underscore",
+ "enum_items": [
+ {"dash": "- (dash)"},
+ {"underscore": "_ (underscore)"},
+ {"dot": ". (dot)"}
+ ]
}
]
},
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json
index 74b2592d29..d6fc30c315 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_nuke_publish.json
@@ -167,7 +167,67 @@
"type": "boolean",
"key": "viewer_lut_raw",
"label": "Viewer LUT raw"
+ },
+ {
+ "key": "outputs",
+ "label": "Output Definitions",
+ "type": "dict-modifiable",
+ "highlight_content": true,
+ "object_type": {
+ "type": "dict",
+ "children": [
+ {
+ "type": "dict",
+ "collapsible": false,
+ "key": "filter",
+ "label": "Filtering",
+ "children": [
+ {
+ "key": "task_types",
+ "label": "Task types",
+ "type": "task-types-enum"
+ },
+ {
+ "key": "families",
+ "label": "Families",
+ "type": "list",
+ "object_type": "text"
+ }
+ ]
+ },
+ {
+ "type": "separator"
+ },
+ {
+ "type": "text",
+ "key": "extension",
+ "label": "File extension"
+ },
+ {
+ "type": "text",
+ "key": "viewer_process_override",
+ "label": "Viewer Process colorspace profile override"
+ },
+ {
+ "type": "boolean",
+ "key": "bake_viewer_process",
+ "label": "Bake Viewer Process"
+ },
+ {
+ "type": "boolean",
+ "key": "bake_viewer_input_process",
+ "label": "Bake Viewer Input Process (LUTs)"
+ },
+ {
+ "key": "add_tags",
+ "label": "Add additional tags to representations",
+ "type": "list",
+ "object_type": "text"
+ }
+ ]
+ }
}
+
]
},
{
diff --git a/openpype/settings/entities/schemas/system_schema/schema_modules.json b/openpype/settings/entities/schemas/system_schema/schema_modules.json
index aab1eea750..52595914ed 100644
--- a/openpype/settings/entities/schemas/system_schema/schema_modules.json
+++ b/openpype/settings/entities/schemas/system_schema/schema_modules.json
@@ -262,6 +262,38 @@
}
]
},
+ {
+ "type": "dict",
+ "key": "job_queue",
+ "label": "Job Queue",
+ "require_restart": true,
+ "collapsible": true,
+ "children": [
+ {
+ "type": "label",
+ "label": "Address of machine where job queue server is running."
+ },
+ {
+ "type": "text",
+ "key": "server_url",
+ "label": "Server Rest URL"
+ },
+ {
+ "type": "separator"
+ },
+ {
+ "type": "label",
+ "label": "Jobs root is used as temporary directory for workers where source is copied and render output can be stored."
+ },
+ {
+ "key": "jobs_root",
+ "label": "Jobs root",
+ "type": "path",
+ "multipath": false,
+ "multiplatform": true
+ }
+ ]
+ },
{
"type": "dynamic_schema",
"name": "system_settings/modules"
diff --git a/openpype/settings/lib.py b/openpype/settings/lib.py
index 60ed54bd4a..ff75562413 100644
--- a/openpype/settings/lib.py
+++ b/openpype/settings/lib.py
@@ -856,6 +856,7 @@ def get_anatomy_settings(
apply_local_settings_on_anatomy_settings(
result, local_settings, project_name, site_name
)
+
return result
diff --git a/openpype/style/__init__.py b/openpype/style/__init__.py
index fd39e93b5d..cb0595d522 100644
--- a/openpype/style/__init__.py
+++ b/openpype/style/__init__.py
@@ -128,9 +128,13 @@ def _load_font():
_FONT_IDS = []
fonts_dirpath = os.path.join(current_dir, "fonts")
font_dirs = []
- font_dirs.append(os.path.join(fonts_dirpath, "Montserrat"))
- font_dirs.append(os.path.join(fonts_dirpath, "Spartan"))
- font_dirs.append(os.path.join(fonts_dirpath, "RobotoMono", "static"))
+ font_dirs.append(os.path.join(fonts_dirpath, "Noto_Sans"))
+ font_dirs.append(os.path.join(
+ fonts_dirpath,
+ "Noto_Sans_Mono",
+ "static",
+ "NotoSansMono"
+ ))
loaded_fonts = []
for font_dir in font_dirs:
diff --git a/openpype/style/data.json b/openpype/style/data.json
index b92ee61764..977de50be2 100644
--- a/openpype/style/data.json
+++ b/openpype/style/data.json
@@ -18,7 +18,6 @@
"green-light": "hsl(155, 80%, 80%)"
},
"color": {
-
"font": "#D3D8DE",
"font-hover": "#F0F2F5",
"font-disabled": "#99A3B2",
@@ -50,7 +49,16 @@
"border": "#373D48",
"border-hover": "rgba(168, 175, 189, .3)",
- "border-focus": "hsl(200, 60%, 60%)",
+ "border-focus": "rgb(92, 173, 214)",
+
+ "tab-widget": {
+ "bg": "#21252B",
+ "bg-selected": "#434a56",
+ "bg-hover": "#373D48",
+ "color": "#99A3B2",
+ "color-selected": "#F0F2F5",
+ "color-hover": "#F0F2F5"
+ },
"loader": {
"asset-view": {
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Black.ttf b/openpype/style/fonts/Montserrat/Montserrat-Black.ttf
deleted file mode 100644
index 437b1157cb..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Black.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-BlackItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-BlackItalic.ttf
deleted file mode 100644
index 52348354c2..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-BlackItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Bold.ttf b/openpype/style/fonts/Montserrat/Montserrat-Bold.ttf
deleted file mode 100644
index 221819bca0..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Bold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-BoldItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-BoldItalic.ttf
deleted file mode 100644
index 9ae2bd240f..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-BoldItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-ExtraBold.ttf b/openpype/style/fonts/Montserrat/Montserrat-ExtraBold.ttf
deleted file mode 100644
index 80ea8061b0..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-ExtraBold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-ExtraBoldItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-ExtraBoldItalic.ttf
deleted file mode 100644
index 6c961e1cc9..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-ExtraBoldItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-ExtraLight.ttf b/openpype/style/fonts/Montserrat/Montserrat-ExtraLight.ttf
deleted file mode 100644
index ca0bbb6569..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-ExtraLight.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-ExtraLightItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-ExtraLightItalic.ttf
deleted file mode 100644
index f3c1559ec7..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-ExtraLightItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Italic.ttf b/openpype/style/fonts/Montserrat/Montserrat-Italic.ttf
deleted file mode 100644
index eb4232a0c2..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Italic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Light.ttf b/openpype/style/fonts/Montserrat/Montserrat-Light.ttf
deleted file mode 100644
index 990857de8e..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Light.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-LightItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-LightItalic.ttf
deleted file mode 100644
index 209604046b..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-LightItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Medium.ttf b/openpype/style/fonts/Montserrat/Montserrat-Medium.ttf
deleted file mode 100644
index 6e079f6984..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Medium.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-MediumItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-MediumItalic.ttf
deleted file mode 100644
index 0dc3ac9c29..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-MediumItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Regular.ttf b/openpype/style/fonts/Montserrat/Montserrat-Regular.ttf
deleted file mode 100644
index 8d443d5d56..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Regular.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-SemiBold.ttf b/openpype/style/fonts/Montserrat/Montserrat-SemiBold.ttf
deleted file mode 100644
index f8a43f2b20..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-SemiBold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-SemiBoldItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-SemiBoldItalic.ttf
deleted file mode 100644
index 336c56ec0c..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-SemiBoldItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-Thin.ttf b/openpype/style/fonts/Montserrat/Montserrat-Thin.ttf
deleted file mode 100644
index b9858757eb..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-Thin.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Montserrat/Montserrat-ThinItalic.ttf b/openpype/style/fonts/Montserrat/Montserrat-ThinItalic.ttf
deleted file mode 100644
index e488998ec7..0000000000
Binary files a/openpype/style/fonts/Montserrat/Montserrat-ThinItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Noto_Sans/NotoSans-Bold.ttf b/openpype/style/fonts/Noto_Sans/NotoSans-Bold.ttf
new file mode 100644
index 0000000000..54ad879b41
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans/NotoSans-Bold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans/NotoSans-BoldItalic.ttf b/openpype/style/fonts/Noto_Sans/NotoSans-BoldItalic.ttf
new file mode 100644
index 0000000000..530a82835d
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans/NotoSans-BoldItalic.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans/NotoSans-Italic.ttf b/openpype/style/fonts/Noto_Sans/NotoSans-Italic.ttf
new file mode 100644
index 0000000000..27ff1ed60a
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans/NotoSans-Italic.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans/NotoSans-Regular.ttf b/openpype/style/fonts/Noto_Sans/NotoSans-Regular.ttf
new file mode 100644
index 0000000000..10589e277e
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans/NotoSans-Regular.ttf differ
diff --git a/openpype/style/fonts/Spartan/OFL.txt b/openpype/style/fonts/Noto_Sans/OFL.txt
similarity index 98%
rename from openpype/style/fonts/Spartan/OFL.txt
rename to openpype/style/fonts/Noto_Sans/OFL.txt
index 808b610ffd..c9857270cc 100644
--- a/openpype/style/fonts/Spartan/OFL.txt
+++ b/openpype/style/fonts/Noto_Sans/OFL.txt
@@ -1,4 +1,4 @@
-Copyright 2020 The Spartan Project Authors (https://github.com/bghryct/Spartan-MB)
+Copyright 2012 Google Inc. All Rights Reserved.
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
diff --git a/openpype/style/fonts/Noto_Sans_Mono/NotoSansMono-VariableFont_wdth,wght.ttf b/openpype/style/fonts/Noto_Sans_Mono/NotoSansMono-VariableFont_wdth,wght.ttf
new file mode 100644
index 0000000000..9dabd9e7a4
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/NotoSansMono-VariableFont_wdth,wght.ttf differ
diff --git a/openpype/style/fonts/Montserrat/OFL.txt b/openpype/style/fonts/Noto_Sans_Mono/OFL.txt
similarity index 97%
rename from openpype/style/fonts/Montserrat/OFL.txt
rename to openpype/style/fonts/Noto_Sans_Mono/OFL.txt
index f435ed8b5e..c9857270cc 100644
--- a/openpype/style/fonts/Montserrat/OFL.txt
+++ b/openpype/style/fonts/Noto_Sans_Mono/OFL.txt
@@ -1,4 +1,4 @@
-Copyright 2011 The Montserrat Project Authors (https://github.com/JulietaUla/Montserrat)
+Copyright 2012 Google Inc. All Rights Reserved.
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
diff --git a/openpype/style/fonts/Noto_Sans_Mono/README.txt b/openpype/style/fonts/Noto_Sans_Mono/README.txt
new file mode 100644
index 0000000000..b8a8fdb965
--- /dev/null
+++ b/openpype/style/fonts/Noto_Sans_Mono/README.txt
@@ -0,0 +1,99 @@
+Noto Sans Mono Variable Font
+============================
+
+This download contains Noto Sans Mono as both a variable font and static fonts.
+
+Noto Sans Mono is a variable font with these axes:
+ wdth
+ wght
+
+This means all the styles are contained in a single file:
+ NotoSansMono-VariableFont_wdth,wght.ttf
+
+If your app fully supports variable fonts, you can now pick intermediate styles
+that aren’t available as static fonts. Not all apps support variable fonts, and
+in those cases you can use the static font files for Noto Sans Mono:
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Thin.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraLight.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Light.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Regular.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Medium.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-SemiBold.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Bold.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraBold.ttf
+ static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Black.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Thin.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraLight.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Light.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Regular.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Medium.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-SemiBold.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Bold.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraBold.ttf
+ static/NotoSansMono_Condensed/NotoSansMono_Condensed-Black.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Thin.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraLight.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Light.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Regular.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Medium.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-SemiBold.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Bold.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraBold.ttf
+ static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Black.ttf
+ static/NotoSansMono/NotoSansMono-Thin.ttf
+ static/NotoSansMono/NotoSansMono-ExtraLight.ttf
+ static/NotoSansMono/NotoSansMono-Light.ttf
+ static/NotoSansMono/NotoSansMono-Regular.ttf
+ static/NotoSansMono/NotoSansMono-Medium.ttf
+ static/NotoSansMono/NotoSansMono-SemiBold.ttf
+ static/NotoSansMono/NotoSansMono-Bold.ttf
+ static/NotoSansMono/NotoSansMono-ExtraBold.ttf
+ static/NotoSansMono/NotoSansMono-Black.ttf
+
+Get started
+-----------
+
+1. Install the font files you want to use
+
+2. Use your app's font picker to view the font family and all the
+available styles
+
+Learn more about variable fonts
+-------------------------------
+
+ https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
+ https://variablefonts.typenetwork.com
+ https://medium.com/variable-fonts
+
+In desktop apps
+
+ https://theblog.adobe.com/can-variable-fonts-illustrator-cc
+ https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts
+
+Online
+
+ https://developers.google.com/fonts/docs/getting_started
+ https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
+ https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts
+
+Installing fonts
+
+ MacOS: https://support.apple.com/en-us/HT201749
+ Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
+ Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
+
+Android Apps
+
+ https://developers.google.com/fonts/docs/android
+ https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts
+
+License
+-------
+Please read the full license text (OFL.txt) to understand the permissions,
+restrictions and requirements for usage, redistribution, and modification.
+
+You can use them freely in your products & projects - print or digital,
+commercial or otherwise.
+
+This isn't legal advice, please consider consulting a lawyer and see the full
+license for all details.
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Black.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Black.ttf
new file mode 100644
index 0000000000..75fe4b4fe9
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Black.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Bold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Bold.ttf
new file mode 100644
index 0000000000..9cefe497da
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Bold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraBold.ttf
new file mode 100644
index 0000000000..9961afc716
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraLight.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraLight.ttf
new file mode 100644
index 0000000000..03ab3f87f2
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-ExtraLight.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Light.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Light.ttf
new file mode 100644
index 0000000000..19a5af2422
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Light.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Medium.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Medium.ttf
new file mode 100644
index 0000000000..62231544b0
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Medium.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Regular.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Regular.ttf
new file mode 100644
index 0000000000..a850b21ca3
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Regular.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-SemiBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-SemiBold.ttf
new file mode 100644
index 0000000000..0f4dffc421
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-SemiBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Thin.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Thin.ttf
new file mode 100644
index 0000000000..0ecd83c350
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono/NotoSansMono-Thin.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Black.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Black.ttf
new file mode 100644
index 0000000000..77ef132a1c
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Black.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Bold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Bold.ttf
new file mode 100644
index 0000000000..41dbc9e543
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Bold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraBold.ttf
new file mode 100644
index 0000000000..640ae09cec
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraLight.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraLight.ttf
new file mode 100644
index 0000000000..02fe86abbb
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-ExtraLight.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Light.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Light.ttf
new file mode 100644
index 0000000000..a0dfac1f80
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Light.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Medium.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Medium.ttf
new file mode 100644
index 0000000000..72a1fa5a87
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Medium.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Regular.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Regular.ttf
new file mode 100644
index 0000000000..8e8591cd89
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Regular.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-SemiBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-SemiBold.ttf
new file mode 100644
index 0000000000..b7843ceb04
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-SemiBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Thin.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Thin.ttf
new file mode 100644
index 0000000000..42f4493555
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_Condensed/NotoSansMono_Condensed-Thin.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Black.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Black.ttf
new file mode 100644
index 0000000000..6ad6ad9188
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Black.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Bold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Bold.ttf
new file mode 100644
index 0000000000..4cdda1512c
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Bold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraBold.ttf
new file mode 100644
index 0000000000..0d428829a9
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraLight.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraLight.ttf
new file mode 100644
index 0000000000..c3b01f97c4
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-ExtraLight.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Light.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Light.ttf
new file mode 100644
index 0000000000..be5b1209e8
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Light.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Medium.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Medium.ttf
new file mode 100644
index 0000000000..5fbb4d9a55
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Medium.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Regular.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Regular.ttf
new file mode 100644
index 0000000000..eac82bf3b4
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Regular.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-SemiBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-SemiBold.ttf
new file mode 100644
index 0000000000..9a75e32feb
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-SemiBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Thin.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Thin.ttf
new file mode 100644
index 0000000000..b710820d7e
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_ExtraCondensed/NotoSansMono_ExtraCondensed-Thin.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Black.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Black.ttf
new file mode 100644
index 0000000000..ef0f93add8
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Black.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Bold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Bold.ttf
new file mode 100644
index 0000000000..bb7091a355
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Bold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraBold.ttf
new file mode 100644
index 0000000000..a737a65a72
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraLight.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraLight.ttf
new file mode 100644
index 0000000000..2a95000602
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-ExtraLight.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Light.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Light.ttf
new file mode 100644
index 0000000000..07906bdabe
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Light.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Medium.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Medium.ttf
new file mode 100644
index 0000000000..89d75e39f8
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Medium.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Regular.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Regular.ttf
new file mode 100644
index 0000000000..0c654e79b1
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Regular.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-SemiBold.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-SemiBold.ttf
new file mode 100644
index 0000000000..e93689fefd
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-SemiBold.ttf differ
diff --git a/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Thin.ttf b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Thin.ttf
new file mode 100644
index 0000000000..b4f1804a74
Binary files /dev/null and b/openpype/style/fonts/Noto_Sans_Mono/static/NotoSansMono_SemiCondensed/NotoSansMono_SemiCondensed-Thin.ttf differ
diff --git a/openpype/style/fonts/RobotoMono/LICENSE.txt b/openpype/style/fonts/RobotoMono/LICENSE.txt
deleted file mode 100644
index d645695673..0000000000
--- a/openpype/style/fonts/RobotoMono/LICENSE.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/openpype/style/fonts/RobotoMono/README.txt b/openpype/style/fonts/RobotoMono/README.txt
deleted file mode 100644
index 1bc1b1cfa2..0000000000
--- a/openpype/style/fonts/RobotoMono/README.txt
+++ /dev/null
@@ -1,77 +0,0 @@
-Roboto Mono Variable Font
-=========================
-
-This download contains Roboto Mono as both variable fonts and static fonts.
-
-Roboto Mono is a variable font with this axis:
- wght
-
-This means all the styles are contained in these files:
- RobotoMono-VariableFont_wght.ttf
- RobotoMono-Italic-VariableFont_wght.ttf
-
-If your app fully supports variable fonts, you can now pick intermediate styles
-that aren’t available as static fonts. Not all apps support variable fonts, and
-in those cases you can use the static font files for Roboto Mono:
- static/RobotoMono-Thin.ttf
- static/RobotoMono-ExtraLight.ttf
- static/RobotoMono-Light.ttf
- static/RobotoMono-Regular.ttf
- static/RobotoMono-Medium.ttf
- static/RobotoMono-SemiBold.ttf
- static/RobotoMono-Bold.ttf
- static/RobotoMono-ThinItalic.ttf
- static/RobotoMono-ExtraLightItalic.ttf
- static/RobotoMono-LightItalic.ttf
- static/RobotoMono-Italic.ttf
- static/RobotoMono-MediumItalic.ttf
- static/RobotoMono-SemiBoldItalic.ttf
- static/RobotoMono-BoldItalic.ttf
-
-Get started
------------
-
-1. Install the font files you want to use
-
-2. Use your app's font picker to view the font family and all the
-available styles
-
-Learn more about variable fonts
--------------------------------
-
- https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
- https://variablefonts.typenetwork.com
- https://medium.com/variable-fonts
-
-In desktop apps
-
- https://theblog.adobe.com/can-variable-fonts-illustrator-cc
- https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts
-
-Online
-
- https://developers.google.com/fonts/docs/getting_started
- https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
- https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts
-
-Installing fonts
-
- MacOS: https://support.apple.com/en-us/HT201749
- Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
- Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
-
-Android Apps
-
- https://developers.google.com/fonts/docs/android
- https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts
-
-License
--------
-Please read the full license text (LICENSE.txt) to understand the permissions,
-restrictions and requirements for usage, redistribution, and modification.
-
-You can use them freely in your products & projects - print or digital,
-commercial or otherwise.
-
-This isn't legal advice, please consider consulting a lawyer and see the full
-license for all details.
diff --git a/openpype/style/fonts/RobotoMono/RobotoMono-Italic-VariableFont_wght.ttf b/openpype/style/fonts/RobotoMono/RobotoMono-Italic-VariableFont_wght.ttf
deleted file mode 100644
index d30055a9e8..0000000000
Binary files a/openpype/style/fonts/RobotoMono/RobotoMono-Italic-VariableFont_wght.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/RobotoMono-VariableFont_wght.ttf b/openpype/style/fonts/RobotoMono/RobotoMono-VariableFont_wght.ttf
deleted file mode 100644
index d2b4746196..0000000000
Binary files a/openpype/style/fonts/RobotoMono/RobotoMono-VariableFont_wght.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Bold.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Bold.ttf
deleted file mode 100644
index 900fce6848..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Bold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-BoldItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-BoldItalic.ttf
deleted file mode 100644
index 4bfe29ae89..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-BoldItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLight.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLight.ttf
deleted file mode 100644
index d535884553..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLight.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLightItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLightItalic.ttf
deleted file mode 100644
index b28960a0ee..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-ExtraLightItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Italic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Italic.ttf
deleted file mode 100644
index 4ee4dc49b4..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Italic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Light.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Light.ttf
deleted file mode 100644
index 276af4c55a..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Light.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-LightItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-LightItalic.ttf
deleted file mode 100644
index a2801c2168..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-LightItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Medium.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Medium.ttf
deleted file mode 100644
index 8461be77a3..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Medium.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-MediumItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-MediumItalic.ttf
deleted file mode 100644
index a3bfaa115a..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-MediumItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Regular.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Regular.ttf
deleted file mode 100644
index 7c4ce36a44..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Regular.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBold.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBold.ttf
deleted file mode 100644
index 15ee6c6e40..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBoldItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBoldItalic.ttf
deleted file mode 100644
index 8e21497793..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-SemiBoldItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-Thin.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-Thin.ttf
deleted file mode 100644
index ee8a3fd41a..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-Thin.ttf and /dev/null differ
diff --git a/openpype/style/fonts/RobotoMono/static/RobotoMono-ThinItalic.ttf b/openpype/style/fonts/RobotoMono/static/RobotoMono-ThinItalic.ttf
deleted file mode 100644
index 40b01e40de..0000000000
Binary files a/openpype/style/fonts/RobotoMono/static/RobotoMono-ThinItalic.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/README.txt b/openpype/style/fonts/Spartan/README.txt
deleted file mode 100644
index 9db64aff0b..0000000000
--- a/openpype/style/fonts/Spartan/README.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-Spartan Variable Font
-=====================
-
-This download contains Spartan as both a variable font and static fonts.
-
-Spartan is a variable font with this axis:
- wght
-
-This means all the styles are contained in a single file:
- Spartan-VariableFont_wght.ttf
-
-If your app fully supports variable fonts, you can now pick intermediate styles
-that aren’t available as static fonts. Not all apps support variable fonts, and
-in those cases you can use the static font files for Spartan:
- static/Spartan-Thin.ttf
- static/Spartan-ExtraLight.ttf
- static/Spartan-Light.ttf
- static/Spartan-Regular.ttf
- static/Spartan-Medium.ttf
- static/Spartan-SemiBold.ttf
- static/Spartan-Bold.ttf
- static/Spartan-ExtraBold.ttf
- static/Spartan-Black.ttf
-
-Get started
------------
-
-1. Install the font files you want to use
-
-2. Use your app's font picker to view the font family and all the
-available styles
-
-Learn more about variable fonts
--------------------------------
-
- https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
- https://variablefonts.typenetwork.com
- https://medium.com/variable-fonts
-
-In desktop apps
-
- https://theblog.adobe.com/can-variable-fonts-illustrator-cc
- https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts
-
-Online
-
- https://developers.google.com/fonts/docs/getting_started
- https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
- https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts
-
-Installing fonts
-
- MacOS: https://support.apple.com/en-us/HT201749
- Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
- Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
-
-Android Apps
-
- https://developers.google.com/fonts/docs/android
- https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts
-
-License
--------
-Please read the full license text (OFL.txt) to understand the permissions,
-restrictions and requirements for usage, redistribution, and modification.
-
-You can use them freely in your products & projects - print or digital,
-commercial or otherwise. However, you can't sell the fonts on their own.
-
-This isn't legal advice, please consider consulting a lawyer and see the full
-license for all details.
diff --git a/openpype/style/fonts/Spartan/Spartan-Black.ttf b/openpype/style/fonts/Spartan/Spartan-Black.ttf
deleted file mode 100644
index 5d3147011e..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Black.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-Bold.ttf b/openpype/style/fonts/Spartan/Spartan-Bold.ttf
deleted file mode 100644
index 5fe4b702b2..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Bold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-ExtraBold.ttf b/openpype/style/fonts/Spartan/Spartan-ExtraBold.ttf
deleted file mode 100644
index 1030b6dec0..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-ExtraBold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-ExtraLight.ttf b/openpype/style/fonts/Spartan/Spartan-ExtraLight.ttf
deleted file mode 100644
index aced3a9e94..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-ExtraLight.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-Light.ttf b/openpype/style/fonts/Spartan/Spartan-Light.ttf
deleted file mode 100644
index 3bb6efa40e..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Light.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-Medium.ttf b/openpype/style/fonts/Spartan/Spartan-Medium.ttf
deleted file mode 100644
index 94b22ecc08..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Medium.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-Regular.ttf b/openpype/style/fonts/Spartan/Spartan-Regular.ttf
deleted file mode 100644
index 7560322e3f..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Regular.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-SemiBold.ttf b/openpype/style/fonts/Spartan/Spartan-SemiBold.ttf
deleted file mode 100644
index 7a5f74adb3..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-SemiBold.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-Thin.ttf b/openpype/style/fonts/Spartan/Spartan-Thin.ttf
deleted file mode 100644
index 4caa0b2be9..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-Thin.ttf and /dev/null differ
diff --git a/openpype/style/fonts/Spartan/Spartan-VariableFont_wght.ttf b/openpype/style/fonts/Spartan/Spartan-VariableFont_wght.ttf
deleted file mode 100644
index b2dd7c3076..0000000000
Binary files a/openpype/style/fonts/Spartan/Spartan-VariableFont_wght.ttf and /dev/null differ
diff --git a/openpype/style/style.css b/openpype/style/style.css
index 89458fd117..fa5b41cd07 100644
--- a/openpype/style/style.css
+++ b/openpype/style/style.css
@@ -19,8 +19,8 @@ Enabled vs Disabled logic in most of stylesheets
*/
* {
- font-size: 9pt;
- font-family: "Spartan";
+ font-size: 10pt;
+ font-family: "Noto Sans";
font-weight: 450;
outline: none;
}
@@ -325,47 +325,38 @@ QTabWidget::pane {
/* move to the right to not mess with borders of widget underneath */
QTabWidget::tab-bar {
- left: 2px;
+ alignment: left;
}
QTabBar::tab {
- padding: 5px;
- border-left: 3px solid transparent;
border-top: 1px solid {color:border};
+ border-left: 1px solid {color:border};
border-right: 1px solid {color:border};
- /* must be single like because of Nuke*/
- background: qlineargradient(x1: 0, y1: 1, x2: 0, y2: 0,stop: 0.5 {color:bg}, stop: 1.0 {color:bg-inputs});
+ padding: 5px;
+ background: {color:tab-widget:bg};
+ color: {color:tab-widget:color};
}
QTabBar::tab:selected {
- background: {color:grey-lighter};
- border-left: 3px solid {color:border-focus};
- /* must be single like because of Nuke*/
- background: qlineargradient(x1: 0, y1: 1, x2: 0, y2: 0,stop: 0.5 {color:bg}, stop: 1.0 {color:border});
-}
-
-QTabBar::tab:!selected {
- background: {color:grey-light};
+ border-left-color: {color:tab-widget:bg-selected};
+ border-right-color: {color:tab-widget:bg-selected};
+ border-top-color: {color:border-focus};
+ background: {color:tab-widget:bg-selected};
+ color: {color:tab-widget:color-selected};
}
+QTabBar::tab:!selected {}
QTabBar::tab:!selected:hover {
- background: {color:grey-lighter};
+ background: {color:tab-widget:bg-hover};
+ color: {color:tab-widget:color-hover};
}
-QTabBar::tab:first {
- border-left: 1px solid {color:border};
-}
-QTabBar::tab:first:selected {
- margin-left: 0;
- border-left: 3px solid {color:border-focus};
-}
-
-QTabBar::tab:last:selected {
- margin-right: 0;
-}
-
-QTabBar::tab:only-one {
- margin: 0;
+QTabBar::tab:first {}
+QTabBar::tab:first:selected {}
+QTabBar::tab:last:!selected {
+ border-right: 1px solid {color:border};
}
+QTabBar::tab:last:selected {}
+QTabBar::tab:only-one {}
QHeaderView {
border: 0px solid {color:border};
@@ -722,20 +713,19 @@ QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical {
}
#CompleterView::item {
- padding: 2px 4px 2px 4px;
- border-left: 3px solid {color:bg-view};
+ background: {color:bg-view-hover};
+ color: {color:font};
+ padding-left: 0px;
}
#CompleterView::item:hover {
- border-left-color: {palette:blue-base};
- background: {color:bg-view-selection};
- color: {color:font};
+ background: {color:bg-view-hover};
}
/* Launcher specific stylesheets */
#IconView[mode="icon"] {
/* font size can't be set on items */
- font-size: 8pt;
+ font-size: 9pt;
border: 0px;
padding: 0px;
margin: 0px;
@@ -765,15 +755,46 @@ QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical {
border: 1px solid {color:border};
border-radius: 0.1em;
}
+
/* Subset Manager */
#SubsetManagerDetailsText {}
#SubsetManagerDetailsText[state="invalid"] {
border: 1px solid #ff0000;
}
+/* Creator */
+#CreatorsView::item {
+ padding: 1px 5px;
+}
+
+#CreatorFamilyLabel {
+ font-size: 10pt;
+ font-weight: bold;
+}
+
+/* Scene Inventory */
+#ButtonWithMenu {
+ padding-right: 16px;
+ border: 1px solid #4A4949;
+ border-radius: 2px;
+}
+#ButtonWithMenu::menu-button {
+ border: 1px solid #4A4949;
+ width: 12px;
+ border-top-left-radius: 0px;
+ border-top-right-radius: 2px;
+ border-bottom-right-radius: 2px;
+ border-bottom-left-radius: 0px;
+}
+
+#ButtonWithMenu[state="1"], #ButtonWithMenu[state="1"]::menu-button, #ButtonWithMenu[state="1"]::menu-button:hover {
+ border-color: green;
+}
+
/* Python console interpreter */
#PythonInterpreterOutput, #PythonCodeEditor {
- font-family: "Roboto Mono";
+ font-family: "Noto Sans Mono";
+ border-radius: 0px;
}
#SubsetView::item, #RepresentationView:item {
@@ -791,7 +812,7 @@ QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical {
/* New Create/Publish UI */
#PublishLogConsole {
- font-family: "Roboto Mono";
+ font-family: "Noto Sans Mono";
}
#VariantInput[state="new"], #VariantInput[state="new"]:focus, #VariantInput[state="new"]:hover {
diff --git a/openpype/tools/assetcreator/app.py b/openpype/tools/assetcreator/app.py
index 5c2553e81e..58697e8aa3 100644
--- a/openpype/tools/assetcreator/app.py
+++ b/openpype/tools/assetcreator/app.py
@@ -1,16 +1,12 @@
import os
import sys
-import json
from subprocess import Popen
-try:
- import ftrack_api_old as ftrack_api
-except Exception:
- import ftrack_api
+
+import ftrack_api
+from Qt import QtWidgets, QtCore
from openpype.api import get_current_project_settings
-from openpype import lib as pypelib
-from avalon.vendor.Qt import QtWidgets, QtCore
+from openpype.tools.utils.lib import qt_app_context
from avalon import io, api, style, schema
-from avalon.tools import lib as parentlib
from . import widget, model
module = sys.modules[__name__]
@@ -630,7 +626,7 @@ def show(parent=None, debug=False, context=None):
if debug is True:
io.install()
- with parentlib.application():
+ with qt_app_context():
window = Window(parent, context)
window.setStyleSheet(style.load_stylesheet())
window.show()
diff --git a/openpype/tools/assetlinks/__init__.py b/openpype/tools/assetlinks/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/openpype/tools/assetlinks/widgets.py b/openpype/tools/assetlinks/widgets.py
new file mode 100644
index 0000000000..9a136462b0
--- /dev/null
+++ b/openpype/tools/assetlinks/widgets.py
@@ -0,0 +1,85 @@
+
+from Qt import QtWidgets
+
+
+class SimpleLinkView(QtWidgets.QWidget):
+
+ def __init__(self, dbcon, parent=None):
+ super(SimpleLinkView, self).__init__(parent=parent)
+ self.dbcon = dbcon
+
+ # TODO: display selected target
+
+ in_text = QtWidgets.QLabel("Inputs")
+ in_view = QtWidgets.QListWidget(parent=self)
+ out_text = QtWidgets.QLabel("Outputs")
+ out_view = QtWidgets.QListWidget(parent=self)
+
+ layout = QtWidgets.QGridLayout(self)
+ layout.setContentsMargins(0, 0, 0, 0)
+ layout.addWidget(in_text, 0, 0)
+ layout.addWidget(in_view, 1, 0)
+ layout.addWidget(out_text, 0, 1)
+ layout.addWidget(out_view, 1, 1)
+
+ self._in_view = in_view
+ self._out_view = out_view
+
+ def clear(self):
+ self._in_view.clear()
+ self._out_view.clear()
+
+ def set_version(self, version_doc):
+ self.clear()
+ if not version_doc or not self.isVisible():
+ return
+
+ # inputs
+ #
+ for link in version_doc["data"].get("inputLinks", []):
+ version = self.dbcon.find_one(
+ {"_id": link["input"], "type": "version"},
+ projection={"name": 1, "parent": 1}
+ )
+ if not version:
+ continue
+ subset = self.dbcon.find_one(
+ {"_id": version["parent"], "type": "subset"},
+ projection={"name": 1, "parent": 1}
+ )
+ if not subset:
+ continue
+ asset = self.dbcon.find_one(
+ {"_id": subset["parent"], "type": "asset"},
+ projection={"name": 1}
+ )
+
+ self._in_view.addItem("{asset} {subset} v{version:0>3}".format(
+ asset=asset["name"],
+ subset=subset["name"],
+ version=version["name"],
+ ))
+
+ # outputs
+ #
+ outputs = self.dbcon.find(
+ {"type": "version", "data.inputLinks.input": version_doc["_id"]},
+ projection={"name": 1, "parent": 1}
+ )
+ for version in outputs or []:
+ subset = self.dbcon.find_one(
+ {"_id": version["parent"], "type": "subset"},
+ projection={"name": 1, "parent": 1}
+ )
+ if not subset:
+ continue
+ asset = self.dbcon.find_one(
+ {"_id": subset["parent"], "type": "asset"},
+ projection={"name": 1}
+ )
+
+ self._out_view.addItem("{asset} {subset} v{version:0>3}".format(
+ asset=asset["name"],
+ subset=subset["name"],
+ version=version["name"],
+ ))
diff --git a/openpype/tools/context_dialog/window.py b/openpype/tools/context_dialog/window.py
index 3e7c8c7065..5d8a2ad62e 100644
--- a/openpype/tools/context_dialog/window.py
+++ b/openpype/tools/context_dialog/window.py
@@ -6,7 +6,7 @@ from avalon.api import AvalonMongoDB
from openpype import style
from openpype.tools.utils.lib import center_window
-from openpype.tools.utils.widgets import AssetWidget
+from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget
from openpype.tools.utils.constants import (
PROJECT_NAME_ROLE
)
@@ -65,8 +65,8 @@ class ContextDialog(QtWidgets.QDialog):
project_combobox.setModel(project_proxy)
# Assets widget
- assets_widget = AssetWidget(
- dbcon, multiselection=False, parent=left_side_widget
+ assets_widget = SingleSelectAssetsWidget(
+ dbcon, parent=left_side_widget
)
left_side_layout = QtWidgets.QVBoxLayout(left_side_widget)
@@ -113,9 +113,7 @@ class ContextDialog(QtWidgets.QDialog):
assets_widget.selection_changed.connect(self._on_asset_change)
assets_widget.refresh_triggered.connect(self._on_asset_refresh_trigger)
assets_widget.refreshed.connect(self._on_asset_widget_refresh_finished)
- tasks_widget.task_changed.selectionChanged.connect(
- self._on_task_change
- )
+ tasks_widget.task_changed.connect(self._on_task_change)
ok_btn.clicked.connect(self._on_ok_click)
self._dbcon = dbcon
@@ -311,11 +309,8 @@ class ContextDialog(QtWidgets.QDialog):
def _set_asset_to_tasks_widget(self):
# filter None docs they are silo
- asset_docs = self._assets_widget.get_selected_assets()
- asset_ids = [asset_doc["_id"] for asset_doc in asset_docs]
- asset_id = None
- if asset_ids:
- asset_id = asset_ids[0]
+ asset_id = self._assets_widget.get_selected_asset_id()
+
self._tasks_widget.set_asset_id(asset_id)
def _confirm_values(self):
@@ -336,11 +331,7 @@ class ContextDialog(QtWidgets.QDialog):
def get_selected_asset(self):
"""Currently selected asset in asset widget."""
- asset_name = None
- for asset_doc in self._assets_widget.get_selected_assets():
- asset_name = asset_doc["name"]
- break
- return asset_name
+ return self._assets_widget.get_selected_asset_name()
def get_selected_task(self):
"""Currently selected task."""
diff --git a/openpype/tools/creator/__init__.py b/openpype/tools/creator/__init__.py
new file mode 100644
index 0000000000..585b8bdf80
--- /dev/null
+++ b/openpype/tools/creator/__init__.py
@@ -0,0 +1,9 @@
+from .window import (
+ show,
+ CreatorWindow
+)
+
+__all__ = (
+ "show",
+ "CreatorWindow"
+)
diff --git a/openpype/tools/creator/constants.py b/openpype/tools/creator/constants.py
new file mode 100644
index 0000000000..26a25dc010
--- /dev/null
+++ b/openpype/tools/creator/constants.py
@@ -0,0 +1,8 @@
+from Qt import QtCore
+
+
+FAMILY_ROLE = QtCore.Qt.UserRole + 1
+ITEM_ID_ROLE = QtCore.Qt.UserRole + 2
+
+SEPARATOR = "---"
+SEPARATORS = {"---", "---separator---"}
diff --git a/openpype/tools/creator/model.py b/openpype/tools/creator/model.py
new file mode 100644
index 0000000000..6907e8f0aa
--- /dev/null
+++ b/openpype/tools/creator/model.py
@@ -0,0 +1,55 @@
+import uuid
+from Qt import QtGui, QtCore
+
+from avalon import api
+
+from . constants import (
+ FAMILY_ROLE,
+ ITEM_ID_ROLE
+)
+
+
+class CreatorsModel(QtGui.QStandardItemModel):
+ def __init__(self, *args, **kwargs):
+ super(CreatorsModel, self).__init__(*args, **kwargs)
+
+ self._creators_by_id = {}
+
+ def reset(self):
+ # TODO change to refresh when clearing is not needed
+ self.clear()
+ self._creators_by_id = {}
+
+ items = []
+ creators = api.discover(api.Creator)
+ for creator in creators:
+ item_id = str(uuid.uuid4())
+ self._creators_by_id[item_id] = creator
+
+ label = creator.label or creator.family
+ item = QtGui.QStandardItem(label)
+ item.setEditable(False)
+ item.setData(item_id, ITEM_ID_ROLE)
+ item.setData(creator.family, FAMILY_ROLE)
+ items.append(item)
+
+ if not items:
+ item = QtGui.QStandardItem("No registered families")
+ item.setEnabled(False)
+ item.setData(QtCore.Qt.ItemIsEnabled, False)
+ items.append(item)
+
+ self.invisibleRootItem().appendRows(items)
+
+ def get_creator_by_id(self, item_id):
+ return self._creators_by_id.get(item_id)
+
+ def get_indexes_by_family(self, family):
+ indexes = []
+ for row in range(self.rowCount()):
+ index = self.index(row, 0)
+ item_id = index.data(ITEM_ID_ROLE)
+ creator_plugin = self._creators_by_id.get(item_id)
+ if creator_plugin and creator_plugin.family == family:
+ indexes.append(index)
+ return indexes
diff --git a/openpype/tools/creator/widgets.py b/openpype/tools/creator/widgets.py
new file mode 100644
index 0000000000..89c90cc048
--- /dev/null
+++ b/openpype/tools/creator/widgets.py
@@ -0,0 +1,266 @@
+import re
+import inspect
+
+from Qt import QtWidgets, QtCore, QtGui
+
+from avalon.vendor import qtawesome
+
+from openpype import style
+from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS
+
+
+class CreateErrorMessageBox(QtWidgets.QDialog):
+ def __init__(
+ self,
+ family,
+ subset_name,
+ asset_name,
+ exc_msg,
+ formatted_traceback,
+ parent=None
+ ):
+ super(CreateErrorMessageBox, self).__init__(parent)
+ self.setWindowTitle("Creation failed")
+ self.setFocusPolicy(QtCore.Qt.StrongFocus)
+ self.setWindowFlags(
+ self.windowFlags() | QtCore.Qt.WindowStaysOnTopHint
+ )
+
+ body_layout = QtWidgets.QVBoxLayout(self)
+
+ main_label = (
+ "Failed to create"
+ )
+ main_label_widget = QtWidgets.QLabel(main_label, self)
+ body_layout.addWidget(main_label_widget)
+
+ item_name_template = (
+ "Family: {}
"
+ "Subset: {}
"
+ "Asset: {}
"
+ )
+ exc_msg_template = "{}"
+
+ line = self._create_line()
+ body_layout.addWidget(line)
+
+ item_name = item_name_template.format(family, subset_name, asset_name)
+ item_name_widget = QtWidgets.QLabel(
+ item_name.replace("\n", "
"), self
+ )
+ body_layout.addWidget(item_name_widget)
+
+ exc_msg = exc_msg_template.format(exc_msg.replace("\n", "
"))
+ message_label_widget = QtWidgets.QLabel(exc_msg, self)
+ body_layout.addWidget(message_label_widget)
+
+ if formatted_traceback:
+ tb_widget = QtWidgets.QLabel(
+ formatted_traceback.replace("\n", "
"), self
+ )
+ tb_widget.setTextInteractionFlags(
+ QtCore.Qt.TextBrowserInteraction
+ )
+ body_layout.addWidget(tb_widget)
+
+ footer_widget = QtWidgets.QWidget(self)
+ footer_layout = QtWidgets.QHBoxLayout(footer_widget)
+ button_box = QtWidgets.QDialogButtonBox(QtCore.Qt.Vertical)
+ button_box.setStandardButtons(
+ QtWidgets.QDialogButtonBox.StandardButton.Ok
+ )
+ button_box.accepted.connect(self._on_accept)
+ footer_layout.addWidget(button_box, alignment=QtCore.Qt.AlignRight)
+ body_layout.addWidget(footer_widget)
+
+ def showEvent(self, event):
+ self.setStyleSheet(style.load_stylesheet())
+ super(CreateErrorMessageBox, self).showEvent(event)
+
+ def _on_accept(self):
+ self.close()
+
+ def _create_line(self):
+ line = QtWidgets.QFrame(self)
+ line.setFixedHeight(2)
+ line.setFrameShape(QtWidgets.QFrame.HLine)
+ line.setFrameShadow(QtWidgets.QFrame.Sunken)
+ return line
+
+
+class SubsetNameValidator(QtGui.QRegExpValidator):
+ invalid = QtCore.Signal(set)
+ pattern = "^[{}]*$".format(SUBSET_NAME_ALLOWED_SYMBOLS)
+
+ def __init__(self):
+ reg = QtCore.QRegExp(self.pattern)
+ super(SubsetNameValidator, self).__init__(reg)
+
+ def validate(self, text, pos):
+ results = super(SubsetNameValidator, self).validate(text, pos)
+ if results[0] == self.Invalid:
+ self.invalid.emit(self.invalid_chars(text))
+ return results
+
+ def invalid_chars(self, text):
+ invalid = set()
+ re_valid = re.compile(self.pattern)
+ for char in text:
+ if char == " ":
+ invalid.add("' '")
+ continue
+ if not re_valid.match(char):
+ invalid.add(char)
+ return invalid
+
+
+class VariantLineEdit(QtWidgets.QLineEdit):
+ report = QtCore.Signal(str)
+ colors = {
+ "empty": (QtGui.QColor("#78879b"), ""),
+ "exists": (QtGui.QColor("#4E76BB"), "border-color: #4E76BB;"),
+ "new": (QtGui.QColor("#7AAB8F"), "border-color: #7AAB8F;"),
+ }
+
+ def __init__(self, *args, **kwargs):
+ super(VariantLineEdit, self).__init__(*args, **kwargs)
+
+ validator = SubsetNameValidator()
+ self.setValidator(validator)
+ self.setToolTip("Only alphanumeric characters (A-Z a-z 0-9), "
+ "'_' and '.' are allowed.")
+
+ self._status_color = self.colors["empty"][0]
+
+ anim = QtCore.QPropertyAnimation()
+ anim.setTargetObject(self)
+ anim.setPropertyName(b"status_color")
+ anim.setEasingCurve(QtCore.QEasingCurve.InCubic)
+ anim.setDuration(300)
+ anim.setStartValue(QtGui.QColor("#C84747")) # `Invalid` status color
+ self.animation = anim
+
+ validator.invalid.connect(self.on_invalid)
+
+ def on_invalid(self, invalid):
+ message = "Invalid character: %s" % ", ".join(invalid)
+ self.report.emit(message)
+ self.animation.stop()
+ self.animation.start()
+
+ def as_empty(self):
+ self._set_border("empty")
+ self.report.emit("Empty subset name ..")
+
+ def as_exists(self):
+ self._set_border("exists")
+ self.report.emit("Existing subset, appending next version.")
+
+ def as_new(self):
+ self._set_border("new")
+ self.report.emit("New subset, creating first version.")
+
+ def _set_border(self, status):
+ qcolor, style = self.colors[status]
+ self.animation.setEndValue(qcolor)
+ self.setStyleSheet(style)
+
+ def _get_status_color(self):
+ return self._status_color
+
+ def _set_status_color(self, color):
+ self._status_color = color
+ self.setStyleSheet("border-color: %s;" % color.name())
+
+ status_color = QtCore.Property(
+ QtGui.QColor, _get_status_color, _set_status_color
+ )
+
+
+class FamilyDescriptionWidget(QtWidgets.QWidget):
+ """A family description widget.
+
+ Shows a family icon, family name and a help description.
+ Used in creator header.
+
+ _________________
+ | ____ |
+ | |icon| FAMILY |
+ | |____| help |
+ |_________________|
+
+ """
+
+ SIZE = 35
+
+ def __init__(self, parent=None):
+ super(FamilyDescriptionWidget, self).__init__(parent=parent)
+
+ icon_label = QtWidgets.QLabel(self)
+ icon_label.setSizePolicy(
+ QtWidgets.QSizePolicy.Maximum,
+ QtWidgets.QSizePolicy.Maximum
+ )
+
+ # Add 4 pixel padding to avoid icon being cut off
+ icon_label.setFixedWidth(self.SIZE + 4)
+ icon_label.setFixedHeight(self.SIZE + 4)
+
+ label_layout = QtWidgets.QVBoxLayout()
+ label_layout.setSpacing(0)
+
+ family_label = QtWidgets.QLabel(self)
+ family_label.setObjectName("CreatorFamilyLabel")
+ family_label.setAlignment(QtCore.Qt.AlignBottom | QtCore.Qt.AlignLeft)
+
+ help_label = QtWidgets.QLabel(self)
+ help_label.setAlignment(QtCore.Qt.AlignTop | QtCore.Qt.AlignLeft)
+
+ label_layout.addWidget(family_label)
+ label_layout.addWidget(help_label)
+
+ layout = QtWidgets.QHBoxLayout(self)
+ layout.setContentsMargins(0, 0, 0, 0)
+ layout.setSpacing(5)
+ layout.addWidget(icon_label)
+ layout.addLayout(label_layout)
+
+ self._help_label = help_label
+ self._family_label = family_label
+ self._icon_label = icon_label
+
+ def set_item(self, creator_plugin):
+ """Update elements to display information of a family item.
+
+ Args:
+ item (dict): A family item as registered with name, help and icon
+
+ Returns:
+ None
+
+ """
+ if not creator_plugin:
+ self._icon_label.setPixmap(None)
+ self._family_label.setText("")
+ self._help_label.setText("")
+ return
+
+ # Support a font-awesome icon
+ icon_name = getattr(creator_plugin, "icon", None) or "info-circle"
+ try:
+ icon = qtawesome.icon("fa.{}".format(icon_name), color="white")
+ pixmap = icon.pixmap(self.SIZE, self.SIZE)
+ except Exception:
+ print("BUG: Couldn't load icon \"fa.{}\"".format(str(icon_name)))
+ # Create transparent pixmap
+ pixmap = QtGui.QPixmap()
+ pixmap.fill(QtCore.Qt.transparent)
+ pixmap = pixmap.scaled(self.SIZE, self.SIZE)
+
+ # Parse a clean line from the Creator's docstring
+ docstring = inspect.getdoc(creator_plugin)
+ creator_help = docstring.splitlines()[0] if docstring else ""
+
+ self._icon_label.setPixmap(pixmap)
+ self._family_label.setText(creator_plugin.family)
+ self._help_label.setText(creator_help)
diff --git a/openpype/tools/creator/window.py b/openpype/tools/creator/window.py
new file mode 100644
index 0000000000..dca1735121
--- /dev/null
+++ b/openpype/tools/creator/window.py
@@ -0,0 +1,509 @@
+import sys
+import traceback
+import re
+
+from Qt import QtWidgets, QtCore
+
+from avalon import api, io
+
+from openpype import style
+from openpype.api import get_current_project_settings
+from openpype.tools.utils.lib import qt_app_context
+from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS
+
+from .model import CreatorsModel
+from .widgets import (
+ CreateErrorMessageBox,
+ VariantLineEdit,
+ FamilyDescriptionWidget
+)
+from .constants import (
+ ITEM_ID_ROLE,
+ SEPARATOR,
+ SEPARATORS
+)
+
+module = sys.modules[__name__]
+module.window = None
+
+
+class CreatorWindow(QtWidgets.QDialog):
+ def __init__(self, parent=None):
+ super(CreatorWindow, self).__init__(parent)
+ self.setWindowTitle("Instance Creator")
+ self.setFocusPolicy(QtCore.Qt.StrongFocus)
+ if not parent:
+ self.setWindowFlags(
+ self.windowFlags() | QtCore.Qt.WindowStaysOnTopHint
+ )
+
+ creator_info = FamilyDescriptionWidget(self)
+
+ creators_model = CreatorsModel()
+
+ creators_proxy = QtCore.QSortFilterProxyModel()
+ creators_proxy.setSourceModel(creators_model)
+
+ creators_view = QtWidgets.QListView(self)
+ creators_view.setObjectName("CreatorsView")
+ creators_view.setModel(creators_proxy)
+
+ asset_name_input = QtWidgets.QLineEdit(self)
+ variant_input = VariantLineEdit(self)
+ subset_name_input = QtWidgets.QLineEdit(self)
+ subset_name_input.setEnabled(False)
+
+ subset_button = QtWidgets.QPushButton()
+ subset_button.setFixedWidth(18)
+ subset_menu = QtWidgets.QMenu(subset_button)
+ subset_button.setMenu(subset_menu)
+
+ name_layout = QtWidgets.QHBoxLayout()
+ name_layout.addWidget(variant_input)
+ name_layout.addWidget(subset_button)
+ name_layout.setSpacing(3)
+ name_layout.setContentsMargins(0, 0, 0, 0)
+
+ body_layout = QtWidgets.QVBoxLayout()
+ body_layout.setContentsMargins(0, 0, 0, 0)
+
+ body_layout.addWidget(creator_info, 0)
+ body_layout.addWidget(QtWidgets.QLabel("Family", self), 0)
+ body_layout.addWidget(creators_view, 1)
+ body_layout.addWidget(QtWidgets.QLabel("Asset", self), 0)
+ body_layout.addWidget(asset_name_input, 0)
+ body_layout.addWidget(QtWidgets.QLabel("Subset", self), 0)
+ body_layout.addLayout(name_layout, 0)
+ body_layout.addWidget(subset_name_input, 0)
+
+ useselection_chk = QtWidgets.QCheckBox("Use selection", self)
+ useselection_chk.setCheckState(QtCore.Qt.Checked)
+
+ create_btn = QtWidgets.QPushButton("Create", self)
+ # Need to store error_msg to prevent garbage collection
+ msg_label = QtWidgets.QLabel(self)
+
+ footer_layout = QtWidgets.QVBoxLayout()
+ footer_layout.addWidget(create_btn, 0)
+ footer_layout.addWidget(msg_label, 0)
+ footer_layout.setContentsMargins(0, 0, 0, 0)
+
+ layout = QtWidgets.QVBoxLayout(self)
+ layout.addLayout(body_layout, 1)
+ layout.addWidget(useselection_chk, 0, QtCore.Qt.AlignLeft)
+ layout.addLayout(footer_layout, 0)
+
+ msg_timer = QtCore.QTimer()
+ msg_timer.setSingleShot(True)
+ msg_timer.setInterval(5000)
+
+ validation_timer = QtCore.QTimer()
+ validation_timer.setSingleShot(True)
+ validation_timer.setInterval(300)
+
+ msg_timer.timeout.connect(self._on_msg_timer)
+ validation_timer.timeout.connect(self._on_validation_timer)
+
+ create_btn.clicked.connect(self._on_create)
+ variant_input.returnPressed.connect(self._on_create)
+ variant_input.textChanged.connect(self._on_data_changed)
+ variant_input.report.connect(self.echo)
+ asset_name_input.textChanged.connect(self._on_data_changed)
+ creators_view.selectionModel().currentChanged.connect(
+ self._on_selection_changed
+ )
+
+ # Store valid states and
+ self._is_valid = False
+ create_btn.setEnabled(self._is_valid)
+
+ self._first_show = True
+
+ # Message dialog when something goes wrong during creation
+ self._message_dialog = None
+
+ self._creator_info = creator_info
+ self._create_btn = create_btn
+ self._useselection_chk = useselection_chk
+ self._variant_input = variant_input
+ self._subset_name_input = subset_name_input
+ self._asset_name_input = asset_name_input
+
+ self._creators_model = creators_model
+ self._creators_proxy = creators_proxy
+ self._creators_view = creators_view
+
+ self._subset_btn = subset_button
+ self._subset_menu = subset_menu
+
+ self._msg_label = msg_label
+
+ self._validation_timer = validation_timer
+ self._msg_timer = msg_timer
+
+ # Defaults
+ self.resize(300, 500)
+ variant_input.setFocus()
+
+ def _set_valid_state(self, valid):
+ if self._is_valid == valid:
+ return
+ self._is_valid = valid
+ self._create_btn.setEnabled(valid)
+
+ def _build_menu(self, default_names=None):
+ """Create optional predefined subset names
+
+ Args:
+ default_names(list): all predefined names
+
+ Returns:
+ None
+ """
+ if not default_names:
+ default_names = []
+
+ menu = self._subset_menu
+ button = self._subset_btn
+
+ # Get and destroy the action group
+ group = button.findChild(QtWidgets.QActionGroup)
+ if group:
+ group.deleteLater()
+
+ state = any(default_names)
+ button.setEnabled(state)
+ if state is False:
+ return
+
+ # Build new action group
+ group = QtWidgets.QActionGroup(button)
+ for name in default_names:
+ if name in SEPARATORS:
+ menu.addSeparator()
+ continue
+ action = group.addAction(name)
+ menu.addAction(action)
+
+ group.triggered.connect(self._on_action_clicked)
+
+ def _on_action_clicked(self, action):
+ self._variant_input.setText(action.text())
+
+ def _on_data_changed(self, *args):
+ # Set invalid state until it's reconfirmed to be valid by the
+ # scheduled callback so any form of creation is held back until
+ # valid again
+ self._set_valid_state(False)
+
+ self._validation_timer.start()
+
+ def _on_validation_timer(self):
+ index = self._creators_view.currentIndex()
+ item_id = index.data(ITEM_ID_ROLE)
+ creator_plugin = self._creators_model.get_creator_by_id(item_id)
+ user_input_text = self._variant_input.text()
+ asset_name = self._asset_name_input.text()
+
+ # Early exit if no asset name
+ if not asset_name.strip():
+ self._build_menu()
+ self.echo("Asset name is required ..")
+ self._set_valid_state(False)
+ return
+
+ asset_doc = None
+ if creator_plugin:
+ # Get the asset from the database which match with the name
+ asset_doc = io.find_one(
+ {"name": asset_name, "type": "asset"},
+ projection={"_id": 1}
+ )
+
+ # Get plugin
+ if not asset_doc or not creator_plugin:
+ subset_name = user_input_text
+ self._build_menu()
+
+ if not creator_plugin:
+ self.echo("No registered families ..")
+ else:
+ self.echo("Asset '%s' not found .." % asset_name)
+ self._set_valid_state(False)
+ return
+
+ project_name = io.Session["AVALON_PROJECT"]
+ asset_id = asset_doc["_id"]
+ task_name = io.Session["AVALON_TASK"]
+
+ # Calculate subset name with Creator plugin
+ subset_name = creator_plugin.get_subset_name(
+ user_input_text, task_name, asset_id, project_name
+ )
+ # Force replacement of prohibited symbols
+ # QUESTION should Creator care about this and here should be only
+ # validated with schema regex?
+
+ # Allow curly brackets in subset name for dynamic keys
+ curly_left = "__cbl__"
+ curly_right = "__cbr__"
+ tmp_subset_name = (
+ subset_name
+ .replace("{", curly_left)
+ .replace("}", curly_right)
+ )
+ # Replace prohibited symbols
+ tmp_subset_name = re.sub(
+ "[^{}]+".format(SUBSET_NAME_ALLOWED_SYMBOLS),
+ "",
+ tmp_subset_name
+ )
+ subset_name = (
+ tmp_subset_name
+ .replace(curly_left, "{")
+ .replace(curly_right, "}")
+ )
+ self._subset_name_input.setText(subset_name)
+
+ # Get all subsets of the current asset
+ subset_docs = io.find(
+ {
+ "type": "subset",
+ "parent": asset_id
+ },
+ {"name": 1}
+ )
+ existing_subset_names = set(subset_docs.distinct("name"))
+ existing_subset_names_low = set(
+ _name.lower()
+ for _name in existing_subset_names
+ )
+
+ # Defaults to dropdown
+ defaults = []
+ # Check if Creator plugin has set defaults
+ if (
+ creator_plugin.defaults
+ and isinstance(creator_plugin.defaults, (list, tuple, set))
+ ):
+ defaults = list(creator_plugin.defaults)
+
+ # Replace
+ compare_regex = re.compile(re.sub(
+ user_input_text, "(.+)", subset_name, flags=re.IGNORECASE
+ ))
+ subset_hints = set()
+ if user_input_text:
+ for _name in existing_subset_names:
+ _result = compare_regex.search(_name)
+ if _result:
+ subset_hints |= set(_result.groups())
+
+ if subset_hints:
+ if defaults:
+ defaults.append(SEPARATOR)
+ defaults.extend(subset_hints)
+ self._build_menu(defaults)
+
+ # Indicate subset existence
+ if not user_input_text:
+ self._variant_input.as_empty()
+ elif subset_name.lower() in existing_subset_names_low:
+ # validate existence of subset name with lowered text
+ # - "renderMain" vs. "rensermain" mean same path item for
+ # windows
+ self._variant_input.as_exists()
+ else:
+ self._variant_input.as_new()
+
+ # Update the valid state
+ valid = subset_name.strip() != ""
+
+ self._set_valid_state(valid)
+
+ def _on_selection_changed(self, old_idx, new_idx):
+ index = self._creators_view.currentIndex()
+ item_id = index.data(ITEM_ID_ROLE)
+
+ creator_plugin = self._creators_model.get_creator_by_id(item_id)
+
+ self._creator_info.set_item(creator_plugin)
+
+ if creator_plugin is None:
+ return
+
+ default = None
+ if hasattr(creator_plugin, "get_default_variant"):
+ default = creator_plugin.get_default_variant()
+
+ if not default:
+ if (
+ creator_plugin.defaults
+ and isinstance(creator_plugin.defaults, list)
+ ):
+ default = creator_plugin.defaults[0]
+ else:
+ default = "Default"
+
+ self._variant_input.setText(default)
+
+ self._on_data_changed()
+
+ def keyPressEvent(self, event):
+ """Custom keyPressEvent.
+
+ Override keyPressEvent to do nothing so that Maya's panels won't
+ take focus when pressing "SHIFT" whilst mouse is over viewport or
+ outliner. This way users don't accidently perform Maya commands
+ whilst trying to name an instance.
+
+ """
+ pass
+
+ def showEvent(self, event):
+ super(CreatorWindow, self).showEvent(event)
+ if self._first_show:
+ self._first_show = False
+ self.setStyleSheet(style.load_stylesheet())
+
+ def refresh(self):
+ self._asset_name_input.setText(io.Session["AVALON_ASSET"])
+
+ self._creators_model.reset()
+
+ pype_project_setting = (
+ get_current_project_settings()
+ ["global"]
+ ["tools"]
+ ["creator"]
+ ["families_smart_select"]
+ )
+ current_index = None
+ family = None
+ task_name = io.Session.get("AVALON_TASK", None)
+ lowered_task_name = task_name.lower()
+ if task_name:
+ for _family, _task_names in pype_project_setting.items():
+ _low_task_names = {name.lower() for name in _task_names}
+ for _task_name in _low_task_names:
+ if _task_name in lowered_task_name:
+ family = _family
+ break
+ if family:
+ break
+
+ if family:
+ indexes = self._creators_model.get_indexes_by_family(family)
+ if indexes:
+ index = indexes[0]
+ current_index = self._creators_proxy.mapFromSource(index)
+
+ if current_index is None or not current_index.isValid():
+ current_index = self._creators_proxy.index(0, 0)
+
+ self._creators_view.setCurrentIndex(current_index)
+
+ def _on_create(self):
+ # Do not allow creation in an invalid state
+ if not self._is_valid:
+ return
+
+ index = self._creators_view.currentIndex()
+ item_id = index.data(ITEM_ID_ROLE)
+ creator_plugin = self._creators_model.get_creator_by_id(item_id)
+ if creator_plugin is None:
+ return
+
+ subset_name = self._subset_name_input.text()
+ asset_name = self._asset_name_input.text()
+ use_selection = self._useselection_chk.isChecked()
+
+ variant = self._variant_input.text()
+
+ error_info = None
+ try:
+ api.create(
+ creator_plugin,
+ subset_name,
+ asset_name,
+ options={"useSelection": use_selection},
+ data={"variant": variant}
+ )
+
+ except api.CreatorError as exc:
+ self.echo("Creator error: {}".format(str(exc)))
+ error_info = (str(exc), None)
+
+ except Exception as exc:
+ self.echo("Program error: %s" % str(exc))
+
+ exc_type, exc_value, exc_traceback = sys.exc_info()
+ formatted_traceback = "".join(traceback.format_exception(
+ exc_type, exc_value, exc_traceback
+ ))
+ error_info = (str(exc), formatted_traceback)
+
+ if error_info:
+ box = CreateErrorMessageBox(
+ creator_plugin.family, subset_name, asset_name, *error_info
+ )
+ box.show()
+ # Store dialog so is not garbage collected before is shown
+ self._message_dialog = box
+
+ else:
+ self.echo("Created %s .." % subset_name)
+
+ def _on_msg_timer(self):
+ self._msg_label.setText("")
+
+ def echo(self, message):
+ self._msg_label.setText(str(message))
+ self._msg_timer.start()
+
+
+def show(debug=False, parent=None):
+ """Display asset creator GUI
+
+ Arguments:
+ debug (bool, optional): Run loader in debug-mode,
+ defaults to False
+ parent (QtCore.QObject, optional): When provided parent the interface
+ to this QObject.
+
+ """
+
+ try:
+ module.window.close()
+ del(module.window)
+ except (AttributeError, RuntimeError):
+ pass
+
+ if debug:
+ from avalon import mock
+ for creator in mock.creators:
+ api.register_plugin(api.Creator, creator)
+
+ import traceback
+ sys.excepthook = lambda typ, val, tb: traceback.print_last()
+
+ io.install()
+
+ any_project = next(
+ project for project in io.projects()
+ if project.get("active", True) is not False
+ )
+
+ api.Session["AVALON_PROJECT"] = any_project["name"]
+ module.project = any_project["name"]
+
+ with qt_app_context():
+ window = CreatorWindow(parent)
+ window.refresh()
+ window.show()
+
+ module.window = window
+
+ # Pull window to the front.
+ module.window.raise_()
+ module.window.activateWindow()
diff --git a/openpype/tools/launcher/window.py b/openpype/tools/launcher/window.py
index 8d6b609282..c8acbe77c2 100644
--- a/openpype/tools/launcher/window.py
+++ b/openpype/tools/launcher/window.py
@@ -8,7 +8,7 @@ from avalon.api import AvalonMongoDB
from openpype import style
from openpype.api import resources
-from openpype.tools.utils.widgets import AssetWidget
+from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget
from openpype.tools.utils.tasks_widget import TasksWidget
from avalon.vendor import qtawesome
@@ -138,14 +138,9 @@ class AssetsPanel(QtWidgets.QWidget):
project_bar_layout.addWidget(project_bar)
# Assets widget
- assets_widget = AssetWidget(dbcon=self.dbcon, parent=self)
-
+ assets_widget = SingleSelectAssetsWidget(dbcon=self.dbcon, parent=self)
# Make assets view flickable
- flick = FlickCharm(parent=self)
- flick.activateOn(assets_widget.view)
- assets_widget.view.setVerticalScrollMode(
- assets_widget.view.ScrollPerPixel
- )
+ assets_widget.activate_flick_charm()
# Tasks widget
tasks_widget = TasksWidget(self.dbcon, self)
@@ -183,6 +178,9 @@ class AssetsPanel(QtWidgets.QWidget):
self._tasks_widget = tasks_widget
self._btn_back = btn_back
+ def select_asset(self, asset_name):
+ self.assets_widget.select_asset_by_name(asset_name)
+
def showEvent(self, event):
super(AssetsPanel, self).showEvent(event)
@@ -206,35 +204,15 @@ class AssetsPanel(QtWidgets.QWidget):
This updates the task view.
"""
- asset_name = None
- asset_silo = None
-
# Check asset on current index and selected assets
- asset_doc = self.assets_widget.get_active_asset_document()
- selected_asset_docs = self.assets_widget.get_selected_assets()
- # If there are not asset selected docs then active asset is not
- # selected
- if not selected_asset_docs:
- asset_doc = None
- elif asset_doc:
- # If selected asset doc and current asset are not same than
- # something bad happened
- if selected_asset_docs[0]["_id"] != asset_doc["_id"]:
- asset_doc = None
-
- if asset_doc:
- asset_name = asset_doc["name"]
- asset_silo = asset_doc.get("silo")
+ asset_id = self.assets_widget.get_selected_asset_id()
+ asset_name = self.assets_widget.get_selected_asset_name()
self.dbcon.Session["AVALON_TASK"] = None
self.dbcon.Session["AVALON_ASSET"] = asset_name
- self.dbcon.Session["AVALON_SILO"] = asset_silo
self.session_changed.emit()
- asset_id = None
- if asset_doc:
- asset_id = asset_doc["_id"]
self._tasks_widget.set_asset_id(asset_id)
def _on_task_change(self):
@@ -431,7 +409,6 @@ class LauncherWindow(QtWidgets.QDialog):
def set_session(self, session):
project_name = session.get("AVALON_PROJECT")
- silo = session.get("AVALON_SILO")
asset_name = session.get("AVALON_ASSET")
task_name = session.get("AVALON_TASK")
@@ -446,11 +423,8 @@ class LauncherWindow(QtWidgets.QDialog):
index
)
- if silo:
- self.asset_panel.assets_widget.set_silo(silo)
-
if asset_name:
- self.asset_panel.assets_widget.select_assets([asset_name])
+ self.asset_panel.select_asset(asset_name)
if task_name:
# requires a forced refresh first
diff --git a/openpype/tools/libraryloader/app.py b/openpype/tools/libraryloader/app.py
index 710e25bd76..d030aa903d 100644
--- a/openpype/tools/libraryloader/app.py
+++ b/openpype/tools/libraryloader/app.py
@@ -11,7 +11,7 @@ from openpype.tools.loader.widgets import (
FamilyListView,
RepresentationWidget
)
-from openpype.tools.utils.widgets import AssetWidget
+from openpype.tools.utils.assets_widget import MultiSelectAssetsWidget
from openpype.modules import ModulesManager
@@ -31,7 +31,7 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
message_timeout = 5000
def __init__(
- self, parent=None, icon=None, show_projects=False, show_libraries=True
+ self, parent=None, show_projects=False, show_libraries=True
):
super(LibraryLoaderWindow, self).__init__(parent)
@@ -76,8 +76,8 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
projects_combobox.setItemDelegate(combobox_delegate)
# Assets widget
- assets_widget = AssetWidget(
- dbcon, multiselection=True, parent=left_side_splitter
+ assets_widget = MultiSelectAssetsWidget(
+ dbcon, parent=left_side_splitter
)
# Families widget
@@ -165,7 +165,6 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
)
assets_widget.selection_changed.connect(self.on_assetschanged)
assets_widget.refresh_triggered.connect(self.on_assetschanged)
- assets_widget.view.clicked.connect(self.on_assetview_click)
subsets_widget.active_changed.connect(self.on_subsetschanged)
subsets_widget.version_changed.connect(self.on_versionschanged)
subsets_widget.refreshed.connect(self._on_subset_refresh)
@@ -204,11 +203,6 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
self._initial_refresh = True
self.refresh()
- def on_assetview_click(self, *args):
- selection_model = self._subsets_widget.view.selectionModel()
- if selection_model.selectedIndexes():
- selection_model.clearSelection()
-
def _set_projects(self):
# Store current project
old_project_name = self.current_project
@@ -348,25 +342,14 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
self._families_filter_view.set_enabled_families(set())
self._families_filter_view.refresh()
- self._assets_widget.model.stop_fetch_thread()
+ self._assets_widget.stop_refresh()
self._assets_widget.refresh()
self._assets_widget.setFocus()
def clear_assets_underlines(self):
last_asset_ids = self.data["state"]["assetIds"]
- if not last_asset_ids:
- return
-
- assets_model = self._assets_widget.model
- id_role = assets_model.ObjectIdRole
-
- for index in tools_lib.iter_model_rows(assets_model, 0):
- if index.data(id_role) not in last_asset_ids:
- continue
-
- assets_model.setData(
- index, [], assets_model.subsetColorsRole
- )
+ if last_asset_ids:
+ self._assets_widget.clear_underlines()
def _assetschanged(self):
"""Selected assets have changed"""
@@ -382,12 +365,8 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
)
return
- # filter None docs they are silo
- asset_docs = self._assets_widget.get_selected_assets()
- if len(asset_docs) == 0:
- return
+ asset_ids = self._assets_widget.get_selected_asset_ids()
- asset_ids = [asset_doc["_id"] for asset_doc in asset_docs]
# Start loading
self._subsets_widget.set_loading_state(
loading=bool(asset_ids),
@@ -402,7 +381,7 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
# Clear the version information on asset change
self._version_info_widget.set_version(None)
- self._thumbnail_widget.set_thumbnail(asset_docs)
+ self._thumbnail_widget.set_thumbnail(asset_ids)
self.data["state"]["assetIds"] = asset_ids
@@ -421,7 +400,7 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
_merged=True, _other=False
)
- asset_models = {}
+ asset_colors = {}
asset_ids = []
for subset_node in selected_subsets:
asset_ids.extend(subset_node.get("assetIds", []))
@@ -429,30 +408,17 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
for subset_node in selected_subsets:
for asset_id in asset_ids:
- if asset_id not in asset_models:
- asset_models[asset_id] = []
+ if asset_id not in asset_colors:
+ asset_colors[asset_id] = []
color = None
if asset_id in subset_node.get("assetIds", []):
color = subset_node["subsetColor"]
- asset_models[asset_id].append(color)
+ asset_colors[asset_id].append(color)
- self.clear_assets_underlines()
+ self._assets_widget.set_underline_colors(asset_colors)
- indexes = self._assets_widget.view.selectionModel().selectedRows()
-
- assets_model = self._assets_widget.model
- for index in indexes:
- id = index.data(assets_model.ObjectIdRole)
- if id not in asset_models:
- continue
-
- assets_model.setData(
- index, asset_models[id], assets_model.subsetColorsRole
- )
- # Trigger repaint
- self._assets_widget.view.updateGeometries()
# Set version in Version Widget
self._versionschanged()
@@ -489,13 +455,14 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
self._version_info_widget.set_version(version_doc)
- thumbnail_docs = version_docs
- if not thumbnail_docs:
- asset_docs = self._assets_widget.get_selected_assets()
- if len(asset_docs) > 0:
- thumbnail_docs = asset_docs
+ thumbnail_src_ids = [
+ version_doc["_id"]
+ for version_doc in version_docs
+ ]
+ if not thumbnail_src_ids:
+ thumbnail_src_ids = self._assets_widget.get_selected_asset_ids()
- self._thumbnail_widget.set_thumbnail(thumbnail_docs)
+ self._thumbnail_widget.set_thumbnail(thumbnail_src_ids)
version_ids = [doc["_id"] for doc in version_docs or []]
if self._repres_widget:
@@ -514,8 +481,8 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
None
"""
- asset = context.get("asset", None)
- if asset is None:
+ asset_name = context.get("asset", None)
+ if asset_name is None:
return
if refresh:
@@ -527,7 +494,7 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
# scheduled refresh and the silo tabs are not shown.
self._refresh_assets()
- self._assets_widget.select_assets(asset)
+ self._assets_widget.select_asset_by_name(asset_name)
def _on_message_timeout(self):
self._message_label.setText("")
@@ -550,10 +517,7 @@ class LibraryLoaderWindow(QtWidgets.QDialog):
return super(LibraryLoaderWindow, self).closeEvent(event)
-def show(
- debug=False, parent=None, icon=None,
- show_projects=False, show_libraries=True
-):
+def show(debug=False, parent=None, show_projects=False, show_libraries=True):
"""Display Loader GUI
Arguments:
@@ -588,9 +552,9 @@ def show(
import traceback
sys.excepthook = lambda typ, val, tb: traceback.print_last()
- with tools_lib.application():
+ with tools_lib.qt_app_context():
window = LibraryLoaderWindow(
- parent, icon, show_projects, show_libraries
+ parent, show_projects, show_libraries
)
window.show()
diff --git a/openpype/tools/loader/app.py b/openpype/tools/loader/app.py
index 9a4f2f1984..b6becc3e9f 100644
--- a/openpype/tools/loader/app.py
+++ b/openpype/tools/loader/app.py
@@ -4,8 +4,8 @@ from Qt import QtWidgets, QtCore
from avalon import api, io, pipeline
from openpype import style
-from openpype.tools.utils.widgets import AssetWidget
from openpype.tools.utils import lib
+from openpype.tools.utils.assets_widget import MultiSelectAssetsWidget
from .widgets import (
SubsetWidget,
@@ -65,8 +65,8 @@ class LoaderWindow(QtWidgets.QDialog):
left_side_splitter.setOrientation(QtCore.Qt.Vertical)
# Assets widget
- assets_widget = AssetWidget(
- io, multiselection=True, parent=left_side_splitter
+ assets_widget = MultiSelectAssetsWidget(
+ io, parent=left_side_splitter
)
assets_widget.set_current_asset_btn_visibility(True)
@@ -156,8 +156,6 @@ class LoaderWindow(QtWidgets.QDialog):
)
assets_widget.selection_changed.connect(self.on_assetschanged)
assets_widget.refresh_triggered.connect(self.on_assetschanged)
- # TODO do not touch view in asset widget
- assets_widget.view.clicked.connect(self.on_assetview_click)
subsets_widget.active_changed.connect(self.on_subsetschanged)
subsets_widget.version_changed.connect(self.on_versionschanged)
subsets_widget.refreshed.connect(self._on_subset_refresh)
@@ -216,12 +214,6 @@ class LoaderWindow(QtWidgets.QDialog):
# Delay calling blocking methods
# -------------------------------
- def on_assetview_click(self, *args):
- # TODO do not touch inner attributes of subset widget
- selection_model = self._subsets_widget.view.selectionModel()
- if selection_model.selectedIndexes():
- selection_model.clearSelection()
-
def refresh(self):
self.echo("Fetching results..")
lib.schedule(self._refresh, 50, channel="mongo")
@@ -271,7 +263,7 @@ class LoaderWindow(QtWidgets.QDialog):
# Refresh families config
self._families_filter_view.refresh()
# Change to context asset on context change
- self._assets_widget.select_assets(io.Session["AVALON_ASSET"])
+ self._assets_widget.select_asset_by_name(io.Session["AVALON_ASSET"])
def _refresh(self):
"""Load assets from database"""
@@ -292,20 +284,9 @@ class LoaderWindow(QtWidgets.QDialog):
on selection change so they match current selection.
"""
# TODO do not touch inner attributes of asset widget
- last_asset_ids = self.data["state"]["assetIds"] or []
- if not last_asset_ids:
- return
-
- assets_widget = self._assets_widget
- id_role = assets_widget.model.ObjectIdRole
-
- for index in lib.iter_model_rows(assets_widget.model, 0):
- if index.data(id_role) not in last_asset_ids:
- continue
-
- assets_widget.model.setData(
- index, [], assets_widget.model.subsetColorsRole
- )
+ last_asset_ids = self.data["state"]["assetIds"]
+ if last_asset_ids:
+ self._assets_widget.clear_underlines()
def _assetschanged(self):
"""Selected assets have changed"""
@@ -317,9 +298,7 @@ class LoaderWindow(QtWidgets.QDialog):
self.clear_assets_underlines()
# filter None docs they are silo
- asset_docs = self._assets_widget.get_selected_assets()
-
- asset_ids = [asset_doc["_id"] for asset_doc in asset_docs]
+ asset_ids = self._assets_widget.get_selected_asset_ids()
# Start loading
subsets_widget.set_loading_state(
loading=bool(asset_ids),
@@ -333,7 +312,7 @@ class LoaderWindow(QtWidgets.QDialog):
)
# Clear the version information on asset change
- self._thumbnail_widget.set_thumbnail(asset_docs)
+ self._thumbnail_widget.set_thumbnail(asset_ids)
self._version_info_widget.set_version(None)
self.data["state"]["assetIds"] = asset_ids
@@ -353,7 +332,7 @@ class LoaderWindow(QtWidgets.QDialog):
_merged=True, _other=False
)
- asset_models = {}
+ asset_colors = {}
asset_ids = []
for subset_node in selected_subsets:
asset_ids.extend(subset_node.get("assetIds", []))
@@ -361,31 +340,17 @@ class LoaderWindow(QtWidgets.QDialog):
for subset_node in selected_subsets:
for asset_id in asset_ids:
- if asset_id not in asset_models:
- asset_models[asset_id] = []
+ if asset_id not in asset_colors:
+ asset_colors[asset_id] = []
color = None
if asset_id in subset_node.get("assetIds", []):
color = subset_node["subsetColor"]
- asset_models[asset_id].append(color)
+ asset_colors[asset_id].append(color)
- self.clear_assets_underlines()
+ self._assets_widget.set_underline_colors(asset_colors)
- # TODO do not use inner attributes of asset widget
- assets_widget = self._assets_widget
- indexes = assets_widget.view.selectionModel().selectedRows()
-
- for index in indexes:
- id = index.data(assets_widget.model.ObjectIdRole)
- if id not in asset_models:
- continue
-
- assets_widget.model.setData(
- index, asset_models[id], assets_widget.model.subsetColorsRole
- )
- # Trigger repaint
- assets_widget.view.updateGeometries()
# Set version in Version Widget
self._versionschanged()
@@ -424,13 +389,14 @@ class LoaderWindow(QtWidgets.QDialog):
self._version_info_widget.set_version(version_doc)
- thumbnail_docs = version_docs
- asset_docs = self._assets_widget.get_selected_assets()
- if not thumbnail_docs:
- if len(asset_docs) > 0:
- thumbnail_docs = asset_docs
+ thumbnail_src_ids = [
+ version_doc["_id"]
+ for version_doc in version_docs
+ ]
+ if not thumbnail_src_ids:
+ thumbnail_src_ids = self._assets_widget.get_selected_asset_ids()
- self._thumbnail_widget.set_thumbnail(thumbnail_docs)
+ self._thumbnail_widget.set_thumbnail(thumbnail_src_ids)
if self._repres_widget is not None:
version_ids = [doc["_id"] for doc in version_docs or []]
@@ -472,7 +438,7 @@ class LoaderWindow(QtWidgets.QDialog):
# scheduled refresh and the silo tabs are not shown.
self._refresh()
- self._assets_widget.select_assets(asset)
+ self._assets_widget.select_asset_by_name(asset)
def _on_message_timeout(self):
self._message_label.setText("")
@@ -665,7 +631,7 @@ def show(debug=False, parent=None, use_context=False):
api.Session["AVALON_PROJECT"] = any_project["name"]
module.project = any_project["name"]
- with lib.application():
+ with lib.qt_app_context():
window = LoaderWindow(parent)
window.show()
diff --git a/openpype/tools/loader/widgets.py b/openpype/tools/loader/widgets.py
index 08b58eebbe..ea45fd4364 100644
--- a/openpype/tools/loader/widgets.py
+++ b/openpype/tools/loader/widgets.py
@@ -16,11 +16,15 @@ from openpype.tools.utils.delegates import (
VersionDelegate,
PrettyTimeDelegate
)
-from openpype.tools.utils.widgets import OptionalMenu
+from openpype.tools.utils.widgets import (
+ OptionalMenu,
+ PlaceholderLineEdit
+)
from openpype.tools.utils.views import (
TreeViewSpinner,
DeselectableTreeView
)
+from openpype.tools.assetlinks.widgets import SimpleLinkView
from .model import (
SubsetsModel,
@@ -174,7 +178,7 @@ class SubsetWidget(QtWidgets.QWidget):
family_proxy = FamiliesFilterProxyModel()
family_proxy.setSourceModel(proxy)
- subset_filter = QtWidgets.QLineEdit(self)
+ subset_filter = PlaceholderLineEdit(self)
subset_filter.setPlaceholderText("Filter subsets..")
group_checkbox = QtWidgets.QCheckBox("Enable Grouping", self)
@@ -794,19 +798,24 @@ class ThumbnailWidget(QtWidgets.QLabel):
QtCore.Qt.SmoothTransformation
)
- def set_thumbnail(self, entity=None):
- if not entity:
+ def set_thumbnail(self, doc_id=None):
+ if not doc_id:
self.set_pixmap()
return
- if isinstance(entity, (list, tuple)):
- if len(entity) == 1:
- entity = entity[0]
- else:
+ if isinstance(doc_id, (list, tuple)):
+ if len(doc_id) < 1:
self.set_pixmap()
return
+ doc_id = doc_id[0]
- thumbnail_id = entity.get("data", {}).get("thumbnail_id")
+ doc = self.dbcon.find_one(
+ {"_id": doc_id},
+ {"data.thumbnail_id"}
+ )
+ thumbnail_id = None
+ if doc:
+ thumbnail_id = doc.get("data", {}).get("thumbnail_id")
if thumbnail_id == self.current_thumb_id:
if self.current_thumbnail is None:
self.set_pixmap()
@@ -841,19 +850,25 @@ class VersionWidget(QtWidgets.QWidget):
def __init__(self, dbcon, parent=None):
super(VersionWidget, self).__init__(parent=parent)
- layout = QtWidgets.QVBoxLayout(self)
- layout.setContentsMargins(0, 0, 0, 0)
- label = QtWidgets.QLabel("Version", self)
data = VersionTextEdit(dbcon, self)
data.setReadOnly(True)
- layout.addWidget(label)
- layout.addWidget(data)
+ depend_widget = SimpleLinkView(dbcon, self)
+
+ tab = QtWidgets.QTabWidget()
+ tab.addTab(data, "Version Info")
+ tab.addTab(depend_widget, "Dependency")
+
+ layout = QtWidgets.QVBoxLayout(self)
+ layout.setContentsMargins(0, 0, 0, 0)
+ layout.addWidget(tab)
self.data = data
+ self.depend_widget = depend_widget
def set_version(self, version_doc):
self.data.set_version(version_doc)
+ self.depend_widget.set_version(version_doc)
class FamilyModel(QtGui.QStandardItemModel):
diff --git a/openpype/tools/mayalookassigner/app.py b/openpype/tools/mayalookassigner/app.py
index d723387f2d..fb99333f87 100644
--- a/openpype/tools/mayalookassigner/app.py
+++ b/openpype/tools/mayalookassigner/app.py
@@ -38,6 +38,7 @@ class App(QtWidgets.QWidget):
# Store callback references
self._callbacks = []
+ self._connections_set_up = False
filename = get_workfile()
@@ -46,17 +47,10 @@ class App(QtWidgets.QWidget):
self.setWindowFlags(QtCore.Qt.Window)
self.setParent(parent)
- # Force to delete the window on close so it triggers
- # closeEvent only once. Otherwise it's retriggered when
- # the widget gets garbage collected.
- self.setAttribute(QtCore.Qt.WA_DeleteOnClose)
-
self.resize(750, 500)
self.setup_ui()
- self.setup_connections()
-
# Force refresh check on initialization
self._on_renderlayer_switch()
@@ -111,6 +105,16 @@ class App(QtWidgets.QWidget):
asset_outliner.view.setColumnWidth(0, 200)
look_outliner.view.setColumnWidth(0, 150)
+ asset_outliner.selection_changed.connect(
+ self.on_asset_selection_changed)
+
+ asset_outliner.refreshed.connect(
+ lambda: self.echo("Loaded assets..")
+ )
+
+ look_outliner.menu_apply_action.connect(self.on_process_selected)
+ remove_unused_btn.clicked.connect(remove_unused_looks)
+
# Open widgets
self.asset_outliner = asset_outliner
self.look_outliner = look_outliner
@@ -123,15 +127,8 @@ class App(QtWidgets.QWidget):
def setup_connections(self):
"""Connect interactive widgets with actions"""
-
- self.asset_outliner.selection_changed.connect(
- self.on_asset_selection_changed)
-
- self.asset_outliner.refreshed.connect(
- lambda: self.echo("Loaded assets.."))
-
- self.look_outliner.menu_apply_action.connect(self.on_process_selected)
- self.remove_unused.clicked.connect(remove_unused_looks)
+ if self._connections_set_up:
+ return
# Maya renderlayer switch callback
callback = om.MEventMessage.addEventCallback(
@@ -139,14 +136,23 @@ class App(QtWidgets.QWidget):
self._on_renderlayer_switch
)
self._callbacks.append(callback)
+ self._connections_set_up = True
- def closeEvent(self, event):
-
+ def remove_connection(self):
# Delete callbacks
for callback in self._callbacks:
om.MMessage.removeCallback(callback)
- return super(App, self).closeEvent(event)
+ self._callbacks = []
+ self._connections_set_up = False
+
+ def showEvent(self, event):
+ self.setup_connections()
+ super(App, self).showEvent(event)
+
+ def closeEvent(self, event):
+ self.remove_connection()
+ super(App, self).closeEvent(event)
def _on_renderlayer_switch(self, *args):
"""Callback that updates on Maya renderlayer switch"""
diff --git a/openpype/tools/project_manager/project_manager/images/bin.png b/openpype/tools/project_manager/project_manager/images/bin.png
new file mode 100644
index 0000000000..9e5bc7a943
Binary files /dev/null and b/openpype/tools/project_manager/project_manager/images/bin.png differ
diff --git a/openpype/tools/project_manager/project_manager/model.py b/openpype/tools/project_manager/project_manager/model.py
index b7ab9e40d0..0c02872b4c 100644
--- a/openpype/tools/project_manager/project_manager/model.py
+++ b/openpype/tools/project_manager/project_manager/model.py
@@ -3,6 +3,10 @@ import copy
import json
from uuid import uuid4
+from pymongo import UpdateOne, DeleteOne
+
+from Qt import QtCore, QtGui
+
from .constants import (
IDENTIFIER_ROLE,
ITEM_TYPE_ROLE,
@@ -15,9 +19,6 @@ from .constants import (
from .style import ResourceCache
from openpype.lib import CURRENT_DOC_SCHEMAS
-from pymongo import UpdateOne, DeleteOne
-from avalon.vendor import qtawesome
-from Qt import QtCore, QtGui
class ProjectModel(QtGui.QStandardItemModel):
diff --git a/openpype/tools/project_manager/project_manager/style.py b/openpype/tools/project_manager/project_manager/style.py
index 17e269c1f6..d3d6857a63 100644
--- a/openpype/tools/project_manager/project_manager/style.py
+++ b/openpype/tools/project_manager/project_manager/style.py
@@ -1,9 +1,14 @@
+import os
+from Qt import QtCore, QtGui
+
from avalon.vendor import qtawesome
class ResourceCache:
+ # TODO use colors from OpenPype style
colors = {
"standard": "#bfccd6",
+ "disabled": "#969696",
"new": "#2d9a4c",
"warning": "#c83232"
}
@@ -58,11 +63,62 @@ class ResourceCache:
},
"refresh": qtawesome.icon(
"fa.refresh",
- color=cls.colors["standard"]
- )
+ color=cls.colors["standard"],
+ color_disabled=cls.colors["disabled"]
+ ),
+ "remove": cls.get_remove_icon()
}
return cls.icons
@classmethod
def get_color(cls, color_name):
return cls.colors[color_name]
+
+ @classmethod
+ def get_remove_icon(cls):
+ src_image = get_remove_image()
+ normal_pix = paint_image_with_color(
+ src_image,
+ QtGui.QColor(cls.colors["standard"])
+ )
+ disabled_pix = paint_image_with_color(
+ src_image,
+ QtGui.QColor(cls.colors["disabled"])
+ )
+ icon = QtGui.QIcon(normal_pix)
+ icon.addPixmap(disabled_pix, QtGui.QIcon.Disabled, QtGui.QIcon.On)
+ icon.addPixmap(disabled_pix, QtGui.QIcon.Disabled, QtGui.QIcon.Off)
+ return icon
+
+
+def get_remove_image():
+ image_path = os.path.join(
+ os.path.dirname(os.path.abspath(__file__)),
+ "images",
+ "bin.png"
+ )
+ return QtGui.QImage(image_path)
+
+
+def paint_image_with_color(image, color):
+ """TODO: This function should be imported from utils.
+
+ At the moment of creation is not available yet.
+ """
+ width = image.width()
+ height = image.height()
+
+ alpha_mask = image.createAlphaMask()
+ alpha_region = QtGui.QRegion(QtGui.QBitmap.fromImage(alpha_mask))
+
+ pixmap = QtGui.QPixmap(width, height)
+ pixmap.fill(QtCore.Qt.transparent)
+
+ painter = QtGui.QPainter(pixmap)
+ painter.setClipRegion(alpha_region)
+ painter.setPen(QtCore.Qt.NoPen)
+ painter.setBrush(color)
+ painter.drawRect(QtCore.QRect(0, 0, width, height))
+ painter.end()
+
+ return pixmap
diff --git a/openpype/tools/project_manager/project_manager/widgets.py b/openpype/tools/project_manager/project_manager/widgets.py
index 8c2f693f11..b4d791b6d5 100644
--- a/openpype/tools/project_manager/project_manager/widgets.py
+++ b/openpype/tools/project_manager/project_manager/widgets.py
@@ -288,3 +288,127 @@ class CreateProjectDialog(QtWidgets.QDialog):
project_codes.add(project_code)
return project_names, project_codes
+
+
+class _SameSizeBtns(QtWidgets.QPushButton):
+ """Button that keep width of all button added as related.
+
+ This happens without changing min/max/fix size of button. Which is
+ welcomed for multidisplay desktops with different resolution.
+ """
+ def __init__(self, *args, **kwargs):
+ super(_SameSizeBtns, self).__init__(*args, **kwargs)
+ self._related_btns = []
+
+ def add_related_btn(self, btn):
+ """Add related button which should be checked for width.
+
+ Args:
+ btn (_SameSizeBtns): Other object of _SameSizeBtns.
+ """
+ self._related_btns.append(btn)
+
+ def hint_width(self):
+ """Get size hint of button not related to others."""
+ return super(_SameSizeBtns, self).sizeHint().width()
+
+ def sizeHint(self):
+ """Calculate size hint based on size hint of this button and related.
+
+ If width is lower than any other button it is changed to higher.
+ """
+ result = super(_SameSizeBtns, self).sizeHint()
+ width = result.width()
+ for btn in self._related_btns:
+ btn_width = btn.hint_width()
+ if btn_width > width:
+ width = btn_width
+
+ result.setWidth(width)
+ return result
+
+
+class ConfirmProjectDeletion(QtWidgets.QDialog):
+ """Dialog which confirms deletion of a project."""
+ def __init__(self, project_name, parent):
+ super(ConfirmProjectDeletion, self).__init__(parent)
+
+ self.setWindowTitle("Delete project?")
+
+ message = (
+ "Project \"{}\" with all related data will be"
+ " permanently removed from the database (This actions won't remove"
+ " any files on disk)."
+ ).format(project_name)
+ message_label = QtWidgets.QLabel(message, self)
+ message_label.setWordWrap(True)
+
+ question_label = QtWidgets.QLabel("Are you sure?", self)
+
+ confirm_input = QtWidgets.QLineEdit(self)
+ confirm_input.setPlaceholderText("Type \"Delete\" to confirm...")
+
+ cancel_btn = _SameSizeBtns("Cancel", self)
+ cancel_btn.setToolTip("Cancel deletion of the project")
+ confirm_btn = _SameSizeBtns("Delete", self)
+ confirm_btn.setEnabled(False)
+ confirm_btn.setToolTip("Confirm deletion")
+
+ cancel_btn.add_related_btn(confirm_btn)
+ confirm_btn.add_related_btn(cancel_btn)
+
+ btns_layout = QtWidgets.QHBoxLayout()
+ btns_layout.addStretch(1)
+ btns_layout.addWidget(cancel_btn, 0)
+ btns_layout.addWidget(confirm_btn, 0)
+
+ layout = QtWidgets.QVBoxLayout(self)
+ layout.addWidget(message_label, 0)
+ layout.addStretch(1)
+ layout.addWidget(question_label, 0)
+ layout.addWidget(confirm_input, 0)
+ layout.addLayout(btns_layout)
+
+ cancel_btn.clicked.connect(self._on_cancel_click)
+ confirm_btn.clicked.connect(self._on_confirm_click)
+ confirm_input.textChanged.connect(self._on_confirm_text_change)
+ confirm_input.returnPressed.connect(self._on_enter_clicked)
+
+ self._cancel_btn = cancel_btn
+ self._confirm_btn = confirm_btn
+ self._confirm_input = confirm_input
+ self._result = 0
+
+ self.setMinimumWidth(480)
+ self.setMaximumWidth(650)
+ self.setMaximumHeight(250)
+
+ def exec_(self, *args, **kwargs):
+ super(ConfirmProjectDeletion, self).exec_(*args, **kwargs)
+ return self._result
+
+ def showEvent(self, event):
+ """Reset result on show."""
+ super(ConfirmProjectDeletion, self).showEvent(event)
+ self._result = 0
+ minimum_size_hint = self.minimumSizeHint()
+ self.resize(self.width(), minimum_size_hint.height() + 30)
+
+ def result(self):
+ """Get result of dialog 1 for confirm 0 for cancel."""
+ return self._result
+
+ def _on_cancel_click(self):
+ self.close()
+
+ def _on_confirm_click(self):
+ self._result = 1
+ self.close()
+
+ def _on_enter_clicked(self):
+ if self._confirm_btn.isEnabled():
+ self._on_confirm_click()
+
+ def _on_confirm_text_change(self):
+ enabled = self._confirm_input.text().lower() == "delete"
+ self._confirm_btn.setEnabled(enabled)
diff --git a/openpype/tools/project_manager/project_manager/window.py b/openpype/tools/project_manager/project_manager/window.py
index a19031ceda..a05811e813 100644
--- a/openpype/tools/project_manager/project_manager/window.py
+++ b/openpype/tools/project_manager/project_manager/window.py
@@ -11,6 +11,7 @@ from . import (
CreateProjectDialog,
PROJECT_NAME_ROLE
)
+from .widgets import ConfirmProjectDeletion
from .style import ResourceCache
from openpype.style import load_stylesheet
from openpype.lib import is_admin_password_required
@@ -77,6 +78,10 @@ class ProjectManagerWindow(QtWidgets.QWidget):
)
create_folders_btn.setEnabled(False)
+ remove_projects_btn = QtWidgets.QPushButton(project_widget)
+ remove_projects_btn.setIcon(ResourceCache.get_icon("remove"))
+ remove_projects_btn.setObjectName("IconBtn")
+
project_layout = QtWidgets.QHBoxLayout(project_widget)
project_layout.setContentsMargins(0, 0, 0, 0)
project_layout.addWidget(project_combobox, 0)
@@ -84,6 +89,7 @@ class ProjectManagerWindow(QtWidgets.QWidget):
project_layout.addWidget(create_project_btn, 0)
project_layout.addWidget(create_folders_btn)
project_layout.addStretch(1)
+ project_layout.addWidget(remove_projects_btn)
# Helper buttons
helper_btns_widget = QtWidgets.QWidget(top_part_widget)
@@ -145,11 +151,13 @@ class ProjectManagerWindow(QtWidgets.QWidget):
refresh_projects_btn.clicked.connect(self._on_project_refresh)
create_project_btn.clicked.connect(self._on_project_create)
create_folders_btn.clicked.connect(self._on_create_folders)
+ remove_projects_btn.clicked.connect(self._on_remove_project)
project_combobox.currentIndexChanged.connect(self._on_project_change)
save_btn.clicked.connect(self._on_save_click)
add_asset_btn.clicked.connect(self._on_add_asset)
add_task_btn.clicked.connect(self._on_add_task)
+ self._dbcon = dbcon
self._project_model = project_model
self._project_proxy_model = project_proxy
@@ -162,6 +170,7 @@ class ProjectManagerWindow(QtWidgets.QWidget):
self._project_combobox = project_combobox
self._create_project_btn = create_project_btn
self._create_folders_btn = create_folders_btn
+ self._remove_projects_btn = remove_projects_btn
self._add_asset_btn = add_asset_btn
self._add_task_btn = add_task_btn
@@ -171,6 +180,7 @@ class ProjectManagerWindow(QtWidgets.QWidget):
def _set_project(self, project_name=None):
self._create_folders_btn.setEnabled(project_name is not None)
+ self._remove_projects_btn.setEnabled(project_name is not None)
self._project_proxy_model.set_filter_default(project_name is not None)
self.hierarchy_view.set_project(project_name)
@@ -252,6 +262,19 @@ class ProjectManagerWindow(QtWidgets.QWidget):
exc_info=True
)
+ def _on_remove_project(self):
+ project_name = self._current_project()
+ dialog = ConfirmProjectDeletion(project_name, self)
+ result = dialog.exec_()
+ if result != 1:
+ return
+
+ database = self._dbcon.database
+ if project_name in database.collection_names():
+ collection = database[project_name]
+ collection.drop()
+ self.refresh_projects()
+
def show_message(self, message):
# TODO add nicer message pop
self.message_label.setText(message)
diff --git a/openpype/tools/publisher/constants.py b/openpype/tools/publisher/constants.py
index cf0850bde8..dc44aade45 100644
--- a/openpype/tools/publisher/constants.py
+++ b/openpype/tools/publisher/constants.py
@@ -6,7 +6,6 @@ CONTEXT_LABEL = "Options"
# Allowed symbols for subset name (and variant)
# - characters, numbers, unsercore and dash
-SUBSET_NAME_ALLOWED_SYMBOLS = "a-zA-Z0-9_."
VARIANT_TOOLTIP = (
"Variant may contain alphabetical characters (a-Z)"
"\nnumerical characters (0-9) dot (\".\") or underscore (\"_\")."
@@ -23,7 +22,6 @@ FAMILY_ROLE = QtCore.Qt.UserRole + 5
__all__ = (
"CONTEXT_ID",
- "SUBSET_NAME_ALLOWED_SYMBOLS",
"VARIANT_TOOLTIP",
"INSTANCE_ID_ROLE",
diff --git a/openpype/tools/publisher/widgets/create_dialog.py b/openpype/tools/publisher/widgets/create_dialog.py
index 0206f038fb..84fc6d4e97 100644
--- a/openpype/tools/publisher/widgets/create_dialog.py
+++ b/openpype/tools/publisher/widgets/create_dialog.py
@@ -9,11 +9,13 @@ except Exception:
commonmark = None
from Qt import QtWidgets, QtCore, QtGui
-from openpype.pipeline.create import CreatorError
+from openpype.pipeline.create import (
+ CreatorError,
+ SUBSET_NAME_ALLOWED_SYMBOLS
+)
from .widgets import IconValuePixmapLabel
from ..constants import (
- SUBSET_NAME_ALLOWED_SYMBOLS,
VARIANT_TOOLTIP,
CREATOR_IDENTIFIER_ROLE,
FAMILY_ROLE
diff --git a/openpype/tools/publisher/widgets/list_view_widgets.py b/openpype/tools/publisher/widgets/list_view_widgets.py
index e87ea3e130..4b2082e523 100644
--- a/openpype/tools/publisher/widgets/list_view_widgets.py
+++ b/openpype/tools/publisher/widgets/list_view_widgets.py
@@ -785,7 +785,7 @@ class InstanceListView(AbstractInstanceView):
group_index = self._instance_model.index(
group_item.row(), group_item.column()
)
- proxy_index = self.mapFromSource(group_index)
+ proxy_index = self._proxy_model.mapFromSource(group_index)
self._instance_view.setExpanded(proxy_index, expanded)
def _on_group_toggle_request(self, group_name, state):
@@ -810,6 +810,6 @@ class InstanceListView(AbstractInstanceView):
self._change_active_instances(instance_ids, active)
- proxy_index = self.mapFromSource(group_item.index())
+ proxy_index = self._proxy_model.mapFromSource(group_item.index())
if not self._instance_view.isExpanded(proxy_index):
self._instance_view.expand(proxy_index)
diff --git a/openpype/tools/publisher/widgets/widgets.py b/openpype/tools/publisher/widgets/widgets.py
index 606985c058..fe00ee78d3 100644
--- a/openpype/tools/publisher/widgets/widgets.py
+++ b/openpype/tools/publisher/widgets/widgets.py
@@ -9,7 +9,7 @@ from avalon.vendor import qtawesome
from openpype.widgets.attribute_defs import create_widget_for_attr_def
from openpype.tools.flickcharm import FlickCharm
-
+from openpype.pipeline.create import SUBSET_NAME_ALLOWED_SYMBOLS
from .models import (
AssetsHierarchyModel,
TasksModel,
@@ -21,7 +21,6 @@ from .icons import (
)
from ..constants import (
- SUBSET_NAME_ALLOWED_SYMBOLS,
VARIANT_TOOLTIP
)
diff --git a/openpype/tools/repack_version.py b/openpype/tools/repack_version.py
new file mode 100644
index 0000000000..0172264c79
--- /dev/null
+++ b/openpype/tools/repack_version.py
@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+"""Script to rehash and repack current version."""
+
+import enlighten
+import blessed
+from pathlib import Path
+import platform
+from zipfile import ZipFile
+from typing import List
+import hashlib
+import sys
+from igniter.bootstrap_repos import OpenPypeVersion
+
+
+class VersionRepacker:
+
+ def __init__(self, directory: str):
+ self._term = blessed.Terminal()
+ self._manager = enlighten.get_manager()
+ self._last_increment = 0
+ self.version_path = Path(directory)
+ self.zip_path = self.version_path.parent
+ _version = {}
+ with open(self.version_path / "openpype" / "version.py") as fp:
+ exec(fp.read(), _version)
+ self._version_py = _version["__version__"]
+ del _version
+
+ def _print(self, msg: str, message_type: int = 0) -> None:
+ """Print message to console.
+
+ Args:
+ msg (str): message to print
+ message_type (int): type of message (0 info, 1 error, 2 note)
+
+ """
+ if message_type == 0:
+ header = self._term.aquamarine3(">>> ")
+ elif message_type == 1:
+ header = self._term.orangered2("!!! ")
+ elif message_type == 2:
+ header = self._term.tan1("... ")
+ else:
+ header = self._term.darkolivegreen3("--- ")
+
+ print("{}{}".format(header, msg))
+
+ @staticmethod
+ def sha256sum(filename):
+ """Calculate sha256 for content of the file.
+
+ Args:
+ filename (str): Path to file.
+
+ Returns:
+ str: hex encoded sha256
+
+ """
+ h = hashlib.sha256()
+ b = bytearray(128 * 1024)
+ mv = memoryview(b)
+ with open(filename, 'rb', buffering=0) as f:
+ for n in iter(lambda: f.readinto(mv), 0):
+ h.update(mv[:n])
+ return h.hexdigest()
+
+ @staticmethod
+ def _filter_dir(path: Path, path_filter: List) -> List[Path]:
+ """Recursively crawl over path and filter."""
+ result = []
+ for item in path.iterdir():
+ if item.name in path_filter:
+ continue
+ if item.name.startswith('.'):
+ continue
+ if item.is_dir():
+ result.extend(VersionRepacker._filter_dir(item, path_filter))
+ else:
+ result.append(item)
+ return result
+
+ def process(self):
+ if (self.version_path / "pyproject.toml").exists():
+ self._print(
+ ("This cannot run on OpenPype sources. "
+ "Please run it on extracted version."), 1)
+ return
+ self._print(f"Rehashing and zipping {self.version_path}")
+ version = OpenPypeVersion.version_in_str(self.version_path.name)
+ if not version:
+ self._print("Cannot get version from directory", 1)
+ return
+
+ self._print(f"Detected version is {version}")
+ # replace version in version.py
+ self._replace_version(version, self.version_path)
+ self._print("Recalculating checksums ...", 2)
+
+ checksums = []
+
+ file_list = VersionRepacker._filter_dir(self.version_path, [])
+ progress_bar = enlighten.Counter(
+ total=len(file_list), desc="Calculating checksums",
+ nits="%", color="green")
+ for file in file_list:
+ checksums.append((
+ VersionRepacker.sha256sum(file.as_posix()),
+ file.resolve().relative_to(self.version_path),
+ file
+ ))
+ progress_bar.update()
+ progress_bar.close()
+
+ progress_bar = enlighten.Counter(
+ total=len(checksums), desc="Zipping directory",
+ nits="%", color=(56, 211, 159))
+
+ zip_filename = self.zip_path / f"openpype-v{version}.zip"
+ with ZipFile(zip_filename, "w") as zip_file:
+
+ for item in checksums:
+ if item[1].as_posix() == "checksums":
+ progress_bar.update()
+ continue
+ zip_file.write(item[2], item[1])
+ progress_bar.update()
+
+ checksums_str = ""
+ for c in checksums:
+ file_str = c[1]
+ if platform.system().lower() == "windows":
+ file_str = c[1].as_posix().replace("\\", "/")
+ checksums_str += "{}:{}\n".format(c[0], file_str)
+ zip_file.writestr("checksums", checksums_str)
+ # test if zip is ok
+ zip_file.testzip()
+ self._print(f"All done, you can find new zip here: {zip_filename}")
+
+ @staticmethod
+ def _replace_version(version: OpenPypeVersion, path: Path):
+ """Replace version in version.py.
+
+ Args:
+ version (OpenPypeVersion): OpenPype version to set
+ path (Path): Path to unzipped version.
+
+ """
+ with open(path / "openpype" / "version.py", "r") as op_version_file:
+ replacement = ""
+
+ for line in op_version_file:
+ stripped_line = line.strip()
+ if stripped_line.strip().startswith("__version__ ="):
+ line = f'__version__ = "{version}"\n'
+ replacement += line
+
+ with open(path / "openpype" / "version.py", "w") as op_version_file:
+ op_version_file.write(replacement)
+
+
+if __name__ == '__main__':
+ print(sys.argv[1])
+ version_packer = VersionRepacker(sys.argv[1])
+ version_packer.process()
diff --git a/openpype/tools/sceneinventory/switch_dialog.py b/openpype/tools/sceneinventory/switch_dialog.py
index ecad8eac0a..75e2b6be40 100644
--- a/openpype/tools/sceneinventory/switch_dialog.py
+++ b/openpype/tools/sceneinventory/switch_dialog.py
@@ -2,10 +2,13 @@ import collections
import logging
from Qt import QtWidgets, QtCore
-from avalon import io, api
+from avalon import io, api, pipeline
from avalon.vendor import qtawesome
-from .widgets import SearchComboBox
+from .widgets import (
+ ButtonWithMenu,
+ SearchComboBox
+)
log = logging.getLogger("SwitchAssetDialog")
@@ -55,7 +58,7 @@ class SwitchAssetDialog(QtWidgets.QDialog):
current_asset_btn = QtWidgets.QPushButton("Use current asset")
accept_icon = qtawesome.icon("fa.check", color="white")
- accept_btn = QtWidgets.QPushButton(self)
+ accept_btn = ButtonWithMenu(self)
accept_btn.setIcon(accept_icon)
main_layout = QtWidgets.QGridLayout(self)
@@ -100,6 +103,30 @@ class SwitchAssetDialog(QtWidgets.QDialog):
self._accept_btn = accept_btn
+ self.setMinimumWidth(self.MIN_WIDTH)
+
+ # Set default focus to accept button so you don't directly type in
+ # first asset field, this also allows to see the placeholder value.
+ accept_btn.setFocus()
+
+ self.content_loaders = set()
+ self.content_assets = {}
+ self.content_subsets = {}
+ self.content_versions = {}
+ self.content_repres = {}
+
+ self.hero_version_ids = set()
+
+ self.missing_assets = []
+ self.missing_versions = []
+ self.missing_subsets = []
+ self.missing_repres = []
+ self.missing_docs = False
+
+ self.archived_assets = []
+ self.archived_subsets = []
+ self.archived_repres = []
+
self._init_asset_name = None
self._init_subset_name = None
self._init_repre_name = None
@@ -110,20 +137,16 @@ class SwitchAssetDialog(QtWidgets.QDialog):
self._prepare_content_data()
self.refresh(True)
- self.setMinimumWidth(self.MIN_WIDTH)
-
- # Set default focus to accept button so you don't directly type in
- # first asset field, this also allows to see the placeholder value.
- accept_btn.setFocus()
-
def _prepare_content_data(self):
- repre_ids = [
- io.ObjectId(item["representation"])
- for item in self._items
- ]
+ repre_ids = set()
+ content_loaders = set()
+ for item in self._items:
+ repre_ids.add(io.ObjectId(item["representation"]))
+ content_loaders.add(item["loader"])
+
repres = list(io.find({
"type": {"$in": ["representation", "archived_representation"]},
- "_id": {"$in": repre_ids}
+ "_id": {"$in": list(repre_ids)}
}))
repres_by_id = {repre["_id"]: repre for repre in repres}
@@ -207,6 +230,7 @@ class SwitchAssetDialog(QtWidgets.QDialog):
else:
content_assets[asset_id] = assets_by_id[asset_id]
+ self.content_loaders = content_loaders
self.content_assets = content_assets
self.content_subsets = content_subsets
self.content_versions = content_versions
@@ -260,8 +284,11 @@ class SwitchAssetDialog(QtWidgets.QDialog):
# Fill comboboxes with values
self.set_labels()
+
self.apply_validations(validation_state)
+ self._build_loaders_menu()
+
if init_refresh: # pre select context if possible
self._assets_box.set_valid_value(self._init_asset_name)
self._subsets_box.set_valid_value(self._init_subset_name)
@@ -269,23 +296,89 @@ class SwitchAssetDialog(QtWidgets.QDialog):
self._fill_check = True
- def _get_loaders(self, representations):
- if not representations:
+ def _build_loaders_menu(self):
+ repre_ids = self._get_current_output_repre_ids()
+ loaders = self._get_loaders(repre_ids)
+ # Get and destroy the action group
+ self._accept_btn.clear_actions()
+
+ if not loaders:
+ return
+
+ # Build new action group
+ group = QtWidgets.QActionGroup(self._accept_btn)
+
+ for loader in loaders:
+ # Label
+ label = getattr(loader, "label", None)
+ if label is None:
+ label = loader.__name__
+
+ action = group.addAction(label)
+ # action = QtWidgets.QAction(label)
+ action.setData(loader)
+
+ # Support font-awesome icons using the `.icon` and `.color`
+ # attributes on plug-ins.
+ icon = getattr(loader, "icon", None)
+ if icon is not None:
+ try:
+ key = "fa.{0}".format(icon)
+ color = getattr(loader, "color", "white")
+ action.setIcon(qtawesome.icon(key, color=color))
+
+ except Exception as exc:
+ print("Unable to set icon for loader {}: {}".format(
+ loader, str(exc)
+ ))
+
+ self._accept_btn.add_action(action)
+
+ group.triggered.connect(self._on_action_clicked)
+
+ def _on_action_clicked(self, action):
+ loader_plugin = action.data()
+ self._trigger_switch(loader_plugin)
+
+ def _get_loaders(self, repre_ids):
+ repre_contexts = None
+ if repre_ids:
+ repre_contexts = pipeline.get_repres_contexts(repre_ids)
+
+ if not repre_contexts:
return list()
- available_loaders = filter(
- lambda l: not (hasattr(l, "is_utility") and l.is_utility),
- api.discover(api.Loader)
- )
+ available_loaders = []
+ for loader_plugin in api.discover(api.Loader):
+ # Skip loaders without switch method
+ if not hasattr(loader_plugin, "switch"):
+ continue
- loaders = set()
-
- for representation in representations:
- for loader in api.loaders_from_representation(
- available_loaders,
- representation
+ # Skip utility loaders
+ if (
+ hasattr(loader_plugin, "is_utility")
+ and loader_plugin.is_utility
):
- loaders.add(loader)
+ continue
+ available_loaders.append(loader_plugin)
+
+ loaders = None
+ for repre_context in repre_contexts.values():
+ _loaders = set(pipeline.loaders_from_repre_context(
+ available_loaders, repre_context
+ ))
+ if loaders is None:
+ loaders = _loaders
+ else:
+ loaders = _loaders.intersection(loaders)
+
+ if not loaders:
+ break
+
+ if loaders is None:
+ loaders = []
+ else:
+ loaders = list(loaders)
return loaders
@@ -325,12 +418,11 @@ class SwitchAssetDialog(QtWidgets.QDialog):
def apply_validations(self, validation_state):
error_msg = "*Please select"
error_sheet = "border: 1px solid red;"
- success_sheet = "border: 1px solid green;"
asset_sheet = None
subset_sheet = None
repre_sheet = None
- accept_sheet = None
+ accept_state = ""
if validation_state.asset_ok is False:
asset_sheet = error_sheet
self._asset_label.setText(error_msg)
@@ -342,14 +434,297 @@ class SwitchAssetDialog(QtWidgets.QDialog):
self._repre_label.setText(error_msg)
if validation_state.all_ok:
- accept_sheet = success_sheet
+ accept_state = "1"
self._assets_box.setStyleSheet(asset_sheet or "")
self._subsets_box.setStyleSheet(subset_sheet or "")
self._representations_box.setStyleSheet(repre_sheet or "")
self._accept_btn.setEnabled(validation_state.all_ok)
- self._accept_btn.setStyleSheet(accept_sheet or "")
+ self._set_style_property(self._accept_btn, "state", accept_state)
+
+ def _set_style_property(self, widget, name, value):
+ cur_value = widget.property(name)
+ if cur_value == value:
+ return
+ widget.setProperty(name, value)
+ widget.style().polish(widget)
+
+ def _get_current_output_repre_ids(self):
+ # NOTE hero versions are not used because it is expected that
+ # hero version has same representations as latests
+ selected_asset = self._assets_box.currentText()
+ selected_subset = self._subsets_box.currentText()
+ selected_repre = self._representations_box.currentText()
+
+ # Nothing is selected
+ # [ ] [ ] [ ]
+ if not selected_asset and not selected_subset and not selected_repre:
+ return list(self.content_repres.keys())
+
+ # Prepare asset document if asset is selected
+ asset_doc = None
+ if selected_asset:
+ asset_doc = io.find_one(
+ {"type": "asset", "name": selected_asset},
+ {"_id": True}
+ )
+ if not asset_doc:
+ return []
+
+ # Everything is selected
+ # [x] [x] [x]
+ if selected_asset and selected_subset and selected_repre:
+ return self._get_current_output_repre_ids_xxx(
+ asset_doc, selected_subset, selected_repre
+ )
+
+ # [x] [x] [ ]
+ # If asset and subset is selected
+ if selected_asset and selected_subset:
+ return self._get_current_output_repre_ids_xxo(
+ asset_doc, selected_subset
+ )
+
+ # [x] [ ] [x]
+ # If asset and repre is selected
+ if selected_asset and selected_repre:
+ return self._get_current_output_repre_ids_xox(
+ asset_doc, selected_repre
+ )
+
+ # [x] [ ] [ ]
+ # If asset and subset is selected
+ if selected_asset:
+ return self._get_current_output_repre_ids_xoo(asset_doc)
+
+ # [ ] [x] [x]
+ if selected_subset and selected_repre:
+ return self._get_current_output_repre_ids_oxx(
+ selected_subset, selected_repre
+ )
+
+ # [ ] [x] [ ]
+ if selected_subset:
+ return self._get_current_output_repre_ids_oxo(
+ selected_subset
+ )
+
+ # [ ] [ ] [x]
+ return self._get_current_output_repre_ids_oox(selected_repre)
+
+ def _get_current_output_repre_ids_xxx(
+ self, asset_doc, selected_subset, selected_repre
+ ):
+ subset_doc = io.find_one(
+ {
+ "type": "subset",
+ "name": selected_subset,
+ "parent": asset_doc["_id"]
+ },
+ {"_id": True}
+ )
+ subset_id = subset_doc["_id"]
+ last_versions_by_subset_id = self.find_last_versions([subset_id])
+ version_doc = last_versions_by_subset_id.get(subset_id)
+ if not version_doc:
+ return []
+
+ repre_docs = io.find(
+ {
+ "type": "representation",
+ "parent": version_doc["_id"],
+ "name": selected_repre
+ },
+ {"_id": True}
+ )
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_xxo(self, asset_doc, selected_subset):
+ subset_doc = io.find_one(
+ {
+ "type": "subset",
+ "parent": asset_doc["_id"],
+ "name": selected_subset
+ },
+ {"_id": True}
+ )
+ if not subset_doc:
+ return []
+
+ repre_names = set()
+ for repre_doc in self.content_repres.values():
+ repre_names.add(repre_doc["name"])
+
+ repre_docs = io.find(
+ {
+ "type": "rerpesentation",
+ "parent": subset_doc["_id"],
+ "name": {"$in": list(repre_names)}
+ },
+ {"_id": True}
+ )
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_xox(self, asset_doc, selected_repre):
+ susbet_names = set()
+ for subset_doc in self.content_subsets.values():
+ susbet_names.add(subset_doc["name"])
+
+ subset_docs = io.find(
+ {
+ "type": "subset",
+ "name": {"$in": list(susbet_names)},
+ "parent": asset_doc["_id"]
+ },
+ {"_id": True}
+ )
+ subset_ids = [subset_doc["_id"] for subset_doc in subset_docs]
+ repre_docs = io.find(
+ {
+ "type": "representation",
+ "parent": {"$in": subset_ids},
+ "name": selected_repre
+ },
+ {"_id": True}
+ )
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_xoo(self, asset_doc):
+ repres_by_subset_name = collections.defaultdict(set)
+ for repre_doc in self.content_repres.values():
+ repre_name = repre_doc["name"]
+ version_doc = self.content_versions[repre_doc["parent"]]
+ subset_doc = self.content_subsets[version_doc["parent"]]
+ subset_name = subset_doc["name"]
+ repres_by_subset_name[subset_name].add(repre_name)
+
+ subset_docs = list(io.find(
+ {
+ "type": "subset",
+ "parent": asset_doc["_id"],
+ "name": {"$in": list(repres_by_subset_name.keys())}
+ },
+ {"_id": True, "name": True}
+ ))
+ subset_name_by_id = {
+ subset_doc["_id"]: subset_doc["name"]
+ for subset_doc in subset_docs
+ }
+ subset_ids = list(subset_name_by_id.keys())
+ last_versions_by_subset_id = self.find_last_versions(subset_ids)
+ last_version_id_by_subset_name = {}
+ for subset_id, last_version in last_versions_by_subset_id.items():
+ subset_name = subset_name_by_id[subset_id]
+ last_version_id_by_subset_name[subset_name] = (
+ last_version["_id"]
+ )
+
+ repre_or_query = []
+ for subset_name, repre_names in repres_by_subset_name.items():
+ version_id = last_version_id_by_subset_name.get(subset_name)
+ # This should not happen but why to crash?
+ if version_id is None:
+ continue
+ repre_or_query.append({
+ "parent": version_id,
+ "name": {"$in": list(repre_names)}
+ })
+ repre_docs = io.find(
+ {"$or": repre_or_query},
+ {"_id": True}
+ )
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_oxx(
+ self, selected_subset, selected_repre
+ ):
+ subset_docs = list(io.find({
+ "type": "subset",
+ "parent": {"$in": list(self.content_assets.keys())},
+ "name": selected_subset
+ }))
+ subset_ids = [subset_doc["_id"] for subset_doc in subset_docs]
+ last_versions_by_subset_id = self.find_last_versions(subset_ids)
+ last_version_ids = [
+ last_version["_id"]
+ for last_version in last_versions_by_subset_id.values()
+ ]
+ repre_docs = io.find({
+ "type": "representation",
+ "parent": {"$in": last_version_ids},
+ "name": selected_repre
+ })
+
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_oxo(self, selected_subset):
+ subset_docs = list(io.find(
+ {
+ "type": "subset",
+ "parent": {"$in": list(self.content_assets.keys())},
+ "name": selected_subset
+ },
+ {"_id": True, "parent": True}
+ ))
+ if not subset_docs:
+ return list()
+
+ subset_docs_by_id = {
+ subset_doc["_id"]: subset_doc
+ for subset_doc in subset_docs
+ }
+ last_versions_by_subset_id = self.find_last_versions(
+ subset_docs_by_id.keys()
+ )
+
+ subset_id_by_version_id = {}
+ for subset_id, last_version in last_versions_by_subset_id.items():
+ version_id = last_version["_id"]
+ subset_id_by_version_id[version_id] = subset_id
+
+ if not subset_id_by_version_id:
+ return list()
+
+ repre_names_by_asset_id = collections.defaultdict(set)
+ for repre_doc in self.content_repres.values():
+ version_doc = self.content_versions[repre_doc["parent"]]
+ subset_doc = self.content_subsets[version_doc["parent"]]
+ asset_doc = self.content_assets[subset_doc["parent"]]
+ repre_name = repre_doc["name"]
+ asset_id = asset_doc["_id"]
+ repre_names_by_asset_id[asset_id].add(repre_name)
+
+ repre_or_query = []
+ for last_version_id, subset_id in subset_id_by_version_id.items():
+ subset_doc = subset_docs_by_id[subset_id]
+ asset_id = subset_doc["parent"]
+ repre_names = repre_names_by_asset_id.get(asset_id)
+ if not repre_names:
+ continue
+ repre_or_query.append({
+ "parent": last_version_id,
+ "name": {"$in": list(repre_names)}
+ })
+ repre_docs = io.find(
+ {
+ "type": "representation",
+ "$or": repre_or_query
+ },
+ {"_id": True}
+ )
+
+ return [repre_doc["_id"] for repre_doc in repre_docs]
+
+ def _get_current_output_repre_ids_oox(self, selected_repre):
+ repre_docs = io.find(
+ {
+ "name": selected_repre,
+ "parent": {"$in": list(self.content_versions.keys())}
+ },
+ {"_id": True}
+ )
+ return [repre_doc["_id"] for repre_doc in repre_docs]
def _get_asset_box_values(self):
asset_docs = io.find(
@@ -852,6 +1227,9 @@ class SwitchAssetDialog(QtWidgets.QDialog):
self._assets_box.setCurrentIndex(index)
def _on_accept(self):
+ self._trigger_switch()
+
+ def _trigger_switch(self, loader=None):
# Use None when not a valid value or when placeholder value
selected_asset = self._assets_box.get_valid_value()
selected_subset = self._subsets_box.get_valid_value()
@@ -974,7 +1352,7 @@ class SwitchAssetDialog(QtWidgets.QDialog):
repre_doc = repres_by_name[container_repre_name]
try:
- api.switch(container, repre_doc)
+ api.switch(container, repre_doc, loader)
except Exception:
msg = (
"Couldn't switch asset."
diff --git a/openpype/tools/sceneinventory/widgets.py b/openpype/tools/sceneinventory/widgets.py
index 6bb74d2d1b..4c4aafad3a 100644
--- a/openpype/tools/sceneinventory/widgets.py
+++ b/openpype/tools/sceneinventory/widgets.py
@@ -1,26 +1,68 @@
from Qt import QtWidgets, QtCore
+from openpype import style
+
+
+class ButtonWithMenu(QtWidgets.QToolButton):
+ def __init__(self, parent=None):
+ super(ButtonWithMenu, self).__init__(parent)
+
+ self.setObjectName("ButtonWithMenu")
+
+ self.setPopupMode(self.MenuButtonPopup)
+ menu = QtWidgets.QMenu(self)
+
+ self.setMenu(menu)
+
+ self._menu = menu
+ self._actions = []
+
+ def menu(self):
+ return self._menu
+
+ def clear_actions(self):
+ if self._menu is not None:
+ self._menu.clear()
+ self._actions = []
+
+ def add_action(self, action):
+ self._actions.append(action)
+ self._menu.addAction(action)
+
+ def _on_action_trigger(self):
+ action = self.sender()
+ if action not in self._actions:
+ return
+ action.trigger()
class SearchComboBox(QtWidgets.QComboBox):
"""Searchable ComboBox with empty placeholder value as first value"""
- def __init__(self, parent=None):
+ def __init__(self, parent):
super(SearchComboBox, self).__init__(parent)
self.setEditable(True)
self.setInsertPolicy(self.NoInsert)
- # Apply completer settings
+ combobox_delegate = QtWidgets.QStyledItemDelegate(self)
+ self.setItemDelegate(combobox_delegate)
+
completer = self.completer()
- completer.setCompletionMode(completer.PopupCompletion)
+ completer.setCompletionMode(
+ QtWidgets.QCompleter.PopupCompletion
+ )
completer.setCaseSensitivity(QtCore.Qt.CaseInsensitive)
- # Force style sheet on popup menu
- # It won't take the parent stylesheet for some reason
- # todo: better fix for completer popup stylesheet
- # if module.window:
- # popup = completer.popup()
- # popup.setStyleSheet(module.window.styleSheet())
+ completer_view = completer.popup()
+ completer_view.setObjectName("CompleterView")
+ completer_delegate = QtWidgets.QStyledItemDelegate(completer_view)
+ completer_view.setItemDelegate(completer_delegate)
+ completer_view.setStyleSheet(style.load_stylesheet())
+
+ self._combobox_delegate = combobox_delegate
+
+ self._completer_delegate = completer_delegate
+ self._completer = completer
def set_placeholder(self, placeholder):
self.lineEdit().setPlaceholderText(placeholder)
diff --git a/openpype/tools/utils/assets_widget.py b/openpype/tools/utils/assets_widget.py
new file mode 100644
index 0000000000..041bb1ef1c
--- /dev/null
+++ b/openpype/tools/utils/assets_widget.py
@@ -0,0 +1,810 @@
+import time
+import collections
+
+import Qt
+from Qt import QtWidgets, QtCore, QtGui
+
+from avalon import style
+from avalon.vendor import qtawesome
+
+from openpype.style import get_objected_colors
+from openpype.tools.flickcharm import FlickCharm
+
+from .views import (
+ TreeViewSpinner,
+ DeselectableTreeView
+)
+from .widgets import PlaceholderLineEdit
+from .models import RecursiveSortFilterProxyModel
+from .lib import DynamicQThread
+
+if Qt.__binding__ == "PySide":
+ from PySide.QtGui import QStyleOptionViewItemV4
+elif Qt.__binding__ == "PyQt4":
+ from PyQt4.QtGui import QStyleOptionViewItemV4
+
+ASSET_ID_ROLE = QtCore.Qt.UserRole + 1
+ASSET_NAME_ROLE = QtCore.Qt.UserRole + 2
+ASSET_LABEL_ROLE = QtCore.Qt.UserRole + 3
+ASSET_UNDERLINE_COLORS_ROLE = QtCore.Qt.UserRole + 4
+
+
+class AssetsView(TreeViewSpinner, DeselectableTreeView):
+ """Asset items view.
+
+ Adds abilities to deselect, show loading spinner and add flick charm
+ (scroll by mouse/touchpad click and move).
+ """
+
+ def __init__(self, parent=None):
+ super(AssetsView, self).__init__(parent)
+ self.setIndentation(15)
+ self.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
+ self.setHeaderHidden(True)
+
+ self._flick_charm_activated = False
+ self._flick_charm = FlickCharm(parent=self)
+ self._before_flick_scroll_mode = None
+
+ def activate_flick_charm(self):
+ if self._flick_charm_activated:
+ return
+ self._flick_charm_activated = True
+ self._before_flick_scroll_mode = self.verticalScrollMode()
+ self._flick_charm.activateOn(self)
+ self.setVerticalScrollMode(self.ScrollPerPixel)
+
+ def deactivate_flick_charm(self):
+ if not self._flick_charm_activated:
+ return
+ self._flick_charm_activated = False
+ self._flick_charm.deactivateFrom(self)
+ if self._before_flick_scroll_mode is not None:
+ self.setVerticalScrollMode(self._before_flick_scroll_mode)
+
+ def mousePressEvent(self, event):
+ index = self.indexAt(event.pos())
+ if not index.isValid():
+ modifiers = QtWidgets.QApplication.keyboardModifiers()
+ if modifiers == QtCore.Qt.ShiftModifier:
+ return
+ elif modifiers == QtCore.Qt.ControlModifier:
+ return
+
+ super(AssetsView, self).mousePressEvent(event)
+
+ def set_loading_state(self, loading, empty):
+ """Change loading state.
+
+ TODO: Separate into 2 individual methods.
+
+ Args:
+ loading(bool): Is loading.
+ empty(bool): Is model empty.
+ """
+ if self.is_loading != loading:
+ if loading:
+ self.spinner.repaintNeeded.connect(
+ self.viewport().update
+ )
+ else:
+ self.spinner.repaintNeeded.disconnect()
+ self.viewport().update()
+
+ self.is_loading = loading
+ self.is_empty = empty
+
+
+class UnderlinesAssetDelegate(QtWidgets.QItemDelegate):
+ """Item delegate drawing bars under asset name.
+
+ This is used in loader and library loader tools. Multiselection of assets
+ may group subsets by name under colored groups. Selected color groups are
+ then propagated back to selected assets as underlines.
+ """
+ bar_height = 3
+
+ def __init__(self, *args, **kwargs):
+ super(UnderlinesAssetDelegate, self).__init__(*args, **kwargs)
+ asset_view_colors = get_objected_colors()["loader"]["asset-view"]
+ self._selected_color = (
+ asset_view_colors["selected"].get_qcolor()
+ )
+ self._hover_color = (
+ asset_view_colors["hover"].get_qcolor()
+ )
+ self._selected_hover_color = (
+ asset_view_colors["selected-hover"].get_qcolor()
+ )
+
+ def sizeHint(self, option, index):
+ """Add bar height to size hint."""
+ result = super(UnderlinesAssetDelegate, self).sizeHint(option, index)
+ height = result.height()
+ result.setHeight(height + self.bar_height)
+
+ return result
+
+ def paint(self, painter, option, index):
+ """Replicate painting of an item and draw color bars if needed."""
+ # Qt4 compat
+ if Qt.__binding__ in ("PySide", "PyQt4"):
+ option = QStyleOptionViewItemV4(option)
+
+ painter.save()
+
+ item_rect = QtCore.QRect(option.rect)
+ item_rect.setHeight(option.rect.height() - self.bar_height)
+
+ subset_colors = index.data(ASSET_UNDERLINE_COLORS_ROLE) or []
+ subset_colors_width = 0
+ if subset_colors:
+ subset_colors_width = option.rect.width() / len(subset_colors)
+
+ subset_rects = []
+ counter = 0
+ for subset_c in subset_colors:
+ new_color = None
+ new_rect = None
+ if subset_c:
+ new_color = QtGui.QColor(*subset_c)
+
+ new_rect = QtCore.QRect(
+ option.rect.left() + (counter * subset_colors_width),
+ option.rect.top() + (
+ option.rect.height() - self.bar_height
+ ),
+ subset_colors_width,
+ self.bar_height
+ )
+ subset_rects.append((new_color, new_rect))
+ counter += 1
+
+ # Background
+ if option.state & QtWidgets.QStyle.State_Selected:
+ if len(subset_colors) == 0:
+ item_rect.setTop(item_rect.top() + (self.bar_height / 2))
+
+ if option.state & QtWidgets.QStyle.State_MouseOver:
+ bg_color = self._selected_hover_color
+ else:
+ bg_color = self._selected_color
+ else:
+ item_rect.setTop(item_rect.top() + (self.bar_height / 2))
+ if option.state & QtWidgets.QStyle.State_MouseOver:
+ bg_color = self._hover_color
+ else:
+ bg_color = QtGui.QColor()
+ bg_color.setAlpha(0)
+
+ # When not needed to do a rounded corners (easier and without
+ # painter restore):
+ painter.fillRect(
+ option.rect,
+ QtGui.QBrush(bg_color)
+ )
+
+ if option.state & QtWidgets.QStyle.State_Selected:
+ for color, subset_rect in subset_rects:
+ if not color or not subset_rect:
+ continue
+ painter.fillRect(subset_rect, QtGui.QBrush(color))
+
+ # Icon
+ icon_index = index.model().index(
+ index.row(), index.column(), index.parent()
+ )
+ # - Default icon_rect if not icon
+ icon_rect = QtCore.QRect(
+ item_rect.left(),
+ item_rect.top(),
+ # To make sure it's same size all the time
+ option.rect.height() - self.bar_height,
+ option.rect.height() - self.bar_height
+ )
+ icon = index.model().data(icon_index, QtCore.Qt.DecorationRole)
+
+ if icon:
+ mode = QtGui.QIcon.Normal
+ if not (option.state & QtWidgets.QStyle.State_Enabled):
+ mode = QtGui.QIcon.Disabled
+ elif option.state & QtWidgets.QStyle.State_Selected:
+ mode = QtGui.QIcon.Selected
+
+ if isinstance(icon, QtGui.QPixmap):
+ icon = QtGui.QIcon(icon)
+ option.decorationSize = icon.size() / icon.devicePixelRatio()
+
+ elif isinstance(icon, QtGui.QColor):
+ pixmap = QtGui.QPixmap(option.decorationSize)
+ pixmap.fill(icon)
+ icon = QtGui.QIcon(pixmap)
+
+ elif isinstance(icon, QtGui.QImage):
+ icon = QtGui.QIcon(QtGui.QPixmap.fromImage(icon))
+ option.decorationSize = icon.size() / icon.devicePixelRatio()
+
+ elif isinstance(icon, QtGui.QIcon):
+ state = QtGui.QIcon.Off
+ if option.state & QtWidgets.QStyle.State_Open:
+ state = QtGui.QIcon.On
+ actual_size = option.icon.actualSize(
+ option.decorationSize, mode, state
+ )
+ option.decorationSize = QtCore.QSize(
+ min(option.decorationSize.width(), actual_size.width()),
+ min(option.decorationSize.height(), actual_size.height())
+ )
+
+ state = QtGui.QIcon.Off
+ if option.state & QtWidgets.QStyle.State_Open:
+ state = QtGui.QIcon.On
+
+ icon.paint(
+ painter, icon_rect,
+ QtCore.Qt.AlignLeft, mode, state
+ )
+
+ # Text
+ text_rect = QtCore.QRect(
+ icon_rect.left() + icon_rect.width() + 2,
+ item_rect.top(),
+ item_rect.width(),
+ item_rect.height()
+ )
+
+ painter.drawText(
+ text_rect, QtCore.Qt.AlignVCenter,
+ index.data(QtCore.Qt.DisplayRole)
+ )
+
+ painter.restore()
+
+
+class AssetModel(QtGui.QStandardItemModel):
+ """A model listing assets in the active project.
+
+ The assets are displayed in a treeview, they are visually parented by
+ a `visualParent` field in the database containing an `_id` to a parent
+ asset.
+
+ Asset document may have defined label, icon or icon color.
+
+ Loading of data for model happens in thread which means that refresh
+ is not sequential. When refresh is triggered it is required to listen for
+ 'refreshed' signal.
+
+ Args:
+ dbcon (AvalonMongoDB): Ready to use connection to mongo with.
+ parent (QObject): Parent Qt object.
+ """
+
+ _doc_fetched = QtCore.Signal()
+ refreshed = QtCore.Signal(bool)
+
+ # Asset document projection
+ _asset_projection = {
+ "name": 1,
+ "parent": 1,
+ "data.visualParent": 1,
+ "data.label": 1,
+ "data.icon": 1,
+ "data.color": 1
+ }
+
+ def __init__(self, dbcon, parent=None):
+ super(AssetModel, self).__init__(parent=parent)
+ self.dbcon = dbcon
+
+ self._refreshing = False
+ self._doc_fetching_thread = None
+ self._doc_fetching_stop = False
+ self._doc_payload = []
+
+ self._doc_fetched.connect(self._on_docs_fetched)
+
+ self._items_with_color_by_id = {}
+ self._items_by_asset_id = {}
+
+ @property
+ def refreshing(self):
+ return self._refreshing
+
+ def get_index_by_asset_id(self, asset_id):
+ item = self._items_by_asset_id.get(asset_id)
+ if item is not None:
+ return item.index()
+ return QtCore.QModelIndex()
+
+ def get_indexes_by_asset_ids(self, asset_ids):
+ return [
+ self.get_index_by_asset_id(asset_id)
+ for asset_id in asset_ids
+ ]
+
+ def get_index_by_asset_name(self, asset_name):
+ indexes = self.get_indexes_by_asset_names([asset_name])
+ for index in indexes:
+ if index.isValid():
+ return index
+ return indexes[0]
+
+ def get_indexes_by_asset_names(self, asset_names):
+ asset_ids_by_name = {
+ asset_name: None
+ for asset_name in asset_names
+ }
+
+ for asset_id, item in self._items_by_asset_id.items():
+ asset_name = item.data(ASSET_NAME_ROLE)
+ if asset_name in asset_ids_by_name:
+ asset_ids_by_name[asset_name] = asset_id
+
+ asset_ids = [
+ asset_ids_by_name[asset_name]
+ for asset_name in asset_names
+ ]
+
+ return self.get_indexes_by_asset_ids(asset_ids)
+
+ def refresh(self, force=False):
+ """Refresh the data for the model."""
+ # Skip fetch if there is already other thread fetching documents
+ if self._refreshing:
+ if not force:
+ return
+ self.stop_refresh()
+
+ # Fetch documents from mongo
+ # Restart payload
+ self._refreshing = True
+ self._doc_payload = []
+ self._doc_fetching_thread = DynamicQThread(self._threaded_fetch)
+ self._doc_fetching_thread.start()
+
+ def stop_refresh(self):
+ self._stop_fetch_thread()
+
+ def clear_underlines(self):
+ for asset_id in tuple(self._items_with_color_by_id.keys()):
+ item = self._items_with_color_by_id.pop(asset_id)
+ item.setData(None, ASSET_UNDERLINE_COLORS_ROLE)
+
+ def set_underline_colors(self, colors_by_asset_id):
+ self.clear_underlines()
+
+ for asset_id, colors in colors_by_asset_id.items():
+ item = self._items_by_asset_id.get(asset_id)
+ if item is None:
+ continue
+ item.setData(colors, ASSET_UNDERLINE_COLORS_ROLE)
+
+ def _on_docs_fetched(self):
+ # Make sure refreshing did not change
+ # - since this line is refreshing sequential and
+ # triggering of new refresh will happen when this method is done
+ if not self._refreshing:
+ root_item = self.invisibleRootItem()
+ root_item.removeRows(0, root_item.rowCount())
+ self._items_by_asset_id = {}
+ self._items_with_color_by_id = {}
+ return
+
+ # Collect asset documents as needed
+ asset_ids = set()
+ asset_docs_by_id = {}
+ asset_ids_by_parents = collections.defaultdict(set)
+ for asset_doc in self._doc_payload:
+ asset_id = asset_doc["_id"]
+ asset_data = asset_doc.get("data") or {}
+ parent_id = asset_data.get("visualParent")
+ asset_ids.add(asset_id)
+ asset_docs_by_id[asset_id] = asset_doc
+ asset_ids_by_parents[parent_id].add(asset_id)
+
+ # Prepare removed asset ids
+ removed_asset_ids = (
+ set(self._items_by_asset_id.keys()) - set(asset_docs_by_id.keys())
+ )
+
+ # Prepare queue for adding new items
+ asset_items_queue = collections.deque()
+
+ # Queue starts with root item and 'visualParent' None
+ root_item = self.invisibleRootItem()
+ asset_items_queue.append((None, root_item))
+
+ while asset_items_queue:
+ # Get item from queue
+ parent_id, parent_item = asset_items_queue.popleft()
+ # Skip if there are no children
+ children_ids = asset_ids_by_parents[parent_id]
+ if not children_ids:
+ continue
+
+ # Go through current children of parent item
+ # - find out items that were deleted and skip creation of already
+ # existing items
+ for row in reversed(range(parent_item.rowCount())):
+ child_item = parent_item.child(row, 0)
+ asset_id = child_item.data(ASSET_ID_ROLE)
+ # Remove item that is not available
+ if asset_id not in children_ids:
+ if asset_id in removed_asset_ids:
+ # Remove and destroy row
+ parent_item.removeRow(row)
+ else:
+ # Just take the row from parent without destroying
+ parent_item.takeRow(row)
+ continue
+
+ # Remove asset id from `children_ids` set
+ # - is used as set for creation of "new items"
+ children_ids.remove(asset_id)
+ # Add existing children to queue
+ asset_items_queue.append((asset_id, child_item))
+
+ new_items = []
+ for asset_id in children_ids:
+ # Look for item in cache (maybe parent changed)
+ item = self._items_by_asset_id.get(asset_id)
+ # Create new item if was not found
+ if item is None:
+ item = QtGui.QStandardItem()
+ item.setEditable(False)
+ item.setData(asset_id, ASSET_ID_ROLE)
+ self._items_by_asset_id[asset_id] = item
+ new_items.append(item)
+ # Add item to queue
+ asset_items_queue.append((asset_id, item))
+
+ if new_items:
+ parent_item.appendRows(new_items)
+
+ # Remove cache of removed items
+ for asset_id in removed_asset_ids:
+ self._items_by_asset_id.pop(asset_id)
+ if asset_id in self._items_with_color_by_id:
+ self._items_with_color_by_id.pop(asset_id)
+
+ # Refresh data
+ # - all items refresh all data except id
+ for asset_id, item in self._items_by_asset_id.items():
+ asset_doc = asset_docs_by_id[asset_id]
+
+ asset_name = asset_doc["name"]
+ if item.data(ASSET_NAME_ROLE) != asset_name:
+ item.setData(asset_name, ASSET_NAME_ROLE)
+
+ asset_data = asset_doc.get("data") or {}
+ asset_label = asset_data.get("label") or asset_name
+ if item.data(ASSET_LABEL_ROLE) != asset_label:
+ item.setData(asset_label, QtCore.Qt.DisplayRole)
+ item.setData(asset_label, ASSET_LABEL_ROLE)
+
+ icon_color = asset_data.get("color") or style.colors.default
+ icon_name = asset_data.get("icon")
+ if not icon_name:
+ # Use default icons if no custom one is specified.
+ # If it has children show a full folder, otherwise
+ # show an open folder
+ if item.rowCount() > 0:
+ icon_name = "folder"
+ else:
+ icon_name = "folder-o"
+
+ try:
+ # font-awesome key
+ full_icon_name = "fa.{0}".format(icon_name)
+ icon = qtawesome.icon(full_icon_name, color=icon_color)
+ item.setData(icon, QtCore.Qt.DecorationRole)
+
+ except Exception:
+ pass
+
+ self.refreshed.emit(bool(self._items_by_asset_id))
+
+ self._stop_fetch_thread()
+
+ def _threaded_fetch(self):
+ asset_docs = self._fetch_asset_docs()
+ if not self._refreshing:
+ return
+
+ self._doc_payload = asset_docs
+
+ # Emit doc fetched only if was not stopped
+ self._doc_fetched.emit()
+
+ def _fetch_asset_docs(self):
+ if not self.dbcon.Session.get("AVALON_PROJECT"):
+ return []
+
+ project_doc = self.dbcon.find_one(
+ {"type": "project"},
+ {"_id": True}
+ )
+ if not project_doc:
+ return []
+
+ # Get all assets sorted by name
+ return list(self.dbcon.find(
+ {"type": "asset"},
+ self._asset_projection
+ ))
+
+ def _stop_fetch_thread(self):
+ self._refreshing = False
+ if self._doc_fetching_thread is not None:
+ while self._doc_fetching_thread.isRunning():
+ time.sleep(0.01)
+ self._doc_fetching_thread = None
+
+
+class AssetsWidget(QtWidgets.QWidget):
+ """Base widget to display a tree of assets with filter.
+
+ Assets have only one column and are sorted by name.
+
+ Refreshing of assets happens in thread so calling 'refresh' method
+ is not sequential. To capture moment when refreshing is finished listen
+ to 'refreshed' signal.
+
+ To capture selection changes listen to 'selection_changed' signal. It won't
+ send any information about new selection as it may be different based on
+ inheritance changes.
+
+ Args:
+ dbcon (AvalonMongoDB): Connection to avalon mongo db.
+ parent (QWidget): Parent Qt widget.
+ """
+
+ # on model refresh
+ refresh_triggered = QtCore.Signal()
+ refreshed = QtCore.Signal()
+ # on view selection change
+ selection_changed = QtCore.Signal()
+ # It was double clicked on view
+ double_clicked = QtCore.Signal()
+
+ def __init__(self, dbcon, parent=None):
+ super(AssetsWidget, self).__init__(parent=parent)
+
+ self.dbcon = dbcon
+
+ # Tree View
+ model = AssetModel(dbcon=self.dbcon, parent=self)
+ proxy = RecursiveSortFilterProxyModel()
+ proxy.setSourceModel(model)
+ proxy.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive)
+ proxy.setSortCaseSensitivity(QtCore.Qt.CaseInsensitive)
+
+ view = AssetsView(self)
+ view.setModel(proxy)
+
+ current_asset_icon = qtawesome.icon(
+ "fa.arrow-down", color=style.colors.light
+ )
+ current_asset_btn = QtWidgets.QPushButton(self)
+ current_asset_btn.setIcon(current_asset_icon)
+ current_asset_btn.setToolTip("Go to Asset from current Session")
+ # Hide by default
+ current_asset_btn.setVisible(False)
+
+ refresh_icon = qtawesome.icon("fa.refresh", color=style.colors.light)
+ refresh_btn = QtWidgets.QPushButton(self)
+ refresh_btn.setIcon(refresh_icon)
+ refresh_btn.setToolTip("Refresh items")
+
+ filter_input = PlaceholderLineEdit(self)
+ filter_input.setPlaceholderText("Filter assets..")
+
+ # Header
+ header_layout = QtWidgets.QHBoxLayout()
+ header_layout.addWidget(filter_input)
+ header_layout.addWidget(current_asset_btn)
+ header_layout.addWidget(refresh_btn)
+
+ # Layout
+ layout = QtWidgets.QVBoxLayout(self)
+ layout.setContentsMargins(0, 0, 0, 0)
+ layout.setSpacing(4)
+ layout.addLayout(header_layout)
+ layout.addWidget(view)
+
+ # Signals/Slots
+ filter_input.textChanged.connect(self._on_filter_text_change)
+
+ selection_model = view.selectionModel()
+ selection_model.selectionChanged.connect(self._on_selection_change)
+ refresh_btn.clicked.connect(self.refresh)
+ current_asset_btn.clicked.connect(self.set_current_session_asset)
+ model.refreshed.connect(self._on_model_refresh)
+ view.doubleClicked.connect(self.double_clicked)
+
+ self._current_asset_btn = current_asset_btn
+ self._model = model
+ self._proxy = proxy
+ self._view = view
+
+ self.model_selection = {}
+
+ @property
+ def refreshing(self):
+ return self._model.refreshing
+
+ def refresh(self):
+ self._refresh_model()
+
+ def stop_refresh(self):
+ self._model.stop_refresh()
+
+ def set_current_session_asset(self):
+ asset_name = self.dbcon.Session.get("AVALON_ASSET")
+ if asset_name:
+ self.select_asset_by_name(asset_name)
+
+ def set_current_asset_btn_visibility(self, visible=None):
+ """Hide set current asset button.
+
+ Not all tools support using of current context asset.
+ """
+ if visible is None:
+ visible = not self._current_asset_btn.isVisible()
+ self._current_asset_btn.setVisible(visible)
+
+ def select_asset(self, asset_id):
+ index = self._model.get_index_by_asset_id(asset_id)
+ new_index = self._proxy.mapFromSource(index)
+ self._select_indexes([new_index])
+
+ def select_asset_by_name(self, asset_name):
+ index = self._model.get_index_by_asset_name(asset_name)
+ new_index = self._proxy.mapFromSource(index)
+ self._select_indexes([new_index])
+
+ def activate_flick_charm(self):
+ self._view.activate_flick_charm()
+
+ def deactivate_flick_charm(self):
+ self._view.deactivate_flick_charm()
+
+ def _on_selection_change(self):
+ self.selection_changed.emit()
+
+ def _on_filter_text_change(self, new_text):
+ self._proxy.setFilterFixedString(new_text)
+
+ def _on_model_refresh(self, has_item):
+ self._proxy.sort(0)
+ self._set_loading_state(loading=False, empty=not has_item)
+ self.refreshed.emit()
+
+ def _refresh_model(self):
+ # Store selection
+ self._set_loading_state(loading=True, empty=True)
+
+ # Trigger signal before refresh is called
+ self.refresh_triggered.emit()
+ # Refresh model
+ self._model.refresh()
+
+ def _set_loading_state(self, loading, empty):
+ self._view.set_loading_state(loading, empty)
+
+ def _select_indexes(self, indexes):
+ valid_indexes = [
+ index
+ for index in indexes
+ if index.isValid()
+ ]
+ if not valid_indexes:
+ return
+
+ selection_model = self._view.selectionModel()
+ selection_model.clearSelection()
+
+ mode = selection_model.Select | selection_model.Rows
+ for index in valid_indexes:
+ self._view.expand(self._proxy.parent(index))
+ selection_model.select(index, mode)
+ self._view.setCurrentIndex(valid_indexes[0])
+
+
+class SingleSelectAssetsWidget(AssetsWidget):
+ """Single selection asset widget.
+
+ Contain single selection specific api methods.
+ """
+ def get_selected_asset_id(self):
+ """Currently selected asset id."""
+ selection_model = self._view.selectionModel()
+ indexes = selection_model.selectedRows()
+ for index in indexes:
+ return index.data(ASSET_ID_ROLE)
+ return None
+
+ def get_selected_asset_name(self):
+ """Currently selected asset name."""
+ selection_model = self._view.selectionModel()
+ indexes = selection_model.selectedRows()
+ for index in indexes:
+ return index.data(ASSET_NAME_ROLE)
+ return None
+
+
+class MultiSelectAssetsWidget(AssetsWidget):
+ """Multiselection asset widget.
+
+ Main purpose is for loader and library loader. If another tool would use
+ multiselection assets this widget should be split and loader's logic
+ separated.
+ """
+ def __init__(self, *args, **kwargs):
+ super(MultiSelectAssetsWidget, self).__init__(*args, **kwargs)
+ self._view.setSelectionMode(QtWidgets.QTreeView.ExtendedSelection)
+
+ delegate = UnderlinesAssetDelegate()
+ self._view.setItemDelegate(delegate)
+ self._delegate = delegate
+
+ def get_selected_asset_ids(self):
+ """Currently selected asset ids."""
+ selection_model = self._view.selectionModel()
+ indexes = selection_model.selectedRows()
+ return [
+ index.data(ASSET_ID_ROLE)
+ for index in indexes
+ ]
+
+ def get_selected_asset_names(self):
+ """Currently selected asset names."""
+ selection_model = self._view.selectionModel()
+ indexes = selection_model.selectedRows()
+ return [
+ index.data(ASSET_NAME_ROLE)
+ for index in indexes
+ ]
+
+ def select_assets(self, asset_ids):
+ """Select assets by their ids.
+
+ Args:
+ asset_ids (list): List of asset ids.
+ """
+ indexes = self._model.get_indexes_by_asset_ids(asset_ids)
+ new_indexes = [
+ self._proxy.mapFromSource(index)
+ for index in indexes
+ ]
+ self._select_indexes(new_indexes)
+
+ def select_assets_by_name(self, asset_names):
+ """Select assets by their names.
+
+ Args:
+ asset_names (list): List of asset names.
+ """
+ indexes = self._model.get_indexes_by_asset_names(asset_names)
+ new_indexes = [
+ self._proxy.mapFromSource(index)
+ for index in indexes
+ ]
+ self._select_indexes(new_indexes)
+
+ def clear_underlines(self):
+ """Clear underlines in asset items."""
+ self._model.clear_underlines()
+
+ self._view.updateGeometries()
+
+ def set_underline_colors(self, colors_by_asset_id):
+ """Change underline colors for passed assets.
+
+ Args:
+ colors_by_asset_id (dict): Key is asset id and value is list
+ of underline colors.
+ """
+ self._model.set_underline_colors(colors_by_asset_id)
+ # Trigger repaint
+ self._view.updateGeometries()
diff --git a/openpype/tools/utils/constants.py b/openpype/tools/utils/constants.py
index 33bdf43c08..8f12c57321 100644
--- a/openpype/tools/utils/constants.py
+++ b/openpype/tools/utils/constants.py
@@ -5,10 +5,6 @@ DEFAULT_PROJECT_LABEL = "< Default >"
PROJECT_NAME_ROLE = QtCore.Qt.UserRole + 101
PROJECT_IS_ACTIVE_ROLE = QtCore.Qt.UserRole + 102
-TASK_NAME_ROLE = QtCore.Qt.UserRole + 301
-TASK_TYPE_ROLE = QtCore.Qt.UserRole + 302
-TASK_ORDER_ROLE = QtCore.Qt.UserRole + 303
-
LOCAL_PROVIDER_ROLE = QtCore.Qt.UserRole + 500 # provider of active site
REMOTE_PROVIDER_ROLE = QtCore.Qt.UserRole + 501 # provider of remote site
LOCAL_PROGRESS_ROLE = QtCore.Qt.UserRole + 502 # percentage downld on active
diff --git a/openpype/tools/utils/delegates.py b/openpype/tools/utils/delegates.py
index 96353c44c6..1caed732d8 100644
--- a/openpype/tools/utils/delegates.py
+++ b/openpype/tools/utils/delegates.py
@@ -8,10 +8,7 @@ from Qt import QtWidgets, QtGui, QtCore
from avalon.lib import HeroVersionType
from openpype.style import get_objected_colors
-from .models import (
- AssetModel,
- TreeModel
-)
+from .models import TreeModel
from . import lib
if Qt.__binding__ == "PySide":
@@ -22,173 +19,6 @@ elif Qt.__binding__ == "PyQt4":
log = logging.getLogger(__name__)
-class AssetDelegate(QtWidgets.QItemDelegate):
- bar_height = 3
-
- def __init__(self, *args, **kwargs):
- super(AssetDelegate, self).__init__(*args, **kwargs)
- asset_view_colors = get_objected_colors()["loader"]["asset-view"]
- self._selected_color = (
- asset_view_colors["selected"].get_qcolor()
- )
- self._hover_color = (
- asset_view_colors["hover"].get_qcolor()
- )
- self._selected_hover_color = (
- asset_view_colors["selected-hover"].get_qcolor()
- )
-
- def sizeHint(self, option, index):
- result = super(AssetDelegate, self).sizeHint(option, index)
- height = result.height()
- result.setHeight(height + self.bar_height)
-
- return result
-
- def paint(self, painter, option, index):
- # Qt4 compat
- if Qt.__binding__ in ("PySide", "PyQt4"):
- option = QStyleOptionViewItemV4(option)
-
- painter.save()
-
- item_rect = QtCore.QRect(option.rect)
- item_rect.setHeight(option.rect.height() - self.bar_height)
-
- subset_colors = index.data(AssetModel.subsetColorsRole)
- subset_colors_width = 0
- if subset_colors:
- subset_colors_width = option.rect.width() / len(subset_colors)
-
- subset_rects = []
- counter = 0
- for subset_c in subset_colors:
- new_color = None
- new_rect = None
- if subset_c:
- new_color = QtGui.QColor(*subset_c)
-
- new_rect = QtCore.QRect(
- option.rect.left() + (counter * subset_colors_width),
- option.rect.top() + (
- option.rect.height() - self.bar_height
- ),
- subset_colors_width,
- self.bar_height
- )
- subset_rects.append((new_color, new_rect))
- counter += 1
-
- # Background
- if option.state & QtWidgets.QStyle.State_Selected:
- if len(subset_colors) == 0:
- item_rect.setTop(item_rect.top() + (self.bar_height / 2))
-
- if option.state & QtWidgets.QStyle.State_MouseOver:
- bg_color = self._selected_hover_color
- else:
- bg_color = self._selected_color
- else:
- item_rect.setTop(item_rect.top() + (self.bar_height / 2))
- if option.state & QtWidgets.QStyle.State_MouseOver:
- bg_color = self._hover_color
- else:
- bg_color = QtGui.QColor()
- bg_color.setAlpha(0)
-
- # When not needed to do a rounded corners (easier and without
- # painter restore):
- # painter.fillRect(
- # item_rect,
- # QtGui.QBrush(bg_color)
- # )
- pen = painter.pen()
- pen.setStyle(QtCore.Qt.NoPen)
- pen.setWidth(0)
- painter.setPen(pen)
- painter.setBrush(QtGui.QBrush(bg_color))
- painter.drawRoundedRect(option.rect, 3, 3)
-
- if option.state & QtWidgets.QStyle.State_Selected:
- for color, subset_rect in subset_rects:
- if not color or not subset_rect:
- continue
- painter.fillRect(subset_rect, QtGui.QBrush(color))
-
- painter.restore()
- painter.save()
-
- # Icon
- icon_index = index.model().index(
- index.row(), index.column(), index.parent()
- )
- # - Default icon_rect if not icon
- icon_rect = QtCore.QRect(
- item_rect.left(),
- item_rect.top(),
- # To make sure it's same size all the time
- option.rect.height() - self.bar_height,
- option.rect.height() - self.bar_height
- )
- icon = index.model().data(icon_index, QtCore.Qt.DecorationRole)
-
- if icon:
- mode = QtGui.QIcon.Normal
- if not (option.state & QtWidgets.QStyle.State_Enabled):
- mode = QtGui.QIcon.Disabled
- elif option.state & QtWidgets.QStyle.State_Selected:
- mode = QtGui.QIcon.Selected
-
- if isinstance(icon, QtGui.QPixmap):
- icon = QtGui.QIcon(icon)
- option.decorationSize = icon.size() / icon.devicePixelRatio()
-
- elif isinstance(icon, QtGui.QColor):
- pixmap = QtGui.QPixmap(option.decorationSize)
- pixmap.fill(icon)
- icon = QtGui.QIcon(pixmap)
-
- elif isinstance(icon, QtGui.QImage):
- icon = QtGui.QIcon(QtGui.QPixmap.fromImage(icon))
- option.decorationSize = icon.size() / icon.devicePixelRatio()
-
- elif isinstance(icon, QtGui.QIcon):
- state = QtGui.QIcon.Off
- if option.state & QtWidgets.QStyle.State_Open:
- state = QtGui.QIcon.On
- actualSize = option.icon.actualSize(
- option.decorationSize, mode, state
- )
- option.decorationSize = QtCore.QSize(
- min(option.decorationSize.width(), actualSize.width()),
- min(option.decorationSize.height(), actualSize.height())
- )
-
- state = QtGui.QIcon.Off
- if option.state & QtWidgets.QStyle.State_Open:
- state = QtGui.QIcon.On
-
- icon.paint(
- painter, icon_rect,
- QtCore.Qt.AlignLeft, mode, state
- )
-
- # Text
- text_rect = QtCore.QRect(
- icon_rect.left() + icon_rect.width() + 2,
- item_rect.top(),
- item_rect.width(),
- item_rect.height()
- )
-
- painter.drawText(
- text_rect, QtCore.Qt.AlignVCenter,
- index.data(QtCore.Qt.DisplayRole)
- )
-
- painter.restore()
-
-
class VersionDelegate(QtWidgets.QStyledItemDelegate):
"""A delegate that display version integer formatted as version string."""
diff --git a/openpype/tools/utils/host_tools.py b/openpype/tools/utils/host_tools.py
index e87da7f0b4..ef1cd3cf5c 100644
--- a/openpype/tools/utils/host_tools.py
+++ b/openpype/tools/utils/host_tools.py
@@ -62,19 +62,18 @@ class HostToolsHelper:
save = True
workfiles_tool = self.get_workfiles_tool(parent)
- if use_context:
- context = {
- "asset": avalon.api.Session["AVALON_ASSET"],
- "silo": avalon.api.Session["AVALON_SILO"],
- "task": avalon.api.Session["AVALON_TASK"]
- }
- workfiles_tool.set_context(context)
+ workfiles_tool.set_save_enabled(save)
- if save:
- workfiles_tool.set_save_enabled(save)
+ if not workfiles_tool.isVisible():
+ workfiles_tool.show()
+
+ if use_context:
+ context = {
+ "asset": avalon.api.Session["AVALON_ASSET"],
+ "task": avalon.api.Session["AVALON_TASK"]
+ }
+ workfiles_tool.set_context(context)
- workfiles_tool.refresh()
- workfiles_tool.show()
# Pull window to the front.
workfiles_tool.raise_()
workfiles_tool.activateWindow()
@@ -109,23 +108,19 @@ class HostToolsHelper:
def get_creator_tool(self, parent):
"""Create, cache and return creator tool window."""
if self._creator_tool is None:
- from avalon.tools.creator.app import Window
+ from openpype.tools.creator import CreatorWindow
- creator_window = Window(parent=parent or self._parent)
+ creator_window = CreatorWindow(parent=parent or self._parent)
self._creator_tool = creator_window
return self._creator_tool
def show_creator(self, parent=None):
"""Show tool to create new instantes for publishing."""
- from avalon import style
-
creator_tool = self.get_creator_tool(parent)
creator_tool.refresh()
creator_tool.show()
- creator_tool.setStyleSheet(style.load_stylesheet())
-
# Pull window to the front.
creator_tool.raise_()
creator_tool.activateWindow()
diff --git a/openpype/tools/utils/lib.py b/openpype/tools/utils/lib.py
index e2815f26e4..4626e35a93 100644
--- a/openpype/tools/utils/lib.py
+++ b/openpype/tools/utils/lib.py
@@ -445,6 +445,30 @@ class GroupsConfig:
return ordered_groups, subset_docs_without_group, subset_docs_by_group
+class DynamicQThread(QtCore.QThread):
+ """QThread which can run any function with argument and kwargs.
+
+ Args:
+ func (function): Function which will be called.
+ args (tuple): Arguments which will be passed to function.
+ kwargs (tuple): Keyword arguments which will be passed to function.
+ parent (QObject): Parent of thread.
+ """
+ def __init__(self, func, args=None, kwargs=None, parent=None):
+ super(DynamicQThread, self).__init__(parent)
+ if args is None:
+ args = tuple()
+ if kwargs is None:
+ kwargs = {}
+ self._func = func
+ self._args = args
+ self._kwargs = kwargs
+
+ def run(self):
+ """Execute the function with arguments."""
+ self._func(*self._args, **self._kwargs)
+
+
def create_qthread(func, *args, **kwargs):
class Thread(QtCore.QThread):
def run(self):
diff --git a/openpype/tools/utils/models.py b/openpype/tools/utils/models.py
index c488743f36..df3eee41a2 100644
--- a/openpype/tools/utils/models.py
+++ b/openpype/tools/utils/models.py
@@ -1,7 +1,5 @@
import re
-import time
import logging
-import collections
import Qt
from Qt import QtCore, QtGui
@@ -11,10 +9,7 @@ from . import lib
from .constants import (
PROJECT_IS_ACTIVE_ROLE,
PROJECT_NAME_ROLE,
- DEFAULT_PROJECT_LABEL,
- TASK_ORDER_ROLE,
- TASK_TYPE_ROLE,
- TASK_NAME_ROLE
+ DEFAULT_PROJECT_LABEL
)
log = logging.getLogger(__name__)
@@ -203,283 +198,6 @@ class Item(dict):
self._children.append(child)
-class AssetModel(TreeModel):
- """A model listing assets in the silo in the active project.
-
- The assets are displayed in a treeview, they are visually parented by
- a `visualParent` field in the database containing an `_id` to a parent
- asset.
-
- """
-
- Columns = ["label"]
- Name = 0
- Deprecated = 2
- ObjectId = 3
-
- DocumentRole = QtCore.Qt.UserRole + 2
- ObjectIdRole = QtCore.Qt.UserRole + 3
- subsetColorsRole = QtCore.Qt.UserRole + 4
-
- doc_fetched = QtCore.Signal(bool)
- refreshed = QtCore.Signal(bool)
-
- # Asset document projection
- asset_projection = {
- "type": 1,
- "schema": 1,
- "name": 1,
- "silo": 1,
- "data.visualParent": 1,
- "data.label": 1,
- "data.tags": 1,
- "data.icon": 1,
- "data.color": 1,
- "data.deprecated": 1
- }
-
- def __init__(self, dbcon=None, parent=None, asset_projection=None):
- super(AssetModel, self).__init__(parent=parent)
- if dbcon is None:
- dbcon = io
- self.dbcon = dbcon
- self.asset_colors = {}
-
- # Projections for Mongo queries
- # - let ability to modify them if used in tools that require more than
- # defaults
- if asset_projection:
- self.asset_projection = asset_projection
-
- self.asset_projection = asset_projection
-
- self._doc_fetching_thread = None
- self._doc_fetching_stop = False
- self._doc_payload = {}
-
- self.doc_fetched.connect(self.on_doc_fetched)
-
- self.refresh()
-
- def _add_hierarchy(self, assets, parent=None, silos=None):
- """Add the assets that are related to the parent as children items.
-
- This method does *not* query the database. These instead are queried
- in a single batch upfront as an optimization to reduce database
- queries. Resulting in up to 10x speed increase.
-
- Args:
- assets (dict): All assets in the currently active silo stored
- by key/value
-
- Returns:
- None
-
- """
- # Reset colors
- self.asset_colors = {}
-
- if silos:
- # WARNING: Silo item "_id" is set to silo value
- # mainly because GUI issue with perserve selection and expanded row
- # and because of easier hierarchy parenting (in "assets")
- for silo in silos:
- item = Item({
- "_id": silo,
- "name": silo,
- "label": silo,
- "type": "silo"
- })
- self.add_child(item, parent=parent)
- self._add_hierarchy(assets, parent=item)
-
- parent_id = parent["_id"] if parent else None
- current_assets = assets.get(parent_id, list())
-
- for asset in current_assets:
- # get label from data, otherwise use name
- data = asset.get("data", {})
- label = data.get("label", asset["name"])
- tags = data.get("tags", [])
-
- # store for the asset for optimization
- deprecated = "deprecated" in tags
-
- item = Item({
- "_id": asset["_id"],
- "name": asset["name"],
- "label": label,
- "type": asset["type"],
- "tags": ", ".join(tags),
- "deprecated": deprecated,
- "_document": asset
- })
- self.add_child(item, parent=parent)
-
- # Add asset's children recursively if it has children
- if asset["_id"] in assets:
- self._add_hierarchy(assets, parent=item)
-
- self.asset_colors[asset["_id"]] = []
-
- def on_doc_fetched(self, was_stopped):
- if was_stopped:
- self.stop_fetch_thread()
- return
-
- self.beginResetModel()
-
- assets_by_parent = self._doc_payload.get("assets_by_parent")
- silos = self._doc_payload.get("silos")
- if assets_by_parent is not None:
- # Build the hierarchical tree items recursively
- self._add_hierarchy(
- assets_by_parent,
- parent=None,
- silos=silos
- )
-
- self.endResetModel()
-
- has_content = bool(assets_by_parent) or bool(silos)
- self.refreshed.emit(has_content)
-
- self.stop_fetch_thread()
-
- def fetch(self):
- self._doc_payload = self._fetch() or {}
- # Emit doc fetched only if was not stopped
- self.doc_fetched.emit(self._doc_fetching_stop)
-
- def _fetch(self):
- if not self.dbcon.Session.get("AVALON_PROJECT"):
- return
-
- project_doc = self.dbcon.find_one(
- {"type": "project"},
- {"_id": True}
- )
- if not project_doc:
- return
-
- # Get all assets sorted by name
- db_assets = self.dbcon.find(
- {"type": "asset"},
- self.asset_projection
- ).sort("name", 1)
-
- # Group the assets by their visual parent's id
- assets_by_parent = collections.defaultdict(list)
- for asset in db_assets:
- if self._doc_fetching_stop:
- return
- parent_id = asset.get("data", {}).get("visualParent")
- assets_by_parent[parent_id].append(asset)
-
- return {
- "assets_by_parent": assets_by_parent,
- "silos": None
- }
-
- def stop_fetch_thread(self):
- if self._doc_fetching_thread is not None:
- self._doc_fetching_stop = True
- while self._doc_fetching_thread.isRunning():
- time.sleep(0.001)
- self._doc_fetching_thread = None
-
- def refresh(self, force=False):
- """Refresh the data for the model."""
- # Skip fetch if there is already other thread fetching documents
- if self._doc_fetching_thread is not None:
- if not force:
- return
- self.stop_fetch_thread()
-
- # Clear model items
- self.clear()
-
- # Fetch documents from mongo
- # Restart payload
- self._doc_payload = {}
- self._doc_fetching_stop = False
- self._doc_fetching_thread = lib.create_qthread(self.fetch)
- self._doc_fetching_thread.start()
-
- def flags(self, index):
- return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable
-
- def setData(self, index, value, role=QtCore.Qt.EditRole):
- if not index.isValid():
- return False
-
- if role == self.subsetColorsRole:
- asset_id = index.data(self.ObjectIdRole)
- self.asset_colors[asset_id] = value
-
- if Qt.__binding__ in ("PyQt4", "PySide"):
- self.dataChanged.emit(index, index)
- else:
- self.dataChanged.emit(index, index, [role])
-
- return True
-
- return super(AssetModel, self).setData(index, value, role)
-
- def data(self, index, role):
- if not index.isValid():
- return
-
- item = index.internalPointer()
- if role == QtCore.Qt.DecorationRole:
- column = index.column()
- if column == self.Name:
- # Allow a custom icon and custom icon color to be defined
- data = item.get("_document", {}).get("data", {})
- icon = data.get("icon", None)
- if icon is None and item.get("type") == "silo":
- icon = "database"
- color = data.get("color", style.colors.default)
-
- if icon is None:
- # Use default icons if no custom one is specified.
- # If it has children show a full folder, otherwise
- # show an open folder
- has_children = self.rowCount(index) > 0
- icon = "folder" if has_children else "folder-o"
-
- # Make the color darker when the asset is deprecated
- if item.get("deprecated", False):
- color = QtGui.QColor(color).darker(250)
-
- try:
- key = "fa.{0}".format(icon) # font-awesome key
- icon = qtawesome.icon(key, color=color)
- return icon
- except Exception as exception:
- # Log an error message instead of erroring out completely
- # when the icon couldn't be created (e.g. invalid name)
- log.error(exception)
-
- return
-
- if role == QtCore.Qt.ForegroundRole: # font color
- if "deprecated" in item.get("tags", []):
- return QtGui.QColor(style.colors.light).darker(250)
-
- if role == self.ObjectIdRole:
- return item.get("_id", None)
-
- if role == self.DocumentRole:
- return item.get("_document", None)
-
- if role == self.subsetColorsRole:
- asset_id = item.get("_id", None)
- return self.asset_colors.get(asset_id) or []
-
- return super(AssetModel, self).data(index, role)
-
-
class RecursiveSortFilterProxyModel(QtCore.QSortFilterProxyModel):
"""Filters to the regex if any of the children matches allow parent"""
def filterAcceptsRow(self, row, parent):
@@ -654,163 +372,3 @@ class ProjectSortFilterProxy(QtCore.QSortFilterProxyModel):
def set_filter_enabled(self, value):
self._filter_enabled = value
self.invalidateFilter()
-
-
-class TasksModel(QtGui.QStandardItemModel):
- """A model listing the tasks combined for a list of assets"""
- def __init__(self, dbcon, parent=None):
- super(TasksModel, self).__init__(parent=parent)
- self.dbcon = dbcon
- self._default_icon = qtawesome.icon(
- "fa.male",
- color=style.colors.default
- )
- self._no_tasks_icon = qtawesome.icon(
- "fa.exclamation-circle",
- color=style.colors.mid
- )
- self._cached_icons = {}
- self._project_task_types = {}
-
- self._last_asset_id = None
-
- self.refresh()
-
- def refresh(self):
- if self.dbcon.Session.get("AVALON_PROJECT"):
- self._refresh_task_types()
- self.set_asset_id(self._last_asset_id)
- else:
- self.clear()
-
- def _refresh_task_types(self):
- # Get the project configured icons from database
- project = self.dbcon.find_one(
- {"type": "project"},
- {"config.tasks"}
- )
- tasks = project["config"].get("tasks") or {}
- self._project_task_types = tasks
-
- def _try_get_awesome_icon(self, icon_name):
- icon = None
- if icon_name:
- try:
- icon = qtawesome.icon(
- "fa.{}".format(icon_name),
- color=style.colors.default
- )
-
- except Exception:
- pass
- return icon
-
- def headerData(self, section, orientation, role):
- # Show nice labels in the header
- if (
- role == QtCore.Qt.DisplayRole
- and orientation == QtCore.Qt.Horizontal
- ):
- if section == 0:
- return "Tasks"
-
- return super(TasksModel, self).headerData(section, orientation, role)
-
- def _get_icon(self, task_icon, task_type_icon):
- if task_icon in self._cached_icons:
- return self._cached_icons[task_icon]
-
- icon = self._try_get_awesome_icon(task_icon)
- if icon is not None:
- self._cached_icons[task_icon] = icon
- return icon
-
- if task_type_icon in self._cached_icons:
- icon = self._cached_icons[task_type_icon]
- self._cached_icons[task_icon] = icon
- return icon
-
- icon = self._try_get_awesome_icon(task_type_icon)
- if icon is None:
- icon = self._default_icon
-
- self._cached_icons[task_icon] = icon
- self._cached_icons[task_type_icon] = icon
-
- return icon
-
- def set_asset_id(self, asset_id):
- asset_doc = None
- if asset_id:
- asset_doc = self.dbcon.find_one(
- {"_id": asset_id},
- {"data.tasks": True}
- )
- self.set_asset(asset_doc)
-
- def set_asset(self, asset_doc):
- """Set assets to track by their database id
-
- Arguments:
- asset_doc (dict): Asset document from MongoDB.
- """
- self.clear()
-
- if not asset_doc:
- self._last_asset_id = None
- return
-
- self._last_asset_id = asset_doc["_id"]
-
- asset_tasks = asset_doc.get("data", {}).get("tasks") or {}
- items = []
- for task_name, task_info in asset_tasks.items():
- task_icon = task_info.get("icon")
- task_type = task_info.get("type")
- task_order = task_info.get("order")
- task_type_info = self._project_task_types.get(task_type) or {}
- task_type_icon = task_type_info.get("icon")
- icon = self._get_icon(task_icon, task_type_icon)
-
- label = "{} ({})".format(task_name, task_type or "type N/A")
- item = QtGui.QStandardItem(label)
- item.setData(task_name, TASK_NAME_ROLE)
- item.setData(task_type, TASK_TYPE_ROLE)
- item.setData(task_order, TASK_ORDER_ROLE)
- item.setData(icon, QtCore.Qt.DecorationRole)
- item.setFlags(QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable)
- items.append(item)
-
- if not items:
- item = QtGui.QStandardItem("No task")
- item.setData(self._no_tasks_icon, QtCore.Qt.DecorationRole)
- item.setFlags(QtCore.Qt.NoItemFlags)
- items.append(item)
-
- self.invisibleRootItem().appendRows(items)
-
-
-class TasksProxyModel(QtCore.QSortFilterProxyModel):
- def lessThan(self, x_index, y_index):
- x_order = x_index.data(TASK_ORDER_ROLE)
- y_order = y_index.data(TASK_ORDER_ROLE)
- if x_order is not None and y_order is not None:
- if x_order < y_order:
- return True
- if x_order > y_order:
- return False
-
- elif x_order is None and y_order is not None:
- return True
-
- elif y_order is None and x_order is not None:
- return False
-
- x_name = x_index.data(QtCore.Qt.DisplayRole)
- y_name = y_index.data(QtCore.Qt.DisplayRole)
- if x_name == y_name:
- return True
-
- if x_name == tuple(sorted((x_name, y_name)))[0]:
- return True
- return False
diff --git a/openpype/tools/utils/tasks_widget.py b/openpype/tools/utils/tasks_widget.py
index 9ffcde2885..419e77c780 100644
--- a/openpype/tools/utils/tasks_widget.py
+++ b/openpype/tools/utils/tasks_widget.py
@@ -4,11 +4,11 @@ from avalon import style
from avalon.vendor import qtawesome
from .views import DeselectableTreeView
-from .constants import (
- TASK_ORDER_ROLE,
- TASK_TYPE_ROLE,
- TASK_NAME_ROLE
-)
+
+
+TASK_NAME_ROLE = QtCore.Qt.UserRole + 1
+TASK_TYPE_ROLE = QtCore.Qt.UserRole + 2
+TASK_ORDER_ROLE = QtCore.Qt.UserRole + 3
class TasksModel(QtGui.QStandardItemModel):
@@ -226,10 +226,6 @@ class TasksWidget(QtWidgets.QWidget):
self._tasks_model.refresh()
def set_asset_id(self, asset_id):
- # Asset deselected
- if asset_id is None:
- return
-
# Try and preserve the last selected task and reselect it
# after switching assets. If there's no currently selected
# asset keep whatever the "last selected" was prior to it.
diff --git a/openpype/tools/utils/views.py b/openpype/tools/utils/views.py
index 89e49fe142..97aaf622a4 100644
--- a/openpype/tools/utils/views.py
+++ b/openpype/tools/utils/views.py
@@ -61,26 +61,3 @@ class TreeViewSpinner(QtWidgets.QTreeView):
self.paint_empty(event)
else:
super(TreeViewSpinner, self).paintEvent(event)
-
-
-class AssetsView(TreeViewSpinner, DeselectableTreeView):
- """Item view.
- This implements a context menu.
- """
-
- def __init__(self, parent=None):
- super(AssetsView, self).__init__(parent)
- self.setIndentation(15)
- self.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
- self.setHeaderHidden(True)
-
- def mousePressEvent(self, event):
- index = self.indexAt(event.pos())
- if not index.isValid():
- modifiers = QtWidgets.QApplication.keyboardModifiers()
- if modifiers == QtCore.Qt.ShiftModifier:
- return
- elif modifiers == QtCore.Qt.ControlModifier:
- return
-
- super(AssetsView, self).mousePressEvent(event)
diff --git a/openpype/tools/utils/widgets.py b/openpype/tools/utils/widgets.py
index 15bcbeff90..ea80636d1a 100644
--- a/openpype/tools/utils/widgets.py
+++ b/openpype/tools/utils/widgets.py
@@ -1,305 +1,33 @@
import logging
-import time
-
-from . import lib
from Qt import QtWidgets, QtCore, QtGui
+
from avalon.vendor import qtawesome, qargparse
-
-from avalon import style
-
-from .models import AssetModel, RecursiveSortFilterProxyModel
-from .views import AssetsView
-from .delegates import AssetDelegate
+from openpype.style import get_objected_colors
log = logging.getLogger(__name__)
-class AssetWidget(QtWidgets.QWidget):
- """A Widget to display a tree of assets with filter
+class PlaceholderLineEdit(QtWidgets.QLineEdit):
+ """Set placeholder color of QLineEdit in Qt 5.12 and higher."""
+ def __init__(self, *args, **kwargs):
+ super(PlaceholderLineEdit, self).__init__(*args, **kwargs)
+ self._first_show = True
- To list the assets of the active project:
- >>> # widget = AssetWidget()
- >>> # widget.refresh()
- >>> # widget.show()
-
- """
-
- refresh_triggered = QtCore.Signal() # on model refresh
- refreshed = QtCore.Signal()
- selection_changed = QtCore.Signal() # on view selection change
- current_changed = QtCore.Signal() # on view current index change
-
- def __init__(self, dbcon, multiselection=False, parent=None):
- super(AssetWidget, self).__init__(parent=parent)
-
- self.dbcon = dbcon
-
- # Tree View
- model = AssetModel(dbcon=self.dbcon, parent=self)
- proxy = RecursiveSortFilterProxyModel()
- proxy.setSourceModel(model)
- proxy.setFilterCaseSensitivity(QtCore.Qt.CaseInsensitive)
-
- view = AssetsView(self)
- view.setModel(proxy)
- if multiselection:
- asset_delegate = AssetDelegate()
- view.setSelectionMode(view.ExtendedSelection)
- view.setItemDelegate(asset_delegate)
-
- icon = qtawesome.icon("fa.arrow-down", color=style.colors.light)
- set_current_asset_btn = QtWidgets.QPushButton(icon, "")
- set_current_asset_btn.setToolTip("Go to Asset from current Session")
- # Hide by default
- set_current_asset_btn.setVisible(False)
-
- icon = qtawesome.icon("fa.refresh", color=style.colors.light)
- refresh = QtWidgets.QPushButton(icon, "", parent=self)
- refresh.setToolTip("Refresh items")
-
- filter_input = QtWidgets.QLineEdit(self)
- filter_input.setPlaceholderText("Filter assets..")
-
- # Header
- header_layout = QtWidgets.QHBoxLayout()
- header_layout.addWidget(filter_input)
- header_layout.addWidget(set_current_asset_btn)
- header_layout.addWidget(refresh)
-
- # Layout
- layout = QtWidgets.QVBoxLayout(self)
- layout.setContentsMargins(0, 0, 0, 0)
- layout.setSpacing(4)
- layout.addLayout(header_layout)
- layout.addWidget(view)
-
- # Signals/Slots
- filter_input.textChanged.connect(proxy.setFilterFixedString)
-
- selection = view.selectionModel()
- selection.selectionChanged.connect(self.selection_changed)
- selection.currentChanged.connect(self.current_changed)
- refresh.clicked.connect(self.refresh)
- set_current_asset_btn.clicked.connect(self.set_current_session_asset)
-
- self.set_current_asset_btn = set_current_asset_btn
- self.model = model
- self.proxy = proxy
- self.view = view
-
- self.model_selection = {}
-
- def set_current_asset_btn_visibility(self, visible=None):
- """Hide set current asset button.
-
- Not all tools support using of current context asset.
- """
- if visible is None:
- visible = not self.set_current_asset_btn.isVisible()
- self.set_current_asset_btn.setVisible(visible)
-
- def _refresh_model(self):
- # Store selection
- self._store_model_selection()
- time_start = time.time()
-
- self.set_loading_state(
- loading=True,
- empty=True
- )
-
- def on_refreshed(has_item):
- self.set_loading_state(loading=False, empty=not has_item)
- self._restore_model_selection()
- self.model.refreshed.disconnect()
- self.refreshed.emit()
- print("Duration: %.3fs" % (time.time() - time_start))
-
- # Connect to signal
- self.model.refreshed.connect(on_refreshed)
- # Trigger signal before refresh is called
- self.refresh_triggered.emit()
- # Refresh model
- self.model.refresh()
-
- def refresh(self):
- self._refresh_model()
-
- def get_active_asset(self):
- """Return the asset item of the current selection."""
- current = self.view.currentIndex()
- return current.data(self.model.ItemRole)
-
- def get_active_asset_document(self):
- """Return the asset document of the current selection."""
- current = self.view.currentIndex()
- return current.data(self.model.DocumentRole)
-
- def get_active_index(self):
- return self.view.currentIndex()
-
- def get_selected_assets(self):
- """Return the documents of selected assets."""
- selection = self.view.selectionModel()
- rows = selection.selectedRows()
- assets = [row.data(self.model.DocumentRole) for row in rows]
-
- # NOTE: skip None object assumed they are silo (backwards comp.)
- return [asset for asset in assets if asset]
-
- def select_assets(self, assets, expand=True, key="name"):
- """Select assets by item key.
-
- Args:
- assets (list): List of asset values that can be found under
- specified `key`
- expand (bool): Whether to also expand to the asset in the view
- key (string): Key that specifies where to look for `assets` values
-
- Returns:
- None
-
- Default `key` is "name" in that case `assets` should contain single
- asset name or list of asset names. (It is good idea to use "_id" key
- instead of name in that case `assets` must contain `ObjectId` object/s)
- It is expected that each value in `assets` will be found only once.
- If the filters according to the `key` and `assets` correspond to
- the more asset, only the first found will be selected.
-
- """
-
- if not isinstance(assets, (tuple, list)):
- assets = [assets]
-
- # convert to list - tuple cant be modified
- assets = set(assets)
-
- # Clear selection
- selection_model = self.view.selectionModel()
- selection_model.clearSelection()
-
- # Select
- mode = selection_model.Select | selection_model.Rows
- for index in lib.iter_model_rows(
- self.proxy, column=0, include_root=False
- ):
- # stop iteration if there are no assets to process
- if not assets:
- break
-
- value = index.data(self.model.ItemRole).get(key)
- if value not in assets:
- continue
-
- # Remove processed asset
- assets.discard(value)
-
- selection_model.select(index, mode)
- if expand:
- # Expand parent index
- self.view.expand(self.proxy.parent(index))
-
- # Set the currently active index
- self.view.setCurrentIndex(index)
-
- def set_loading_state(self, loading, empty):
- if self.view.is_loading != loading:
- if loading:
- self.view.spinner.repaintNeeded.connect(
- self.view.viewport().update
+ def showEvent(self, event):
+ super(PlaceholderLineEdit, self).showEvent(event)
+ if self._first_show:
+ self._first_show = False
+ filter_palette = self.palette()
+ if hasattr(filter_palette, "PlaceholderText"):
+ color_obj = get_objected_colors()["font"]
+ color = color_obj.get_qcolor()
+ color.setAlpha(67)
+ filter_palette.setColor(
+ filter_palette.PlaceholderText,
+ color
)
- else:
- self.view.spinner.repaintNeeded.disconnect()
-
- self.view.is_loading = loading
- self.view.is_empty = empty
-
- def _store_model_selection(self):
- index = self.view.currentIndex()
- current = None
- if index and index.isValid():
- current = index.data(self.model.ObjectIdRole)
-
- expanded = set()
- model = self.view.model()
- for index in lib.iter_model_rows(
- model, column=0, include_root=False
- ):
- if self.view.isExpanded(index):
- value = index.data(self.model.ObjectIdRole)
- expanded.add(value)
-
- selection_model = self.view.selectionModel()
-
- selected = None
- selected_rows = selection_model.selectedRows()
- if selected_rows:
- selected = set(
- row.data(self.model.ObjectIdRole)
- for row in selected_rows
- )
-
- self.model_selection = {
- "expanded": expanded,
- "selected": selected,
- "current": current
- }
-
- def _restore_model_selection(self):
- model = self.view.model()
- not_set = object()
- expanded = self.model_selection.pop("expanded", not_set)
- selected = self.model_selection.pop("selected", not_set)
- current = self.model_selection.pop("current", not_set)
-
- if (
- expanded is not_set
- or selected is not_set
- or current is not_set
- ):
- return
-
- if expanded:
- for index in lib.iter_model_rows(
- model, column=0, include_root=False
- ):
- is_expanded = index.data(self.model.ObjectIdRole) in expanded
- self.view.setExpanded(index, is_expanded)
-
- if not selected and not current:
- self.set_current_session_asset()
- return
-
- current_index = None
- selected_indexes = []
- # Go through all indices, select the ones with similar data
- for index in lib.iter_model_rows(
- model, column=0, include_root=False
- ):
- object_id = index.data(self.model.ObjectIdRole)
- if object_id in selected:
- selected_indexes.append(index)
-
- if not current_index and object_id == current:
- current_index = index
-
- if current_index:
- self.view.setCurrentIndex(current_index)
-
- if not selected_indexes:
- return
- selection_model = self.view.selectionModel()
- flags = selection_model.Select | selection_model.Rows
- for index in selected_indexes:
- # Ensure item is visible
- self.view.scrollTo(index)
- selection_model.select(index, flags)
-
- def set_current_session_asset(self):
- asset_name = self.dbcon.Session.get("AVALON_ASSET")
- if asset_name:
- self.select_assets([asset_name])
+ self.setPalette(filter_palette)
class OptionalMenu(QtWidgets.QMenu):
diff --git a/openpype/tools/workfiles/app.py b/openpype/tools/workfiles/app.py
index edea7bb1e0..4f5e179d9b 100644
--- a/openpype/tools/workfiles/app.py
+++ b/openpype/tools/workfiles/app.py
@@ -12,15 +12,12 @@ from avalon import io, api, pipeline
from openpype import style
from openpype.tools.utils.lib import (
- schedule, qt_app_context
+ schedule,
+ qt_app_context
)
-from openpype.tools.utils.widgets import AssetWidget
+from openpype.tools.utils.assets_widget import SingleSelectAssetsWidget
from openpype.tools.utils.tasks_widget import TasksWidget
from openpype.tools.utils.delegates import PrettyTimeDelegate
-
-from .model import FilesModel
-from .view import FilesView
-
from openpype.lib import (
Anatomy,
get_workdir,
@@ -30,6 +27,9 @@ from openpype.lib import (
get_workfile_template_key
)
+from .model import FilesModel
+from .view import FilesView
+
log = logging.getLogger(__name__)
module = sys.modules[__name__]
@@ -59,20 +59,39 @@ class NameWindow(QtWidgets.QDialog):
# Set work file data for template formatting
asset_name = session["AVALON_ASSET"]
+ task_name = session["AVALON_TASK"]
project_doc = io.find_one(
{"type": "project"},
{
"name": True,
- "data.code": True
+ "data.code": True,
+ "config.tasks": True,
}
)
+ asset_doc = io.find_one(
+ {
+ "type": "asset",
+ "name": asset_name
+ },
+ {"data.tasks": True}
+ )
+
+ task_type = asset_doc["data"]["tasks"].get(task_name, {}).get("type")
+
+ project_task_types = project_doc["config"]["tasks"]
+ task_short = project_task_types.get(task_type, {}).get("short_name")
+
self.data = {
"project": {
"name": project_doc["name"],
"code": project_doc["data"].get("code")
},
"asset": asset_name,
- "task": session["AVALON_TASK"],
+ "task": {
+ "name": task_name,
+ "type": task_type,
+ "short": task_short,
+ },
"version": 1,
"user": getpass.getuser(),
"comment": "",
@@ -81,7 +100,9 @@ class NameWindow(QtWidgets.QDialog):
# Store project anatomy
self.anatomy = anatomy
- self.template = anatomy.templates[template_key]["file"]
+ self.template = anatomy.templates[template_key]["file"].replace(
+ "{task}", "{task[name]}"
+ )
self.template_key = template_key
# Btns widget
@@ -326,7 +347,8 @@ class FilesWidget(QtWidgets.QWidget):
super(FilesWidget, self).__init__(parent=parent)
# Setup
- self._asset = None
+ self._asset_id = None
+ self._asset_doc = None
self._task_name = None
self._task_type = None
@@ -422,15 +444,17 @@ class FilesWidget(QtWidgets.QWidget):
self.btn_browse = btn_browse
self.btn_save = btn_save
- def set_asset_task(self, asset, task_name, task_type):
- self._asset = asset
+ def set_asset_task(self, asset_id, task_name, task_type):
+ if asset_id != self._asset_id:
+ self._asset_doc = None
+ self._asset_id = asset_id
self._task_name = task_name
self._task_type = task_type
# Define a custom session so we can query the work root
# for a "Work area" that is not our current Session.
# This way we can browse it even before we enter it.
- if self._asset and self._task_name and self._task_type:
+ if self._asset_id and self._task_name and self._task_type:
session = self._get_session()
self.root = self.host.work_root(session)
self.files_model.set_root(self.root)
@@ -446,6 +470,14 @@ class FilesWidget(QtWidgets.QWidget):
# Manually trigger file selection
self.on_file_select()
+ def _get_asset_doc(self):
+ if self._asset_id is None:
+ return None
+
+ if self._asset_doc is None:
+ self._asset_doc = io.find_one({"_id": self._asset_id})
+ return self._asset_doc
+
def _get_session(self):
"""Return a modified session for the current asset and task"""
@@ -457,7 +489,7 @@ class FilesWidget(QtWidgets.QWidget):
)
changes = pipeline.compute_session_changes(
session,
- asset=self._asset,
+ asset=self._get_asset_doc(),
task=self._task_name,
template_key=self.template_key
)
@@ -471,7 +503,7 @@ class FilesWidget(QtWidgets.QWidget):
session = api.Session.copy()
changes = pipeline.compute_session_changes(
session,
- asset=self._asset,
+ asset=self._get_asset_doc(),
task=self._task_name,
template_key=self.template_key
)
@@ -481,7 +513,7 @@ class FilesWidget(QtWidgets.QWidget):
return
api.update_current_task(
- asset=self._asset,
+ asset=self._get_asset_doc(),
task=self._task_name,
template_key=self.template_key
)
@@ -628,7 +660,9 @@ class FilesWidget(QtWidgets.QWidget):
self._enter_session() # Make sure we are in the right session
self.host.save_file(file_path)
- self.set_asset_task(self._asset, self._task_name, self._task_type)
+ self.set_asset_task(
+ self._asset_id, self._task_name, self._task_type
+ )
pipeline.emit("after.workfile.save", [file_path])
@@ -654,7 +688,7 @@ class FilesWidget(QtWidgets.QWidget):
session = api.Session.copy()
changes = pipeline.compute_session_changes(
session,
- asset=self._asset,
+ asset=self._get_asset_doc(),
task=self._task_name,
template_key=self.template_key
)
@@ -679,7 +713,7 @@ class FilesWidget(QtWidgets.QWidget):
# Force a full to the asset as opposed to just self.refresh() so
# that it will actually check again whether the Work directory exists
- self.set_asset_task(self._asset, self._task_name, self._task_type)
+ self.set_asset_task(self._asset_id, self._task_name, self._task_type)
def refresh(self):
"""Refresh listed files for current selection in the interface"""
@@ -775,10 +809,10 @@ class SidePanelWidget(QtWidgets.QWidget):
self.on_note_change()
self.save_clicked.emit()
- def set_context(self, asset_doc, task_name, filepath, workfile_doc):
+ def set_context(self, asset_id, task_name, filepath, workfile_doc):
# Check if asset, task and file are selected
# NOTE workfile document is not requirement
- enabled = bool(asset_doc) and bool(task_name) and bool(filepath)
+ enabled = bool(asset_id) and bool(task_name) and bool(filepath)
self.details_input.setEnabled(enabled)
self.note_input.setEnabled(enabled)
@@ -856,7 +890,7 @@ class Window(QtWidgets.QMainWindow):
home_page_widget = QtWidgets.QWidget(pages_widget)
home_body_widget = QtWidgets.QWidget(home_page_widget)
- assets_widget = AssetWidget(io, parent=home_body_widget)
+ assets_widget = SingleSelectAssetsWidget(io, parent=home_body_widget)
assets_widget.set_current_asset_btn_visibility(True)
tasks_widget = TasksWidget(io, home_body_widget)
@@ -884,14 +918,21 @@ class Window(QtWidgets.QMainWindow):
# the files widget has a filter field which tasks does not.
tasks_widget.setContentsMargins(0, 32, 0, 0)
+ # Set context after asset widget is refreshed
+ # - to do so it is necessary to wait until refresh is done
+ set_context_timer = QtCore.QTimer()
+ set_context_timer.setInterval(100)
+
# Connect signals
- assets_widget.current_changed.connect(self.on_asset_changed)
+ set_context_timer.timeout.connect(self._on_context_set_timeout)
+ assets_widget.selection_changed.connect(self.on_asset_changed)
tasks_widget.task_changed.connect(self.on_task_changed)
files_widget.file_selected.connect(self.on_file_select)
files_widget.workfile_created.connect(self.on_workfile_create)
files_widget.file_opened.connect(self._on_file_opened)
side_panel.save_clicked.connect(self.on_side_panel_save)
+ self._set_context_timer = set_context_timer
self.home_page_widget = home_page_widget
self.pages_widget = pages_widget
self.home_body_widget = home_body_widget
@@ -908,11 +949,13 @@ class Window(QtWidgets.QMainWindow):
self.resize(1200, 600)
self._first_show = True
+ self._context_to_set = None
def showEvent(self, event):
super(Window, self).showEvent(event)
if self._first_show:
self._first_show = False
+ self.refresh()
self.setStyleSheet(style.load_stylesheet())
def keyPressEvent(self, event):
@@ -936,21 +979,17 @@ class Window(QtWidgets.QMainWindow):
schedule(self._on_asset_changed, 50, channel="mongo")
def on_file_select(self, filepath):
- asset_docs = self.assets_widget.get_selected_assets()
- asset_doc = None
- if asset_docs:
- asset_doc = asset_docs[0]
-
+ asset_id = self.assets_widget.get_selected_asset_id()
task_name = self.tasks_widget.get_selected_task_name()
workfile_doc = None
- if asset_doc and task_name and filepath:
+ if asset_id and task_name and filepath:
filename = os.path.split(filepath)[1]
workfile_doc = get_workfile_doc(
- asset_doc["_id"], task_name, filename, io
+ asset_id, task_name, filename, io
)
self.side_panel.set_context(
- asset_doc, task_name, filepath, workfile_doc
+ asset_id, task_name, filepath, workfile_doc
)
def on_workfile_create(self, filepath):
@@ -972,14 +1011,13 @@ class Window(QtWidgets.QMainWindow):
if filepath is None:
filepath = self.files_widget._get_selected_filepath()
task_name = self.tasks_widget.get_selected_task_name()
- asset_docs = self.assets_widget.get_selected_assets()
- if not task_name or not asset_docs or not filepath:
+ asset_id = self.assets_widget.get_selected_asset_id()
+ if not task_name or not asset_id or not filepath:
return
- asset_doc = asset_docs[0]
filename = os.path.split(filepath)[1]
return get_workfile_doc(
- asset_doc["_id"], task_name, filename, io
+ asset_id, task_name, filename, io
)
def _create_workfile_doc(self, filepath, force=False):
@@ -989,62 +1027,68 @@ class Window(QtWidgets.QMainWindow):
if not workfile_doc:
workdir, filename = os.path.split(filepath)
- asset_docs = self.assets_widget.get_selected_assets()
- asset_doc = asset_docs[0]
- task_name = self.tasks_widget.get_current_task_name()
+ asset_id = self.assets_widget.get_selected_asset_id()
+ asset_doc = io.find_one({"_id": asset_id})
+ task_name = self.tasks_widget.get_selected_task_name()
create_workfile_doc(asset_doc, task_name, filename, workdir, io)
- def set_context(self, context):
- if "asset" in context:
- asset = context["asset"]
- asset_document = io.find_one(
- {
- "name": asset,
- "type": "asset"
- },
- {"_id": 1}
- ) or {}
-
- # Select the asset
- self.assets_widget.select_assets([asset], expand=True)
-
- self.tasks_widget.set_asset_id(asset_document.get("_id"))
-
- if "task" in context:
- self.tasks_widget.select_task_name(context["task"])
-
def refresh(self):
# Refresh asset widget
self.assets_widget.refresh()
self._on_task_changed()
+ def set_context(self, context):
+ self._context_to_set = context
+ self._set_context_timer.start()
+
+ def _on_context_set_timeout(self):
+ if self._context_to_set is None:
+ self._set_context_timer.stop()
+ return
+
+ if self.assets_widget.refreshing:
+ return
+
+ self._context_to_set, context = None, self._context_to_set
+ if "asset" in context:
+ asset_doc = io.find_one(
+ {
+ "name": context["asset"],
+ "type": "asset"
+ },
+ {"_id": 1}
+ ) or {}
+ asset_id = asset_doc.get("_id")
+ # Select the asset
+ self.assets_widget.select_asset(asset_id)
+ self.tasks_widget.set_asset_id(asset_id)
+
+ if "task" in context:
+ self.tasks_widget.select_task_name(context["task"])
+
def _on_asset_changed(self):
- asset = self.assets_widget.get_selected_assets() or None
- asset_id = None
- if not asset:
+ asset_id = self.assets_widget.get_selected_asset_id()
+ if asset_id:
+ self.tasks_widget.setEnabled(True)
+ else:
# Force disable the other widgets if no
# active selection
self.tasks_widget.setEnabled(False)
self.files_widget.setEnabled(False)
- else:
- asset = asset[0]
- asset_id = asset.get("_id")
- self.tasks_widget.setEnabled(True)
self.tasks_widget.set_asset_id(asset_id)
def _on_task_changed(self):
- asset = self.assets_widget.get_selected_assets() or None
- if asset is not None:
- asset = asset[0]
+ asset_id = self.assets_widget.get_selected_asset_id()
task_name = self.tasks_widget.get_selected_task_name()
task_type = self.tasks_widget.get_selected_task_type()
- self.tasks_widget.setEnabled(bool(asset))
+ asset_is_valid = asset_id is not None
+ self.tasks_widget.setEnabled(asset_is_valid)
- self.files_widget.setEnabled(all([bool(task_name), bool(asset)]))
- self.files_widget.set_asset_task(asset, task_name, task_type)
+ self.files_widget.setEnabled(bool(task_name) and asset_is_valid)
+ self.files_widget.set_asset_task(asset_id, task_name, task_type)
self.files_widget.refresh()
diff --git a/openpype/version.py b/openpype/version.py
index ef4bbe505b..5e23fc2168 100644
--- a/openpype/version.py
+++ b/openpype/version.py
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
"""Package declaring Pype version."""
-__version__ = "3.6.2-nightly.1"
+__version__ = "3.7.0-nightly.2"
diff --git a/pyproject.toml b/pyproject.toml
index cfe7422d49..8f42fd31a7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "OpenPype"
-version = "3.6.2-nightly.1" # OpenPype
+version = "3.7.0-nightly.2" # OpenPype
description = "Open VFX and Animation pipeline with support."
authors = ["OpenPype Team "]
license = "MIT License"
diff --git a/tests/unit/igniter/test_bootstrap_repos.py b/tests/unit/igniter/test_bootstrap_repos.py
index 740a71a5ce..d6e861c262 100644
--- a/tests/unit/igniter/test_bootstrap_repos.py
+++ b/tests/unit/igniter/test_bootstrap_repos.py
@@ -140,7 +140,7 @@ def test_search_string_for_openpype_version(printer):
]
for ver_string in strings:
printer(f"testing {ver_string[0]} should be {ver_string[1]}")
- assert OpenPypeVersion.version_in_str(ver_string[0])[0] == \
+ assert OpenPypeVersion.version_in_str(ver_string[0]) == \
ver_string[1]
diff --git a/tools/run_mongo.ps1 b/tools/run_mongo.ps1
index 32f6cfed17..f6fa37207d 100644
--- a/tools/run_mongo.ps1
+++ b/tools/run_mongo.ps1
@@ -113,7 +113,7 @@ $port = 2707
# path to database
$dbpath = (Get-Item $openpype_root).parent.FullName + "\mongo_db_data"
-$preferred_version = "4.0"
+$preferred_version = "5.0"
$mongoPath = Find-Mongo $preferred_version
Write-Host ">>> " -NoNewLine -ForegroundColor Green
diff --git a/website/docs/admin_openpype_commands.md b/website/docs/admin_openpype_commands.md
index 7a46ee7906..0831cf4f5a 100644
--- a/website/docs/admin_openpype_commands.md
+++ b/website/docs/admin_openpype_commands.md
@@ -32,7 +32,10 @@ For more information [see here](admin_use#run-openpype).
| Command | Description | Arguments |
| --- | --- |: --- :|
-| tray | Launch OpenPype Tray. | [📑](#tray-arguments)
+| contextselection | Open Context selection dialog. | |
+| module | Run command line arguments for modules. | |
+| repack-version | Tool to re-create version zip. | [📑](#repack-version-arguments) |
+| tray | Launch OpenPype Tray. | [📑](#tray-arguments)
| eventserver | This should be ideally used by system service (such as systemd or upstart on linux and window service). | [📑](#eventserver-arguments) |
| launch | Launch application in Pype environment. | [📑](#launch-arguments) |
| publish | Pype takes JSON from provided path and use it to publish data in it. | [📑](#publish-arguments) |
@@ -156,4 +159,10 @@ openpypeconsole settings
`standalonepublisher` has no command-line arguments.
```shell
openpype_console standalonepublisher
-```
\ No newline at end of file
+```
+
+### `repack-version` arguments {#repack-version-arguments}
+Takes path to unzipped and possibly modified OpenPype version. Files will be
+zipped, checksums recalculated and version will be determined by folder name
+(and written to `version.py`).
+
diff --git a/website/docs/admin_settings_project_anatomy.md b/website/docs/admin_settings_project_anatomy.md
index 54023d468f..30784686e2 100644
--- a/website/docs/admin_settings_project_anatomy.md
+++ b/website/docs/admin_settings_project_anatomy.md
@@ -57,7 +57,9 @@ We have a few required anatomy templates for OpenPype to work properly, however
| `project[code]` | Project's code |
| `hierarchy` | All hierarchical parents as subfolders |
| `asset` | Name of asset or shot |
-| `task` | Name of task |
+| `task[name]` | Name of task |
+| `task[type]` | Type of task |
+| `task[short]` | Shortname of task |
| `version` | Version number |
| `subset` | Subset name |
| `family` | Main family name |