- icon in ftrack
'''
+ _process_id = None
# Default priority is 100
priority = 100
# Type is just for logging purpose (e.g.: Action, Event, Application,...)
@@ -70,6 +72,13 @@ class BaseHandler(object):
self.register = self.register_decorator(self.register)
self.launch = self.launch_log(self.launch)
+ @staticmethod
+ def process_identifier():
+ """Helper property to have """
+ if not BaseHandler._process_id:
+ BaseHandler._process_id = str(uuid.uuid4())
+ return BaseHandler._process_id
+
# Decorator
def register_decorator(self, func):
@functools.wraps(func)
diff --git a/openpype/modules/log_viewer/tray/app.py b/openpype/modules/log_viewer/tray/app.py
index 9aab37cd20..1e8d6483cd 100644
--- a/openpype/modules/log_viewer/tray/app.py
+++ b/openpype/modules/log_viewer/tray/app.py
@@ -7,12 +7,13 @@ class LogsWindow(QtWidgets.QWidget):
def __init__(self, parent=None):
super(LogsWindow, self).__init__(parent)
- self.setStyleSheet(style.load_stylesheet())
+ self.setWindowTitle("Logs viewer")
+
self.resize(1400, 800)
log_detail = OutputWidget(parent=self)
logs_widget = LogsWidget(log_detail, parent=self)
- main_layout = QtWidgets.QHBoxLayout()
+ main_layout = QtWidgets.QHBoxLayout(self)
log_splitter = QtWidgets.QSplitter(self)
log_splitter.setOrientation(QtCore.Qt.Horizontal)
@@ -24,5 +25,4 @@ class LogsWindow(QtWidgets.QWidget):
self.logs_widget = logs_widget
self.log_detail = log_detail
- self.setLayout(main_layout)
- self.setWindowTitle("Logs")
+ self.setStyleSheet(style.load_stylesheet())
diff --git a/openpype/modules/log_viewer/tray/widgets.py b/openpype/modules/log_viewer/tray/widgets.py
index b9a8499a4c..5a67780413 100644
--- a/openpype/modules/log_viewer/tray/widgets.py
+++ b/openpype/modules/log_viewer/tray/widgets.py
@@ -77,12 +77,10 @@ class CustomCombo(QtWidgets.QWidget):
toolbutton.setMenu(toolmenu)
toolbutton.setPopupMode(QtWidgets.QToolButton.MenuButtonPopup)
- layout = QtWidgets.QHBoxLayout()
+ layout = QtWidgets.QHBoxLayout(self)
layout.setContentsMargins(0, 0, 0, 0)
layout.addWidget(toolbutton)
- self.setLayout(layout)
-
toolmenu.selection_changed.connect(self.selection_changed)
self.toolbutton = toolbutton
@@ -141,7 +139,6 @@ class LogsWidget(QtWidgets.QWidget):
filter_layout.addWidget(refresh_btn)
view = QtWidgets.QTreeView(self)
- view.setAllColumnsShowFocus(True)
view.setEditTriggers(QtWidgets.QAbstractItemView.NoEditTriggers)
layout = QtWidgets.QVBoxLayout(self)
@@ -229,9 +226,9 @@ class OutputWidget(QtWidgets.QWidget):
super(OutputWidget, self).__init__(parent=parent)
layout = QtWidgets.QVBoxLayout(self)
- show_timecode_checkbox = QtWidgets.QCheckBox("Show timestamp")
+ show_timecode_checkbox = QtWidgets.QCheckBox("Show timestamp", self)
- output_text = QtWidgets.QTextEdit()
+ output_text = QtWidgets.QTextEdit(self)
output_text.setReadOnly(True)
# output_text.setLineWrapMode(QtWidgets.QTextEdit.FixedPixelWidth)
diff --git a/openpype/modules/timers_manager/rest_api.py b/openpype/modules/timers_manager/rest_api.py
index 975c1a91f9..ac8d8b7b74 100644
--- a/openpype/modules/timers_manager/rest_api.py
+++ b/openpype/modules/timers_manager/rest_api.py
@@ -3,6 +3,7 @@ from openpype.api import Logger
log = Logger().get_logger("Event processor")
+
class TimersManagerModuleRestApi:
"""
REST API endpoint used for calling from hosts when context change
@@ -22,6 +23,11 @@ class TimersManagerModuleRestApi:
self.prefix + "/start_timer",
self.start_timer
)
+ self.server_manager.add_route(
+ "POST",
+ self.prefix + "/stop_timer",
+ self.stop_timer
+ )
async def start_timer(self, request):
data = await request.json()
@@ -38,3 +44,7 @@ class TimersManagerModuleRestApi:
self.module.stop_timers()
self.module.start_timer(project_name, asset_name, task_name, hierarchy)
return Response(status=200)
+
+ async def stop_timer(self, request):
+ self.module.stop_timers()
+ return Response(status=200)
diff --git a/openpype/plugins/publish/integrate_new.py b/openpype/plugins/publish/integrate_new.py
index c5ce6d23aa..3504206fe1 100644
--- a/openpype/plugins/publish/integrate_new.py
+++ b/openpype/plugins/publish/integrate_new.py
@@ -303,6 +303,8 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
key_values = {"families": family, "tasks": task_name}
profile = filter_profiles(self.template_name_profiles, key_values,
logger=self.log)
+
+ template_name = "publish"
if profile:
template_name = profile["template_name"]
@@ -380,7 +382,12 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
test_dest_files = list()
for i in [1, 2]:
- template_data["frame"] = src_padding_exp % i
+ template_data["representation"] = repre['ext']
+ if not repre.get("udim"):
+ template_data["frame"] = src_padding_exp % i
+ else:
+ template_data["udim"] = src_padding_exp % i
+
anatomy_filled = anatomy.format(template_data)
template_filled = anatomy_filled[template_name]["path"]
if repre_context is None:
@@ -388,7 +395,10 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
test_dest_files.append(
os.path.normpath(template_filled)
)
- template_data["frame"] = repre_context["frame"]
+ if not repre.get("udim"):
+ template_data["frame"] = repre_context["frame"]
+ else:
+ template_data["udim"] = repre_context["udim"]
self.log.debug(
"test_dest_files: {}".format(str(test_dest_files)))
@@ -453,7 +463,9 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
dst_start_frame = dst_padding
# Store used frame value to template data
- template_data["frame"] = dst_start_frame
+ if repre.get("frame"):
+ template_data["frame"] = dst_start_frame
+
dst = "{0}{1}{2}".format(
dst_head,
dst_start_frame,
@@ -476,6 +488,10 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
"Given file name is a full path"
)
+ template_data["representation"] = repre['ext']
+ # Store used frame value to template data
+ if repre.get("udim"):
+ template_data["udim"] = repre["udim"][0]
src = os.path.join(stagingdir, fname)
anatomy_filled = anatomy.format(template_data)
template_filled = anatomy_filled[template_name]["path"]
@@ -488,6 +504,9 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
repre['published_path'] = dst
self.log.debug("__ dst: {}".format(dst))
+ if repre.get("udim"):
+ repre_context["udim"] = repre.get("udim") # store list
+
repre["publishedFiles"] = published_files
for key in self.db_representation_context_keys:
@@ -1045,6 +1064,7 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
)
)
shutil.copy(file_url, new_name)
+ os.remove(file_url)
else:
self.log.debug(
"Renaming file {} to {}".format(
diff --git a/openpype/plugins/publish/validate_editorial_asset_name.py b/openpype/plugins/publish/validate_editorial_asset_name.py
index ccea42dc37..f13e3b4f38 100644
--- a/openpype/plugins/publish/validate_editorial_asset_name.py
+++ b/openpype/plugins/publish/validate_editorial_asset_name.py
@@ -11,7 +11,7 @@ class ValidateEditorialAssetName(pyblish.api.ContextPlugin):
"""
order = pyblish.api.ValidatorOrder
- label = "Validate Asset Name"
+ label = "Validate Editorial Asset Name"
def process(self, context):
diff --git a/openpype/plugins/publish/validate_instance_in_context.py b/openpype/plugins/publish/validate_instance_in_context.py
index 29f002f142..61b4d82027 100644
--- a/openpype/plugins/publish/validate_instance_in_context.py
+++ b/openpype/plugins/publish/validate_instance_in_context.py
@@ -92,15 +92,16 @@ class RepairSelectInvalidInstances(pyblish.api.Action):
context_asset = context.data["assetEntity"]["name"]
for instance in instances:
- self.set_attribute(instance, context_asset)
+ if "nuke" in pyblish.api.registered_hosts():
+ import openpype.hosts.nuke.api as nuke_api
+ origin_node = instance[0]
+ nuke_api.lib.recreate_instance(
+ origin_node, avalon_data={"asset": context_asset}
+ )
+ else:
+ self.set_attribute(instance, context_asset)
def set_attribute(self, instance, context_asset):
- if "nuke" in pyblish.api.registered_hosts():
- import nuke
- nuke.toNode(
- instance.data.get("name")
- )["avalon:asset"].setValue(context_asset)
-
if "maya" in pyblish.api.registered_hosts():
from maya import cmds
cmds.setAttr(
diff --git a/openpype/settings/defaults/project_anatomy/templates.json b/openpype/settings/defaults/project_anatomy/templates.json
index 63477b9d82..53abd35ed5 100644
--- a/openpype/settings/defaults/project_anatomy/templates.json
+++ b/openpype/settings/defaults/project_anatomy/templates.json
@@ -17,7 +17,7 @@
},
"publish": {
"folder": "{root[work]}/{project[name]}/{hierarchy}/{asset}/publish/{family}/{subset}/{@version}",
- "file": "{project[code]}_{asset}_{subset}_{@version}<_{output}><.{@frame}>.{ext}",
+ "file": "{project[code]}_{asset}_{subset}_{@version}<_{output}><.{@frame}><_{udim}>.{ext}",
"path": "{@folder}/{@file}",
"thumbnail": "{thumbnail_root}/{project[name]}/{_id}_{thumbnail_type}.{ext}"
},
diff --git a/openpype/settings/defaults/project_settings/ftrack.json b/openpype/settings/defaults/project_settings/ftrack.json
index 7cf5568662..dae5a591e9 100644
--- a/openpype/settings/defaults/project_settings/ftrack.json
+++ b/openpype/settings/defaults/project_settings/ftrack.json
@@ -136,7 +136,8 @@
"Pypeclub",
"Administrator",
"Project manager"
- ]
+ ],
+ "create_project_structure_checked": false
},
"clean_hierarchical_attr": {
"enabled": true,
diff --git a/openpype/settings/defaults/project_settings/global.json b/openpype/settings/defaults/project_settings/global.json
index 43053c38c0..c14486f384 100644
--- a/openpype/settings/defaults/project_settings/global.json
+++ b/openpype/settings/defaults/project_settings/global.json
@@ -1,5 +1,13 @@
{
"publish": {
+ "ValidateEditorialAssetName": {
+ "enabled": true,
+ "optional": false
+ },
+ "ValidateVersion": {
+ "enabled": true,
+ "optional": false
+ },
"IntegrateHeroVersion": {
"enabled": true,
"optional": true,
@@ -260,6 +268,13 @@
"enabled": true
}
],
+ "open_workfile_tool_on_startup": [
+ {
+ "hosts": [],
+ "tasks": [],
+ "enabled": false
+ }
+ ],
"sw_folders": {
"compositing": [
"nuke",
diff --git a/openpype/settings/defaults/project_settings/maya.json b/openpype/settings/defaults/project_settings/maya.json
index b92dc52b92..dc95632bb8 100644
--- a/openpype/settings/defaults/project_settings/maya.json
+++ b/openpype/settings/defaults/project_settings/maya.json
@@ -20,6 +20,22 @@
]
}
},
+ "scriptsmenu": {
+ "name": "OpenPype Tools",
+ "definition": [
+ {
+ "type": "action",
+ "command": "import openpype.hosts.maya.api.commands as op_cmds; op_cmds.edit_shader_definitions()",
+ "sourcetype": "python",
+ "title": "Edit shader name definitions",
+ "tooltip": "Edit shader name definitions used in validation and renaming.",
+ "tags": [
+ "pipeline",
+ "shader"
+ ]
+ }
+ ]
+ },
"create": {
"CreateLook": {
"enabled": true,
diff --git a/openpype/settings/defaults/project_settings/standalonepublisher.json b/openpype/settings/defaults/project_settings/standalonepublisher.json
index f08212934d..50c1e34366 100644
--- a/openpype/settings/defaults/project_settings/standalonepublisher.json
+++ b/openpype/settings/defaults/project_settings/standalonepublisher.json
@@ -123,6 +123,16 @@
],
"help": "Process multiple Mov files and publish them for layout and comp."
},
+ "create_texture_batch": {
+ "name": "texture_batch",
+ "label": "Texture Batch",
+ "family": "texture_batch",
+ "icon": "image",
+ "defaults": [
+ "Main"
+ ],
+ "help": "Texture files with UDIM together with worfile"
+ },
"__dynamic_keys_labels__": {
"create_workfile": "Workfile",
"create_model": "Model",
@@ -134,10 +144,65 @@
"create_image": "Image",
"create_matchmove": "Matchmove",
"create_render": "Render",
- "create_mov_batch": "Batch Mov"
+ "create_mov_batch": "Batch Mov",
+ "create_texture_batch": "Batch Texture"
}
},
"publish": {
+ "CollectTextures": {
+ "enabled": true,
+ "active": true,
+ "main_workfile_extensions": [
+ "mra"
+ ],
+ "other_workfile_extensions": [
+ "spp",
+ "psd"
+ ],
+ "texture_extensions": [
+ "exr",
+ "dpx",
+ "jpg",
+ "jpeg",
+ "png",
+ "tiff",
+ "tga",
+ "gif",
+ "svg"
+ ],
+ "workfile_families": [],
+ "texture_families": [],
+ "color_space": [
+ "linsRGB",
+ "raw",
+ "acesg"
+ ],
+ "input_naming_patterns": {
+ "workfile": [
+ "^([^.]+)(_[^_.]*)?_v([0-9]{3,}).+"
+ ],
+ "textures": [
+ "^([^_.]+)_([^_.]+)_v([0-9]{3,})_([^_.]+)_({color_space})_(1[0-9]{3}).+"
+ ]
+ },
+ "input_naming_groups": {
+ "workfile": [
+ "asset",
+ "filler",
+ "version"
+ ],
+ "textures": [
+ "asset",
+ "shader",
+ "version",
+ "channel",
+ "color_space",
+ "udim"
+ ]
+ },
+ "workfile_subset_template": "textures{Subset}Workfile",
+ "texture_subset_template": "textures{Subset}_{Shader}_{Channel}"
+ },
"ValidateSceneSettings": {
"enabled": true,
"optional": true,
@@ -189,7 +254,7 @@
},
"shot_add_tasks": {}
},
- "shot_add_tasks": {
+ "CollectInstances": {
"custom_start_frame": 0,
"timeline_frame_start": 900000,
"timeline_frame_offset": 0,
diff --git a/openpype/settings/defaults/project_settings/tvpaint.json b/openpype/settings/defaults/project_settings/tvpaint.json
index 763802a73f..47f486aa98 100644
--- a/openpype/settings/defaults/project_settings/tvpaint.json
+++ b/openpype/settings/defaults/project_settings/tvpaint.json
@@ -18,6 +18,11 @@
"optional": true,
"active": true
},
+ "ValidateStartFrame": {
+ "enabled": false,
+ "optional": true,
+ "active": true
+ },
"ValidateAssetName": {
"enabled": true,
"optional": true,
diff --git a/openpype/settings/entities/anatomy_entities.py b/openpype/settings/entities/anatomy_entities.py
index d048ffabba..489e1f8294 100644
--- a/openpype/settings/entities/anatomy_entities.py
+++ b/openpype/settings/entities/anatomy_entities.py
@@ -1,5 +1,6 @@
from .dict_immutable_keys_entity import DictImmutableKeysEntity
from .lib import OverrideState
+from .exceptions import EntitySchemaError
class AnatomyEntity(DictImmutableKeysEntity):
@@ -23,3 +24,25 @@ class AnatomyEntity(DictImmutableKeysEntity):
if not child_obj.has_project_override:
child_obj.add_to_project_override()
return super(AnatomyEntity, self).on_child_change(child_obj)
+
+ def schema_validations(self):
+ non_group_children = []
+ for key, child_obj in self.non_gui_children.items():
+ if not child_obj.is_group:
+ non_group_children.append(key)
+
+ if non_group_children:
+ _non_group_children = [
+ "project_anatomy/{}".format(key)
+ for key in non_group_children
+ ]
+ reason = (
+ "Anatomy must have all children as groups."
+ " Set 'is_group' to `true` on > {}"
+ ).format(", ".join([
+ '"{}"'.format(item)
+ for item in _non_group_children
+ ]))
+ raise EntitySchemaError(self, reason)
+
+ return super(AnatomyEntity, self).schema_validations()
diff --git a/openpype/settings/entities/dict_conditional.py b/openpype/settings/entities/dict_conditional.py
index 96065b670e..d275d8ac3d 100644
--- a/openpype/settings/entities/dict_conditional.py
+++ b/openpype/settings/entities/dict_conditional.py
@@ -144,6 +144,13 @@ class DictConditionalEntity(ItemEntity):
self.enum_entity = None
+ # GUI attributes
+ self.enum_is_horizontal = self.schema_data.get(
+ "enum_is_horizontal", False
+ )
+ # `enum_on_right` can be used only if
+ self.enum_on_right = self.schema_data.get("enum_on_right", False)
+
self.highlight_content = self.schema_data.get(
"highlight_content", False
)
@@ -185,13 +192,13 @@ class DictConditionalEntity(ItemEntity):
children_def_keys = []
for children_def in self.enum_children:
if not isinstance(children_def, dict):
- raise EntitySchemaError((
+ raise EntitySchemaError(self, (
"Children definition under key 'enum_children' must"
" be a dictionary."
))
if "key" not in children_def:
- raise EntitySchemaError((
+ raise EntitySchemaError(self, (
"Children definition under key 'enum_children' miss"
" 'key' definition."
))
@@ -286,7 +293,7 @@ class DictConditionalEntity(ItemEntity):
"multiselection": False,
"enum_items": enum_items,
"key": enum_key,
- "label": self.enum_label or enum_key
+ "label": self.enum_label
}
enum_entity = self.create_schema_object(enum_schema, self)
diff --git a/openpype/settings/entities/enum_entity.py b/openpype/settings/entities/enum_entity.py
index d306eca7ef..4f6a2886bc 100644
--- a/openpype/settings/entities/enum_entity.py
+++ b/openpype/settings/entities/enum_entity.py
@@ -1,3 +1,4 @@
+import copy
from .input_entities import InputEntity
from .exceptions import EntitySchemaError
from .lib import (
@@ -118,30 +119,43 @@ class HostsEnumEntity(BaseEnumEntity):
implementation instead of application name.
"""
schema_types = ["hosts-enum"]
+ all_host_names = [
+ "aftereffects",
+ "blender",
+ "celaction",
+ "fusion",
+ "harmony",
+ "hiero",
+ "houdini",
+ "maya",
+ "nuke",
+ "photoshop",
+ "resolve",
+ "tvpaint",
+ "unreal",
+ "standalonepublisher"
+ ]
def _item_initalization(self):
self.multiselection = self.schema_data.get("multiselection", True)
- self.use_empty_value = self.schema_data.get(
- "use_empty_value", not self.multiselection
- )
+ use_empty_value = False
+ if not self.multiselection:
+ use_empty_value = self.schema_data.get(
+ "use_empty_value", use_empty_value
+ )
+ self.use_empty_value = use_empty_value
+
+ hosts_filter = self.schema_data.get("hosts_filter") or []
+ self.hosts_filter = hosts_filter
+
custom_labels = self.schema_data.get("custom_labels") or {}
- host_names = [
- "aftereffects",
- "blender",
- "celaction",
- "fusion",
- "harmony",
- "hiero",
- "houdini",
- "maya",
- "nuke",
- "photoshop",
- "resolve",
- "tvpaint",
- "unreal",
- "standalonepublisher"
- ]
+ host_names = copy.deepcopy(self.all_host_names)
+ if hosts_filter:
+ for host_name in tuple(host_names):
+ if host_name not in hosts_filter:
+ host_names.remove(host_name)
+
if self.use_empty_value:
host_names.insert(0, "")
# Add default label for empty value if not available
@@ -173,6 +187,44 @@ class HostsEnumEntity(BaseEnumEntity):
# GUI attribute
self.placeholder = self.schema_data.get("placeholder")
+ def schema_validations(self):
+ if self.hosts_filter:
+ enum_len = len(self.enum_items)
+ if (
+ enum_len == 0
+ or (enum_len == 1 and self.use_empty_value)
+ ):
+ joined_filters = ", ".join([
+ '"{}"'.format(item)
+ for item in self.hosts_filter
+ ])
+ reason = (
+ "All host names were removed after applying"
+ " host filters. {}"
+ ).format(joined_filters)
+ raise EntitySchemaError(self, reason)
+
+ invalid_filters = set()
+ for item in self.hosts_filter:
+ if item not in self.all_host_names:
+ invalid_filters.add(item)
+
+ if invalid_filters:
+ joined_filters = ", ".join([
+ '"{}"'.format(item)
+ for item in self.hosts_filter
+ ])
+ expected_hosts = ", ".join([
+ '"{}"'.format(item)
+ for item in self.all_host_names
+ ])
+ self.log.warning((
+ "Host filters containt invalid host names:"
+ " \"{}\" Expected values are {}"
+ ).format(joined_filters, expected_hosts))
+
+ super(HostsEnumEntity, self).schema_validations()
+
class AppsEnumEntity(BaseEnumEntity):
schema_types = ["apps-enum"]
diff --git a/openpype/settings/entities/schemas/README.md b/openpype/settings/entities/schemas/README.md
index d457e44e74..399c4ac1d9 100644
--- a/openpype/settings/entities/schemas/README.md
+++ b/openpype/settings/entities/schemas/README.md
@@ -204,6 +204,8 @@
- it is possible to add darker background with `"highlight_content"` (Default: `False`)
- darker background has limits of maximum applies after 3-4 nested highlighted items there is not difference in the color
- output is dictionary `{the "key": children values}`
+- for UI porposes was added `enum_is_horizontal` which will make combobox appear next to children inputs instead of on top of them (Default: `False`)
+ - this has extended ability of `enum_on_right` which will move combobox to right side next to children widgets (Default: `False`)
```
# Example
{
@@ -379,6 +381,9 @@ How output of the schema could look like on save:
- multiselection can be allowed with setting key `"multiselection"` to `True` (Default: `False`)
- it is possible to add empty value (represented with empty string) with setting `"use_empty_value"` to `True` (Default: `False`)
- it is possible to set `"custom_labels"` for host names where key `""` is empty value (Default: `{}`)
+- to filter host names it is required to define `"hosts_filter"` which is list of host names that will be available
+ - do not pass empty string if `use_empty_value` is enabled
+ - ignoring host names would be more dangerous in some cases
```
{
"key": "host",
@@ -389,7 +394,10 @@ How output of the schema could look like on save:
"custom_labels": {
"": "N/A",
"nuke": "Nuke"
- }
+ },
+ "hosts_filter": [
+ "nuke"
+ ]
}
```
@@ -577,6 +585,15 @@ How output of the schema could look like on save:
}
```
+## Anatomy
+Anatomy represents data stored on project document.
+
+### anatomy
+- entity works similarly to `dict`
+- anatomy has always all keys overriden with overrides
+ - overrides are not applied as all anatomy data must be available from project document
+ - all children must be groups
+
## Proxy wrappers
- should wraps multiple inputs only visually
- these does not have `"key"` key and do not allow to have `"is_file"` or `"is_group"` modifiers enabled
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_ftrack.json b/openpype/settings/entities/schemas/projects_schema/schema_project_ftrack.json
index a94ebc8888..1cc08b96f8 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_ftrack.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_ftrack.json
@@ -441,6 +441,18 @@
"key": "role_list",
"label": "Roles",
"object_type": "text"
+ },
+ {
+ "type": "separator"
+ },
+ {
+ "type": "label",
+ "label": "Check \"Create project structure\" by default"
+ },
+ {
+ "type": "boolean",
+ "key": "create_project_structure_checked",
+ "label": "Checked"
}
]
},
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json b/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
index e70c0da708..cc70516c72 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
@@ -47,6 +47,10 @@
}
]
},
+ {
+ "type": "schema",
+ "name": "schema_maya_scriptsmenu"
+ },
{
"type": "schema",
"name": "schema_maya_create"
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_standalonepublisher.json b/openpype/settings/entities/schemas/projects_schema/schema_project_standalonepublisher.json
index c627012531..37fcaac69f 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_standalonepublisher.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_standalonepublisher.json
@@ -56,6 +56,119 @@
"key": "publish",
"label": "Publish plugins",
"children": [
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "CollectTextures",
+ "label": "Collect Textures",
+ "checkbox_key": "enabled",
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "active",
+ "label": "Active"
+ },
+ {
+ "type": "list",
+ "key": "main_workfile_extensions",
+ "object_type": "text",
+ "label": "Main workfile extensions"
+ },
+ {
+ "key": "other_workfile_extensions",
+ "label": "Support workfile extensions",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "type": "list",
+ "key": "texture_extensions",
+ "object_type": "text",
+ "label": "Texture extensions"
+ },
+ {
+ "type": "list",
+ "key": "workfile_families",
+ "object_type": "text",
+ "label": "Additional families for workfile"
+ },
+ {
+ "type": "list",
+ "key": "texture_families",
+ "object_type": "text",
+ "label": "Additional families for textures"
+ },
+ {
+ "type": "list",
+ "key": "color_space",
+ "object_type": "text",
+ "label": "Color spaces"
+ },
+ {
+ "type": "dict",
+ "collapsible": false,
+ "key": "input_naming_patterns",
+ "label": "Regex patterns for naming conventions",
+ "children": [
+ {
+ "type": "label",
+ "label": "Add regex groups matching expected name"
+ },
+ {
+ "type": "list",
+ "object_type": "text",
+ "key": "workfile",
+ "label": "Workfile naming pattern"
+ },
+ {
+ "type": "list",
+ "object_type": "text",
+ "key": "textures",
+ "label": "Textures naming pattern"
+ }
+ ]
+ },
+ {
+ "type": "dict",
+ "collapsible": false,
+ "key": "input_naming_groups",
+ "label": "Group order for regex patterns",
+ "children": [
+ {
+ "type": "label",
+ "label": "Add names of matched groups in correct order. Available values: ('filler', 'asset', 'shader', 'version', 'channel', 'color_space', 'udim')"
+ },
+ {
+ "type": "list",
+ "object_type": "text",
+ "key": "workfile",
+ "label": "Workfile group positions"
+ },
+ {
+ "type": "list",
+ "object_type": "text",
+ "key": "textures",
+ "label": "Textures group positions"
+ }
+ ]
+ },
+ {
+ "type": "text",
+ "key": "workfile_subset_template",
+ "label": "Subset name template for workfile"
+ },
+ {
+ "type": "text",
+ "key": "texture_subset_template",
+ "label": "Subset name template for textures"
+ }
+ ]
+ },
{
"type": "dict",
"collapsible": true,
@@ -214,7 +327,7 @@
{
"type": "dict",
"collapsible": true,
- "key": "shot_add_tasks",
+ "key": "CollectInstances",
"label": "Collect Clip Instances",
"is_group": true,
"children": [
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json b/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
index 67aa4b0a06..368141813f 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_tvpaint.json
@@ -52,6 +52,17 @@
}
]
},
+ {
+ "type": "schema_template",
+ "name": "template_publish_plugin",
+ "template_data": [
+ {
+ "key": "ValidateStartFrame",
+ "label": "Validate Scene Start Frame",
+ "docstring": "Validate first frame of scene is set to '0'."
+ }
+ ]
+ },
{
"type": "schema_template",
"name": "template_publish_plugin",
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 2b2eab8868..3c589f9492 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
@@ -3,6 +3,7 @@
"key": "imageio",
"label": "Color Management and Output Formats",
"is_file": true,
+ "is_group": true,
"children": [
{
"key": "hiero",
@@ -14,7 +15,6 @@
"type": "dict",
"label": "Workfile",
"collapsible": false,
- "is_group": true,
"children": [
{
"type": "form",
@@ -89,7 +89,6 @@
"type": "dict",
"label": "Colorspace on Inputs by regex detection",
"collapsible": true,
- "is_group": true,
"children": [
{
"type": "list",
@@ -124,7 +123,6 @@
"type": "dict",
"label": "Viewer",
"collapsible": false,
- "is_group": true,
"children": [
{
"type": "text",
@@ -138,7 +136,6 @@
"type": "dict",
"label": "Workfile",
"collapsible": false,
- "is_group": true,
"children": [
{
"type": "form",
@@ -236,7 +233,6 @@
"type": "dict",
"label": "Nodes",
"collapsible": true,
- "is_group": true,
"children": [
{
"key": "requiredNodes",
@@ -339,7 +335,6 @@
"type": "dict",
"label": "Colorspace on Inputs by regex detection",
"collapsible": true,
- "is_group": true,
"children": [
{
"type": "list",
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 4715db4888..a1cbc8639f 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
@@ -4,6 +4,46 @@
"key": "publish",
"label": "Publish plugins",
"children": [
+ {
+ "type": "dict",
+ "collapsible": true,
+ "checkbox_key": "enabled",
+ "key": "ValidateEditorialAssetName",
+ "label": "Validate Editorial Asset Name",
+ "is_group": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ }
+ ]
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "checkbox_key": "enabled",
+ "key": "ValidateVersion",
+ "label": "Validate Version",
+ "is_group": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ }
+ ]
+ },
{
"type": "dict",
"collapsible": true,
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
index 8c92a45a56..9e39eeb39e 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_global_tools.json
@@ -78,7 +78,57 @@
"type": "hosts-enum",
"key": "hosts",
"label": "Hosts",
- "multiselection": true
+ "multiselection": true,
+ "hosts_filter": [
+ "aftereffects",
+ "blender",
+ "celaction",
+ "fusion",
+ "harmony",
+ "hiero",
+ "houdini",
+ "maya",
+ "nuke",
+ "photoshop",
+ "resolve",
+ "tvpaint",
+ "unreal"
+ ]
+ },
+ {
+ "key": "tasks",
+ "label": "Tasks",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "type": "splitter"
+ },
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ }
+ ]
+ }
+ },
+ {
+ "type": "list",
+ "key": "open_workfile_tool_on_startup",
+ "label": "Open workfile tool on launch",
+ "is_group": true,
+ "use_label_wrap": true,
+ "object_type": {
+ "type": "dict",
+ "children": [
+ {
+ "type": "hosts-enum",
+ "key": "hosts",
+ "label": "Hosts",
+ "multiselection": true,
+ "hosts_filter": [
+ "nuke"
+ ]
},
{
"key": "tasks",
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
index 5ca7059ee5..89cd30aed0 100644
--- a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_publish.json
@@ -147,9 +147,14 @@
"key": "enabled",
"label": "Enabled"
},
+ {
+ "type": "boolean",
+ "key": "database",
+ "label": "Use database shader name definitions"
+ },
{
"type": "label",
- "label": "Path to material file defining list of material names to check. This is material name per line simple text file.
It will be checked against named group shader in your Validation regex.For example:
^.*(?P=<shader>.+)_GEO
"
+ "label": "Path to material file defining list of material names to check. This is material name per line simple text file.
It will be checked against named group shader in your Validation regex.For example:
^.*(?P=<shader>.+)_GEO
This is used instead of database definitions if they are disabled."
},
{
"type": "path",
@@ -162,6 +167,15 @@
"type": "text",
"key": "regex",
"label": "Validation regex"
+ },
+ {
+ "type": "label",
+ "label": "Regex for validating name of top level group name.
You can use named capturing groups:
(?P<asset>.*) for Asset name
(?P<subset>.*) for Subset
(?P<project>.*) for project
For example to check for asset in name so *_some_asset_name_GRP is valid, use:
.*?_(?P<asset>.*)_GEO"
+ },
+ {
+ "type": "text",
+ "key": "top_level_regex",
+ "label": "Top level group name regex"
}
]
},
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_scriptsmenu.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_scriptsmenu.json
new file mode 100644
index 0000000000..e841d6ba77
--- /dev/null
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_maya_scriptsmenu.json
@@ -0,0 +1,22 @@
+{
+ "type": "dict",
+ "collapsible": true,
+ "key": "scriptsmenu",
+ "label": "Scripts Menu Definition",
+ "children": [
+ {
+ "type": "text",
+ "key": "name",
+ "label": "Menu Name"
+ },
+ {
+ "type": "splitter"
+ },
+ {
+ "type": "raw-json",
+ "key": "definition",
+ "label": "Menu definition",
+ "is_list": true
+ }
+ ]
+}
\ No newline at end of file
diff --git a/openpype/settings/entities/schemas/system_schema/example_schema.json b/openpype/settings/entities/schemas/system_schema/example_schema.json
index c3287d7452..8ec97064a1 100644
--- a/openpype/settings/entities/schemas/system_schema/example_schema.json
+++ b/openpype/settings/entities/schemas/system_schema/example_schema.json
@@ -9,6 +9,31 @@
"label": "Color input",
"type": "color"
},
+ {
+ "type": "dict-conditional",
+ "key": "overriden_value",
+ "label": "Overriden value",
+ "enum_key": "overriden",
+ "enum_is_horizontal": true,
+ "enum_children": [
+ {
+ "key": "overriden",
+ "label": "Override value",
+ "children": [
+ {
+ "type": "number",
+ "key": "value",
+ "label": "value"
+ }
+ ]
+ },
+ {
+ "key": "inherit",
+ "label": "Inherit value",
+ "children": []
+ }
+ ]
+ },
{
"type": "dict-conditional",
"use_label_wrap": true,
diff --git a/openpype/settings/lib.py b/openpype/settings/lib.py
index 4a3e66de33..5c2c0dcd94 100644
--- a/openpype/settings/lib.py
+++ b/openpype/settings/lib.py
@@ -315,14 +315,28 @@ class DuplicatedEnvGroups(Exception):
super(DuplicatedEnvGroups, self).__init__(msg)
+def load_openpype_default_settings():
+ """Load openpype default settings."""
+ return load_jsons_from_dir(DEFAULTS_DIR)
+
+
def reset_default_settings():
+ """Reset cache of default settings. Can't be used now."""
global _DEFAULT_SETTINGS
_DEFAULT_SETTINGS = None
def get_default_settings():
+ """Get default settings.
+
+ Todo:
+ Cache loaded defaults.
+
+ Returns:
+ dict: Loaded default settings.
+ """
# TODO add cacher
- return load_jsons_from_dir(DEFAULTS_DIR)
+ return load_openpype_default_settings()
# global _DEFAULT_SETTINGS
# if _DEFAULT_SETTINGS is None:
# _DEFAULT_SETTINGS = load_jsons_from_dir(DEFAULTS_DIR)
@@ -868,6 +882,25 @@ def get_environments():
return find_environments(get_system_settings(False))
+def get_general_environments():
+ """Get general environments.
+
+ Function is implemented to be able load general environments without using
+ `get_default_settings`.
+ """
+ # Use only openpype defaults.
+ # - prevent to use `get_system_settings` where `get_default_settings`
+ # is used
+ default_values = load_openpype_default_settings()
+ studio_overrides = get_studio_system_settings_overrides()
+ result = apply_overrides(default_values, studio_overrides)
+ environments = result["general"]["environment"]
+
+ clear_metadata_from_settings(environments)
+
+ return environments
+
+
def clear_metadata_from_settings(values):
"""Remove all metadata keys from loaded settings."""
if isinstance(values, dict):
diff --git a/openpype/style/style.css b/openpype/style/style.css
index c57b9a8da6..b955bdc2a6 100644
--- a/openpype/style/style.css
+++ b/openpype/style/style.css
@@ -35,6 +35,10 @@ QWidget:disabled {
color: {color:font-disabled};
}
+QLabel {
+ background: transparent;
+}
+
/* Inputs */
QAbstractSpinBox, QLineEdit, QPlainTextEdit, QTextEdit {
border: 1px solid {color:border};
@@ -97,7 +101,7 @@ QToolButton:disabled {
background: {color:bg-buttons-disabled};
}
-QToolButton[popupMode="1"] {
+QToolButton[popupMode="1"], QToolButton[popupMode="MenuButtonPopup"] {
/* make way for the popup button */
padding-right: 20px;
border: 1px solid {color:bg-buttons};
@@ -340,6 +344,11 @@ QAbstractItemView {
selection-background-color: transparent;
}
+QAbstractItemView::item {
+ /* `border: none` hide outline of selected item. */
+ border: none;
+}
+
QAbstractItemView:disabled{
background: {color:bg-view-disabled};
alternate-background-color: {color:bg-view-alternate-disabled};
diff --git a/openpype/tools/settings/settings/categories.py b/openpype/tools/settings/settings/categories.py
index 0aacd590db..8be3eddfa8 100644
--- a/openpype/tools/settings/settings/categories.py
+++ b/openpype/tools/settings/settings/categories.py
@@ -294,6 +294,7 @@ class SettingsCategoryWidget(QtWidgets.QWidget):
msg = "
".join(warnings)
dialog = QtWidgets.QMessageBox(self)
+ dialog.setWindowTitle("Save warnings")
dialog.setText(msg)
dialog.setIcon(QtWidgets.QMessageBox.Warning)
dialog.exec_()
@@ -303,6 +304,7 @@ class SettingsCategoryWidget(QtWidgets.QWidget):
except Exception as exc:
formatted_traceback = traceback.format_exception(*sys.exc_info())
dialog = QtWidgets.QMessageBox(self)
+ dialog.setWindowTitle("Unexpected error")
msg = "Unexpected error happened!\n\nError: {}".format(str(exc))
dialog.setText(msg)
dialog.setDetailedText("\n".join(formatted_traceback))
@@ -392,6 +394,7 @@ class SettingsCategoryWidget(QtWidgets.QWidget):
except Exception as exc:
formatted_traceback = traceback.format_exception(*sys.exc_info())
dialog = QtWidgets.QMessageBox(self)
+ dialog.setWindowTitle("Unexpected error")
msg = "Unexpected error happened!\n\nError: {}".format(str(exc))
dialog.setText(msg)
dialog.setDetailedText("\n".join(formatted_traceback))
diff --git a/openpype/tools/settings/settings/dict_conditional.py b/openpype/tools/settings/settings/dict_conditional.py
index da2f53497e..31a4fa9fab 100644
--- a/openpype/tools/settings/settings/dict_conditional.py
+++ b/openpype/tools/settings/settings/dict_conditional.py
@@ -24,6 +24,7 @@ class DictConditionalWidget(BaseWidget):
self.body_widget = None
self.content_widget = None
self.content_layout = None
+ self.enum_layout = None
label = None
if self.entity.is_dynamic_item:
@@ -40,8 +41,36 @@ class DictConditionalWidget(BaseWidget):
self._enum_key_by_wrapper_id = {}
self._added_wrapper_ids = set()
- self.content_layout.setColumnStretch(0, 0)
- self.content_layout.setColumnStretch(1, 1)
+ enum_layout = QtWidgets.QGridLayout()
+ enum_layout.setContentsMargins(0, 0, 0, 0)
+ enum_layout.setColumnStretch(0, 0)
+ enum_layout.setColumnStretch(1, 1)
+
+ all_children_layout = QtWidgets.QVBoxLayout()
+ all_children_layout.setContentsMargins(0, 0, 0, 0)
+
+ if self.entity.enum_is_horizontal:
+ if self.entity.enum_on_right:
+ self.content_layout.addLayout(all_children_layout, 0, 0)
+ self.content_layout.addLayout(enum_layout, 0, 1)
+ # Stretch combobox to minimum and expand value
+ self.content_layout.setColumnStretch(0, 1)
+ self.content_layout.setColumnStretch(1, 0)
+ else:
+ self.content_layout.addLayout(enum_layout, 0, 0)
+ self.content_layout.addLayout(all_children_layout, 0, 1)
+ # Stretch combobox to minimum and expand value
+ self.content_layout.setColumnStretch(0, 0)
+ self.content_layout.setColumnStretch(1, 1)
+
+ else:
+ # Expand content
+ self.content_layout.setColumnStretch(0, 1)
+ self.content_layout.addLayout(enum_layout, 0, 0)
+ self.content_layout.addLayout(all_children_layout, 1, 0)
+
+ self.enum_layout = enum_layout
+ self.all_children_layout = all_children_layout
# Add enum entity to layout mapping
enum_entity = self.entity.enum_entity
@@ -58,6 +87,8 @@ class DictConditionalWidget(BaseWidget):
content_layout.setContentsMargins(0, 0, 0, 0)
content_layout.setSpacing(5)
+ all_children_layout.addWidget(content_widget)
+
self._content_by_enum_value[enum_key] = {
"widget": content_widget,
"layout": content_layout
@@ -80,9 +111,6 @@ class DictConditionalWidget(BaseWidget):
for item_key, children in self.entity.children.items():
content_widget = self._content_by_enum_value[item_key]["widget"]
- row = self.content_layout.rowCount()
- self.content_layout.addWidget(content_widget, row, 0, 1, 2)
-
for child_obj in children:
self.input_fields.append(
self.create_ui_for_entity(
@@ -191,12 +219,25 @@ class DictConditionalWidget(BaseWidget):
else:
map_id = widget.entity.id
- content_widget = self.content_widget
- content_layout = self.content_layout
- if map_id != self.entity.enum_entity.id:
- enum_value = self._enum_key_by_wrapper_id[map_id]
- content_widget = self._content_by_enum_value[enum_value]["widget"]
- content_layout = self._content_by_enum_value[enum_value]["layout"]
+ is_enum_item = map_id == self.entity.enum_entity.id
+ if is_enum_item:
+ content_widget = self.content_widget
+ content_layout = self.enum_layout
+
+ if not label:
+ content_layout.addWidget(widget, 0, 0, 1, 2)
+ return
+
+ label_widget = GridLabelWidget(label, widget)
+ label_widget.input_field = widget
+ widget.label_widget = label_widget
+ content_layout.addWidget(label_widget, 0, 0, 1, 1)
+ content_layout.addWidget(widget, 0, 1, 1, 1)
+ return
+
+ enum_value = self._enum_key_by_wrapper_id[map_id]
+ content_widget = self._content_by_enum_value[enum_value]["widget"]
+ content_layout = self._content_by_enum_value[enum_value]["layout"]
wrapper = self._parent_widget_by_entity_id[map_id]
if wrapper is not content_widget:
diff --git a/openpype/tools/settings/settings/window.py b/openpype/tools/settings/settings/window.py
index a60a2a1d88..4e88301349 100644
--- a/openpype/tools/settings/settings/window.py
+++ b/openpype/tools/settings/settings/window.py
@@ -94,7 +94,8 @@ class MainWidget(QtWidgets.QWidget):
super(MainWidget, self).showEvent(event)
if self._reset_on_show:
self._reset_on_show = False
- self.reset()
+ # Trigger reset with 100ms delay
+ QtCore.QTimer.singleShot(100, self.reset)
def _show_password_dialog(self):
if self._password_dialog:
@@ -107,6 +108,8 @@ class MainWidget(QtWidgets.QWidget):
self._password_dialog = None
if password_passed:
self.reset()
+ if not self.isVisible():
+ self.show()
else:
self.close()
@@ -141,7 +144,10 @@ class MainWidget(QtWidgets.QWidget):
# Don't show dialog if there are not registered slots for
# `trigger_restart` signal.
# - For example when settings are runnin as standalone tool
- if self.receivers(self.trigger_restart) < 1:
+ # - PySide2 and PyQt5 compatible way how to find out
+ method_index = self.metaObject().indexOfMethod("trigger_restart()")
+ method = self.metaObject().method(method_index)
+ if not self.isSignalConnected(method):
return
dialog = RestartDialog(self)
diff --git a/openpype/tools/standalonepublish/widgets/widget_component_item.py b/openpype/tools/standalonepublish/widgets/widget_component_item.py
index 186c8024db..de3cde50cd 100644
--- a/openpype/tools/standalonepublish/widgets/widget_component_item.py
+++ b/openpype/tools/standalonepublish/widgets/widget_component_item.py
@@ -1,7 +1,6 @@
import os
from Qt import QtCore, QtGui, QtWidgets
from .resources import get_resource
-from avalon import style
class ComponentItem(QtWidgets.QFrame):
@@ -61,7 +60,7 @@ class ComponentItem(QtWidgets.QFrame):
name="menu", size=QtCore.QSize(22, 22)
)
- self.action_menu = QtWidgets.QMenu()
+ self.action_menu = QtWidgets.QMenu(self.btn_action_menu)
expanding_sizePolicy = QtWidgets.QSizePolicy(
QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding
@@ -229,7 +228,6 @@ class ComponentItem(QtWidgets.QFrame):
if not self.btn_action_menu.isVisible():
self.btn_action_menu.setVisible(True)
self.btn_action_menu.clicked.connect(self.show_actions)
- self.action_menu.setStyleSheet(style.load_stylesheet())
def set_repre_name_valid(self, valid):
self.has_valid_repre = valid
diff --git a/openpype/tools/standalonepublish/widgets/widget_drop_frame.py b/openpype/tools/standalonepublish/widgets/widget_drop_frame.py
index 63dcb82e83..7fe43c4203 100644
--- a/openpype/tools/standalonepublish/widgets/widget_drop_frame.py
+++ b/openpype/tools/standalonepublish/widgets/widget_drop_frame.py
@@ -211,7 +211,8 @@ class DropDataFrame(QtWidgets.QFrame):
folder_path = os.path.dirname(collection.head)
if file_base[-1] in ['.', '_']:
file_base = file_base[:-1]
- file_ext = collection.tail
+ file_ext = os.path.splitext(
+ collection.format('{head}{padding}{tail}'))[1]
repr_name = file_ext.replace('.', '')
range = collection.format('{ranges}')
diff --git a/openpype/tools/workfiles/app.py b/openpype/tools/workfiles/app.py
index d567e26d74..42f0e422ae 100644
--- a/openpype/tools/workfiles/app.py
+++ b/openpype/tools/workfiles/app.py
@@ -693,16 +693,16 @@ class FilesWidget(QtWidgets.QWidget):
)
return
- file_path = os.path.join(self.root, work_file)
+ file_path = os.path.join(os.path.normpath(self.root), work_file)
- pipeline.emit("before.workfile.save", file_path)
+ pipeline.emit("before.workfile.save", [file_path])
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)
- pipeline.emit("after.workfile.save", file_path)
+ pipeline.emit("after.workfile.save", [file_path])
self.workfile_created.emit(file_path)
diff --git a/openpype/vendor/python/common/scriptsmenu/__init__.py b/openpype/vendor/python/common/scriptsmenu/__init__.py
new file mode 100644
index 0000000000..a881f73533
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/__init__.py
@@ -0,0 +1,5 @@
+from .scriptsmenu import ScriptsMenu
+from . import version
+
+__all__ = ["ScriptsMenu"]
+__version__ = version.version
diff --git a/openpype/vendor/python/common/scriptsmenu/action.py b/openpype/vendor/python/common/scriptsmenu/action.py
new file mode 100644
index 0000000000..dc4d775f6a
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/action.py
@@ -0,0 +1,207 @@
+import os
+
+from .vendor.Qt import QtWidgets
+
+
+class Action(QtWidgets.QAction):
+ """Custom Action widget"""
+
+ def __init__(self, parent=None):
+
+ QtWidgets.QAction.__init__(self, parent)
+
+ self._root = None
+ self._tags = list()
+ self._command = None
+ self._sourcetype = None
+ self._iconfile = None
+ self._label = None
+
+ self._COMMAND = """import imp
+f, filepath, descr = imp.find_module('{module_name}', ['{dirname}'])
+module = imp.load_module('{module_name}', f, filepath, descr)
+module.{module_name}()"""
+
+ @property
+ def root(self):
+ return self._root
+
+ @root.setter
+ def root(self, value):
+ self._root = value
+
+ @property
+ def tags(self):
+ return self._tags
+
+ @tags.setter
+ def tags(self, value):
+ self._tags = value
+
+ @property
+ def command(self):
+ return self._command
+
+ @command.setter
+ def command(self, value):
+ """
+ Store the command in the QAction
+
+ Args:
+ value (str): the full command which will be executed when clicked
+
+ Return:
+ None
+ """
+ self._command = value
+
+ @property
+ def sourcetype(self):
+ return self._sourcetype
+
+ @sourcetype.setter
+ def sourcetype(self, value):
+ """
+ Set the command type to get the correct execution of the command given
+
+ Args:
+ value (str): the name of the command type
+
+ Returns:
+ None
+
+ """
+ self._sourcetype = value
+
+ @property
+ def iconfile(self):
+ return self._iconfile
+
+ @iconfile.setter
+ def iconfile(self, value):
+ """Store the path to the image file which needs to be displayed
+
+ Args:
+ value (str): the path to the image
+
+ Returns:
+ None
+ """
+ self._iconfile = value
+
+ @property
+ def label(self):
+ return self._label
+
+ @label.setter
+ def label(self, value):
+ """
+ Set the abbreviation which will be used as overlay text in the shelf
+
+ Args:
+ value (str): an abbreviation of the name
+
+ Returns:
+ None
+
+ """
+ self._label = value
+
+ def run_command(self):
+ """
+ Run the command of the instance or copy the command to the active shelf
+ based on the current modifiers.
+
+ If callbacks have been registered with fouind modifier integer the
+ function will trigger all callbacks. When a callback function returns a
+ non zero integer it will not execute the action's command
+
+ """
+
+ # get the current application and its linked keyboard modifiers
+ modifiers = QtWidgets.QApplication.keyboardModifiers()
+
+ # If the menu has a callback registered for the current modifier
+ # we run the callback instead of the action itself.
+ registered = self._root.registered_callbacks
+ callbacks = registered.get(int(modifiers), [])
+ for callback in callbacks:
+ signal = callback(self)
+ if signal != 0:
+ # Exit function on non-zero return code
+ return
+
+ exec(self.process_command())
+
+ def process_command(self):
+ """
+ Check if the command is a file which needs to be launched and if it
+ has a relative path, if so return the full path by expanding
+ environment variables. Wrap any mel command in a executable string
+ for Python and return the string if the source type is
+
+ Add your own source type and required process to ensure callback
+ is stored correctly.
+
+ An example of a process is the sourcetype is MEL
+ (Maya Embedded Language) as Python cannot run it on its own so it
+ needs to be wrapped in a string in which we explicitly import mel and
+ run it as a mel.eval. The string is then parsed to python as
+ exec("command").
+
+ Returns:
+ str: a clean command which can be used
+
+ """
+ if self._sourcetype == "python":
+ return self._command
+
+ if self._sourcetype == "mel":
+ # Escape single quotes
+ conversion = self._command.replace("'", "\\'")
+ return "import maya; maya.mel.eval('{}')".format(conversion)
+
+ if self._sourcetype == "file":
+ if os.path.isabs(self._command):
+ filepath = self._command
+ else:
+ filepath = os.path.normpath(os.path.expandvars(self._command))
+
+ return self._wrap_filepath(filepath)
+
+ def has_tag(self, tag):
+ """Check whether the tag matches with the action's tags.
+
+ A partial match will also return True, for example tag `a` will match
+ correctly with the `ape` tag on the Action.
+
+ Args:
+ tag (str): The tag
+
+ Returns
+ bool: Whether the action is tagged with given tag
+
+ """
+
+ for tagitem in self.tags:
+ if tag not in tagitem:
+ continue
+ return True
+
+ return False
+
+ def _wrap_filepath(self, file_path):
+ """Create a wrapped string for the python command
+
+ Args:
+ file_path (str): the filepath of a script
+
+ Returns:
+ str: the wrapped command
+ """
+
+ dirname = os.path.dirname(r"{}".format(file_path))
+ dirpath = dirname.replace("\\", "/")
+ module_name = os.path.splitext(os.path.basename(file_path))[0]
+
+ return self._COMMAND.format(module_name=module_name, dirname=dirpath)
diff --git a/openpype/vendor/python/common/scriptsmenu/launchformari.py b/openpype/vendor/python/common/scriptsmenu/launchformari.py
new file mode 100644
index 0000000000..25cfc80d96
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/launchformari.py
@@ -0,0 +1,54 @@
+
+# Import third-party modules
+from vendor.Qt import QtWidgets
+
+# Import local modules
+import scriptsmenu
+
+
+def _mari_main_window():
+ """Get Mari main window.
+
+ Returns:
+ MriMainWindow: Mari's main window.
+
+ """
+ for obj in QtWidgets.QApplication.topLevelWidgets():
+ if obj.metaObject().className() == 'MriMainWindow':
+ return obj
+ raise RuntimeError('Could not find Mari MainWindow instance')
+
+
+def _mari_main_menubar():
+ """Get Mari main menu bar.
+
+ Returns:
+ Retrieve the main menubar of the Mari window.
+
+ """
+ mari_window = _mari_main_window()
+ menubar = [
+ i for i in mari_window.children() if isinstance(i, QtWidgets.QMenuBar)
+ ]
+ assert len(menubar) == 1, "Error, could not find menu bar!"
+ return menubar[0]
+
+
+def main(title="Scripts"):
+ """Build the main scripts menu in Mari.
+
+ Args:
+ title (str): Name of the menu in the application.
+
+ Returns:
+ scriptsmenu.ScriptsMenu: Instance object.
+
+ """
+ mari_main_bar = _mari_main_menubar()
+ for mari_bar in mari_main_bar.children():
+ if isinstance(mari_bar, scriptsmenu.ScriptsMenu):
+ if mari_bar.title() == title:
+ menu = mari_bar
+ return menu
+ menu = scriptsmenu.ScriptsMenu(title=title, parent=mari_main_bar)
+ return menu
diff --git a/openpype/vendor/python/common/scriptsmenu/launchformaya.py b/openpype/vendor/python/common/scriptsmenu/launchformaya.py
new file mode 100644
index 0000000000..7ad66f0ad2
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/launchformaya.py
@@ -0,0 +1,137 @@
+import logging
+
+import maya.cmds as cmds
+import maya.mel as mel
+
+import scriptsmenu
+from .vendor.Qt import QtCore, QtWidgets
+
+log = logging.getLogger(__name__)
+
+
+def register_repeat_last(action):
+ """Register the action in repeatLast to ensure the RepeatLast hotkey works
+
+ Args:
+ action (action.Action): Action wigdet instance
+
+ Returns:
+ int: 0
+
+ """
+ command = action.process_command()
+ command = command.replace("\n", "; ")
+ # Register command to Maya (mel)
+ cmds.repeatLast(addCommand='python("{}")'.format(command),
+ addCommandLabel=action.label)
+
+ return 0
+
+
+def to_shelf(action):
+ """Copy clicked menu item to the currently active Maya shelf
+ Args:
+ action (action.Action): the action instance which is clicked
+
+ Returns:
+ int: 1
+
+ """
+
+ shelftoplevel = mel.eval("$gShelfTopLevel = $gShelfTopLevel;")
+ current_active_shelf = cmds.tabLayout(shelftoplevel,
+ query=True,
+ selectTab=True)
+
+ cmds.shelfButton(command=action.process_command(),
+ sourceType="python",
+ parent=current_active_shelf,
+ image=action.iconfile or "pythonFamily.png",
+ annotation=action.statusTip(),
+ imageOverlayLabel=action.label or "")
+
+ return 1
+
+
+def _maya_main_window():
+ """Return Maya's main window"""
+ for obj in QtWidgets.QApplication.topLevelWidgets():
+ if obj.objectName() == 'MayaWindow':
+ return obj
+ raise RuntimeError('Could not find MayaWindow instance')
+
+
+def _maya_main_menubar():
+ """Retrieve the main menubar of the Maya window"""
+ mayawindow = _maya_main_window()
+ menubar = [i for i in mayawindow.children()
+ if isinstance(i, QtWidgets.QMenuBar)]
+
+ assert len(menubar) == 1, "Error, could not find menu bar!"
+
+ return menubar[0]
+
+
+def find_scripts_menu(title, parent):
+ """
+ Check if the menu exists with the given title in the parent
+
+ Args:
+ title (str): the title name of the scripts menu
+
+ parent (QtWidgets.QMenuBar): the menubar to check
+
+ Returns:
+ QtWidgets.QMenu or None
+
+ """
+
+ menu = None
+ search = [i for i in parent.children() if
+ isinstance(i, scriptsmenu.ScriptsMenu)
+ and i.title() == title]
+
+ if search:
+ assert len(search) < 2, ("Multiple instances of menu '{}' "
+ "in menu bar".format(title))
+ menu = search[0]
+
+ return menu
+
+
+def main(title="Scripts", parent=None, objectName=None):
+ """Build the main scripts menu in Maya
+
+ Args:
+ title (str): name of the menu in the application
+
+ parent (QtWidgets.QtMenuBar): the parent object for the menu
+
+ objectName (str): custom objectName for scripts menu
+
+ Returns:
+ scriptsmenu.ScriptsMenu instance
+
+ """
+
+ mayamainbar = parent or _maya_main_menubar()
+ try:
+ # check menu already exists
+ menu = find_scripts_menu(title, mayamainbar)
+ if not menu:
+ log.info("Attempting to build menu ...")
+ object_name = objectName or title.lower()
+ menu = scriptsmenu.ScriptsMenu(title=title,
+ parent=mayamainbar,
+ objectName=object_name)
+ except Exception as e:
+ log.error(e)
+ return
+
+ # Register control + shift callback to add to shelf (maya behavior)
+ modifiers = QtCore.Qt.ControlModifier | QtCore.Qt.ShiftModifier
+ menu.register_callback(int(modifiers), to_shelf)
+
+ menu.register_callback(0, register_repeat_last)
+
+ return menu
diff --git a/openpype/vendor/python/common/scriptsmenu/launchfornuke.py b/openpype/vendor/python/common/scriptsmenu/launchfornuke.py
new file mode 100644
index 0000000000..23e4ed1b4d
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/launchfornuke.py
@@ -0,0 +1,36 @@
+import scriptsmenu
+from .vendor.Qt import QtWidgets
+
+
+def _nuke_main_window():
+ """Return Nuke's main window"""
+ for obj in QtWidgets.QApplication.topLevelWidgets():
+ if (obj.inherits('QMainWindow') and
+ obj.metaObject().className() == 'Foundry::UI::DockMainWindow'):
+ return obj
+ raise RuntimeError('Could not find Nuke MainWindow instance')
+
+
+def _nuke_main_menubar():
+ """Retrieve the main menubar of the Nuke window"""
+ nuke_window = _nuke_main_window()
+ menubar = [i for i in nuke_window.children()
+ if isinstance(i, QtWidgets.QMenuBar)]
+
+ assert len(menubar) == 1, "Error, could not find menu bar!"
+ return menubar[0]
+
+
+def main(title="Scripts"):
+ # Register control + shift callback to add to shelf (Nuke behavior)
+ # modifiers = QtCore.Qt.ControlModifier | QtCore.Qt.ShiftModifier
+ # menu.register_callback(modifiers, to_shelf)
+ nuke_main_bar = _nuke_main_menubar()
+ for nuke_bar in nuke_main_bar.children():
+ if isinstance(nuke_bar, scriptsmenu.ScriptsMenu):
+ if nuke_bar.title() == title:
+ menu = nuke_bar
+ return menu
+
+ menu = scriptsmenu.ScriptsMenu(title=title, parent=nuke_main_bar)
+ return menu
\ No newline at end of file
diff --git a/openpype/vendor/python/common/scriptsmenu/scriptsmenu.py b/openpype/vendor/python/common/scriptsmenu/scriptsmenu.py
new file mode 100644
index 0000000000..e2b7ff96c7
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/scriptsmenu.py
@@ -0,0 +1,316 @@
+import os
+import json
+import logging
+from collections import defaultdict
+
+from .vendor.Qt import QtWidgets, QtCore
+from . import action
+
+log = logging.getLogger(__name__)
+
+
+class ScriptsMenu(QtWidgets.QMenu):
+ """A Qt menu that displays a list of searchable actions"""
+
+ updated = QtCore.Signal(QtWidgets.QMenu)
+
+ def __init__(self, *args, **kwargs):
+ """Initialize Scripts menu
+
+ Args:
+ title (str): the name of the root menu which will be created
+
+ parent (QtWidgets.QObject) : the QObject to parent the menu to
+
+ Returns:
+ None
+
+ """
+ QtWidgets.QMenu.__init__(self, *args, **kwargs)
+
+ self.searchbar = None
+ self.update_action = None
+
+ self._script_actions = []
+ self._callbacks = defaultdict(list)
+
+ # Automatically add it to the parent menu
+ parent = kwargs.get("parent", None)
+ if parent:
+ parent.addMenu(self)
+
+ objectname = kwargs.get("objectName", "scripts")
+ title = kwargs.get("title", "Scripts")
+ self.setObjectName(objectname)
+ self.setTitle(title)
+
+ # add default items in the menu
+ self.create_default_items()
+
+ def on_update(self):
+ self.updated.emit(self)
+
+ @property
+ def registered_callbacks(self):
+ return self._callbacks.copy()
+
+ def create_default_items(self):
+ """Add a search bar to the top of the menu given"""
+
+ # create widget and link function
+ searchbar = QtWidgets.QLineEdit()
+ searchbar.setFixedWidth(120)
+ searchbar.setPlaceholderText("Search ...")
+ searchbar.textChanged.connect(self._update_search)
+ self.searchbar = searchbar
+
+ # create widget holder
+ searchbar_action = QtWidgets.QWidgetAction(self)
+
+ # add widget to widget holder
+ searchbar_action.setDefaultWidget(self.searchbar)
+ searchbar_action.setObjectName("Searchbar")
+
+ # add update button and link function
+ update_action = QtWidgets.QAction(self)
+ update_action.setObjectName("Update Scripts")
+ update_action.setText("Update Scripts")
+ update_action.setVisible(False)
+ update_action.triggered.connect(self.on_update)
+ self.update_action = update_action
+
+ # add action to menu
+ self.addAction(searchbar_action)
+ self.addAction(update_action)
+
+ # add separator object
+ separator = self.addSeparator()
+ separator.setObjectName("separator")
+
+ def add_menu(self, title, parent=None):
+ """Create a sub menu for a parent widget
+
+ Args:
+ parent(QtWidgets.QWidget): the object to parent the menu to
+
+ title(str): the title of the menu
+
+ Returns:
+ QtWidget.QMenu instance
+ """
+
+ if not parent:
+ parent = self
+
+ menu = QtWidgets.QMenu(parent, title)
+ menu.setTitle(title)
+ menu.setObjectName(title)
+ menu.setTearOffEnabled(True)
+ parent.addMenu(menu)
+
+ return menu
+
+ def add_script(self, parent, title, command, sourcetype, icon=None,
+ tags=None, label=None, tooltip=None):
+ """Create an action item which runs a script when clicked
+
+ Args:
+ parent (QtWidget.QWidget): The widget to parent the item to
+
+ title (str): The text which will be displayed in the menu
+
+ command (str): The command which needs to be run when the item is
+ clicked.
+
+ sourcetype (str): The type of command, the way the command is
+ processed is based on the source type.
+
+ icon (str): The file path of an icon to display with the menu item
+
+ tags (list, tuple): Keywords which describe the action
+
+ label (str): A short description of the script which will be displayed
+ when hovering over the menu item
+
+ tooltip (str): A tip for the user about the usage fo the tool
+
+ Returns:
+ QtWidget.QAction instance
+
+ """
+
+ assert tags is None or isinstance(tags, (list, tuple))
+ # Ensure tags is a list
+ tags = list() if tags is None else list(tags)
+ tags.append(title.lower())
+
+ assert icon is None or isinstance(icon, str), (
+ "Invalid data type for icon, supported : None, string")
+
+ # create new action
+ script_action = action.Action(parent)
+ script_action.setText(title)
+ script_action.setObjectName(title)
+ script_action.tags = tags
+
+ # link action to root for callback library
+ script_action.root = self
+
+ # Set up the command
+ script_action.sourcetype = sourcetype
+ script_action.command = command
+
+ try:
+ script_action.process_command()
+ except RuntimeError as e:
+ raise RuntimeError("Script action can't be "
+ "processed: {}".format(e))
+
+ if icon:
+ iconfile = os.path.expandvars(icon)
+ script_action.iconfile = iconfile
+ script_action_icon = QtWidgets.QIcon(iconfile)
+ script_action.setIcon(script_action_icon)
+
+ if label:
+ script_action.label = label
+
+ if tooltip:
+ script_action.setStatusTip(tooltip)
+
+ script_action.triggered.connect(script_action.run_command)
+ parent.addAction(script_action)
+
+ # Add to our searchable actions
+ self._script_actions.append(script_action)
+
+ return script_action
+
+ def build_from_configuration(self, parent, configuration):
+ """Process the configurations and store the configuration
+
+ This creates all submenus from a configuration.json file.
+
+ When the configuration holds the key `main` all scripts under `main` will
+ be added to the main menu first before adding the rest
+
+ Args:
+ parent (ScriptsMenu): script menu instance
+ configuration (list): A ScriptsMenu configuration list
+
+ Returns:
+ None
+
+ """
+
+ for item in configuration:
+ assert isinstance(item, dict), "Configuration is wrong!"
+
+ # skip items which have no `type` key
+ item_type = item.get('type', None)
+ if not item_type:
+ log.warning("Missing 'type' from configuration item")
+ continue
+
+ # add separator
+ # Special behavior for separators
+ if item_type == "separator":
+ parent.addSeparator()
+
+ # add submenu
+ # items should hold a collection of submenu items (dict)
+ elif item_type == "menu":
+ assert "items" in item, "Menu is missing 'items' key"
+ menu = self.add_menu(parent=parent, title=item["title"])
+ self.build_from_configuration(menu, item["items"])
+
+ # add script
+ elif item_type == "action":
+ # filter out `type` from the item dict
+ config = {key: value for key, value in
+ item.items() if key != "type"}
+
+ self.add_script(parent=parent, **config)
+
+ def set_update_visible(self, state):
+ self.update_action.setVisible(state)
+
+ def clear_menu(self):
+ """Clear all menu items which are not default
+
+ Returns:
+ None
+
+ """
+
+ # TODO: Set up a more robust implementation for this
+ # Delete all except the first three actions
+ for _action in self.actions()[3:]:
+ self.removeAction(_action)
+
+ def register_callback(self, modifiers, callback):
+ self._callbacks[modifiers].append(callback)
+
+ def _update_search(self, search):
+ """Hide all the samples which do not match the user's import
+
+ Returns:
+ None
+
+ """
+
+ if not search:
+ for action in self._script_actions:
+ action.setVisible(True)
+ else:
+ for action in self._script_actions:
+ if not action.has_tag(search.lower()):
+ action.setVisible(False)
+
+ # Set visibility for all submenus
+ for action in self.actions():
+ if not action.menu():
+ continue
+
+ menu = action.menu()
+ visible = any(action.isVisible() for action in menu.actions())
+ action.setVisible(visible)
+
+
+def load_configuration(path):
+ """Load the configuration from a file
+
+ Read out the JSON file which will dictate the structure of the scripts menu
+
+ Args:
+ path (str): file path of the .JSON file
+
+ Returns:
+ dict
+
+ """
+
+ if not os.path.isfile(path):
+ raise AttributeError("Given configuration is not "
+ "a file!\n'{}'".format(path))
+
+ extension = os.path.splitext(path)[-1]
+ if extension != ".json":
+ raise AttributeError("Given configuration file has unsupported "
+ "file type, provide a .json file")
+
+ # retrieve and store config
+ with open(path, "r") as f:
+ configuration = json.load(f)
+
+ return configuration
+
+
+def application(configuration, parent):
+ import sys
+ app = QtWidgets.QApplication(sys.argv)
+
+ scriptsmenu = ScriptsMenu(configuration, parent)
+ scriptsmenu.show()
+
+ sys.exit(app.exec_())
diff --git a/openpype/vendor/python/common/scriptsmenu/vendor/Qt.py b/openpype/vendor/python/common/scriptsmenu/vendor/Qt.py
new file mode 100644
index 0000000000..fe4b45f18f
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/vendor/Qt.py
@@ -0,0 +1,1989 @@
+"""Minimal Python 2 & 3 shim around all Qt bindings
+
+DOCUMENTATION
+ Qt.py was born in the film and visual effects industry to address
+ the growing need for the development of software capable of running
+ with more than one flavour of the Qt bindings for Python - PySide,
+ PySide2, PyQt4 and PyQt5.
+
+ 1. Build for one, run with all
+ 2. Explicit is better than implicit
+ 3. Support co-existence
+
+ Default resolution order:
+ - PySide2
+ - PyQt5
+ - PySide
+ - PyQt4
+
+ Usage:
+ >> import sys
+ >> from Qt import QtWidgets
+ >> app = QtWidgets.QApplication(sys.argv)
+ >> button = QtWidgets.QPushButton("Hello World")
+ >> button.show()
+ >> app.exec_()
+
+ All members of PySide2 are mapped from other bindings, should they exist.
+ If no equivalent member exist, it is excluded from Qt.py and inaccessible.
+ The idea is to highlight members that exist across all supported binding,
+ and guarantee that code that runs on one binding runs on all others.
+
+ For more details, visit https://github.com/mottosso/Qt.py
+
+LICENSE
+
+ See end of file for license (MIT, BSD) information.
+
+"""
+
+import os
+import sys
+import types
+import shutil
+import importlib
+
+
+__version__ = "1.2.3"
+
+# Enable support for `from Qt import *`
+__all__ = []
+
+# Flags from environment variables
+QT_VERBOSE = bool(os.getenv("QT_VERBOSE"))
+QT_PREFERRED_BINDING = os.getenv("QT_PREFERRED_BINDING", "")
+QT_SIP_API_HINT = os.getenv("QT_SIP_API_HINT")
+
+# Reference to Qt.py
+Qt = sys.modules[__name__]
+Qt.QtCompat = types.ModuleType("QtCompat")
+
+try:
+ long
+except NameError:
+ # Python 3 compatibility
+ long = int
+
+
+"""Common members of all bindings
+
+This is where each member of Qt.py is explicitly defined.
+It is based on a "lowest common denominator" of all bindings;
+including members found in each of the 4 bindings.
+
+The "_common_members" dictionary is generated using the
+build_membership.sh script.
+
+"""
+
+_common_members = {
+ "QtCore": [
+ "QAbstractAnimation",
+ "QAbstractEventDispatcher",
+ "QAbstractItemModel",
+ "QAbstractListModel",
+ "QAbstractState",
+ "QAbstractTableModel",
+ "QAbstractTransition",
+ "QAnimationGroup",
+ "QBasicTimer",
+ "QBitArray",
+ "QBuffer",
+ "QByteArray",
+ "QByteArrayMatcher",
+ "QChildEvent",
+ "QCoreApplication",
+ "QCryptographicHash",
+ "QDataStream",
+ "QDate",
+ "QDateTime",
+ "QDir",
+ "QDirIterator",
+ "QDynamicPropertyChangeEvent",
+ "QEasingCurve",
+ "QElapsedTimer",
+ "QEvent",
+ "QEventLoop",
+ "QEventTransition",
+ "QFile",
+ "QFileInfo",
+ "QFileSystemWatcher",
+ "QFinalState",
+ "QGenericArgument",
+ "QGenericReturnArgument",
+ "QHistoryState",
+ "QItemSelectionRange",
+ "QIODevice",
+ "QLibraryInfo",
+ "QLine",
+ "QLineF",
+ "QLocale",
+ "QMargins",
+ "QMetaClassInfo",
+ "QMetaEnum",
+ "QMetaMethod",
+ "QMetaObject",
+ "QMetaProperty",
+ "QMimeData",
+ "QModelIndex",
+ "QMutex",
+ "QMutexLocker",
+ "QObject",
+ "QParallelAnimationGroup",
+ "QPauseAnimation",
+ "QPersistentModelIndex",
+ "QPluginLoader",
+ "QPoint",
+ "QPointF",
+ "QProcess",
+ "QProcessEnvironment",
+ "QPropertyAnimation",
+ "QReadLocker",
+ "QReadWriteLock",
+ "QRect",
+ "QRectF",
+ "QRegExp",
+ "QResource",
+ "QRunnable",
+ "QSemaphore",
+ "QSequentialAnimationGroup",
+ "QSettings",
+ "QSignalMapper",
+ "QSignalTransition",
+ "QSize",
+ "QSizeF",
+ "QSocketNotifier",
+ "QState",
+ "QStateMachine",
+ "QSysInfo",
+ "QSystemSemaphore",
+ "QT_TRANSLATE_NOOP",
+ "QT_TR_NOOP",
+ "QT_TR_NOOP_UTF8",
+ "QTemporaryFile",
+ "QTextBoundaryFinder",
+ "QTextCodec",
+ "QTextDecoder",
+ "QTextEncoder",
+ "QTextStream",
+ "QTextStreamManipulator",
+ "QThread",
+ "QThreadPool",
+ "QTime",
+ "QTimeLine",
+ "QTimer",
+ "QTimerEvent",
+ "QTranslator",
+ "QUrl",
+ "QVariantAnimation",
+ "QWaitCondition",
+ "QWriteLocker",
+ "QXmlStreamAttribute",
+ "QXmlStreamAttributes",
+ "QXmlStreamEntityDeclaration",
+ "QXmlStreamEntityResolver",
+ "QXmlStreamNamespaceDeclaration",
+ "QXmlStreamNotationDeclaration",
+ "QXmlStreamReader",
+ "QXmlStreamWriter",
+ "Qt",
+ "QtCriticalMsg",
+ "QtDebugMsg",
+ "QtFatalMsg",
+ "QtMsgType",
+ "QtSystemMsg",
+ "QtWarningMsg",
+ "qAbs",
+ "qAddPostRoutine",
+ "qChecksum",
+ "qCritical",
+ "qDebug",
+ "qFatal",
+ "qFuzzyCompare",
+ "qIsFinite",
+ "qIsInf",
+ "qIsNaN",
+ "qIsNull",
+ "qRegisterResourceData",
+ "qUnregisterResourceData",
+ "qVersion",
+ "qWarning",
+ "qrand",
+ "qsrand"
+ ],
+ "QtGui": [
+ "QAbstractTextDocumentLayout",
+ "QActionEvent",
+ "QBitmap",
+ "QBrush",
+ "QClipboard",
+ "QCloseEvent",
+ "QColor",
+ "QConicalGradient",
+ "QContextMenuEvent",
+ "QCursor",
+ "QDesktopServices",
+ "QDoubleValidator",
+ "QDrag",
+ "QDragEnterEvent",
+ "QDragLeaveEvent",
+ "QDragMoveEvent",
+ "QDropEvent",
+ "QFileOpenEvent",
+ "QFocusEvent",
+ "QFont",
+ "QFontDatabase",
+ "QFontInfo",
+ "QFontMetrics",
+ "QFontMetricsF",
+ "QGradient",
+ "QHelpEvent",
+ "QHideEvent",
+ "QHoverEvent",
+ "QIcon",
+ "QIconDragEvent",
+ "QIconEngine",
+ "QImage",
+ "QImageIOHandler",
+ "QImageReader",
+ "QImageWriter",
+ "QInputEvent",
+ "QInputMethodEvent",
+ "QIntValidator",
+ "QKeyEvent",
+ "QKeySequence",
+ "QLinearGradient",
+ "QMatrix2x2",
+ "QMatrix2x3",
+ "QMatrix2x4",
+ "QMatrix3x2",
+ "QMatrix3x3",
+ "QMatrix3x4",
+ "QMatrix4x2",
+ "QMatrix4x3",
+ "QMatrix4x4",
+ "QMouseEvent",
+ "QMoveEvent",
+ "QMovie",
+ "QPaintDevice",
+ "QPaintEngine",
+ "QPaintEngineState",
+ "QPaintEvent",
+ "QPainter",
+ "QPainterPath",
+ "QPainterPathStroker",
+ "QPalette",
+ "QPen",
+ "QPicture",
+ "QPictureIO",
+ "QPixmap",
+ "QPixmapCache",
+ "QPolygon",
+ "QPolygonF",
+ "QQuaternion",
+ "QRadialGradient",
+ "QRegExpValidator",
+ "QRegion",
+ "QResizeEvent",
+ "QSessionManager",
+ "QShortcutEvent",
+ "QShowEvent",
+ "QStandardItem",
+ "QStandardItemModel",
+ "QStatusTipEvent",
+ "QSyntaxHighlighter",
+ "QTabletEvent",
+ "QTextBlock",
+ "QTextBlockFormat",
+ "QTextBlockGroup",
+ "QTextBlockUserData",
+ "QTextCharFormat",
+ "QTextCursor",
+ "QTextDocument",
+ "QTextDocumentFragment",
+ "QTextFormat",
+ "QTextFragment",
+ "QTextFrame",
+ "QTextFrameFormat",
+ "QTextImageFormat",
+ "QTextInlineObject",
+ "QTextItem",
+ "QTextLayout",
+ "QTextLength",
+ "QTextLine",
+ "QTextList",
+ "QTextListFormat",
+ "QTextObject",
+ "QTextObjectInterface",
+ "QTextOption",
+ "QTextTable",
+ "QTextTableCell",
+ "QTextTableCellFormat",
+ "QTextTableFormat",
+ "QTouchEvent",
+ "QTransform",
+ "QValidator",
+ "QVector2D",
+ "QVector3D",
+ "QVector4D",
+ "QWhatsThisClickedEvent",
+ "QWheelEvent",
+ "QWindowStateChangeEvent",
+ "qAlpha",
+ "qBlue",
+ "qGray",
+ "qGreen",
+ "qIsGray",
+ "qRed",
+ "qRgb",
+ "qRgba"
+ ],
+ "QtHelp": [
+ "QHelpContentItem",
+ "QHelpContentModel",
+ "QHelpContentWidget",
+ "QHelpEngine",
+ "QHelpEngineCore",
+ "QHelpIndexModel",
+ "QHelpIndexWidget",
+ "QHelpSearchEngine",
+ "QHelpSearchQuery",
+ "QHelpSearchQueryWidget",
+ "QHelpSearchResultWidget"
+ ],
+ "QtMultimedia": [
+ "QAbstractVideoBuffer",
+ "QAbstractVideoSurface",
+ "QAudio",
+ "QAudioDeviceInfo",
+ "QAudioFormat",
+ "QAudioInput",
+ "QAudioOutput",
+ "QVideoFrame",
+ "QVideoSurfaceFormat"
+ ],
+ "QtNetwork": [
+ "QAbstractNetworkCache",
+ "QAbstractSocket",
+ "QAuthenticator",
+ "QHostAddress",
+ "QHostInfo",
+ "QLocalServer",
+ "QLocalSocket",
+ "QNetworkAccessManager",
+ "QNetworkAddressEntry",
+ "QNetworkCacheMetaData",
+ "QNetworkConfiguration",
+ "QNetworkConfigurationManager",
+ "QNetworkCookie",
+ "QNetworkCookieJar",
+ "QNetworkDiskCache",
+ "QNetworkInterface",
+ "QNetworkProxy",
+ "QNetworkProxyFactory",
+ "QNetworkProxyQuery",
+ "QNetworkReply",
+ "QNetworkRequest",
+ "QNetworkSession",
+ "QSsl",
+ "QTcpServer",
+ "QTcpSocket",
+ "QUdpSocket"
+ ],
+ "QtOpenGL": [
+ "QGL",
+ "QGLContext",
+ "QGLFormat",
+ "QGLWidget"
+ ],
+ "QtPrintSupport": [
+ "QAbstractPrintDialog",
+ "QPageSetupDialog",
+ "QPrintDialog",
+ "QPrintEngine",
+ "QPrintPreviewDialog",
+ "QPrintPreviewWidget",
+ "QPrinter",
+ "QPrinterInfo"
+ ],
+ "QtSql": [
+ "QSql",
+ "QSqlDatabase",
+ "QSqlDriver",
+ "QSqlDriverCreatorBase",
+ "QSqlError",
+ "QSqlField",
+ "QSqlIndex",
+ "QSqlQuery",
+ "QSqlQueryModel",
+ "QSqlRecord",
+ "QSqlRelation",
+ "QSqlRelationalDelegate",
+ "QSqlRelationalTableModel",
+ "QSqlResult",
+ "QSqlTableModel"
+ ],
+ "QtSvg": [
+ "QGraphicsSvgItem",
+ "QSvgGenerator",
+ "QSvgRenderer",
+ "QSvgWidget"
+ ],
+ "QtTest": [
+ "QTest"
+ ],
+ "QtWidgets": [
+ "QAbstractButton",
+ "QAbstractGraphicsShapeItem",
+ "QAbstractItemDelegate",
+ "QAbstractItemView",
+ "QAbstractScrollArea",
+ "QAbstractSlider",
+ "QAbstractSpinBox",
+ "QAction",
+ "QActionGroup",
+ "QApplication",
+ "QBoxLayout",
+ "QButtonGroup",
+ "QCalendarWidget",
+ "QCheckBox",
+ "QColorDialog",
+ "QColumnView",
+ "QComboBox",
+ "QCommandLinkButton",
+ "QCommonStyle",
+ "QCompleter",
+ "QDataWidgetMapper",
+ "QDateEdit",
+ "QDateTimeEdit",
+ "QDesktopWidget",
+ "QDial",
+ "QDialog",
+ "QDialogButtonBox",
+ "QDirModel",
+ "QDockWidget",
+ "QDoubleSpinBox",
+ "QErrorMessage",
+ "QFileDialog",
+ "QFileIconProvider",
+ "QFileSystemModel",
+ "QFocusFrame",
+ "QFontComboBox",
+ "QFontDialog",
+ "QFormLayout",
+ "QFrame",
+ "QGesture",
+ "QGestureEvent",
+ "QGestureRecognizer",
+ "QGraphicsAnchor",
+ "QGraphicsAnchorLayout",
+ "QGraphicsBlurEffect",
+ "QGraphicsColorizeEffect",
+ "QGraphicsDropShadowEffect",
+ "QGraphicsEffect",
+ "QGraphicsEllipseItem",
+ "QGraphicsGridLayout",
+ "QGraphicsItem",
+ "QGraphicsItemGroup",
+ "QGraphicsLayout",
+ "QGraphicsLayoutItem",
+ "QGraphicsLineItem",
+ "QGraphicsLinearLayout",
+ "QGraphicsObject",
+ "QGraphicsOpacityEffect",
+ "QGraphicsPathItem",
+ "QGraphicsPixmapItem",
+ "QGraphicsPolygonItem",
+ "QGraphicsProxyWidget",
+ "QGraphicsRectItem",
+ "QGraphicsRotation",
+ "QGraphicsScale",
+ "QGraphicsScene",
+ "QGraphicsSceneContextMenuEvent",
+ "QGraphicsSceneDragDropEvent",
+ "QGraphicsSceneEvent",
+ "QGraphicsSceneHelpEvent",
+ "QGraphicsSceneHoverEvent",
+ "QGraphicsSceneMouseEvent",
+ "QGraphicsSceneMoveEvent",
+ "QGraphicsSceneResizeEvent",
+ "QGraphicsSceneWheelEvent",
+ "QGraphicsSimpleTextItem",
+ "QGraphicsTextItem",
+ "QGraphicsTransform",
+ "QGraphicsView",
+ "QGraphicsWidget",
+ "QGridLayout",
+ "QGroupBox",
+ "QHBoxLayout",
+ "QHeaderView",
+ "QInputDialog",
+ "QItemDelegate",
+ "QItemEditorCreatorBase",
+ "QItemEditorFactory",
+ "QKeyEventTransition",
+ "QLCDNumber",
+ "QLabel",
+ "QLayout",
+ "QLayoutItem",
+ "QLineEdit",
+ "QListView",
+ "QListWidget",
+ "QListWidgetItem",
+ "QMainWindow",
+ "QMdiArea",
+ "QMdiSubWindow",
+ "QMenu",
+ "QMenuBar",
+ "QMessageBox",
+ "QMouseEventTransition",
+ "QPanGesture",
+ "QPinchGesture",
+ "QPlainTextDocumentLayout",
+ "QPlainTextEdit",
+ "QProgressBar",
+ "QProgressDialog",
+ "QPushButton",
+ "QRadioButton",
+ "QRubberBand",
+ "QScrollArea",
+ "QScrollBar",
+ "QShortcut",
+ "QSizeGrip",
+ "QSizePolicy",
+ "QSlider",
+ "QSpacerItem",
+ "QSpinBox",
+ "QSplashScreen",
+ "QSplitter",
+ "QSplitterHandle",
+ "QStackedLayout",
+ "QStackedWidget",
+ "QStatusBar",
+ "QStyle",
+ "QStyleFactory",
+ "QStyleHintReturn",
+ "QStyleHintReturnMask",
+ "QStyleHintReturnVariant",
+ "QStyleOption",
+ "QStyleOptionButton",
+ "QStyleOptionComboBox",
+ "QStyleOptionComplex",
+ "QStyleOptionDockWidget",
+ "QStyleOptionFocusRect",
+ "QStyleOptionFrame",
+ "QStyleOptionGraphicsItem",
+ "QStyleOptionGroupBox",
+ "QStyleOptionHeader",
+ "QStyleOptionMenuItem",
+ "QStyleOptionProgressBar",
+ "QStyleOptionRubberBand",
+ "QStyleOptionSizeGrip",
+ "QStyleOptionSlider",
+ "QStyleOptionSpinBox",
+ "QStyleOptionTab",
+ "QStyleOptionTabBarBase",
+ "QStyleOptionTabWidgetFrame",
+ "QStyleOptionTitleBar",
+ "QStyleOptionToolBar",
+ "QStyleOptionToolBox",
+ "QStyleOptionToolButton",
+ "QStyleOptionViewItem",
+ "QStylePainter",
+ "QStyledItemDelegate",
+ "QSwipeGesture",
+ "QSystemTrayIcon",
+ "QTabBar",
+ "QTabWidget",
+ "QTableView",
+ "QTableWidget",
+ "QTableWidgetItem",
+ "QTableWidgetSelectionRange",
+ "QTapAndHoldGesture",
+ "QTapGesture",
+ "QTextBrowser",
+ "QTextEdit",
+ "QTimeEdit",
+ "QToolBar",
+ "QToolBox",
+ "QToolButton",
+ "QToolTip",
+ "QTreeView",
+ "QTreeWidget",
+ "QTreeWidgetItem",
+ "QTreeWidgetItemIterator",
+ "QUndoCommand",
+ "QUndoGroup",
+ "QUndoStack",
+ "QUndoView",
+ "QVBoxLayout",
+ "QWhatsThis",
+ "QWidget",
+ "QWidgetAction",
+ "QWidgetItem",
+ "QWizard",
+ "QWizardPage"
+ ],
+ "QtX11Extras": [
+ "QX11Info"
+ ],
+ "QtXml": [
+ "QDomAttr",
+ "QDomCDATASection",
+ "QDomCharacterData",
+ "QDomComment",
+ "QDomDocument",
+ "QDomDocumentFragment",
+ "QDomDocumentType",
+ "QDomElement",
+ "QDomEntity",
+ "QDomEntityReference",
+ "QDomImplementation",
+ "QDomNamedNodeMap",
+ "QDomNode",
+ "QDomNodeList",
+ "QDomNotation",
+ "QDomProcessingInstruction",
+ "QDomText",
+ "QXmlAttributes",
+ "QXmlContentHandler",
+ "QXmlDTDHandler",
+ "QXmlDeclHandler",
+ "QXmlDefaultHandler",
+ "QXmlEntityResolver",
+ "QXmlErrorHandler",
+ "QXmlInputSource",
+ "QXmlLexicalHandler",
+ "QXmlLocator",
+ "QXmlNamespaceSupport",
+ "QXmlParseException",
+ "QXmlReader",
+ "QXmlSimpleReader"
+ ],
+ "QtXmlPatterns": [
+ "QAbstractMessageHandler",
+ "QAbstractUriResolver",
+ "QAbstractXmlNodeModel",
+ "QAbstractXmlReceiver",
+ "QSourceLocation",
+ "QXmlFormatter",
+ "QXmlItem",
+ "QXmlName",
+ "QXmlNamePool",
+ "QXmlNodeModelIndex",
+ "QXmlQuery",
+ "QXmlResultItems",
+ "QXmlSchema",
+ "QXmlSchemaValidator",
+ "QXmlSerializer"
+ ]
+}
+
+""" Missing members
+
+This mapping describes members that have been deprecated
+in one or more bindings and have been left out of the
+_common_members mapping.
+
+The member can provide an extra details string to be
+included in exceptions and warnings.
+"""
+
+_missing_members = {
+ "QtGui": {
+ "QMatrix": "Deprecated in PyQt5",
+ },
+}
+
+
+def _qInstallMessageHandler(handler):
+ """Install a message handler that works in all bindings
+
+ Args:
+ handler: A function that takes 3 arguments, or None
+ """
+ def messageOutputHandler(*args):
+ # In Qt4 bindings, message handlers are passed 2 arguments
+ # In Qt5 bindings, message handlers are passed 3 arguments
+ # The first argument is a QtMsgType
+ # The last argument is the message to be printed
+ # The Middle argument (if passed) is a QMessageLogContext
+ if len(args) == 3:
+ msgType, logContext, msg = args
+ elif len(args) == 2:
+ msgType, msg = args
+ logContext = None
+ else:
+ raise TypeError(
+ "handler expected 2 or 3 arguments, got {0}".format(len(args)))
+
+ if isinstance(msg, bytes):
+ # In python 3, some bindings pass a bytestring, which cannot be
+ # used elsewhere. Decoding a python 2 or 3 bytestring object will
+ # consistently return a unicode object.
+ msg = msg.decode()
+
+ handler(msgType, logContext, msg)
+
+ passObject = messageOutputHandler if handler else handler
+ if Qt.IsPySide or Qt.IsPyQt4:
+ return Qt._QtCore.qInstallMsgHandler(passObject)
+ elif Qt.IsPySide2 or Qt.IsPyQt5:
+ return Qt._QtCore.qInstallMessageHandler(passObject)
+
+
+def _getcpppointer(object):
+ if hasattr(Qt, "_shiboken2"):
+ return getattr(Qt, "_shiboken2").getCppPointer(object)[0]
+ elif hasattr(Qt, "_shiboken"):
+ return getattr(Qt, "_shiboken").getCppPointer(object)[0]
+ elif hasattr(Qt, "_sip"):
+ return getattr(Qt, "_sip").unwrapinstance(object)
+ raise AttributeError("'module' has no attribute 'getCppPointer'")
+
+
+def _wrapinstance(ptr, base=None):
+ """Enable implicit cast of pointer to most suitable class
+
+ This behaviour is available in sip per default.
+
+ Based on http://nathanhorne.com/pyqtpyside-wrap-instance
+
+ Usage:
+ This mechanism kicks in under these circumstances.
+ 1. Qt.py is using PySide 1 or 2.
+ 2. A `base` argument is not provided.
+
+ See :func:`QtCompat.wrapInstance()`
+
+ Arguments:
+ ptr (long): Pointer to QObject in memory
+ base (QObject, optional): Base class to wrap with. Defaults to QObject,
+ which should handle anything.
+
+ """
+
+ assert isinstance(ptr, long), "Argument 'ptr' must be of type "
+ assert (base is None) or issubclass(base, Qt.QtCore.QObject), (
+ "Argument 'base' must be of type ")
+
+ if Qt.IsPyQt4 or Qt.IsPyQt5:
+ func = getattr(Qt, "_sip").wrapinstance
+ elif Qt.IsPySide2:
+ func = getattr(Qt, "_shiboken2").wrapInstance
+ elif Qt.IsPySide:
+ func = getattr(Qt, "_shiboken").wrapInstance
+ else:
+ raise AttributeError("'module' has no attribute 'wrapInstance'")
+
+ if base is None:
+ q_object = func(long(ptr), Qt.QtCore.QObject)
+ meta_object = q_object.metaObject()
+ class_name = meta_object.className()
+ super_class_name = meta_object.superClass().className()
+
+ if hasattr(Qt.QtWidgets, class_name):
+ base = getattr(Qt.QtWidgets, class_name)
+
+ elif hasattr(Qt.QtWidgets, super_class_name):
+ base = getattr(Qt.QtWidgets, super_class_name)
+
+ else:
+ base = Qt.QtCore.QObject
+
+ return func(long(ptr), base)
+
+
+def _isvalid(object):
+ """Check if the object is valid to use in Python runtime.
+
+ Usage:
+ See :func:`QtCompat.isValid()`
+
+ Arguments:
+ object (QObject): QObject to check the validity of.
+
+ """
+
+ assert isinstance(object, Qt.QtCore.QObject)
+
+ if hasattr(Qt, "_shiboken2"):
+ return getattr(Qt, "_shiboken2").isValid(object)
+
+ elif hasattr(Qt, "_shiboken"):
+ return getattr(Qt, "_shiboken").isValid(object)
+
+ elif hasattr(Qt, "_sip"):
+ return not getattr(Qt, "_sip").isdeleted(object)
+
+ else:
+ raise AttributeError("'module' has no attribute isValid")
+
+
+def _translate(context, sourceText, *args):
+ # In Qt4 bindings, translate can be passed 2 or 3 arguments
+ # In Qt5 bindings, translate can be passed 2 arguments
+ # The first argument is disambiguation[str]
+ # The last argument is n[int]
+ # The middle argument can be encoding[QtCore.QCoreApplication.Encoding]
+ if len(args) == 3:
+ disambiguation, encoding, n = args
+ elif len(args) == 2:
+ disambiguation, n = args
+ encoding = None
+ else:
+ raise TypeError(
+ "Expected 4 or 5 arguments, got {0}.".format(len(args) + 2))
+
+ if hasattr(Qt.QtCore, "QCoreApplication"):
+ app = getattr(Qt.QtCore, "QCoreApplication")
+ else:
+ raise NotImplementedError(
+ "Missing QCoreApplication implementation for {binding}".format(
+ binding=Qt.__binding__,
+ )
+ )
+ if Qt.__binding__ in ("PySide2", "PyQt5"):
+ sanitized_args = [context, sourceText, disambiguation, n]
+ else:
+ sanitized_args = [
+ context,
+ sourceText,
+ disambiguation,
+ encoding or app.CodecForTr,
+ n
+ ]
+ return app.translate(*sanitized_args)
+
+
+def _loadUi(uifile, baseinstance=None):
+ """Dynamically load a user interface from the given `uifile`
+
+ This function calls `uic.loadUi` if using PyQt bindings,
+ else it implements a comparable binding for PySide.
+
+ Documentation:
+ http://pyqt.sourceforge.net/Docs/PyQt5/designer.html#PyQt5.uic.loadUi
+
+ Arguments:
+ uifile (str): Absolute path to Qt Designer file.
+ baseinstance (QWidget): Instantiated QWidget or subclass thereof
+
+ Return:
+ baseinstance if `baseinstance` is not `None`. Otherwise
+ return the newly created instance of the user interface.
+
+ """
+ if hasattr(Qt, "_uic"):
+ return Qt._uic.loadUi(uifile, baseinstance)
+
+ elif hasattr(Qt, "_QtUiTools"):
+ # Implement `PyQt5.uic.loadUi` for PySide(2)
+
+ class _UiLoader(Qt._QtUiTools.QUiLoader):
+ """Create the user interface in a base instance.
+
+ Unlike `Qt._QtUiTools.QUiLoader` itself this class does not
+ create a new instance of the top-level widget, but creates the user
+ interface in an existing instance of the top-level class if needed.
+
+ This mimics the behaviour of `PyQt5.uic.loadUi`.
+
+ """
+
+ def __init__(self, baseinstance):
+ super(_UiLoader, self).__init__(baseinstance)
+ self.baseinstance = baseinstance
+ self.custom_widgets = {}
+
+ def _loadCustomWidgets(self, etree):
+ """
+ Workaround to pyside-77 bug.
+
+ From QUiLoader doc we should use registerCustomWidget method.
+ But this causes a segfault on some platforms.
+
+ Instead we fetch from customwidgets DOM node the python class
+ objects. Then we can directly use them in createWidget method.
+ """
+
+ def headerToModule(header):
+ """
+ Translate a header file to python module path
+ foo/bar.h => foo.bar
+ """
+ # Remove header extension
+ module = os.path.splitext(header)[0]
+
+ # Replace os separator by python module separator
+ return module.replace("/", ".").replace("\\", ".")
+
+ custom_widgets = etree.find("customwidgets")
+
+ if custom_widgets is None:
+ return
+
+ for custom_widget in custom_widgets:
+ class_name = custom_widget.find("class").text
+ header = custom_widget.find("header").text
+ module = importlib.import_module(headerToModule(header))
+ self.custom_widgets[class_name] = getattr(module,
+ class_name)
+
+ def load(self, uifile, *args, **kwargs):
+ from xml.etree.ElementTree import ElementTree
+
+ # For whatever reason, if this doesn't happen then
+ # reading an invalid or non-existing .ui file throws
+ # a RuntimeError.
+ etree = ElementTree()
+ etree.parse(uifile)
+ self._loadCustomWidgets(etree)
+
+ widget = Qt._QtUiTools.QUiLoader.load(
+ self, uifile, *args, **kwargs)
+
+ # Workaround for PySide 1.0.9, see issue #208
+ widget.parentWidget()
+
+ return widget
+
+ def createWidget(self, class_name, parent=None, name=""):
+ """Called for each widget defined in ui file
+
+ Overridden here to populate `baseinstance` instead.
+
+ """
+
+ if parent is None and self.baseinstance:
+ # Supposed to create the top-level widget,
+ # return the base instance instead
+ return self.baseinstance
+
+ # For some reason, Line is not in the list of available
+ # widgets, but works fine, so we have to special case it here.
+ if class_name in self.availableWidgets() + ["Line"]:
+ # Create a new widget for child widgets
+ widget = Qt._QtUiTools.QUiLoader.createWidget(self,
+ class_name,
+ parent,
+ name)
+ elif class_name in self.custom_widgets:
+ widget = self.custom_widgets[class_name](parent)
+ else:
+ raise Exception("Custom widget '%s' not supported"
+ % class_name)
+
+ if self.baseinstance:
+ # Set an attribute for the new child widget on the base
+ # instance, just like PyQt5.uic.loadUi does.
+ setattr(self.baseinstance, name, widget)
+
+ return widget
+
+ widget = _UiLoader(baseinstance).load(uifile)
+ Qt.QtCore.QMetaObject.connectSlotsByName(widget)
+
+ return widget
+
+ else:
+ raise NotImplementedError("No implementation available for loadUi")
+
+
+"""Misplaced members
+
+These members from the original submodule are misplaced relative PySide2
+
+"""
+_misplaced_members = {
+ "PySide2": {
+ "QtCore.QStringListModel": "QtCore.QStringListModel",
+ "QtGui.QStringListModel": "QtCore.QStringListModel",
+ "QtCore.Property": "QtCore.Property",
+ "QtCore.Signal": "QtCore.Signal",
+ "QtCore.Slot": "QtCore.Slot",
+ "QtCore.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
+ "QtCore.QSortFilterProxyModel": "QtCore.QSortFilterProxyModel",
+ "QtCore.QItemSelection": "QtCore.QItemSelection",
+ "QtCore.QItemSelectionModel": "QtCore.QItemSelectionModel",
+ "QtCore.QItemSelectionRange": "QtCore.QItemSelectionRange",
+ "QtUiTools.QUiLoader": ["QtCompat.loadUi", _loadUi],
+ "shiboken2.wrapInstance": ["QtCompat.wrapInstance", _wrapinstance],
+ "shiboken2.getCppPointer": ["QtCompat.getCppPointer", _getcpppointer],
+ "shiboken2.isValid": ["QtCompat.isValid", _isvalid],
+ "QtWidgets.qApp": "QtWidgets.QApplication.instance()",
+ "QtCore.QCoreApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtWidgets.QApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtCore.qInstallMessageHandler": [
+ "QtCompat.qInstallMessageHandler", _qInstallMessageHandler
+ ],
+ "QtWidgets.QStyleOptionViewItem": "QtCompat.QStyleOptionViewItemV4",
+ },
+ "PyQt5": {
+ "QtCore.pyqtProperty": "QtCore.Property",
+ "QtCore.pyqtSignal": "QtCore.Signal",
+ "QtCore.pyqtSlot": "QtCore.Slot",
+ "QtCore.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
+ "QtCore.QSortFilterProxyModel": "QtCore.QSortFilterProxyModel",
+ "QtCore.QStringListModel": "QtCore.QStringListModel",
+ "QtCore.QItemSelection": "QtCore.QItemSelection",
+ "QtCore.QItemSelectionModel": "QtCore.QItemSelectionModel",
+ "QtCore.QItemSelectionRange": "QtCore.QItemSelectionRange",
+ "uic.loadUi": ["QtCompat.loadUi", _loadUi],
+ "sip.wrapinstance": ["QtCompat.wrapInstance", _wrapinstance],
+ "sip.unwrapinstance": ["QtCompat.getCppPointer", _getcpppointer],
+ "sip.isdeleted": ["QtCompat.isValid", _isvalid],
+ "QtWidgets.qApp": "QtWidgets.QApplication.instance()",
+ "QtCore.QCoreApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtWidgets.QApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtCore.qInstallMessageHandler": [
+ "QtCompat.qInstallMessageHandler", _qInstallMessageHandler
+ ],
+ "QtWidgets.QStyleOptionViewItem": "QtCompat.QStyleOptionViewItemV4",
+ },
+ "PySide": {
+ "QtGui.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
+ "QtGui.QSortFilterProxyModel": "QtCore.QSortFilterProxyModel",
+ "QtGui.QStringListModel": "QtCore.QStringListModel",
+ "QtGui.QItemSelection": "QtCore.QItemSelection",
+ "QtGui.QItemSelectionModel": "QtCore.QItemSelectionModel",
+ "QtCore.Property": "QtCore.Property",
+ "QtCore.Signal": "QtCore.Signal",
+ "QtCore.Slot": "QtCore.Slot",
+ "QtGui.QItemSelectionRange": "QtCore.QItemSelectionRange",
+ "QtGui.QAbstractPrintDialog": "QtPrintSupport.QAbstractPrintDialog",
+ "QtGui.QPageSetupDialog": "QtPrintSupport.QPageSetupDialog",
+ "QtGui.QPrintDialog": "QtPrintSupport.QPrintDialog",
+ "QtGui.QPrintEngine": "QtPrintSupport.QPrintEngine",
+ "QtGui.QPrintPreviewDialog": "QtPrintSupport.QPrintPreviewDialog",
+ "QtGui.QPrintPreviewWidget": "QtPrintSupport.QPrintPreviewWidget",
+ "QtGui.QPrinter": "QtPrintSupport.QPrinter",
+ "QtGui.QPrinterInfo": "QtPrintSupport.QPrinterInfo",
+ "QtUiTools.QUiLoader": ["QtCompat.loadUi", _loadUi],
+ "shiboken.wrapInstance": ["QtCompat.wrapInstance", _wrapinstance],
+ "shiboken.unwrapInstance": ["QtCompat.getCppPointer", _getcpppointer],
+ "shiboken.isValid": ["QtCompat.isValid", _isvalid],
+ "QtGui.qApp": "QtWidgets.QApplication.instance()",
+ "QtCore.QCoreApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtGui.QApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtCore.qInstallMsgHandler": [
+ "QtCompat.qInstallMessageHandler", _qInstallMessageHandler
+ ],
+ "QtGui.QStyleOptionViewItemV4": "QtCompat.QStyleOptionViewItemV4",
+ },
+ "PyQt4": {
+ "QtGui.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
+ "QtGui.QSortFilterProxyModel": "QtCore.QSortFilterProxyModel",
+ "QtGui.QItemSelection": "QtCore.QItemSelection",
+ "QtGui.QStringListModel": "QtCore.QStringListModel",
+ "QtGui.QItemSelectionModel": "QtCore.QItemSelectionModel",
+ "QtCore.pyqtProperty": "QtCore.Property",
+ "QtCore.pyqtSignal": "QtCore.Signal",
+ "QtCore.pyqtSlot": "QtCore.Slot",
+ "QtGui.QItemSelectionRange": "QtCore.QItemSelectionRange",
+ "QtGui.QAbstractPrintDialog": "QtPrintSupport.QAbstractPrintDialog",
+ "QtGui.QPageSetupDialog": "QtPrintSupport.QPageSetupDialog",
+ "QtGui.QPrintDialog": "QtPrintSupport.QPrintDialog",
+ "QtGui.QPrintEngine": "QtPrintSupport.QPrintEngine",
+ "QtGui.QPrintPreviewDialog": "QtPrintSupport.QPrintPreviewDialog",
+ "QtGui.QPrintPreviewWidget": "QtPrintSupport.QPrintPreviewWidget",
+ "QtGui.QPrinter": "QtPrintSupport.QPrinter",
+ "QtGui.QPrinterInfo": "QtPrintSupport.QPrinterInfo",
+ # "QtCore.pyqtSignature": "QtCore.Slot",
+ "uic.loadUi": ["QtCompat.loadUi", _loadUi],
+ "sip.wrapinstance": ["QtCompat.wrapInstance", _wrapinstance],
+ "sip.unwrapinstance": ["QtCompat.getCppPointer", _getcpppointer],
+ "sip.isdeleted": ["QtCompat.isValid", _isvalid],
+ "QtCore.QString": "str",
+ "QtGui.qApp": "QtWidgets.QApplication.instance()",
+ "QtCore.QCoreApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtGui.QApplication.translate": [
+ "QtCompat.translate", _translate
+ ],
+ "QtCore.qInstallMsgHandler": [
+ "QtCompat.qInstallMessageHandler", _qInstallMessageHandler
+ ],
+ "QtGui.QStyleOptionViewItemV4": "QtCompat.QStyleOptionViewItemV4",
+ }
+}
+
+""" Compatibility Members
+
+This dictionary is used to build Qt.QtCompat objects that provide a consistent
+interface for obsolete members, and differences in binding return values.
+
+{
+ "binding": {
+ "classname": {
+ "targetname": "binding_namespace",
+ }
+ }
+}
+"""
+_compatibility_members = {
+ "PySide2": {
+ "QWidget": {
+ "grab": "QtWidgets.QWidget.grab",
+ },
+ "QHeaderView": {
+ "sectionsClickable": "QtWidgets.QHeaderView.sectionsClickable",
+ "setSectionsClickable":
+ "QtWidgets.QHeaderView.setSectionsClickable",
+ "sectionResizeMode": "QtWidgets.QHeaderView.sectionResizeMode",
+ "setSectionResizeMode":
+ "QtWidgets.QHeaderView.setSectionResizeMode",
+ "sectionsMovable": "QtWidgets.QHeaderView.sectionsMovable",
+ "setSectionsMovable": "QtWidgets.QHeaderView.setSectionsMovable",
+ },
+ "QFileDialog": {
+ "getOpenFileName": "QtWidgets.QFileDialog.getOpenFileName",
+ "getOpenFileNames": "QtWidgets.QFileDialog.getOpenFileNames",
+ "getSaveFileName": "QtWidgets.QFileDialog.getSaveFileName",
+ },
+ },
+ "PyQt5": {
+ "QWidget": {
+ "grab": "QtWidgets.QWidget.grab",
+ },
+ "QHeaderView": {
+ "sectionsClickable": "QtWidgets.QHeaderView.sectionsClickable",
+ "setSectionsClickable":
+ "QtWidgets.QHeaderView.setSectionsClickable",
+ "sectionResizeMode": "QtWidgets.QHeaderView.sectionResizeMode",
+ "setSectionResizeMode":
+ "QtWidgets.QHeaderView.setSectionResizeMode",
+ "sectionsMovable": "QtWidgets.QHeaderView.sectionsMovable",
+ "setSectionsMovable": "QtWidgets.QHeaderView.setSectionsMovable",
+ },
+ "QFileDialog": {
+ "getOpenFileName": "QtWidgets.QFileDialog.getOpenFileName",
+ "getOpenFileNames": "QtWidgets.QFileDialog.getOpenFileNames",
+ "getSaveFileName": "QtWidgets.QFileDialog.getSaveFileName",
+ },
+ },
+ "PySide": {
+ "QWidget": {
+ "grab": "QtWidgets.QPixmap.grabWidget",
+ },
+ "QHeaderView": {
+ "sectionsClickable": "QtWidgets.QHeaderView.isClickable",
+ "setSectionsClickable": "QtWidgets.QHeaderView.setClickable",
+ "sectionResizeMode": "QtWidgets.QHeaderView.resizeMode",
+ "setSectionResizeMode": "QtWidgets.QHeaderView.setResizeMode",
+ "sectionsMovable": "QtWidgets.QHeaderView.isMovable",
+ "setSectionsMovable": "QtWidgets.QHeaderView.setMovable",
+ },
+ "QFileDialog": {
+ "getOpenFileName": "QtWidgets.QFileDialog.getOpenFileName",
+ "getOpenFileNames": "QtWidgets.QFileDialog.getOpenFileNames",
+ "getSaveFileName": "QtWidgets.QFileDialog.getSaveFileName",
+ },
+ },
+ "PyQt4": {
+ "QWidget": {
+ "grab": "QtWidgets.QPixmap.grabWidget",
+ },
+ "QHeaderView": {
+ "sectionsClickable": "QtWidgets.QHeaderView.isClickable",
+ "setSectionsClickable": "QtWidgets.QHeaderView.setClickable",
+ "sectionResizeMode": "QtWidgets.QHeaderView.resizeMode",
+ "setSectionResizeMode": "QtWidgets.QHeaderView.setResizeMode",
+ "sectionsMovable": "QtWidgets.QHeaderView.isMovable",
+ "setSectionsMovable": "QtWidgets.QHeaderView.setMovable",
+ },
+ "QFileDialog": {
+ "getOpenFileName": "QtWidgets.QFileDialog.getOpenFileName",
+ "getOpenFileNames": "QtWidgets.QFileDialog.getOpenFileNames",
+ "getSaveFileName": "QtWidgets.QFileDialog.getSaveFileName",
+ },
+ },
+}
+
+
+def _apply_site_config():
+ try:
+ import QtSiteConfig
+ except ImportError:
+ # If no QtSiteConfig module found, no modifications
+ # to _common_members are needed.
+ pass
+ else:
+ # Provide the ability to modify the dicts used to build Qt.py
+ if hasattr(QtSiteConfig, 'update_members'):
+ QtSiteConfig.update_members(_common_members)
+
+ if hasattr(QtSiteConfig, 'update_misplaced_members'):
+ QtSiteConfig.update_misplaced_members(members=_misplaced_members)
+
+ if hasattr(QtSiteConfig, 'update_compatibility_members'):
+ QtSiteConfig.update_compatibility_members(
+ members=_compatibility_members)
+
+
+def _new_module(name):
+ return types.ModuleType(__name__ + "." + name)
+
+
+def _import_sub_module(module, name):
+ """import_sub_module will mimic the function of importlib.import_module"""
+ module = __import__(module.__name__ + "." + name)
+ for level in name.split("."):
+ module = getattr(module, level)
+ return module
+
+
+def _setup(module, extras):
+ """Install common submodules"""
+
+ Qt.__binding__ = module.__name__
+
+ for name in list(_common_members) + extras:
+ try:
+ submodule = _import_sub_module(
+ module, name)
+ except ImportError:
+ try:
+ # For extra modules like sip and shiboken that may not be
+ # children of the binding.
+ submodule = __import__(name)
+ except ImportError:
+ continue
+
+ setattr(Qt, "_" + name, submodule)
+
+ if name not in extras:
+ # Store reference to original binding,
+ # but don't store speciality modules
+ # such as uic or QtUiTools
+ setattr(Qt, name, _new_module(name))
+
+
+def _reassign_misplaced_members(binding):
+ """Apply misplaced members from `binding` to Qt.py
+
+ Arguments:
+ binding (dict): Misplaced members
+
+ """
+
+ for src, dst in _misplaced_members[binding].items():
+ dst_value = None
+
+ src_parts = src.split(".")
+ src_module = src_parts[0]
+ src_member = None
+ if len(src_parts) > 1:
+ src_member = src_parts[1:]
+
+ if isinstance(dst, (list, tuple)):
+ dst, dst_value = dst
+
+ dst_parts = dst.split(".")
+ dst_module = dst_parts[0]
+ dst_member = None
+ if len(dst_parts) > 1:
+ dst_member = dst_parts[1]
+
+ # Get the member we want to store in the namesapce.
+ if not dst_value:
+ try:
+ _part = getattr(Qt, "_" + src_module)
+ while src_member:
+ member = src_member.pop(0)
+ _part = getattr(_part, member)
+ dst_value = _part
+ except AttributeError:
+ # If the member we want to store in the namespace does not
+ # exist, there is no need to continue. This can happen if a
+ # request was made to rename a member that didn't exist, for
+ # example if QtWidgets isn't available on the target platform.
+ _log("Misplaced member has no source: {0}".format(src))
+ continue
+
+ try:
+ src_object = getattr(Qt, dst_module)
+ except AttributeError:
+ if dst_module not in _common_members:
+ # Only create the Qt parent module if its listed in
+ # _common_members. Without this check, if you remove QtCore
+ # from _common_members, the default _misplaced_members will add
+ # Qt.QtCore so it can add Signal, Slot, etc.
+ msg = 'Not creating missing member module "{m}" for "{c}"'
+ _log(msg.format(m=dst_module, c=dst_member))
+ continue
+ # If the dst is valid but the Qt parent module does not exist
+ # then go ahead and create a new module to contain the member.
+ setattr(Qt, dst_module, _new_module(dst_module))
+ src_object = getattr(Qt, dst_module)
+ # Enable direct import of the new module
+ sys.modules[__name__ + "." + dst_module] = src_object
+
+ if not dst_value:
+ dst_value = getattr(Qt, "_" + src_module)
+ if src_member:
+ dst_value = getattr(dst_value, src_member)
+
+ setattr(
+ src_object,
+ dst_member or dst_module,
+ dst_value
+ )
+
+
+def _build_compatibility_members(binding, decorators=None):
+ """Apply `binding` to QtCompat
+
+ Arguments:
+ binding (str): Top level binding in _compatibility_members.
+ decorators (dict, optional): Provides the ability to decorate the
+ original Qt methods when needed by a binding. This can be used
+ to change the returned value to a standard value. The key should
+ be the classname, the value is a dict where the keys are the
+ target method names, and the values are the decorator functions.
+
+ """
+
+ decorators = decorators or dict()
+
+ # Allow optional site-level customization of the compatibility members.
+ # This method does not need to be implemented in QtSiteConfig.
+ try:
+ import QtSiteConfig
+ except ImportError:
+ pass
+ else:
+ if hasattr(QtSiteConfig, 'update_compatibility_decorators'):
+ QtSiteConfig.update_compatibility_decorators(binding, decorators)
+
+ _QtCompat = type("QtCompat", (object,), {})
+
+ for classname, bindings in _compatibility_members[binding].items():
+ attrs = {}
+ for target, binding in bindings.items():
+ namespaces = binding.split('.')
+ try:
+ src_object = getattr(Qt, "_" + namespaces[0])
+ except AttributeError as e:
+ _log("QtCompat: AttributeError: %s" % e)
+ # Skip reassignment of non-existing members.
+ # This can happen if a request was made to
+ # rename a member that didn't exist, for example
+ # if QtWidgets isn't available on the target platform.
+ continue
+
+ # Walk down any remaining namespace getting the object assuming
+ # that if the first namespace exists the rest will exist.
+ for namespace in namespaces[1:]:
+ src_object = getattr(src_object, namespace)
+
+ # decorate the Qt method if a decorator was provided.
+ if target in decorators.get(classname, []):
+ # staticmethod must be called on the decorated method to
+ # prevent a TypeError being raised when the decorated method
+ # is called.
+ src_object = staticmethod(
+ decorators[classname][target](src_object))
+
+ attrs[target] = src_object
+
+ # Create the QtCompat class and install it into the namespace
+ compat_class = type(classname, (_QtCompat,), attrs)
+ setattr(Qt.QtCompat, classname, compat_class)
+
+
+def _pyside2():
+ """Initialise PySide2
+
+ These functions serve to test the existence of a binding
+ along with set it up in such a way that it aligns with
+ the final step; adding members from the original binding
+ to Qt.py
+
+ """
+
+ import PySide2 as module
+ extras = ["QtUiTools"]
+ try:
+ try:
+ # Before merge of PySide and shiboken
+ import shiboken2
+ except ImportError:
+ # After merge of PySide and shiboken, May 2017
+ from PySide2 import shiboken2
+ extras.append("shiboken2")
+ except ImportError:
+ pass
+
+ _setup(module, extras)
+ Qt.__binding_version__ = module.__version__
+
+ if hasattr(Qt, "_shiboken2"):
+ Qt.QtCompat.wrapInstance = _wrapinstance
+ Qt.QtCompat.getCppPointer = _getcpppointer
+ Qt.QtCompat.delete = shiboken2.delete
+
+ if hasattr(Qt, "_QtUiTools"):
+ Qt.QtCompat.loadUi = _loadUi
+
+ if hasattr(Qt, "_QtCore"):
+ Qt.__qt_version__ = Qt._QtCore.qVersion()
+ Qt.QtCompat.dataChanged = (
+ lambda self, topleft, bottomright, roles=None:
+ self.dataChanged.emit(topleft, bottomright, roles or [])
+ )
+
+ if hasattr(Qt, "_QtWidgets"):
+ Qt.QtCompat.setSectionResizeMode = \
+ Qt._QtWidgets.QHeaderView.setSectionResizeMode
+
+ _reassign_misplaced_members("PySide2")
+ _build_compatibility_members("PySide2")
+
+
+def _pyside():
+ """Initialise PySide"""
+
+ import PySide as module
+ extras = ["QtUiTools"]
+ try:
+ try:
+ # Before merge of PySide and shiboken
+ import shiboken
+ except ImportError:
+ # After merge of PySide and shiboken, May 2017
+ from PySide import shiboken
+ extras.append("shiboken")
+ except ImportError:
+ pass
+
+ _setup(module, extras)
+ Qt.__binding_version__ = module.__version__
+
+ if hasattr(Qt, "_shiboken"):
+ Qt.QtCompat.wrapInstance = _wrapinstance
+ Qt.QtCompat.getCppPointer = _getcpppointer
+ Qt.QtCompat.delete = shiboken.delete
+
+ if hasattr(Qt, "_QtUiTools"):
+ Qt.QtCompat.loadUi = _loadUi
+
+ if hasattr(Qt, "_QtGui"):
+ setattr(Qt, "QtWidgets", _new_module("QtWidgets"))
+ setattr(Qt, "_QtWidgets", Qt._QtGui)
+ if hasattr(Qt._QtGui, "QX11Info"):
+ setattr(Qt, "QtX11Extras", _new_module("QtX11Extras"))
+ Qt.QtX11Extras.QX11Info = Qt._QtGui.QX11Info
+
+ Qt.QtCompat.setSectionResizeMode = Qt._QtGui.QHeaderView.setResizeMode
+
+ if hasattr(Qt, "_QtCore"):
+ Qt.__qt_version__ = Qt._QtCore.qVersion()
+ Qt.QtCompat.dataChanged = (
+ lambda self, topleft, bottomright, roles=None:
+ self.dataChanged.emit(topleft, bottomright)
+ )
+
+ _reassign_misplaced_members("PySide")
+ _build_compatibility_members("PySide")
+
+
+def _pyqt5():
+ """Initialise PyQt5"""
+
+ import PyQt5 as module
+ extras = ["uic"]
+
+ try:
+ import sip
+ extras += ["sip"]
+ except ImportError:
+
+ # Relevant to PyQt5 5.11 and above
+ try:
+ from PyQt5 import sip
+ extras += ["sip"]
+ except ImportError:
+ sip = None
+
+ _setup(module, extras)
+ if hasattr(Qt, "_sip"):
+ Qt.QtCompat.wrapInstance = _wrapinstance
+ Qt.QtCompat.getCppPointer = _getcpppointer
+ Qt.QtCompat.delete = sip.delete
+
+ if hasattr(Qt, "_uic"):
+ Qt.QtCompat.loadUi = _loadUi
+
+ if hasattr(Qt, "_QtCore"):
+ Qt.__binding_version__ = Qt._QtCore.PYQT_VERSION_STR
+ Qt.__qt_version__ = Qt._QtCore.QT_VERSION_STR
+ Qt.QtCompat.dataChanged = (
+ lambda self, topleft, bottomright, roles=None:
+ self.dataChanged.emit(topleft, bottomright, roles or [])
+ )
+
+ if hasattr(Qt, "_QtWidgets"):
+ Qt.QtCompat.setSectionResizeMode = \
+ Qt._QtWidgets.QHeaderView.setSectionResizeMode
+
+ _reassign_misplaced_members("PyQt5")
+ _build_compatibility_members('PyQt5')
+
+
+def _pyqt4():
+ """Initialise PyQt4"""
+
+ import sip
+
+ # Validation of envivornment variable. Prevents an error if
+ # the variable is invalid since it's just a hint.
+ try:
+ hint = int(QT_SIP_API_HINT)
+ except TypeError:
+ hint = None # Variable was None, i.e. not set.
+ except ValueError:
+ raise ImportError("QT_SIP_API_HINT=%s must be a 1 or 2")
+
+ for api in ("QString",
+ "QVariant",
+ "QDate",
+ "QDateTime",
+ "QTextStream",
+ "QTime",
+ "QUrl"):
+ try:
+ sip.setapi(api, hint or 2)
+ except AttributeError:
+ raise ImportError("PyQt4 < 4.6 isn't supported by Qt.py")
+ except ValueError:
+ actual = sip.getapi(api)
+ if not hint:
+ raise ImportError("API version already set to %d" % actual)
+ else:
+ # Having provided a hint indicates a soft constraint, one
+ # that doesn't throw an exception.
+ sys.stderr.write(
+ "Warning: API '%s' has already been set to %d.\n"
+ % (api, actual)
+ )
+
+ import PyQt4 as module
+ extras = ["uic"]
+ try:
+ import sip
+ extras.append(sip.__name__)
+ except ImportError:
+ sip = None
+
+ _setup(module, extras)
+ if hasattr(Qt, "_sip"):
+ Qt.QtCompat.wrapInstance = _wrapinstance
+ Qt.QtCompat.getCppPointer = _getcpppointer
+ Qt.QtCompat.delete = sip.delete
+
+ if hasattr(Qt, "_uic"):
+ Qt.QtCompat.loadUi = _loadUi
+
+ if hasattr(Qt, "_QtGui"):
+ setattr(Qt, "QtWidgets", _new_module("QtWidgets"))
+ setattr(Qt, "_QtWidgets", Qt._QtGui)
+ if hasattr(Qt._QtGui, "QX11Info"):
+ setattr(Qt, "QtX11Extras", _new_module("QtX11Extras"))
+ Qt.QtX11Extras.QX11Info = Qt._QtGui.QX11Info
+
+ Qt.QtCompat.setSectionResizeMode = \
+ Qt._QtGui.QHeaderView.setResizeMode
+
+ if hasattr(Qt, "_QtCore"):
+ Qt.__binding_version__ = Qt._QtCore.PYQT_VERSION_STR
+ Qt.__qt_version__ = Qt._QtCore.QT_VERSION_STR
+ Qt.QtCompat.dataChanged = (
+ lambda self, topleft, bottomright, roles=None:
+ self.dataChanged.emit(topleft, bottomright)
+ )
+
+ _reassign_misplaced_members("PyQt4")
+
+ # QFileDialog QtCompat decorator
+ def _standardizeQFileDialog(some_function):
+ """Decorator that makes PyQt4 return conform to other bindings"""
+ def wrapper(*args, **kwargs):
+ ret = (some_function(*args, **kwargs))
+
+ # PyQt4 only returns the selected filename, force it to a
+ # standard return of the selected filename, and a empty string
+ # for the selected filter
+ return ret, ''
+
+ wrapper.__doc__ = some_function.__doc__
+ wrapper.__name__ = some_function.__name__
+
+ return wrapper
+
+ decorators = {
+ "QFileDialog": {
+ "getOpenFileName": _standardizeQFileDialog,
+ "getOpenFileNames": _standardizeQFileDialog,
+ "getSaveFileName": _standardizeQFileDialog,
+ }
+ }
+ _build_compatibility_members('PyQt4', decorators)
+
+
+def _none():
+ """Internal option (used in installer)"""
+
+ Mock = type("Mock", (), {"__getattr__": lambda Qt, attr: None})
+
+ Qt.__binding__ = "None"
+ Qt.__qt_version__ = "0.0.0"
+ Qt.__binding_version__ = "0.0.0"
+ Qt.QtCompat.loadUi = lambda uifile, baseinstance=None: None
+ Qt.QtCompat.setSectionResizeMode = lambda *args, **kwargs: None
+
+ for submodule in _common_members.keys():
+ setattr(Qt, submodule, Mock())
+ setattr(Qt, "_" + submodule, Mock())
+
+
+def _log(text):
+ if QT_VERBOSE:
+ sys.stdout.write(text + "\n")
+
+
+def _convert(lines):
+ """Convert compiled .ui file from PySide2 to Qt.py
+
+ Arguments:
+ lines (list): Each line of of .ui file
+
+ Usage:
+ >> with open("myui.py") as f:
+ .. lines = _convert(f.readlines())
+
+ """
+
+ def parse(line):
+ line = line.replace("from PySide2 import", "from Qt import QtCompat,")
+ line = line.replace("QtWidgets.QApplication.translate",
+ "QtCompat.translate")
+ if "QtCore.SIGNAL" in line:
+ raise NotImplementedError("QtCore.SIGNAL is missing from PyQt5 "
+ "and so Qt.py does not support it: you "
+ "should avoid defining signals inside "
+ "your ui files.")
+ return line
+
+ parsed = list()
+ for line in lines:
+ line = parse(line)
+ parsed.append(line)
+
+ return parsed
+
+
+def _cli(args):
+ """Qt.py command-line interface"""
+ import argparse
+
+ parser = argparse.ArgumentParser()
+ parser.add_argument("--convert",
+ help="Path to compiled Python module, e.g. my_ui.py")
+ parser.add_argument("--compile",
+ help="Accept raw .ui file and compile with native "
+ "PySide2 compiler.")
+ parser.add_argument("--stdout",
+ help="Write to stdout instead of file",
+ action="store_true")
+ parser.add_argument("--stdin",
+ help="Read from stdin instead of file",
+ action="store_true")
+
+ args = parser.parse_args(args)
+
+ if args.stdout:
+ raise NotImplementedError("--stdout")
+
+ if args.stdin:
+ raise NotImplementedError("--stdin")
+
+ if args.compile:
+ raise NotImplementedError("--compile")
+
+ if args.convert:
+ sys.stdout.write("#\n"
+ "# WARNING: --convert is an ALPHA feature.\n#\n"
+ "# See https://github.com/mottosso/Qt.py/pull/132\n"
+ "# for details.\n"
+ "#\n")
+
+ #
+ # ------> Read
+ #
+ with open(args.convert) as f:
+ lines = _convert(f.readlines())
+
+ backup = "%s_backup%s" % os.path.splitext(args.convert)
+ sys.stdout.write("Creating \"%s\"..\n" % backup)
+ shutil.copy(args.convert, backup)
+
+ #
+ # <------ Write
+ #
+ with open(args.convert, "w") as f:
+ f.write("".join(lines))
+
+ sys.stdout.write("Successfully converted \"%s\"\n" % args.convert)
+
+
+class MissingMember(object):
+ """
+ A placeholder type for a missing Qt object not
+ included in Qt.py
+
+ Args:
+ name (str): The name of the missing type
+ details (str): An optional custom error message
+ """
+ ERR_TMPL = ("{} is not a common object across PySide2 "
+ "and the other Qt bindings. It is not included "
+ "as a common member in the Qt.py layer")
+
+ def __init__(self, name, details=''):
+ self.__name = name
+ self.__err = self.ERR_TMPL.format(name)
+
+ if details:
+ self.__err = "{}: {}".format(self.__err, details)
+
+ def __repr__(self):
+ return "<{}: {}>".format(self.__class__.__name__, self.__name)
+
+ def __getattr__(self, name):
+ raise NotImplementedError(self.__err)
+
+ def __call__(self, *a, **kw):
+ raise NotImplementedError(self.__err)
+
+
+def _install():
+ # Default order (customise order and content via QT_PREFERRED_BINDING)
+ default_order = ("PySide2", "PyQt5", "PySide", "PyQt4")
+ preferred_order = list(
+ b for b in QT_PREFERRED_BINDING.split(os.pathsep) if b
+ )
+
+ order = preferred_order or default_order
+
+ available = {
+ "PySide2": _pyside2,
+ "PyQt5": _pyqt5,
+ "PySide": _pyside,
+ "PyQt4": _pyqt4,
+ "None": _none
+ }
+
+ _log("Order: '%s'" % "', '".join(order))
+
+ # Allow site-level customization of the available modules.
+ _apply_site_config()
+
+ found_binding = False
+ for name in order:
+ _log("Trying %s" % name)
+
+ try:
+ available[name]()
+ found_binding = True
+ break
+
+ except ImportError as e:
+ _log("ImportError: %s" % e)
+
+ except KeyError:
+ _log("ImportError: Preferred binding '%s' not found." % name)
+
+ if not found_binding:
+ # If not binding were found, throw this error
+ raise ImportError("No Qt binding were found.")
+
+ # Install individual members
+ for name, members in _common_members.items():
+ try:
+ their_submodule = getattr(Qt, "_%s" % name)
+ except AttributeError:
+ continue
+
+ our_submodule = getattr(Qt, name)
+
+ # Enable import *
+ __all__.append(name)
+
+ # Enable direct import of submodule,
+ # e.g. import Qt.QtCore
+ sys.modules[__name__ + "." + name] = our_submodule
+
+ for member in members:
+ # Accept that a submodule may miss certain members.
+ try:
+ their_member = getattr(their_submodule, member)
+ except AttributeError:
+ _log("'%s.%s' was missing." % (name, member))
+ continue
+
+ setattr(our_submodule, member, their_member)
+
+ # Install missing member placeholders
+ for name, members in _missing_members.items():
+ our_submodule = getattr(Qt, name)
+
+ for member in members:
+
+ # If the submodule already has this member installed,
+ # either by the common members, or the site config,
+ # then skip installing this one over it.
+ if hasattr(our_submodule, member):
+ continue
+
+ placeholder = MissingMember("{}.{}".format(name, member),
+ details=members[member])
+ setattr(our_submodule, member, placeholder)
+
+ # Enable direct import of QtCompat
+ sys.modules['Qt.QtCompat'] = Qt.QtCompat
+
+ # Backwards compatibility
+ if hasattr(Qt.QtCompat, 'loadUi'):
+ Qt.QtCompat.load_ui = Qt.QtCompat.loadUi
+
+
+_install()
+
+# Setup Binding Enum states
+Qt.IsPySide2 = Qt.__binding__ == 'PySide2'
+Qt.IsPyQt5 = Qt.__binding__ == 'PyQt5'
+Qt.IsPySide = Qt.__binding__ == 'PySide'
+Qt.IsPyQt4 = Qt.__binding__ == 'PyQt4'
+
+"""Augment QtCompat
+
+QtCompat contains wrappers and added functionality
+to the original bindings, such as the CLI interface
+and otherwise incompatible members between bindings,
+such as `QHeaderView.setSectionResizeMode`.
+
+"""
+
+Qt.QtCompat._cli = _cli
+Qt.QtCompat._convert = _convert
+
+# Enable command-line interface
+if __name__ == "__main__":
+ _cli(sys.argv[1:])
+
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2016-2017 Marcus Ottosson
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+# In PySide(2), loadUi does not exist, so we implement it
+#
+# `_UiLoader` is adapted from the qtpy project, which was further influenced
+# by qt-helpers which was released under a 3-clause BSD license which in turn
+# is based on a solution at:
+#
+# - https://gist.github.com/cpbotha/1b42a20c8f3eb9bb7cb8
+#
+# The License for this code is as follows:
+#
+# qt-helpers - a common front-end to various Qt modules
+#
+# Copyright (c) 2015, Chris Beaumont and Thomas Robitaille
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the
+# distribution.
+# * Neither the name of the Glue project nor the names of its contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Which itself was based on the solution at
+#
+# https://gist.github.com/cpbotha/1b42a20c8f3eb9bb7cb8
+#
+# which was released under the MIT license:
+#
+# Copyright (c) 2011 Sebastian Wiesner
+# Modifications by Charl Botha
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files
+# (the "Software"),to deal in the Software without restriction,
+# including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/openpype/vendor/python/common/scriptsmenu/vendor/__init__.py b/openpype/vendor/python/common/scriptsmenu/vendor/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/openpype/vendor/python/common/scriptsmenu/version.py b/openpype/vendor/python/common/scriptsmenu/version.py
new file mode 100644
index 0000000000..73f9426c2d
--- /dev/null
+++ b/openpype/vendor/python/common/scriptsmenu/version.py
@@ -0,0 +1,9 @@
+VERSION_MAJOR = 1
+VERSION_MINOR = 5
+VERSION_PATCH = 1
+
+
+version = '{}.{}.{}'.format(VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)
+__version__ = version
+
+__all__ = ['version', '__version__']
diff --git a/openpype/version.py b/openpype/version.py
index 55f4c21997..ee121051ea 100644
--- a/openpype/version.py
+++ b/openpype/version.py
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
"""Package declaring Pype version."""
-__version__ = "3.3.0-nightly.4"
+__version__ = "3.3.0-nightly.6"
diff --git a/repos/avalon-core b/repos/avalon-core
index d8be0bdb37..cfd4191e36 160000
--- a/repos/avalon-core
+++ b/repos/avalon-core
@@ -1 +1 @@
-Subproject commit d8be0bdb37961e32243f1de0eb9696e86acf7443
+Subproject commit cfd4191e364b47de7364096f45d9d9d9a901692a
diff --git a/start.py b/start.py
index 1b5c25ae3a..419a956835 100644
--- a/start.py
+++ b/start.py
@@ -208,14 +208,21 @@ def set_openpype_global_environments() -> None:
"""Set global OpenPype's environments."""
import acre
- from openpype.settings import get_environments
+ try:
+ from openpype.settings import get_general_environments
- all_env = get_environments()
+ general_env = get_general_environments()
+
+ except Exception:
+ # Backwards compatibility for OpenPype versions where
+ # `get_general_environments` does not exists yet
+ from openpype.settings import get_environments
+
+ all_env = get_environments()
+ general_env = all_env["global"]
- # TODO Global environments will be stored in "general" settings so loading
- # will be modified and can be done in igniter.
env = acre.merge(
- acre.parse(all_env["global"]),
+ acre.parse(general_env),
dict(os.environ)
)
os.environ.clear()
diff --git a/tools/build.ps1 b/tools/build.ps1
index e1962ee933..10da3d0b83 100644
--- a/tools/build.ps1
+++ b/tools/build.ps1
@@ -80,17 +80,6 @@ function Show-PSWarning() {
}
}
-function Install-Poetry() {
- Write-Host ">>> " -NoNewline -ForegroundColor Green
- Write-Host "Installing Poetry ... "
- $python = "python"
- if (Get-Command "pyenv" -ErrorAction SilentlyContinue) {
- $python = & pyenv which python
- }
- $env:POETRY_HOME="$openpype_root\.poetry"
- (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py -UseBasicParsing).Content | & $($python) -
-}
-
$art = @"
. . .. . ..
diff --git a/tools/create_env.ps1 b/tools/create_env.ps1
index 2ab6abe76e..e2ec401bb3 100644
--- a/tools/create_env.ps1
+++ b/tools/create_env.ps1
@@ -62,9 +62,12 @@ function Test-Python() {
Write-Host "Detecting host Python ... " -NoNewline
$python = "python"
if (Get-Command "pyenv" -ErrorAction SilentlyContinue) {
- $python = & pyenv which python
+ $pyenv_python = & pyenv which python
+ if (Test-Path -PathType Leaf -Path "$($pyenv_python)") {
+ $python = $pyenv_python
+ }
}
- if (-not (Get-Command "python3" -ErrorAction SilentlyContinue)) {
+ if (-not (Get-Command $python -ErrorAction SilentlyContinue)) {
Write-Host "!!! Python not detected" -ForegroundColor red
Set-Location -Path $current_dir
Exit-WithCode 1
diff --git a/website/docs/admin_hosts_maya.md b/website/docs/admin_hosts_maya.md
index 83c4121be9..5e0aa15345 100644
--- a/website/docs/admin_hosts_maya.md
+++ b/website/docs/admin_hosts_maya.md
@@ -4,11 +4,11 @@ title: Maya
sidebar_label: Maya
---
-## Maya
+## Publish Plugins
-### Publish Plugins
+### Render Settings Validator
-#### Render Settings Validator (`ValidateRenderSettings`)
+`ValidateRenderSettings`
Render Settings Validator is here to make sure artists will submit renders
we correct settings. Some of these settings are needed by OpenPype but some
@@ -49,4 +49,49 @@ Arnolds Camera (AA) samples to 6.
Note that `aiOptions` is not the name of node but rather its type. For renderers there is usually
just one instance of this node type but if that is not so, validator will go through all its
instances and check the value there. Node type for **VRay** settings is `VRaySettingsNode`, for **Renderman**
-it is `rmanGlobals`, for **Redshift** it is `RedshiftOptions`.
\ No newline at end of file
+it is `rmanGlobals`, for **Redshift** it is `RedshiftOptions`.
+
+### Model Name Validator
+
+`ValidateRenderSettings`
+
+This validator can enforce specific names for model members. It will check them against **Validation Regex**.
+There is special group in that regex - **shader**. If present, it will take that part of the name as shader name
+and it will compare it with list of shaders defined either in file name specified in **Material File** or from
+database file that is per project and can be directly edited from Maya's *OpenPype Tools > Edit Shader name definitions* when
+**Use database shader name definitions** is on. This list defines simply as one shader name per line.
+
+
+
+For example - you are using default regex `(.*)_(\d)*_(?P.*)_(GEO)` and you have two shaders defined
+in either file or database `foo` and `bar`.
+
+Object named `SomeCube_0001_foo_GEO` will pass but `SomeCube_GEO` will not and `SomeCube_001_xxx_GEO` will not too.
+
+#### Top level group name
+There is a validation for top level group name too. You can specify whatever regex you'd like to use. Default will
+pass everything with `_GRP` suffix. You can use *named capturing groups* to validate against specific data. If you
+put `(?P.*)` it will try to match everything captured in that group against current asset name. Likewise you can
+use it for **subset** and **project** - `(?P.*)` and `(?P.*)`.
+
+**Example**
+
+You are working on asset (shot) `0030_OGC_0190`. You have this regex in **Top level group name**:
+```regexp
+.*?_(?P.*)_GRP
+```
+
+When you publish your model with top group named like `foo_GRP` it will fail. But with `foo_0030_OGC_0190_GRP` it will pass.
+
+:::info About regex
+All regexes used here are in Python variant.
+:::
+
+## Custom Menu
+You can add your custom tools menu into Maya by extending definitions in **Maya -> Scripts Menu Definition**.
+
+
+:::note Work in progress
+This is still work in progress. Menu definition will be handled more friendly with widgets and not
+raw json.
+:::
\ No newline at end of file
diff --git a/website/docs/assets/maya-admin_model_name_validator.png b/website/docs/assets/maya-admin_model_name_validator.png
new file mode 100644
index 0000000000..d1b92c5fc3
Binary files /dev/null and b/website/docs/assets/maya-admin_model_name_validator.png differ
diff --git a/website/docs/assets/maya-admin_scriptsmenu.png b/website/docs/assets/maya-admin_scriptsmenu.png
new file mode 100644
index 0000000000..ecfe7e42a7
Binary files /dev/null and b/website/docs/assets/maya-admin_scriptsmenu.png differ
diff --git a/website/docs/project_settings/assets/standalone_creators.png b/website/docs/project_settings/assets/standalone_creators.png
new file mode 100644
index 0000000000..cfadfa305d
Binary files /dev/null and b/website/docs/project_settings/assets/standalone_creators.png differ
diff --git a/website/docs/project_settings/settings_project_standalone.md b/website/docs/project_settings/settings_project_standalone.md
new file mode 100644
index 0000000000..b359dc70d0
--- /dev/null
+++ b/website/docs/project_settings/settings_project_standalone.md
@@ -0,0 +1,98 @@
+---
+id: settings_project_standalone
+title: Project Standalone Publisher Setting
+sidebar_label: Standalone Publisher
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Project settings can have project specific values. Each new project is using studio values defined in **default** project but these values can be modified or overriden per project.
+
+:::warning Default studio values
+Projects always use default project values unless they have [project override](../admin_settings#project-overrides) (orage colour). Any changes in default project may affect all existing projects.
+:::
+
+## Creator Plugins
+
+Contains list of implemented families to show in middle menu in Standalone Publisher. Each plugin must contain:
+- name
+- label
+- family
+- icon
+- default subset(s)
+- help (additional short information about family)
+
+
+
+## Publish plugins
+
+### Collect Textures
+
+Serves to collect all needed information about workfiles and textures created from those. Allows to publish
+main workfile (for example from Mari), additional worfiles (from Substance Painter) and exported textures.
+
+Available configuration:
+- Main workfile extension - only single workfile can be "main" one
+- Support workfile extensions - additional workfiles will be published to same folder as "main", just under `resourses` subfolder
+- Texture extension - what kind of formats are expected for textures
+- Additional families for workfile - should any family ('ftrack', 'review') be added to published workfile
+- Additional families for textures - should any family ('ftrack', 'review') be added to published textures
+
+#### Naming conventions
+
+Implementation tries to be flexible and cover multiple naming conventions for workfiles and textures.
+
+##### Workfile naming pattern
+
+Provide regex matching pattern containing regex groups used to parse workfile name to learn needed information. (For example
+build name.)
+
+Example:
+
+- pattern: ```^([^.]+)(_[^_.]*)?_v([0-9]{3,}).+```
+- with groups: ```["asset", "filler", "version"]```
+
+parses `corridorMain_v001` into three groups:
+- asset build (`corridorMain`)
+- filler (in this case empty)
+- version (`001`)
+
+Advanced example (for texture files):
+
+- pattern: ```^([^_.]+)_([^_.]+)_v([0-9]{3,})_([^_.]+)_({color_space})_(1[0-9]{3}).+```
+- with groups: ```["asset", "shader", "version", "channel", "color_space", "udim"]```
+
+parses `corridorMain_aluminiumID_v001_baseColor_linsRGB_1001.exr`:
+- asset build (`corridorMain`)
+- shader (`aluminiumID`)
+- version (`001`)
+- channel (`baseColor`)
+- color_space (`linsRGB`)
+- udim (`1001`)
+
+
+In case of different naming pattern, additional groups could be added or removed. Number of matching groups (`(...)`) must be same as number of items in `Group order for regex patterns`
+
+##### Workfile group positions
+
+For each matching regex group set in previous paragraph, its ordinal position is required (in case of need for addition of new groups etc.)
+
+Number of groups added here must match number of parsing groups from `Workfile naming pattern`.
+
+##### Output names
+
+Output names of published workfiles and textures could be configured separately:
+- Subset name template for workfile
+- Subset name template for textures (implemented keys: ["color_space", "channel", "subset", "shader"])
+
+
+### Validate Scene Settings
+
+#### Check Frame Range for Extensions
+
+Configure families, file extension and task to validate that DB setting (frame range) matches currently published values.
+
+### ExtractThumbnailSP
+
+Plugin responsible for generating thumbnails, configure appropriate values for your version o ffmpeg.
\ No newline at end of file
diff --git a/website/sidebars.js b/website/sidebars.js
index d38973e40f..488814a385 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -65,7 +65,8 @@ module.exports = {
label: "Project Settings",
items: [
"project_settings/settings_project_global",
- "project_settings/settings_project_nuke"
+ "project_settings/settings_project_nuke",
+ "project_settings/settings_project_standalone"
],
},
],