diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2a8e962085..cee0183273 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,8 +1,8 @@
# Changelog
-## [3.14.1-nightly.3](https://github.com/pypeclub/OpenPype/tree/HEAD)
+## [3.14.1](https://github.com/pypeclub/OpenPype/tree/3.14.1) (2022-08-30)
-[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.14.0...HEAD)
+[Full Changelog](https://github.com/pypeclub/OpenPype/compare/3.14.0...3.14.1)
### 📖 Documentation
@@ -12,33 +12,37 @@
**🆕 New features**
- Webpublisher:change create flatten image into tri state [\#3678](https://github.com/pypeclub/OpenPype/pull/3678)
+- Blender: validators code correction with settings and defaults [\#3662](https://github.com/pypeclub/OpenPype/pull/3662)
**🚀 Enhancements**
+- General: Thumbnail can use project roots [\#3750](https://github.com/pypeclub/OpenPype/pull/3750)
- Settings: Remove settings lock on tray exit [\#3720](https://github.com/pypeclub/OpenPype/pull/3720)
- General: Added helper getters to modules manager [\#3712](https://github.com/pypeclub/OpenPype/pull/3712)
- Unreal: Define unreal as module and use host class [\#3701](https://github.com/pypeclub/OpenPype/pull/3701)
- Settings: Lock settings UI session [\#3700](https://github.com/pypeclub/OpenPype/pull/3700)
- General: Benevolent context label collector [\#3686](https://github.com/pypeclub/OpenPype/pull/3686)
- Ftrack: Store ftrack entities on hierarchy integration to instances [\#3677](https://github.com/pypeclub/OpenPype/pull/3677)
-- Ftrack: More logs related to auto sync value change [\#3671](https://github.com/pypeclub/OpenPype/pull/3671)
- Blender: ops refresh manager after process events [\#3663](https://github.com/pypeclub/OpenPype/pull/3663)
**🐛 Bug fixes**
+- Maya: Fix typo in getPanel argument `with\_focus` -\> `withFocus` [\#3753](https://github.com/pypeclub/OpenPype/pull/3753)
+- General: Smaller fixes of imports [\#3748](https://github.com/pypeclub/OpenPype/pull/3748)
- General: Logger tweaks [\#3741](https://github.com/pypeclub/OpenPype/pull/3741)
+- Nuke: missing job dependency if multiple bake streams [\#3737](https://github.com/pypeclub/OpenPype/pull/3737)
- Nuke: color-space settings from anatomy is working [\#3721](https://github.com/pypeclub/OpenPype/pull/3721)
- Settings: Fix studio default anatomy save [\#3716](https://github.com/pypeclub/OpenPype/pull/3716)
- Maya: Use project name instead of project code [\#3709](https://github.com/pypeclub/OpenPype/pull/3709)
- Settings: Fix project overrides save [\#3708](https://github.com/pypeclub/OpenPype/pull/3708)
- Workfiles tool: Fix published workfile filtering [\#3704](https://github.com/pypeclub/OpenPype/pull/3704)
- PS, AE: Provide default variant value for workfile subset [\#3703](https://github.com/pypeclub/OpenPype/pull/3703)
-- RoyalRender: handle host name that is not set [\#3695](https://github.com/pypeclub/OpenPype/pull/3695)
- Flame: retime is working on clip publishing [\#3684](https://github.com/pypeclub/OpenPype/pull/3684)
- Webpublisher: added check for empty context [\#3682](https://github.com/pypeclub/OpenPype/pull/3682)
**🔀 Refactored code**
+- General: Move delivery logic to pipeline [\#3751](https://github.com/pypeclub/OpenPype/pull/3751)
- General: Host addons cleanup [\#3744](https://github.com/pypeclub/OpenPype/pull/3744)
- Webpublisher: Webpublisher is used as addon [\#3740](https://github.com/pypeclub/OpenPype/pull/3740)
- Photoshop: Defined photoshop as addon [\#3736](https://github.com/pypeclub/OpenPype/pull/3736)
@@ -105,10 +109,6 @@
[Full Changelog](https://github.com/pypeclub/OpenPype/compare/CI/3.13.0-nightly.1...3.13.0)
-**🆕 New features**
-
-- Support for mutliple installed versions - 3.13 [\#3605](https://github.com/pypeclub/OpenPype/pull/3605)
-
**🚀 Enhancements**
- Editorial: Mix audio use side file for ffmpeg filters [\#3630](https://github.com/pypeclub/OpenPype/pull/3630)
@@ -123,14 +123,10 @@
- General: Extract review aspect ratio scale is calculated by ffmpeg [\#3620](https://github.com/pypeclub/OpenPype/pull/3620)
- Maya: Fix types of default settings [\#3617](https://github.com/pypeclub/OpenPype/pull/3617)
- Integrator: Don't force to have dot before frame [\#3611](https://github.com/pypeclub/OpenPype/pull/3611)
-- AfterEffects: refactored integrate doesnt work formulti frame publishes [\#3610](https://github.com/pypeclub/OpenPype/pull/3610)
-- Maya look data contents fails with custom attribute on group [\#3607](https://github.com/pypeclub/OpenPype/pull/3607)
-- TrayPublisher: Fix wrong conflict merge [\#3600](https://github.com/pypeclub/OpenPype/pull/3600)
**🔀 Refactored code**
- General: Plugin settings handled by plugins [\#3623](https://github.com/pypeclub/OpenPype/pull/3623)
-- General: Naive implementation of document create, update, delete [\#3601](https://github.com/pypeclub/OpenPype/pull/3601)
**Merged pull requests:**
diff --git a/openpype/client/operations.py b/openpype/client/operations.py
index c0716ee109..9daaa3e116 100644
--- a/openpype/client/operations.py
+++ b/openpype/client/operations.py
@@ -24,6 +24,7 @@ CURRENT_SUBSET_SCHEMA = "openpype:subset-3.0"
CURRENT_VERSION_SCHEMA = "openpype:version-3.0"
CURRENT_REPRESENTATION_SCHEMA = "openpype:representation-2.0"
CURRENT_WORKFILE_INFO_SCHEMA = "openpype:workfile-1.0"
+CURRENT_THUMBNAIL_SCHEMA = "openpype:thumbnail-1.0"
def _create_or_convert_to_mongo_id(mongo_id):
@@ -195,6 +196,29 @@ def new_representation_doc(
}
+def new_thumbnail_doc(data=None, entity_id=None):
+ """Create skeleton data of thumbnail document.
+
+ Args:
+ data (Dict[str, Any]): Thumbnail document data.
+ entity_id (Union[str, ObjectId]): Predefined id of document. New id is
+ created if not passed.
+
+ Returns:
+ Dict[str, Any]: Skeleton of thumbnail document.
+ """
+
+ if data is None:
+ data = {}
+
+ return {
+ "_id": _create_or_convert_to_mongo_id(entity_id),
+ "type": "thumbnail",
+ "schema": CURRENT_THUMBNAIL_SCHEMA,
+ "data": data
+ }
+
+
def new_workfile_info_doc(
filename, asset_id, task_name, files, data=None, entity_id=None
):
diff --git a/openpype/hosts/blender/plugins/publish/validate_camera_zero_keyframe.py b/openpype/hosts/blender/plugins/publish/validate_camera_zero_keyframe.py
index 39b9b67511..5ba4808875 100644
--- a/openpype/hosts/blender/plugins/publish/validate_camera_zero_keyframe.py
+++ b/openpype/hosts/blender/plugins/publish/validate_camera_zero_keyframe.py
@@ -1,8 +1,9 @@
from typing import List
-import mathutils
+import bpy
import pyblish.api
+import openpype.api
import openpype.hosts.blender.api.action
@@ -17,18 +18,15 @@ class ValidateCameraZeroKeyframe(pyblish.api.InstancePlugin):
order = openpype.api.ValidateContentsOrder
hosts = ["blender"]
families = ["camera"]
- category = "geometry"
version = (0, 1, 0)
label = "Zero Keyframe"
actions = [openpype.hosts.blender.api.action.SelectInvalidAction]
- _identity = mathutils.Matrix()
-
- @classmethod
- def get_invalid(cls, instance) -> List:
+ @staticmethod
+ def get_invalid(instance) -> List:
invalid = []
- for obj in [obj for obj in instance]:
- if obj.type == "CAMERA":
+ for obj in instance:
+ if isinstance(obj, bpy.types.Object) and obj.type == "CAMERA":
if obj.animation_data and obj.animation_data.action:
action = obj.animation_data.action
frames_set = set()
@@ -45,4 +43,5 @@ class ValidateCameraZeroKeyframe(pyblish.api.InstancePlugin):
invalid = self.get_invalid(instance)
if invalid:
raise RuntimeError(
- f"Object found in instance is not in Object Mode: {invalid}")
+ f"Camera must have a keyframe at frame 0: {invalid}"
+ )
diff --git a/openpype/hosts/blender/plugins/publish/validate_mesh_has_uv.py b/openpype/hosts/blender/plugins/publish/validate_mesh_has_uv.py
index 1c73476fc8..83146c641e 100644
--- a/openpype/hosts/blender/plugins/publish/validate_mesh_has_uv.py
+++ b/openpype/hosts/blender/plugins/publish/validate_mesh_has_uv.py
@@ -3,13 +3,14 @@ from typing import List
import bpy
import pyblish.api
+import openpype.api
import openpype.hosts.blender.api.action
class ValidateMeshHasUvs(pyblish.api.InstancePlugin):
"""Validate that the current mesh has UV's."""
- order = pyblish.api.ValidatorOrder
+ order = openpype.api.ValidateContentsOrder
hosts = ["blender"]
families = ["model"]
category = "geometry"
@@ -25,7 +26,10 @@ class ValidateMeshHasUvs(pyblish.api.InstancePlugin):
for uv_layer in obj.data.uv_layers:
for polygon in obj.data.polygons:
for loop_index in polygon.loop_indices:
- if not uv_layer.data[loop_index].uv:
+ if (
+ loop_index >= len(uv_layer.data)
+ or not uv_layer.data[loop_index].uv
+ ):
return False
return True
@@ -33,20 +37,20 @@ class ValidateMeshHasUvs(pyblish.api.InstancePlugin):
@classmethod
def get_invalid(cls, instance) -> List:
invalid = []
- # TODO (jasper): only check objects in the collection that will be published?
- for obj in [
- obj for obj in instance]:
- try:
- if obj.type == 'MESH':
- # Make sure we are in object mode.
- bpy.ops.object.mode_set(mode='OBJECT')
- if not cls.has_uvs(obj):
- invalid.append(obj)
- except:
- continue
+ for obj in instance:
+ if isinstance(obj, bpy.types.Object) and obj.type == 'MESH':
+ if obj.mode != "OBJECT":
+ cls.log.warning(
+ f"Mesh object {obj.name} should be in 'OBJECT' mode"
+ " to be properly checked."
+ )
+ if not cls.has_uvs(obj):
+ invalid.append(obj)
return invalid
def process(self, instance):
invalid = self.get_invalid(instance)
if invalid:
- raise RuntimeError(f"Meshes found in instance without valid UV's: {invalid}")
+ raise RuntimeError(
+ f"Meshes found in instance without valid UV's: {invalid}"
+ )
diff --git a/openpype/hosts/blender/plugins/publish/validate_mesh_no_negative_scale.py b/openpype/hosts/blender/plugins/publish/validate_mesh_no_negative_scale.py
index 00159a2d36..329a8d80c3 100644
--- a/openpype/hosts/blender/plugins/publish/validate_mesh_no_negative_scale.py
+++ b/openpype/hosts/blender/plugins/publish/validate_mesh_no_negative_scale.py
@@ -3,28 +3,27 @@ from typing import List
import bpy
import pyblish.api
+import openpype.api
import openpype.hosts.blender.api.action
class ValidateMeshNoNegativeScale(pyblish.api.Validator):
"""Ensure that meshes don't have a negative scale."""
- order = pyblish.api.ValidatorOrder
+ order = openpype.api.ValidateContentsOrder
hosts = ["blender"]
families = ["model"]
+ category = "geometry"
label = "Mesh No Negative Scale"
actions = [openpype.hosts.blender.api.action.SelectInvalidAction]
@staticmethod
def get_invalid(instance) -> List:
invalid = []
- # TODO (jasper): only check objects in the collection that will be published?
- for obj in [
- obj for obj in bpy.data.objects if obj.type == 'MESH'
- ]:
- if any(v < 0 for v in obj.scale):
- invalid.append(obj)
-
+ for obj in instance:
+ if isinstance(obj, bpy.types.Object) and obj.type == 'MESH':
+ if any(v < 0 for v in obj.scale):
+ invalid.append(obj)
return invalid
def process(self, instance):
diff --git a/openpype/hosts/blender/plugins/publish/validate_no_colons_in_name.py b/openpype/hosts/blender/plugins/publish/validate_no_colons_in_name.py
index 261ff864d5..daf35c61ac 100644
--- a/openpype/hosts/blender/plugins/publish/validate_no_colons_in_name.py
+++ b/openpype/hosts/blender/plugins/publish/validate_no_colons_in_name.py
@@ -1,6 +1,9 @@
from typing import List
+import bpy
+
import pyblish.api
+import openpype.api
import openpype.hosts.blender.api.action
@@ -19,13 +22,13 @@ class ValidateNoColonsInName(pyblish.api.InstancePlugin):
label = "No Colons in names"
actions = [openpype.hosts.blender.api.action.SelectInvalidAction]
- @classmethod
- def get_invalid(cls, instance) -> List:
+ @staticmethod
+ def get_invalid(instance) -> List:
invalid = []
- for obj in [obj for obj in instance]:
+ for obj in instance:
if ':' in obj.name:
invalid.append(obj)
- if obj.type == 'ARMATURE':
+ if isinstance(obj, bpy.types.Object) and obj.type == 'ARMATURE':
for bone in obj.data.bones:
if ':' in bone.name:
invalid.append(obj)
@@ -36,4 +39,5 @@ class ValidateNoColonsInName(pyblish.api.InstancePlugin):
invalid = self.get_invalid(instance)
if invalid:
raise RuntimeError(
- f"Objects found with colon in name: {invalid}")
+ f"Objects found with colon in name: {invalid}"
+ )
diff --git a/openpype/hosts/blender/plugins/publish/validate_object_mode.py b/openpype/hosts/blender/plugins/publish/validate_object_mode.py
index 90ef0b7c41..ac60e00f89 100644
--- a/openpype/hosts/blender/plugins/publish/validate_object_mode.py
+++ b/openpype/hosts/blender/plugins/publish/validate_object_mode.py
@@ -1,5 +1,7 @@
from typing import List
+import bpy
+
import pyblish.api
import openpype.hosts.blender.api.action
@@ -10,26 +12,21 @@ class ValidateObjectIsInObjectMode(pyblish.api.InstancePlugin):
order = pyblish.api.ValidatorOrder - 0.01
hosts = ["blender"]
families = ["model", "rig", "layout"]
- category = "geometry"
label = "Validate Object Mode"
actions = [openpype.hosts.blender.api.action.SelectInvalidAction]
optional = False
- @classmethod
- def get_invalid(cls, instance) -> List:
+ @staticmethod
+ def get_invalid(instance) -> List:
invalid = []
- for obj in [obj for obj in instance]:
- try:
- if obj.type == 'MESH' or obj.type == 'ARMATURE':
- # Check if the object is in object mode.
- if not obj.mode == 'OBJECT':
- invalid.append(obj)
- except Exception:
- continue
+ for obj in instance:
+ if isinstance(obj, bpy.types.Object) and obj.mode != "OBJECT":
+ invalid.append(obj)
return invalid
def process(self, instance):
invalid = self.get_invalid(instance)
if invalid:
raise RuntimeError(
- f"Object found in instance is not in Object Mode: {invalid}")
+ f"Object found in instance is not in Object Mode: {invalid}"
+ )
diff --git a/openpype/hosts/blender/plugins/publish/validate_transform_zero.py b/openpype/hosts/blender/plugins/publish/validate_transform_zero.py
index 7456dbc423..6e03094794 100644
--- a/openpype/hosts/blender/plugins/publish/validate_transform_zero.py
+++ b/openpype/hosts/blender/plugins/publish/validate_transform_zero.py
@@ -1,8 +1,10 @@
from typing import List
import mathutils
+import bpy
import pyblish.api
+import openpype.api
import openpype.hosts.blender.api.action
@@ -18,7 +20,6 @@ class ValidateTransformZero(pyblish.api.InstancePlugin):
order = openpype.api.ValidateContentsOrder
hosts = ["blender"]
families = ["model"]
- category = "geometry"
version = (0, 1, 0)
label = "Transform Zero"
actions = [openpype.hosts.blender.api.action.SelectInvalidAction]
@@ -28,8 +29,11 @@ class ValidateTransformZero(pyblish.api.InstancePlugin):
@classmethod
def get_invalid(cls, instance) -> List:
invalid = []
- for obj in [obj for obj in instance]:
- if obj.matrix_basis != cls._identity:
+ for obj in instance:
+ if (
+ isinstance(obj, bpy.types.Object)
+ and obj.matrix_basis != cls._identity
+ ):
invalid.append(obj)
return invalid
@@ -37,4 +41,6 @@ class ValidateTransformZero(pyblish.api.InstancePlugin):
invalid = self.get_invalid(instance)
if invalid:
raise RuntimeError(
- f"Object found in instance is not in Object Mode: {invalid}")
+ "Object found in instance has not"
+ f" transform to zero: {invalid}"
+ )
diff --git a/openpype/hosts/houdini/plugins/publish/collect_current_file.py b/openpype/hosts/houdini/plugins/publish/collect_current_file.py
index c0b987ebbc..1383c274a2 100644
--- a/openpype/hosts/houdini/plugins/publish/collect_current_file.py
+++ b/openpype/hosts/houdini/plugins/publish/collect_current_file.py
@@ -1,27 +1,28 @@
import os
import hou
+from openpype.pipeline import legacy_io
import pyblish.api
class CollectHoudiniCurrentFile(pyblish.api.ContextPlugin):
"""Inject the current working file into context"""
- order = pyblish.api.CollectorOrder - 0.5
+ order = pyblish.api.CollectorOrder - 0.01
label = "Houdini Current File"
hosts = ["houdini"]
def process(self, context):
"""Inject the current working file"""
- filepath = hou.hipFile.path()
- if not os.path.exists(filepath):
+ current_file = hou.hipFile.path()
+ if not os.path.exists(current_file):
# By default Houdini will even point a new scene to a path.
# However if the file is not saved at all and does not exist,
# we assume the user never set it.
filepath = ""
- elif os.path.basename(filepath) == "untitled.hip":
+ elif os.path.basename(current_file) == "untitled.hip":
# Due to even a new file being called 'untitled.hip' we are unable
# to confirm the current scene was ever saved because the file
# could have existed already. We will allow it if the file exists,
@@ -33,4 +34,43 @@ class CollectHoudiniCurrentFile(pyblish.api.ContextPlugin):
"saved correctly."
)
- context.data["currentFile"] = filepath
+ context.data["currentFile"] = current_file
+
+ folder, file = os.path.split(current_file)
+ filename, ext = os.path.splitext(file)
+
+ task = legacy_io.Session["AVALON_TASK"]
+
+ data = {}
+
+ # create instance
+ instance = context.create_instance(name=filename)
+ subset = 'workfile' + task.capitalize()
+
+ data.update({
+ "subset": subset,
+ "asset": os.getenv("AVALON_ASSET", None),
+ "label": subset,
+ "publish": True,
+ "family": 'workfile',
+ "families": ['workfile'],
+ "setMembers": [current_file],
+ "frameStart": context.data['frameStart'],
+ "frameEnd": context.data['frameEnd'],
+ "handleStart": context.data['handleStart'],
+ "handleEnd": context.data['handleEnd']
+ })
+
+ data['representations'] = [{
+ 'name': ext.lstrip("."),
+ 'ext': ext.lstrip("."),
+ 'files': file,
+ "stagingDir": folder,
+ }]
+
+ instance.data.update(data)
+
+ self.log.info('Collected instance: {}'.format(file))
+ self.log.info('Scene path: {}'.format(current_file))
+ self.log.info('staging Dir: {}'.format(folder))
+ self.log.info('subset: {}'.format(subset))
diff --git a/openpype/hosts/houdini/plugins/publish/validate_workfile_paths.py b/openpype/hosts/houdini/plugins/publish/validate_workfile_paths.py
new file mode 100644
index 0000000000..79b3e894e5
--- /dev/null
+++ b/openpype/hosts/houdini/plugins/publish/validate_workfile_paths.py
@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+import openpype.api
+import pyblish.api
+import hou
+
+
+class ValidateWorkfilePaths(pyblish.api.InstancePlugin):
+ """Validate workfile paths so they are absolute."""
+
+ order = pyblish.api.ValidatorOrder
+ families = ["workfile"]
+ hosts = ["houdini"]
+ label = "Validate Workfile Paths"
+ actions = [openpype.api.RepairAction]
+ optional = True
+
+ node_types = ["file", "alembic"]
+ prohibited_vars = ["$HIP", "$JOB"]
+
+ def process(self, instance):
+ invalid = self.get_invalid()
+ self.log.info(
+ "node types to check: {}".format(", ".join(self.node_types)))
+ self.log.info(
+ "prohibited vars: {}".format(", ".join(self.prohibited_vars))
+ )
+ if invalid:
+ for param in invalid:
+ self.log.error(
+ "{}: {}".format(param.path(), param.unexpandedString()))
+
+ raise RuntimeError("Invalid paths found")
+
+ @classmethod
+ def get_invalid(cls):
+ invalid = []
+ for param, _ in hou.fileReferences():
+ # skip nodes we are not interested in
+ if param.node().type().name() not in cls.node_types:
+ continue
+
+ if any(
+ v for v in cls.prohibited_vars
+ if v in param.unexpandedString()):
+ invalid.append(param)
+
+ return invalid
+
+ @classmethod
+ def repair(cls, instance):
+ invalid = cls.get_invalid()
+ for param in invalid:
+ cls.log.info("processing: {}".format(param.path()))
+ cls.log.info("Replacing {} for {}".format(
+ param.unexpandedString(),
+ hou.text.expandString(param.unexpandedString())))
+ param.set(hou.text.expandString(param.unexpandedString()))
diff --git a/openpype/hosts/houdini/startup/python3.9libs/pythonrc.py b/openpype/hosts/houdini/startup/python3.9libs/pythonrc.py
new file mode 100644
index 0000000000..afadbffd3e
--- /dev/null
+++ b/openpype/hosts/houdini/startup/python3.9libs/pythonrc.py
@@ -0,0 +1,10 @@
+from openpype.pipeline import install_host
+from openpype.hosts.houdini import api
+
+
+def main():
+ print("Installing OpenPype ...")
+ install_host(api)
+
+
+main()
diff --git a/openpype/hosts/maya/plugins/publish/extract_playblast.py b/openpype/hosts/maya/plugins/publish/extract_playblast.py
index 54ef09e060..871adda0c3 100644
--- a/openpype/hosts/maya/plugins/publish/extract_playblast.py
+++ b/openpype/hosts/maya/plugins/publish/extract_playblast.py
@@ -128,7 +128,7 @@ class ExtractPlayblast(openpype.api.Extractor):
# Update preset with current panel setting
# if override_viewport_options is turned off
if not override_viewport_options:
- panel = cmds.getPanel(with_focus=True)
+ panel = cmds.getPanel(withFocus=True)
panel_preset = capture.parse_active_view()
preset.update(panel_preset)
cmds.setFocus(panel)
diff --git a/openpype/hosts/maya/plugins/publish/extract_thumbnail.py b/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
index 01980578cf..9380da5128 100644
--- a/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
+++ b/openpype/hosts/maya/plugins/publish/extract_thumbnail.py
@@ -100,9 +100,9 @@ class ExtractThumbnail(openpype.api.Extractor):
# camera.
if preset.pop("isolate_view", False) and instance.data.get("isolate"):
preset["isolate"] = instance.data["setMembers"]
-
+
# Show or Hide Image Plane
- image_plane = instance.data.get("imagePlane", True)
+ image_plane = instance.data.get("imagePlane", True)
if "viewport_options" in preset:
preset["viewport_options"]["imagePlane"] = image_plane
else:
@@ -117,7 +117,7 @@ class ExtractThumbnail(openpype.api.Extractor):
# Update preset with current panel setting
# if override_viewport_options is turned off
if not override_viewport_options:
- panel = cmds.getPanel(with_focus=True)
+ panel = cmds.getPanel(withFocus=True)
panel_preset = capture.parse_active_view()
preset.update(panel_preset)
cmds.setFocus(panel)
diff --git a/openpype/lib/__init__.py b/openpype/lib/__init__.py
index adb857a056..17aafc3e8b 100644
--- a/openpype/lib/__init__.py
+++ b/openpype/lib/__init__.py
@@ -192,6 +192,8 @@ from .plugin_tools import (
)
from .path_tools import (
+ format_file_size,
+ collect_frames,
create_hard_link,
version_up,
get_version_from_path,
@@ -353,6 +355,8 @@ __all__ = [
"set_plugin_attributes_from_settings",
"source_hash",
+ "format_file_size",
+ "collect_frames",
"create_hard_link",
"version_up",
"get_version_from_path",
diff --git a/openpype/lib/delivery.py b/openpype/lib/delivery.py
index ffcfe9fa4d..efb542de75 100644
--- a/openpype/lib/delivery.py
+++ b/openpype/lib/delivery.py
@@ -1,81 +1,113 @@
"""Functions useful for delivery action or loader"""
import os
import shutil
-import glob
-import clique
-import collections
-
-from .path_templates import (
- StringTemplate,
- TemplateUnsolved,
-)
+import functools
+import warnings
+class DeliveryDeprecatedWarning(DeprecationWarning):
+ pass
+
+
+def deprecated(new_destination):
+ """Mark functions as deprecated.
+
+ It will result in a warning being emitted when the function is used.
+ """
+
+ func = None
+ if callable(new_destination):
+ func = new_destination
+ new_destination = None
+
+ def _decorator(decorated_func):
+ if new_destination is None:
+ warning_message = (
+ " Please check content of deprecated function to figure out"
+ " possible replacement."
+ )
+ else:
+ warning_message = " Please replace your usage with '{}'.".format(
+ new_destination
+ )
+
+ @functools.wraps(decorated_func)
+ def wrapper(*args, **kwargs):
+ warnings.simplefilter("always", DeliveryDeprecatedWarning)
+ warnings.warn(
+ (
+ "Call to deprecated function '{}'"
+ "\nFunction was moved or removed.{}"
+ ).format(decorated_func.__name__, warning_message),
+ category=DeliveryDeprecatedWarning,
+ stacklevel=4
+ )
+ return decorated_func(*args, **kwargs)
+ return wrapper
+
+ if func is None:
+ return _decorator
+ return _decorator(func)
+
+
+@deprecated("openpype.lib.path_tools.collect_frames")
def collect_frames(files):
+ """Returns dict of source path and its frame, if from sequence
+
+ Uses clique as most precise solution, used when anatomy template that
+ created files is not known.
+
+ Assumption is that frames are separated by '.', negative frames are not
+ allowed.
+
+ Args:
+ files(list) or (set with single value): list of source paths
+
+ Returns:
+ (dict): {'/asset/subset_v001.0001.png': '0001', ....}
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- Returns dict of source path and its frame, if from sequence
- Uses clique as most precise solution, used when anatomy template that
- created files is not known.
+ from .path_tools import collect_frames
- Assumption is that frames are separated by '.', negative frames are not
- allowed.
+ return collect_frames(files)
- Args:
- files(list) or (set with single value): list of source paths
- Returns:
- (dict): {'/asset/subset_v001.0001.png': '0001', ....}
+
+@deprecated("openpype.lib.path_tools.format_file_size")
+def sizeof_fmt(num, suffix=None):
+ """Returns formatted string with size in appropriate unit
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- patterns = [clique.PATTERNS["frames"]]
- collections, remainder = clique.assemble(files, minimum_items=1,
- patterns=patterns)
- sources_and_frames = {}
- if collections:
- for collection in collections:
- src_head = collection.head
- src_tail = collection.tail
-
- for index in collection.indexes:
- src_frame = collection.format("{padding}") % index
- src_file_name = "{}{}{}".format(src_head, src_frame,
- src_tail)
- sources_and_frames[src_file_name] = src_frame
- else:
- sources_and_frames[remainder.pop()] = None
-
- return sources_and_frames
-
-
-def sizeof_fmt(num, suffix='B'):
- """Returns formatted string with size in appropriate unit"""
- for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
- if abs(num) < 1024.0:
- return "%3.1f%s%s" % (num, unit, suffix)
- num /= 1024.0
- return "%.1f%s%s" % (num, 'Yi', suffix)
+ from .path_tools import format_file_size
+ return format_file_size(num, suffix)
+@deprecated("openpype.pipeline.load.get_representation_path_with_anatomy")
def path_from_representation(representation, anatomy):
- try:
- template = representation["data"]["template"]
+ """Get representation path using representation document and anatomy.
- except KeyError:
- return None
+ Args:
+ representation (Dict[str, Any]): Representation document.
+ anatomy (Anatomy): Project anatomy.
- try:
- context = representation["context"]
- context["root"] = anatomy.roots
- path = StringTemplate.format_strict_template(template, context)
- return os.path.normpath(path)
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
+ """
- except TemplateUnsolved:
- # Template references unavailable data
- return None
+ from openpype.pipeline.load import get_representation_path_with_anatomy
- return path
+ return get_representation_path_with_anatomy(representation, anatomy)
+@deprecated
def copy_file(src_path, dst_path):
"""Hardlink file if possible(to save space), copy if not"""
from openpype.lib import create_hard_link # safer importing
@@ -91,131 +123,96 @@ def copy_file(src_path, dst_path):
shutil.copyfile(src_path, dst_path)
+@deprecated("openpype.pipeline.delivery.get_format_dict")
def get_format_dict(anatomy, location_path):
"""Returns replaced root values from user provider value.
- Args:
- anatomy (Anatomy)
- location_path (str): user provided value
- Returns:
- (dict): prepared for formatting of a template
+ Args:
+ anatomy (Anatomy)
+ location_path (str): user provided value
+
+ Returns:
+ (dict): prepared for formatting of a template
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- format_dict = {}
- if location_path:
- location_path = location_path.replace("\\", "/")
- root_names = anatomy.root_names_from_templates(
- anatomy.templates["delivery"]
- )
- if root_names is None:
- format_dict["root"] = location_path
- else:
- format_dict["root"] = {}
- for name in root_names:
- format_dict["root"][name] = location_path
- return format_dict
+
+ from openpype.pipeline.delivery import get_format_dict
+
+ return get_format_dict(anatomy, location_path)
+@deprecated("openpype.pipeline.delivery.check_destination_path")
def check_destination_path(repre_id,
anatomy, anatomy_data,
datetime_data, template_name):
""" Try to create destination path based on 'template_name'.
- In the case that path cannot be filled, template contains unmatched
- keys, provide error message to filter out repre later.
+ In the case that path cannot be filled, template contains unmatched
+ keys, provide error message to filter out repre later.
- Args:
- anatomy (Anatomy)
- anatomy_data (dict): context to fill anatomy
- datetime_data (dict): values with actual date
- template_name (str): to pick correct delivery template
- Returns:
- (collections.defauldict): {"TYPE_OF_ERROR":"ERROR_DETAIL"}
+ Args:
+ anatomy (Anatomy)
+ anatomy_data (dict): context to fill anatomy
+ datetime_data (dict): values with actual date
+ template_name (str): to pick correct delivery template
+
+ Returns:
+ (collections.defauldict): {"TYPE_OF_ERROR":"ERROR_DETAIL"}
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- anatomy_data.update(datetime_data)
- anatomy_filled = anatomy.format_all(anatomy_data)
- dest_path = anatomy_filled["delivery"][template_name]
- report_items = collections.defaultdict(list)
- if not dest_path.solved:
- msg = (
- "Missing keys in Representation's context"
- " for anatomy template \"{}\"."
- ).format(template_name)
+ from openpype.pipeline.delivery import check_destination_path
- sub_msg = (
- "Representation: {}
"
- ).format(repre_id)
-
- if dest_path.missing_keys:
- keys = ", ".join(dest_path.missing_keys)
- sub_msg += (
- "- Missing keys: \"{}\"
"
- ).format(keys)
-
- if dest_path.invalid_types:
- items = []
- for key, value in dest_path.invalid_types.items():
- items.append("\"{}\" {}".format(key, str(value)))
-
- keys = ", ".join(items)
- sub_msg += (
- "- Invalid value DataType: \"{}\"
"
- ).format(keys)
-
- report_items[msg].append(sub_msg)
-
- return report_items
+ return check_destination_path(
+ repre_id,
+ anatomy,
+ anatomy_data,
+ datetime_data,
+ template_name
+ )
+@deprecated("openpype.pipeline.delivery.deliver_single_file")
def process_single_file(
src_path, repre, anatomy, template_name, anatomy_data, format_dict,
report_items, log
):
"""Copy single file to calculated path based on template
- Args:
- src_path(str): path of source representation file
- _repre (dict): full repre, used only in process_sequence, here only
- as to share same signature
- anatomy (Anatomy)
- template_name (string): user selected delivery template name
- anatomy_data (dict): data from repre to fill anatomy with
- format_dict (dict): root dictionary with names and values
- report_items (collections.defaultdict): to return error messages
- log (Logger): for log printing
- Returns:
- (collections.defaultdict , int)
+ Args:
+ src_path(str): path of source representation file
+ _repre (dict): full repre, used only in process_sequence, here only
+ as to share same signature
+ anatomy (Anatomy)
+ template_name (string): user selected delivery template name
+ anatomy_data (dict): data from repre to fill anatomy with
+ format_dict (dict): root dictionary with names and values
+ report_items (collections.defaultdict): to return error messages
+ log (Logger): for log printing
+
+ Returns:
+ (collections.defaultdict , int)
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- # Make sure path is valid for all platforms
- src_path = os.path.normpath(src_path.replace("\\", "/"))
- if not os.path.exists(src_path):
- msg = "{} doesn't exist for {}".format(src_path, repre["_id"])
- report_items["Source file was not found"].append(msg)
- return report_items, 0
+ from openpype.pipeline.delivery import deliver_single_file
- anatomy_filled = anatomy.format(anatomy_data)
- if format_dict:
- template_result = anatomy_filled["delivery"][template_name]
- delivery_path = template_result.rootless.format(**format_dict)
- else:
- delivery_path = anatomy_filled["delivery"][template_name]
-
- # Backwards compatibility when extension contained `.`
- delivery_path = delivery_path.replace("..", ".")
- # Make sure path is valid for all platforms
- delivery_path = os.path.normpath(delivery_path.replace("\\", "/"))
-
- delivery_folder = os.path.dirname(delivery_path)
- if not os.path.exists(delivery_folder):
- os.makedirs(delivery_folder)
-
- log.debug("Copying single: {} -> {}".format(src_path, delivery_path))
- copy_file(src_path, delivery_path)
-
- return report_items, 1
+ return deliver_single_file(
+ src_path, repre, anatomy, template_name, anatomy_data, format_dict,
+ report_items, log
+ )
+@deprecated("openpype.pipeline.delivery.deliver_sequence")
def process_sequence(
src_path, repre, anatomy, template_name, anatomy_data, format_dict,
report_items, log
@@ -223,128 +220,33 @@ def process_sequence(
""" For Pype2(mainly - works in 3 too) where representation might not
contain files.
- Uses listing physical files (not 'files' on repre as a)might not be
- present, b)might not be reliable for representation and copying them.
+ Uses listing physical files (not 'files' on repre as a)might not be
+ present, b)might not be reliable for representation and copying them.
- TODO Should be refactored when files are sufficient to drive all
- representations.
+ TODO Should be refactored when files are sufficient to drive all
+ representations.
- Args:
- src_path(str): path of source representation file
- repre (dict): full representation
- anatomy (Anatomy)
- template_name (string): user selected delivery template name
- anatomy_data (dict): data from repre to fill anatomy with
- format_dict (dict): root dictionary with names and values
- report_items (collections.defaultdict): to return error messages
- log (Logger): for log printing
- Returns:
- (collections.defaultdict , int)
+ Args:
+ src_path(str): path of source representation file
+ repre (dict): full representation
+ anatomy (Anatomy)
+ template_name (string): user selected delivery template name
+ anatomy_data (dict): data from repre to fill anatomy with
+ format_dict (dict): root dictionary with names and values
+ report_items (collections.defaultdict): to return error messages
+ log (Logger): for log printing
+
+ Returns:
+ (collections.defaultdict , int)
+
+ Deprecated:
+ Function was moved to different location and will be removed
+ after 3.16.* release.
"""
- src_path = os.path.normpath(src_path.replace("\\", "/"))
- def hash_path_exist(myPath):
- res = myPath.replace('#', '*')
- glob_search_results = glob.glob(res)
- if len(glob_search_results) > 0:
- return True
- return False
+ from openpype.pipeline.delivery import deliver_sequence
- if not hash_path_exist(src_path):
- msg = "{} doesn't exist for {}".format(src_path,
- repre["_id"])
- report_items["Source file was not found"].append(msg)
- return report_items, 0
-
- delivery_templates = anatomy.templates.get("delivery") or {}
- delivery_template = delivery_templates.get(template_name)
- if delivery_template is None:
- msg = (
- "Delivery template \"{}\" in anatomy of project \"{}\""
- " was not found"
- ).format(template_name, anatomy.project_name)
- report_items[""].append(msg)
- return report_items, 0
-
- # Check if 'frame' key is available in template which is required
- # for sequence delivery
- if "{frame" not in delivery_template:
- msg = (
- "Delivery template \"{}\" in anatomy of project \"{}\""
- "does not contain '{{frame}}' key to fill. Delivery of sequence"
- " can't be processed."
- ).format(template_name, anatomy.project_name)
- report_items[""].append(msg)
- return report_items, 0
-
- dir_path, file_name = os.path.split(str(src_path))
-
- context = repre["context"]
- ext = context.get("ext", context.get("representation"))
-
- if not ext:
- msg = "Source extension not found, cannot find collection"
- report_items[msg].append(src_path)
- log.warning("{} <{}>".format(msg, context))
- return report_items, 0
-
- ext = "." + ext
- # context.representation could be .psd
- ext = ext.replace("..", ".")
-
- src_collections, remainder = clique.assemble(os.listdir(dir_path))
- src_collection = None
- for col in src_collections:
- if col.tail != ext:
- continue
-
- src_collection = col
- break
-
- if src_collection is None:
- msg = "Source collection of files was not found"
- report_items[msg].append(src_path)
- log.warning("{} <{}>".format(msg, src_path))
- return report_items, 0
-
- frame_indicator = "@####@"
-
- anatomy_data["frame"] = frame_indicator
- anatomy_filled = anatomy.format(anatomy_data)
-
- if format_dict:
- template_result = anatomy_filled["delivery"][template_name]
- delivery_path = template_result.rootless.format(**format_dict)
- else:
- delivery_path = anatomy_filled["delivery"][template_name]
-
- delivery_path = os.path.normpath(delivery_path.replace("\\", "/"))
- delivery_folder = os.path.dirname(delivery_path)
- dst_head, dst_tail = delivery_path.split(frame_indicator)
- dst_padding = src_collection.padding
- dst_collection = clique.Collection(
- head=dst_head,
- tail=dst_tail,
- padding=dst_padding
+ return deliver_sequence(
+ src_path, repre, anatomy, template_name, anatomy_data, format_dict,
+ report_items, log
)
-
- if not os.path.exists(delivery_folder):
- os.makedirs(delivery_folder)
-
- src_head = src_collection.head
- src_tail = src_collection.tail
- uploaded = 0
- for index in src_collection.indexes:
- src_padding = src_collection.format("{padding}") % index
- src_file_name = "{}{}{}".format(src_head, src_padding, src_tail)
- src = os.path.normpath(
- os.path.join(dir_path, src_file_name)
- )
-
- dst_padding = dst_collection.format("{padding}") % index
- dst = "{}{}{}".format(dst_head, dst_padding, dst_tail)
- log.debug("Copying single: {} -> {}".format(src, dst))
- copy_file(src, dst)
- uploaded += 1
-
- return report_items, uploaded
diff --git a/openpype/lib/path_tools.py b/openpype/lib/path_tools.py
index 4f28be3302..1835c71644 100644
--- a/openpype/lib/path_tools.py
+++ b/openpype/lib/path_tools.py
@@ -6,6 +6,8 @@ import logging
import six
import platform
+import clique
+
from openpype.client import get_project
from openpype.settings import get_project_settings
@@ -14,6 +16,27 @@ from .profiles_filtering import filter_profiles
log = logging.getLogger(__name__)
+def format_file_size(file_size, suffix=None):
+ """Returns formatted string with size in appropriate unit.
+
+ Args:
+ file_size (int): Size of file in bytes.
+ suffix (str): Suffix for formatted size. Default is 'B' (as bytes).
+
+ Returns:
+ str: Formatted size using proper unit and passed suffix (e.g. 7 MiB).
+ """
+
+ if suffix is None:
+ suffix = "B"
+
+ for unit in ["", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi"]:
+ if abs(file_size) < 1024.0:
+ return "%3.1f%s%s" % (file_size, unit, suffix)
+ file_size /= 1024.0
+ return "%.1f%s%s" % (file_size, "Yi", suffix)
+
+
def create_hard_link(src_path, dst_path):
"""Create hardlink of file.
@@ -50,6 +73,43 @@ def create_hard_link(src_path, dst_path):
)
+def collect_frames(files):
+ """Returns dict of source path and its frame, if from sequence
+
+ Uses clique as most precise solution, used when anatomy template that
+ created files is not known.
+
+ Assumption is that frames are separated by '.', negative frames are not
+ allowed.
+
+ Args:
+ files(list) or (set with single value): list of source paths
+
+ Returns:
+ (dict): {'/asset/subset_v001.0001.png': '0001', ....}
+ """
+
+ patterns = [clique.PATTERNS["frames"]]
+ collections, remainder = clique.assemble(
+ files, minimum_items=1, patterns=patterns)
+
+ sources_and_frames = {}
+ if collections:
+ for collection in collections:
+ src_head = collection.head
+ src_tail = collection.tail
+
+ for index in collection.indexes:
+ src_frame = collection.format("{padding}") % index
+ src_file_name = "{}{}{}".format(
+ src_head, src_frame, src_tail)
+ sources_and_frames[src_file_name] = src_frame
+ else:
+ sources_and_frames[remainder.pop()] = None
+
+ return sources_and_frames
+
+
def _rreplace(s, a, b, n=1):
"""Replace a with b in string s from right side n times."""
return b.join(s.rsplit(a, n))
@@ -119,12 +179,12 @@ def get_version_from_path(file):
"""Find version number in file path string.
Args:
- file (string): file path
+ file (str): file path
Returns:
- v: version number in string ('001')
-
+ str: version number in string ('001')
"""
+
pattern = re.compile(r"[\._]v([0-9]+)", re.IGNORECASE)
try:
return pattern.findall(file)[-1]
@@ -140,16 +200,17 @@ def get_last_version_from_path(path_dir, filter):
"""Find last version of given directory content.
Args:
- path_dir (string): directory path
+ path_dir (str): directory path
filter (list): list of strings used as file name filter
Returns:
- string: file name with last version
+ str: file name with last version
Example:
last_version_file = get_last_version_from_path(
"/project/shots/shot01/work", ["shot01", "compositing", "nk"])
"""
+
assert os.path.isdir(path_dir), "`path_dir` argument needs to be directory"
assert isinstance(filter, list) and (
len(filter) != 0), "`filter` argument needs to be list and not empty"
diff --git a/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py b/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py
index c55f85c8da..1d68793d53 100644
--- a/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_aftereffects_deadline.py
@@ -3,8 +3,10 @@ import attr
import getpass
import pyblish.api
-from openpype.lib import env_value_to_bool
-from openpype.lib.delivery import collect_frames
+from openpype.lib import (
+ env_value_to_bool,
+ collect_frames,
+)
from openpype.pipeline import legacy_io
from openpype_modules.deadline import abstract_submit_deadline
from openpype_modules.deadline.abstract_submit_deadline import DeadlineJobInfo
diff --git a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
index 336a56ec45..b09d2935ab 100644
--- a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
+++ b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py
@@ -114,6 +114,13 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin):
instance.data["deadlineSubmissionJob"] = resp.json()
instance.data["publishJobState"] = "Suspended"
+ # add to list of job Id
+ if not instance.data.get("bakingSubmissionJobs"):
+ instance.data["bakingSubmissionJobs"] = []
+
+ instance.data["bakingSubmissionJobs"].append(
+ resp.json()["_id"])
+
# redefinition of families
if "render.farm" in families:
instance.data['family'] = 'write'
diff --git a/openpype/modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_job.py
index 379953c9e4..2647dcf0cb 100644
--- a/openpype/modules/deadline/plugins/publish/submit_publish_job.py
+++ b/openpype/modules/deadline/plugins/publish/submit_publish_job.py
@@ -296,6 +296,12 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin):
for assembly_id in instance.data.get("assemblySubmissionJobs"):
payload["JobInfo"]["JobDependency{}".format(job_index)] = assembly_id # noqa: E501
job_index += 1
+ elif instance.data.get("bakingSubmissionJobs"):
+ self.log.info("Adding baking submission jobs as dependencies...")
+ job_index = 0
+ for assembly_id in instance.data["bakingSubmissionJobs"]:
+ payload["JobInfo"]["JobDependency{}".format(job_index)] = assembly_id # noqa: E501
+ job_index += 1
else:
payload["JobInfo"]["JobDependency0"] = job["_id"]
diff --git a/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py b/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
index c2426e0d78..f0a3ddd246 100644
--- a/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
+++ b/openpype/modules/deadline/plugins/publish/validate_expected_and_rendered_files.py
@@ -3,7 +3,7 @@ import requests
import pyblish.api
-from openpype.lib.delivery import collect_frames
+from openpype.lib import collect_frames
from openpype_modules.deadline.abstract_submit_deadline import requests_get
diff --git a/openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py b/openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py
index 79d04a7854..c543dc8834 100644
--- a/openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py
+++ b/openpype/modules/ftrack/event_handlers_user/action_delete_old_versions.py
@@ -11,7 +11,11 @@ from openpype.client import (
get_versions,
get_representations
)
-from openpype.lib import StringTemplate, TemplateUnsolved
+from openpype.lib import (
+ StringTemplate,
+ TemplateUnsolved,
+ format_file_size,
+)
from openpype.pipeline import AvalonMongoDB, Anatomy
from openpype_modules.ftrack.lib import BaseAction, statics_icon
@@ -134,13 +138,6 @@ class DeleteOldVersions(BaseAction):
"title": self.inteface_title
}
- def sizeof_fmt(self, num, suffix='B'):
- for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
- if abs(num) < 1024.0:
- return "%3.1f%s%s" % (num, unit, suffix)
- num /= 1024.0
- return "%.1f%s%s" % (num, 'Yi', suffix)
-
def launch(self, session, entities, event):
values = event["data"].get("values")
if not values:
@@ -359,7 +356,7 @@ class DeleteOldVersions(BaseAction):
dir_paths, file_paths_by_dir, delete=False
)
- msg = "Total size of files: " + self.sizeof_fmt(size)
+ msg = "Total size of files: {}".format(format_file_size(size))
self.log.warning(msg)
@@ -430,7 +427,7 @@ class DeleteOldVersions(BaseAction):
"message": msg
}
- msg = "Total size of files deleted: " + self.sizeof_fmt(size)
+ msg = "Total size of files deleted: {}".format(format_file_size(size))
self.log.warning(msg)
diff --git a/openpype/modules/ftrack/event_handlers_user/action_delivery.py b/openpype/modules/ftrack/event_handlers_user/action_delivery.py
index eec245070c..a400c8f5f0 100644
--- a/openpype/modules/ftrack/event_handlers_user/action_delivery.py
+++ b/openpype/modules/ftrack/event_handlers_user/action_delivery.py
@@ -10,19 +10,19 @@ from openpype.client import (
get_versions,
get_representations
)
-from openpype.pipeline import Anatomy
from openpype_modules.ftrack.lib import BaseAction, statics_icon
from openpype_modules.ftrack.lib.avalon_sync import CUST_ATTR_ID_KEY
from openpype_modules.ftrack.lib.custom_attributes import (
query_custom_attributes
)
from openpype.lib.dateutils import get_datetime_data
-from openpype.lib.delivery import (
- path_from_representation,
+from openpype.pipeline import Anatomy
+from openpype.pipeline.load import get_representation_path_with_anatomy
+from openpype.pipeline.delivery import (
get_format_dict,
check_destination_path,
- process_single_file,
- process_sequence
+ deliver_single_file,
+ deliver_sequence,
)
@@ -580,7 +580,7 @@ class Delivery(BaseAction):
if frame:
repre["context"]["frame"] = len(str(frame)) * "#"
- repre_path = path_from_representation(repre, anatomy)
+ repre_path = get_representation_path_with_anatomy(repre, anatomy)
# TODO add backup solution where root of path from component
# is replaced with root
args = (
@@ -594,9 +594,9 @@ class Delivery(BaseAction):
self.log
)
if not frame:
- process_single_file(*args)
+ deliver_single_file(*args)
else:
- process_sequence(*args)
+ deliver_sequence(*args)
return self.report(report_items)
diff --git a/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py b/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
index 5758068f86..576a7d36c4 100644
--- a/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
+++ b/openpype/modules/ftrack/plugins/publish/collect_ftrack_family.py
@@ -8,7 +8,7 @@ Provides:
import pyblish.api
from openpype.pipeline import legacy_io
-from openpype.lib.plugin_tools import filter_profiles
+from openpype.lib import filter_profiles
class CollectFtrackFamily(pyblish.api.InstancePlugin):
diff --git a/openpype/pipeline/create/creator_plugins.py b/openpype/pipeline/create/creator_plugins.py
index 9e1530a6a7..bf2fdd2c5f 100644
--- a/openpype/pipeline/create/creator_plugins.py
+++ b/openpype/pipeline/create/creator_plugins.py
@@ -9,7 +9,7 @@ from abc import (
import six
from openpype.settings import get_system_settings, get_project_settings
-from openpype.lib import get_subset_name_with_asset_doc
+from .subset_name import get_subset_name
from openpype.pipeline.plugin_discover import (
discover,
register_plugin,
@@ -75,6 +75,7 @@ class BaseCreator:
):
# Reference to CreateContext
self.create_context = create_context
+ self.project_settings = project_settings
# Creator is running in headless mode (without UI elemets)
# - we may use UI inside processing this attribute should be checked
@@ -276,14 +277,15 @@ class BaseCreator:
variant, task_name, asset_doc, project_name, host_name
)
- return get_subset_name_with_asset_doc(
+ return get_subset_name(
self.family,
variant,
task_name,
asset_doc,
project_name,
host_name,
- dynamic_data=dynamic_data
+ dynamic_data=dynamic_data,
+ project_settings=self.project_settings
)
def get_instance_attr_defs(self):
diff --git a/openpype/pipeline/delivery.py b/openpype/pipeline/delivery.py
new file mode 100644
index 0000000000..8cf9a43aac
--- /dev/null
+++ b/openpype/pipeline/delivery.py
@@ -0,0 +1,310 @@
+"""Functions useful for delivery of published representations."""
+import os
+import shutil
+import glob
+import clique
+import collections
+
+from openpype.lib import create_hard_link
+
+
+def _copy_file(src_path, dst_path):
+ """Hardlink file if possible(to save space), copy if not.
+
+ Because of using hardlinks should not be function used in other parts
+ of pipeline.
+ """
+
+ if os.path.exists(dst_path):
+ return
+ try:
+ create_hard_link(
+ src_path,
+ dst_path
+ )
+ except OSError:
+ shutil.copyfile(src_path, dst_path)
+
+
+def get_format_dict(anatomy, location_path):
+ """Returns replaced root values from user provider value.
+
+ Args:
+ anatomy (Anatomy): Project anatomy.
+ location_path (str): User provided value.
+
+ Returns:
+ (dict): Prepared data for formatting of a template.
+ """
+
+ format_dict = {}
+ if not location_path:
+ return format_dict
+
+ location_path = location_path.replace("\\", "/")
+ root_names = anatomy.root_names_from_templates(
+ anatomy.templates["delivery"]
+ )
+ format_dict["root"] = {}
+ for name in root_names:
+ format_dict["root"][name] = location_path
+ return format_dict
+
+
+def check_destination_path(
+ repre_id,
+ anatomy,
+ anatomy_data,
+ datetime_data,
+ template_name
+):
+ """ Try to create destination path based on 'template_name'.
+
+ In the case that path cannot be filled, template contains unmatched
+ keys, provide error message to filter out repre later.
+
+ Args:
+ repre_id (str): Representation id.
+ anatomy (Anatomy): Project anatomy.
+ anatomy_data (dict): Template data to fill anatomy templates.
+ datetime_data (dict): Values with actual date.
+ template_name (str): Name of template which should be used from anatomy
+ templates.
+ Returns:
+ Dict[str, List[str]]: Report of happened errors. Key is message title
+ value is detailed information.
+ """
+
+ anatomy_data.update(datetime_data)
+ anatomy_filled = anatomy.format_all(anatomy_data)
+ dest_path = anatomy_filled["delivery"][template_name]
+ report_items = collections.defaultdict(list)
+
+ if not dest_path.solved:
+ msg = (
+ "Missing keys in Representation's context"
+ " for anatomy template \"{}\"."
+ ).format(template_name)
+
+ sub_msg = (
+ "Representation: {}
"
+ ).format(repre_id)
+
+ if dest_path.missing_keys:
+ keys = ", ".join(dest_path.missing_keys)
+ sub_msg += (
+ "- Missing keys: \"{}\"
"
+ ).format(keys)
+
+ if dest_path.invalid_types:
+ items = []
+ for key, value in dest_path.invalid_types.items():
+ items.append("\"{}\" {}".format(key, str(value)))
+
+ keys = ", ".join(items)
+ sub_msg += (
+ "- Invalid value DataType: \"{}\"
"
+ ).format(keys)
+
+ report_items[msg].append(sub_msg)
+
+ return report_items
+
+
+def deliver_single_file(
+ src_path,
+ repre,
+ anatomy,
+ template_name,
+ anatomy_data,
+ format_dict,
+ report_items,
+ log
+):
+ """Copy single file to calculated path based on template
+
+ Args:
+ src_path(str): path of source representation file
+ repre (dict): full repre, used only in deliver_sequence, here only
+ as to share same signature
+ anatomy (Anatomy)
+ template_name (string): user selected delivery template name
+ anatomy_data (dict): data from repre to fill anatomy with
+ format_dict (dict): root dictionary with names and values
+ report_items (collections.defaultdict): to return error messages
+ log (logging.Logger): for log printing
+
+ Returns:
+ (collections.defaultdict, int)
+ """
+
+ # Make sure path is valid for all platforms
+ src_path = os.path.normpath(src_path.replace("\\", "/"))
+
+ if not os.path.exists(src_path):
+ msg = "{} doesn't exist for {}".format(src_path, repre["_id"])
+ report_items["Source file was not found"].append(msg)
+ return report_items, 0
+
+ anatomy_filled = anatomy.format(anatomy_data)
+ if format_dict:
+ template_result = anatomy_filled["delivery"][template_name]
+ delivery_path = template_result.rootless.format(**format_dict)
+ else:
+ delivery_path = anatomy_filled["delivery"][template_name]
+
+ # Backwards compatibility when extension contained `.`
+ delivery_path = delivery_path.replace("..", ".")
+ # Make sure path is valid for all platforms
+ delivery_path = os.path.normpath(delivery_path.replace("\\", "/"))
+
+ delivery_folder = os.path.dirname(delivery_path)
+ if not os.path.exists(delivery_folder):
+ os.makedirs(delivery_folder)
+
+ log.debug("Copying single: {} -> {}".format(src_path, delivery_path))
+ _copy_file(src_path, delivery_path)
+
+ return report_items, 1
+
+
+def deliver_sequence(
+ src_path,
+ repre,
+ anatomy,
+ template_name,
+ anatomy_data,
+ format_dict,
+ report_items,
+ log
+):
+ """ For Pype2(mainly - works in 3 too) where representation might not
+ contain files.
+
+ Uses listing physical files (not 'files' on repre as a)might not be
+ present, b)might not be reliable for representation and copying them.
+
+ TODO Should be refactored when files are sufficient to drive all
+ representations.
+
+ Args:
+ src_path(str): path of source representation file
+ repre (dict): full representation
+ anatomy (Anatomy)
+ template_name (string): user selected delivery template name
+ anatomy_data (dict): data from repre to fill anatomy with
+ format_dict (dict): root dictionary with names and values
+ report_items (collections.defaultdict): to return error messages
+ log (logging.Logger): for log printing
+
+ Returns:
+ (collections.defaultdict, int)
+ """
+
+ src_path = os.path.normpath(src_path.replace("\\", "/"))
+
+ def hash_path_exist(myPath):
+ res = myPath.replace('#', '*')
+ glob_search_results = glob.glob(res)
+ if len(glob_search_results) > 0:
+ return True
+ return False
+
+ if not hash_path_exist(src_path):
+ msg = "{} doesn't exist for {}".format(
+ src_path, repre["_id"])
+ report_items["Source file was not found"].append(msg)
+ return report_items, 0
+
+ delivery_templates = anatomy.templates.get("delivery") or {}
+ delivery_template = delivery_templates.get(template_name)
+ if delivery_template is None:
+ msg = (
+ "Delivery template \"{}\" in anatomy of project \"{}\""
+ " was not found"
+ ).format(template_name, anatomy.project_name)
+ report_items[""].append(msg)
+ return report_items, 0
+
+ # Check if 'frame' key is available in template which is required
+ # for sequence delivery
+ if "{frame" not in delivery_template:
+ msg = (
+ "Delivery template \"{}\" in anatomy of project \"{}\""
+ "does not contain '{{frame}}' key to fill. Delivery of sequence"
+ " can't be processed."
+ ).format(template_name, anatomy.project_name)
+ report_items[""].append(msg)
+ return report_items, 0
+
+ dir_path, file_name = os.path.split(str(src_path))
+
+ context = repre["context"]
+ ext = context.get("ext", context.get("representation"))
+
+ if not ext:
+ msg = "Source extension not found, cannot find collection"
+ report_items[msg].append(src_path)
+ log.warning("{} <{}>".format(msg, context))
+ return report_items, 0
+
+ ext = "." + ext
+ # context.representation could be .psd
+ ext = ext.replace("..", ".")
+
+ src_collections, remainder = clique.assemble(os.listdir(dir_path))
+ src_collection = None
+ for col in src_collections:
+ if col.tail != ext:
+ continue
+
+ src_collection = col
+ break
+
+ if src_collection is None:
+ msg = "Source collection of files was not found"
+ report_items[msg].append(src_path)
+ log.warning("{} <{}>".format(msg, src_path))
+ return report_items, 0
+
+ frame_indicator = "@####@"
+
+ anatomy_data["frame"] = frame_indicator
+ anatomy_filled = anatomy.format(anatomy_data)
+
+ if format_dict:
+ template_result = anatomy_filled["delivery"][template_name]
+ delivery_path = template_result.rootless.format(**format_dict)
+ else:
+ delivery_path = anatomy_filled["delivery"][template_name]
+
+ delivery_path = os.path.normpath(delivery_path.replace("\\", "/"))
+ delivery_folder = os.path.dirname(delivery_path)
+ dst_head, dst_tail = delivery_path.split(frame_indicator)
+ dst_padding = src_collection.padding
+ dst_collection = clique.Collection(
+ head=dst_head,
+ tail=dst_tail,
+ padding=dst_padding
+ )
+
+ if not os.path.exists(delivery_folder):
+ os.makedirs(delivery_folder)
+
+ src_head = src_collection.head
+ src_tail = src_collection.tail
+ uploaded = 0
+ for index in src_collection.indexes:
+ src_padding = src_collection.format("{padding}") % index
+ src_file_name = "{}{}{}".format(src_head, src_padding, src_tail)
+ src = os.path.normpath(
+ os.path.join(dir_path, src_file_name)
+ )
+
+ dst_padding = dst_collection.format("{padding}") % index
+ dst = "{}{}{}".format(dst_head, dst_padding, dst_tail)
+ log.debug("Copying single: {} -> {}".format(src, dst))
+ _copy_file(src, dst)
+ uploaded += 1
+
+ return report_items, uploaded
diff --git a/openpype/pipeline/load/__init__.py b/openpype/pipeline/load/__init__.py
index b6bdd13d50..bf38a0b3c8 100644
--- a/openpype/pipeline/load/__init__.py
+++ b/openpype/pipeline/load/__init__.py
@@ -1,6 +1,8 @@
from .utils import (
HeroVersionType,
+
IncompatibleLoaderError,
+ InvalidRepresentationContext,
get_repres_contexts,
get_subset_contexts,
@@ -20,6 +22,7 @@ from .utils import (
get_representation_path_from_context,
get_representation_path,
+ get_representation_path_with_anatomy,
is_compatible_loader,
@@ -46,7 +49,9 @@ from .plugins import (
__all__ = (
# utils.py
"HeroVersionType",
+
"IncompatibleLoaderError",
+ "InvalidRepresentationContext",
"get_repres_contexts",
"get_subset_contexts",
@@ -66,6 +71,7 @@ __all__ = (
"get_representation_path_from_context",
"get_representation_path",
+ "get_representation_path_with_anatomy",
"is_compatible_loader",
diff --git a/openpype/pipeline/load/utils.py b/openpype/pipeline/load/utils.py
index 99d6876d4b..83b904e4a7 100644
--- a/openpype/pipeline/load/utils.py
+++ b/openpype/pipeline/load/utils.py
@@ -23,6 +23,10 @@ from openpype.client import (
get_representation_by_name,
get_representation_parents
)
+from openpype.lib import (
+ StringTemplate,
+ TemplateUnsolved,
+)
from openpype.pipeline import (
schema,
legacy_io,
@@ -61,6 +65,11 @@ class IncompatibleLoaderError(ValueError):
pass
+class InvalidRepresentationContext(ValueError):
+ """Representation path can't be received using representation document."""
+ pass
+
+
def get_repres_contexts(representation_ids, dbcon=None):
"""Return parenthood context for representation.
@@ -515,6 +524,52 @@ def get_representation_path_from_context(context):
return get_representation_path(representation, root)
+def get_representation_path_with_anatomy(repre_doc, anatomy):
+ """Receive representation path using representation document and anatomy.
+
+ Anatomy is used to replace 'root' key in representation file. Ideally
+ should be used instead of 'get_representation_path' which is based on
+ "current context".
+
+ Future notes:
+ We want also be able store resources into representation and I can
+ imagine the result should also contain paths to possible resources.
+
+ Args:
+ repre_doc (Dict[str, Any]): Representation document.
+ anatomy (Anatomy): Project anatomy object.
+
+ Returns:
+ Union[None, TemplateResult]: None if path can't be received
+
+ Raises:
+ InvalidRepresentationContext: When representation data are probably
+ invalid or not available.
+ """
+
+ try:
+ template = repre_doc["data"]["template"]
+
+ except KeyError:
+ raise InvalidRepresentationContext((
+ "Representation document does not"
+ " contain template in data ('data.template')"
+ ))
+
+ try:
+ context = repre_doc["context"]
+ context["root"] = anatomy.roots
+ path = StringTemplate.format_strict_template(template, context)
+
+ except TemplateUnsolved as exc:
+ raise InvalidRepresentationContext((
+ "Couldn't resolve representation template with available data."
+ " Reason: {}".format(str(exc))
+ ))
+
+ return path.normalized()
+
+
def get_representation_path(representation, root=None, dbcon=None):
"""Get filename from representation document
@@ -533,8 +588,6 @@ def get_representation_path(representation, root=None, dbcon=None):
"""
- from openpype.lib import StringTemplate, TemplateUnsolved
-
if dbcon is None:
dbcon = legacy_io
@@ -737,6 +790,7 @@ def get_outdated_containers(host=None, project_name=None):
if host is None:
from openpype.pipeline import registered_host
+
host = registered_host()
if project_name is None:
diff --git a/openpype/pipeline/template_data.py b/openpype/pipeline/template_data.py
index 824a25127c..bab46a627d 100644
--- a/openpype/pipeline/template_data.py
+++ b/openpype/pipeline/template_data.py
@@ -28,27 +28,37 @@ def get_general_template_data(system_settings=None):
}
-def get_project_template_data(project_doc):
+def get_project_template_data(project_doc=None, project_name=None):
"""Extract data from project document that are used in templates.
Project document must have 'name' and (at this moment) optional
key 'data.code'.
+ One of 'project_name' or 'project_doc' must be passed. With prepared
+ project document is function much faster because don't have to query.
+
Output contains formatting keys:
- 'project[name]' - Project name
- 'project[code]' - Project code
Args:
project_doc (Dict[str, Any]): Queried project document.
+ project_name (str): Name of project.
Returns:
Dict[str, Dict[str, str]]: Template data based on project document.
"""
+ if not project_name:
+ project_name = project_doc["name"]
+
+ if not project_doc:
+ project_code = get_project(project_name, fields=["data.code"])
+
project_code = project_doc.get("data", {}).get("code")
return {
"project": {
- "name": project_doc["name"],
+ "name": project_name,
"code": project_code
}
}
diff --git a/openpype/pipeline/thumbnail.py b/openpype/pipeline/thumbnail.py
index eb383b16d9..39f3e17893 100644
--- a/openpype/pipeline/thumbnail.py
+++ b/openpype/pipeline/thumbnail.py
@@ -4,6 +4,7 @@ import logging
from openpype.client import get_project
from . import legacy_io
+from .anatomy import Anatomy
from .plugin_discover import (
discover,
register_plugin,
@@ -73,19 +74,20 @@ class ThumbnailResolver(object):
class TemplateResolver(ThumbnailResolver):
-
priority = 90
def process(self, thumbnail_entity, thumbnail_type):
-
- if not os.environ.get("AVALON_THUMBNAIL_ROOT"):
- return
-
template = thumbnail_entity["data"].get("template")
if not template:
self.log.debug("Thumbnail entity does not have set template")
return
+ thumbnail_root_format_key = "{thumbnail_root}"
+ thumbnail_root = os.environ.get("AVALON_THUMBNAIL_ROOT") or ""
+ # Check if template require thumbnail root and if is avaiable
+ if thumbnail_root_format_key in template and not thumbnail_root:
+ return
+
project_name = self.dbcon.active_project()
project = get_project(project_name, fields=["name", "data.code"])
@@ -95,12 +97,16 @@ class TemplateResolver(ThumbnailResolver):
template_data.update({
"_id": str(thumbnail_entity["_id"]),
"thumbnail_type": thumbnail_type,
- "thumbnail_root": os.environ.get("AVALON_THUMBNAIL_ROOT"),
+ "thumbnail_root": thumbnail_root,
"project": {
"name": project["name"],
"code": project["data"].get("code")
- }
+ },
})
+ # Add anatomy roots if is in template
+ if "{root" in template:
+ anatomy = Anatomy(project_name)
+ template_data["root"] = anatomy.roots
try:
filepath = os.path.normpath(template.format(**template_data))
diff --git a/openpype/pipeline/workfile/path_resolving.py b/openpype/pipeline/workfile/path_resolving.py
index ed1d1d793e..6d9e72dbd2 100644
--- a/openpype/pipeline/workfile/path_resolving.py
+++ b/openpype/pipeline/workfile/path_resolving.py
@@ -419,9 +419,14 @@ def get_custom_workfile_template(
# when path is available try to format it in case
# there are some anatomy template strings
if matching_item:
+ # extend anatomy context with os.environ to
+ # also allow formatting against env
+ full_context_data = os.environ.copy()
+ full_context_data.update(anatomy_context_data)
+
template = matching_item["path"][platform.system().lower()]
return StringTemplate.format_strict_template(
- template, anatomy_context_data
+ template, full_context_data
).normalized()
return None
diff --git a/openpype/plugins/load/delete_old_versions.py b/openpype/plugins/load/delete_old_versions.py
index 6e0b464cc1..b7ac015268 100644
--- a/openpype/plugins/load/delete_old_versions.py
+++ b/openpype/plugins/load/delete_old_versions.py
@@ -7,11 +7,15 @@ from pymongo import UpdateOne
import qargparse
from Qt import QtWidgets, QtCore
-from openpype.client import get_versions, get_representations
from openpype import style
-from openpype.pipeline import load, AvalonMongoDB, Anatomy
-from openpype.lib import StringTemplate
+from openpype.client import get_versions, get_representations
from openpype.modules import ModulesManager
+from openpype.lib import format_file_size
+from openpype.pipeline import load, AvalonMongoDB, Anatomy
+from openpype.pipeline.load import (
+ get_representation_path_with_anatomy,
+ InvalidRepresentationContext,
+)
class DeleteOldVersions(load.SubsetLoaderPlugin):
@@ -38,13 +42,6 @@ class DeleteOldVersions(load.SubsetLoaderPlugin):
)
]
- def sizeof_fmt(self, num, suffix='B'):
- for unit in ['', 'Ki', 'Mi', 'Gi', 'Ti', 'Pi', 'Ei', 'Zi']:
- if abs(num) < 1024.0:
- return "%3.1f%s%s" % (num, unit, suffix)
- num /= 1024.0
- return "%.1f%s%s" % (num, 'Yi', suffix)
-
def delete_whole_dir_paths(self, dir_paths, delete=True):
size = 0
@@ -80,27 +77,28 @@ class DeleteOldVersions(load.SubsetLoaderPlugin):
def path_from_representation(self, representation, anatomy):
try:
- template = representation["data"]["template"]
-
+ context = representation["context"]
except KeyError:
return (None, None)
+ try:
+ path = get_representation_path_with_anatomy(
+ representation, anatomy
+ )
+ except InvalidRepresentationContext:
+ return (None, None)
+
sequence_path = None
- try:
- context = representation["context"]
- context["root"] = anatomy.roots
- path = str(StringTemplate.format_template(template, context))
- if "frame" in context:
- context["frame"] = self.sequence_splitter
- sequence_path = os.path.normpath(str(
- StringTemplate.format_template(template, context)
- ))
+ if "frame" in context:
+ context["frame"] = self.sequence_splitter
+ sequence_path = get_representation_path_with_anatomy(
+ representation, anatomy
+ )
- except KeyError:
- # Template references unavailable data
- return (None, None)
+ if sequence_path:
+ sequence_path = sequence_path.normalized()
- return (os.path.normpath(path), sequence_path)
+ return (path.normalized(), sequence_path)
def delete_only_repre_files(self, dir_paths, file_paths, delete=True):
size = 0
@@ -456,7 +454,7 @@ class DeleteOldVersions(load.SubsetLoaderPlugin):
size += self.main(project_name, data, remove_publish_folder)
print("Progressing {}/{}".format(count + 1, len(contexts)))
- msg = "Total size of files: " + self.sizeof_fmt(size)
+ msg = "Total size of files: {}".format(format_file_size(size))
self.log.info(msg)
self.message(msg)
diff --git a/openpype/plugins/load/delivery.py b/openpype/plugins/load/delivery.py
index f6e1d4f06b..89c24f2402 100644
--- a/openpype/plugins/load/delivery.py
+++ b/openpype/plugins/load/delivery.py
@@ -7,15 +7,17 @@ from openpype.client import get_representations
from openpype.pipeline import load, Anatomy
from openpype import resources, style
-from openpype.lib.dateutils import get_datetime_data
-from openpype.lib.delivery import (
- sizeof_fmt,
- path_from_representation,
+from openpype.lib import (
+ format_file_size,
+ collect_frames,
+ get_datetime_data,
+)
+from openpype.pipeline.load import get_representation_path_with_anatomy
+from openpype.pipeline.delivery import (
get_format_dict,
check_destination_path,
- process_single_file,
- process_sequence,
- collect_frames
+ deliver_single_file,
+ deliver_sequence,
)
@@ -167,7 +169,9 @@ class DeliveryOptionsDialog(QtWidgets.QDialog):
if repre["name"] not in selected_repres:
continue
- repre_path = path_from_representation(repre, self.anatomy)
+ repre_path = get_representation_path_with_anatomy(
+ repre, self.anatomy
+ )
anatomy_data = copy.deepcopy(repre["context"])
new_report_items = check_destination_path(str(repre["_id"]),
@@ -202,7 +206,7 @@ class DeliveryOptionsDialog(QtWidgets.QDialog):
args[0] = src_path
if frame:
anatomy_data["frame"] = frame
- new_report_items, uploaded = process_single_file(*args)
+ new_report_items, uploaded = deliver_single_file(*args)
report_items.update(new_report_items)
self._update_progress(uploaded)
else: # fallback for Pype2 and representations without files
@@ -211,9 +215,9 @@ class DeliveryOptionsDialog(QtWidgets.QDialog):
repre["context"]["frame"] = len(str(frame)) * "#"
if not frame:
- new_report_items, uploaded = process_single_file(*args)
+ new_report_items, uploaded = deliver_single_file(*args)
else:
- new_report_items, uploaded = process_sequence(*args)
+ new_report_items, uploaded = deliver_sequence(*args)
report_items.update(new_report_items)
self._update_progress(uploaded)
@@ -263,8 +267,9 @@ class DeliveryOptionsDialog(QtWidgets.QDialog):
def _prepare_label(self):
"""Provides text with no of selected files and their size."""
- label = "{} files, size {}".format(self.files_selected,
- sizeof_fmt(self.size_selected))
+ label = "{} files, size {}".format(
+ self.files_selected,
+ format_file_size(self.size_selected))
return label
def _get_selected_repres(self):
diff --git a/openpype/plugins/publish/integrate_thumbnail.py b/openpype/plugins/publish/integrate_thumbnail.py
index 8ae0dd2d60..d86cec10ad 100644
--- a/openpype/plugins/publish/integrate_thumbnail.py
+++ b/openpype/plugins/publish/integrate_thumbnail.py
@@ -6,10 +6,9 @@ import copy
import six
import pyblish.api
-from bson.objectid import ObjectId
from openpype.client import get_version_by_id
-from openpype.pipeline import legacy_io
+from openpype.client.operations import OperationsSession, new_thumbnail_doc
class IntegrateThumbnails(pyblish.api.InstancePlugin):
@@ -24,13 +23,9 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
]
def process(self, instance):
-
- if not os.environ.get("AVALON_THUMBNAIL_ROOT"):
- self.log.warning(
- "AVALON_THUMBNAIL_ROOT is not set."
- " Skipping thumbnail integration."
- )
- return
+ env_key = "AVALON_THUMBNAIL_ROOT"
+ thumbnail_root_format_key = "{thumbnail_root}"
+ thumbnail_root = os.environ.get(env_key) or ""
published_repres = instance.data.get("published_representations")
if not published_repres:
@@ -51,6 +46,16 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
).format(project_name))
return
+ thumbnail_template = anatomy.templates["publish"]["thumbnail"]
+ if (
+ not thumbnail_root
+ and thumbnail_root_format_key in thumbnail_template
+ ):
+ self.log.warning((
+ "{} is not set. Skipping thumbnail integration."
+ ).format(env_key))
+ return
+
thumb_repre = None
thumb_repre_anatomy_data = None
for repre_info in published_repres.values():
@@ -66,10 +71,6 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
)
return
- legacy_io.install()
-
- thumbnail_template = anatomy.templates["publish"]["thumbnail"]
-
version = get_version_by_id(project_name, thumb_repre["parent"])
if not version:
raise AssertionError(
@@ -88,14 +89,15 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
filename, file_extension = os.path.splitext(src_full_path)
# Create id for mongo entity now to fill anatomy template
- thumbnail_id = ObjectId()
+ thumbnail_doc = new_thumbnail_doc()
+ thumbnail_id = thumbnail_doc["_id"]
# Prepare anatomy template fill data
template_data = copy.deepcopy(thumb_repre_anatomy_data)
template_data.update({
"_id": str(thumbnail_id),
- "thumbnail_root": os.environ.get("AVALON_THUMBNAIL_ROOT"),
"ext": file_extension[1:],
+ "thumbnail_root": thumbnail_root,
"thumbnail_type": "thumbnail"
})
@@ -117,8 +119,8 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
shutil.copy(src_full_path, dst_full_path)
# Clean template data from keys that are dynamic
- template_data.pop("_id")
- template_data.pop("thumbnail_root")
+ for key in ("_id", "thumbnail_root"):
+ template_data.pop(key, None)
repre_context = template_filled.used_values
for key in self.required_context_keys:
@@ -127,34 +129,40 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
continue
repre_context[key] = template_data[key]
- thumbnail_entity = {
- "_id": thumbnail_id,
- "type": "thumbnail",
- "schema": "openpype:thumbnail-1.0",
- "data": {
- "template": thumbnail_template,
- "template_data": repre_context
- }
+ op_session = OperationsSession()
+
+ thumbnail_doc["data"] = {
+ "template": thumbnail_template,
+ "template_data": repre_context
}
- # Create thumbnail entity
- legacy_io.insert_one(thumbnail_entity)
- self.log.debug(
- "Creating entity in database {}".format(str(thumbnail_entity))
+ op_session.create_entity(
+ project_name, thumbnail_doc["type"], thumbnail_doc
)
+ # Create thumbnail entity
+ self.log.debug(
+ "Creating entity in database {}".format(str(thumbnail_doc))
+ )
+
# Set thumbnail id for version
- legacy_io.update_many(
- {"_id": version["_id"]},
- {"$set": {"data.thumbnail_id": thumbnail_id}}
+ op_session.update_entity(
+ project_name,
+ version["type"],
+ version["_id"],
+ {"data.thumbnail_id": thumbnail_id}
)
self.log.debug("Setting thumbnail for version \"{}\" <{}>".format(
version["name"], str(version["_id"])
))
asset_entity = instance.data["assetEntity"]
- legacy_io.update_many(
- {"_id": asset_entity["_id"]},
- {"$set": {"data.thumbnail_id": thumbnail_id}}
+ op_session.update_entity(
+ project_name,
+ asset_entity["type"],
+ asset_entity["_id"],
+ {"data.thumbnail_id": thumbnail_id}
)
self.log.debug("Setting thumbnail for asset \"{}\" <{}>".format(
asset_entity["name"], str(version["_id"])
))
+
+ op_session.commit()
diff --git a/openpype/settings/defaults/project_settings/blender.json b/openpype/settings/defaults/project_settings/blender.json
index a7262dcb5d..2720e0286d 100644
--- a/openpype/settings/defaults/project_settings/blender.json
+++ b/openpype/settings/defaults/project_settings/blender.json
@@ -2,5 +2,69 @@
"workfile_builder": {
"create_first_version": false,
"custom_templates": []
+ },
+ "publish": {
+ "ValidateCameraZeroKeyframe": {
+ "enabled": true,
+ "optional": true,
+ "active": true
+ },
+ "ValidateMeshHasUvs": {
+ "enabled": true,
+ "optional": true,
+ "active": true
+ },
+ "ValidateMeshNoNegativeScale": {
+ "enabled": true,
+ "optional": false,
+ "active": true
+ },
+ "ValidateTransformZero": {
+ "enabled": true,
+ "optional": false,
+ "active": true
+ },
+ "ExtractBlend": {
+ "enabled": true,
+ "optional": true,
+ "active": true,
+ "families": [
+ "model",
+ "camera",
+ "rig",
+ "action",
+ "layout"
+ ]
+ },
+ "ExtractBlendAnimation": {
+ "enabled": true,
+ "optional": true,
+ "active": true
+ },
+ "ExtractCamera": {
+ "enabled": true,
+ "optional": true,
+ "active": true
+ },
+ "ExtractFBX": {
+ "enabled": true,
+ "optional": true,
+ "active": false
+ },
+ "ExtractAnimationFBX": {
+ "enabled": true,
+ "optional": true,
+ "active": false
+ },
+ "ExtractABC": {
+ "enabled": true,
+ "optional": true,
+ "active": false
+ },
+ "ExtractLayout": {
+ "enabled": true,
+ "optional": true,
+ "active": false
+ }
}
-}
\ No newline at end of file
+}
diff --git a/openpype/settings/defaults/project_settings/houdini.json b/openpype/settings/defaults/project_settings/houdini.json
index 911bf82d9b..b7d2104ba1 100644
--- a/openpype/settings/defaults/project_settings/houdini.json
+++ b/openpype/settings/defaults/project_settings/houdini.json
@@ -47,6 +47,18 @@
}
},
"publish": {
+ "ValidateWorkfilePaths": {
+ "enabled": true,
+ "optional": true,
+ "node_types": [
+ "file",
+ "alembic"
+ ],
+ "prohibited_vars": [
+ "$HIP",
+ "$JOB"
+ ]
+ },
"ValidateContainers": {
"enabled": true,
"optional": true,
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_blender.json b/openpype/settings/entities/schemas/projects_schema/schema_project_blender.json
index af09329a03..4c72ebda2f 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_blender.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_blender.json
@@ -12,6 +12,10 @@
"workfile_builder/builder_on_start",
"workfile_builder/profiles"
]
+ },
+ {
+ "type": "schema",
+ "name": "schema_blender_publish"
}
]
}
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_houdini.json b/openpype/settings/entities/schemas/projects_schema/schema_project_houdini.json
index cad99dde22..d8728c0f4b 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_houdini.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_houdini.json
@@ -10,22 +10,8 @@
"name": "schema_houdini_create"
},
{
- "type": "dict",
- "collapsible": true,
- "key": "publish",
- "label": "Publish plugins",
- "children": [
- {
- "type": "schema_template",
- "name": "template_publish_plugin",
- "template_data": [
- {
- "key": "ValidateContainers",
- "label": "ValidateContainers"
- }
- ]
- }
- ]
+ "type": "schema",
+ "name": "schema_houdini_publish"
}
]
}
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json
new file mode 100644
index 0000000000..58428ad60a
--- /dev/null
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_blender_publish.json
@@ -0,0 +1,113 @@
+{
+ "type": "dict",
+ "collapsible": true,
+ "key": "publish",
+ "label": "Publish plugins",
+ "children": [
+ {
+ "type": "label",
+ "label": "Validators"
+ },
+ {
+ "type": "schema_template",
+ "name": "template_publish_plugin",
+ "template_data": [
+ {
+ "key": "ValidateCameraZeroKeyframe",
+ "label": "Validate Camera Zero Keyframe"
+ }
+ ]
+ },
+ {
+ "type": "collapsible-wrap",
+ "label": "Model",
+ "children": [
+ {
+ "type": "schema_template",
+ "name": "template_publish_plugin",
+ "template_data": [
+ {
+ "key": "ValidateMeshHasUvs",
+ "label": "Validate Mesh Has UVs"
+ },
+ {
+ "key": "ValidateMeshNoNegativeScale",
+ "label": "Validate Mesh No Negative Scale"
+ },
+ {
+ "key": "ValidateTransformZero",
+ "label": "Validate Transform Zero"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "type": "splitter"
+ },
+ {
+ "type": "label",
+ "label": "Extractors"
+ },
+ {
+ "type": "dict",
+ "collapsible": true,
+ "key": "ExtractBlend",
+ "label": "Extract Blend",
+ "checkbox_key": "enabled",
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ },
+ {
+ "type": "boolean",
+ "key": "active",
+ "label": "Active"
+ },
+ {
+ "key": "families",
+ "label": "Families",
+ "type": "list",
+ "object_type": "text"
+ }
+ ]
+ },
+ {
+ "type": "schema_template",
+ "name": "template_publish_plugin",
+ "template_data": [
+ {
+ "key": "ExtractFBX",
+ "label": "Extract FBX (model and rig)"
+ },
+ {
+ "key": "ExtractABC",
+ "label": "Extract ABC (model and pointcache)"
+ },
+ {
+ "key": "ExtractBlendAnimation",
+ "label": "Extract Animation as Blend"
+ },
+ {
+ "key": "ExtractAnimationFBX",
+ "label": "Extract Animation as FBX"
+ },
+ {
+ "key": "ExtractCamera",
+ "label": "Extract FBX Camera as FBX"
+ },
+ {
+ "key": "ExtractLayout",
+ "label": "Extract Layout as JSON"
+ }
+ ]
+ }
+ ]
+}
diff --git a/openpype/settings/entities/schemas/projects_schema/schemas/schema_houdini_publish.json b/openpype/settings/entities/schemas/projects_schema/schemas/schema_houdini_publish.json
new file mode 100644
index 0000000000..aa6eaf5164
--- /dev/null
+++ b/openpype/settings/entities/schemas/projects_schema/schemas/schema_houdini_publish.json
@@ -0,0 +1,50 @@
+{
+ "type": "dict",
+ "collapsible": true,
+ "key": "publish",
+ "label": "Publish plugins",
+ "children": [
+ {
+ "type": "dict",
+ "collapsible": true,
+ "checkbox_key": "enabled",
+ "key": "ValidateWorkfilePaths",
+ "label": "Validate Workfile Paths",
+ "is_group": true,
+ "children": [
+ {
+ "type": "boolean",
+ "key": "enabled",
+ "label": "Enabled"
+ },
+ {
+ "type": "boolean",
+ "key": "optional",
+ "label": "Optional"
+ },
+ {
+ "key": "node_types",
+ "label": "Node types",
+ "type": "list",
+ "object_type": "text"
+ },
+ {
+ "key": "prohibited_vars",
+ "label": "Prohibited variables",
+ "type": "list",
+ "object_type": "text"
+ }
+ ]
+ },
+ {
+ "type": "schema_template",
+ "name": "template_publish_plugin",
+ "template_data": [
+ {
+ "key": "ValidateContainers",
+ "label": "ValidateContainers"
+ }
+ ]
+ }
+ ]
+}
\ No newline at end of file
diff --git a/openpype/version.py b/openpype/version.py
index 7894bb8bf4..963f9171e2 100644
--- a/openpype/version.py
+++ b/openpype/version.py
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
"""Package declaring Pype version."""
-__version__ = "3.14.1-nightly.3"
+__version__ = "3.14.1"
diff --git a/pyproject.toml b/pyproject.toml
index 75e4721d7f..2fe2573baf 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "OpenPype"
-version = "3.14.1-nightly.3" # OpenPype
+version = "3.14.1" # OpenPype
description = "Open VFX and Animation pipeline with support."
authors = ["OpenPype Team "]
license = "MIT License"