From 058fcb97a358a972d34a4cabd45773e249e15cf0 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 9 Jun 2023 17:51:54 +0800 Subject: [PATCH 001/198] multiple render camera supports for 3dsmax --- openpype/hosts/max/api/lib_rendersettings.py | 11 ++-------- .../hosts/max/plugins/create/create_render.py | 22 ++++++++++++++----- .../max/plugins/publish/collect_render.py | 5 +++++ .../plugins/publish/submit_max_deadline.py | 11 ++++++++++ 4 files changed, 34 insertions(+), 15 deletions(-) diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 91e4a5bf9b..db8dee3340 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -35,15 +35,8 @@ class RenderSettings(object): ) def set_render_camera(self, selection): - for sel in selection: - # to avoid Attribute Error from pymxs wrapper - found = False - if rt.classOf(sel) in rt.Camera.classes: - found = True - rt.viewport.setCamera(sel) - break - if not found: - raise RuntimeError("Camera not found") + # to avoid Attribute Error from pymxs wrapper + return rt.viewport.setCamera(selection[0]) def render_output(self, container): folder = rt.maxFilePath diff --git a/openpype/hosts/max/plugins/create/create_render.py b/openpype/hosts/max/plugins/create/create_render.py index 5ad895b86e..ec5635b81b 100644 --- a/openpype/hosts/max/plugins/create/create_render.py +++ b/openpype/hosts/max/plugins/create/create_render.py @@ -14,7 +14,10 @@ class CreateRender(plugin.MaxCreator): def create(self, subset_name, instance_data, pre_create_data): from pymxs import runtime as rt - sel_obj = list(rt.selection) + sel_obj = [ + c for c in rt.Objects + if rt.classOf(c) in rt.Camera.classes] + file = rt.maxFileName filename, _ = os.path.splitext(file) instance_data["AssetName"] = filename @@ -24,11 +27,20 @@ class CreateRender(plugin.MaxCreator): instance_data, pre_create_data) # type: CreatedInstance container_name = instance.data.get("instance_node") - container = rt.getNodeByName(container_name) # TODO: Disable "Add to Containers?" Panel # parent the selected cameras into the container - for obj in sel_obj: - obj.parent = container + if self.selected_nodes: + # set viewport camera for + # rendering(mandatory for deadline) + sel_obj = [ + c for c in rt.getCurrentSelection() + if rt.classOf(c) in rt.Camera.classes] + + if not sel_obj: + raise RuntimeError("Please add at least one camera to the scene " + "before creating the render instance") + + RenderSettings().set_render_camera(sel_obj) # for additional work on the node: # instance_node = rt.getNodeByName(instance.get("instance_node")) @@ -37,7 +49,5 @@ class CreateRender(plugin.MaxCreator): # Changing the Render Setup dialog settings should be done # with the actual Render Setup dialog in a closed state. - # set viewport camera for rendering(mandatory for deadline) - RenderSettings().set_render_camera(sel_obj) # set output paths for rendering(mandatory for deadline) RenderSettings().render_output(container_name) diff --git a/openpype/hosts/max/plugins/publish/collect_render.py b/openpype/hosts/max/plugins/publish/collect_render.py index db5c84fad9..cbb3a7b4d6 100644 --- a/openpype/hosts/max/plugins/publish/collect_render.py +++ b/openpype/hosts/max/plugins/publish/collect_render.py @@ -48,6 +48,10 @@ class CollectRender(pyblish.api.InstancePlugin): instance.name, asset_id) self.log.debug("version_doc: {0}".format(version_doc)) + sel_obj = [ + c for c in rt.Objects + if rt.classOf(c) in rt.Camera.classes] + version_int = 1 if version_doc: version_int += int(version_doc["name"]) @@ -78,6 +82,7 @@ class CollectRender(pyblish.api.InstancePlugin): "renderer": renderer, "source": filepath, "plugin": "3dsmax", + "cameras": sel_obj, "frameStart": int(rt.rendStart), "frameEnd": int(rt.rendEnd), "version": version_int, diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index b6a30e36b7..ff5adc39ad 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -212,6 +212,17 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, plugin_data["RenderOutput"] = beauty_name # as 3dsmax has version with different languages plugin_data["Language"] = "ENU" + render_cameras = instance.data["cameras"] + if render_cameras: + for i, camera in enumerate(render_cameras): + cam_name = "Camera%s" % (i + 1) + plugin_data[cam_name] = camera.name + # set the default camera + plugin_data["Camera"] = render_cameras[0].name + # set empty camera of Camera 0 for the ' + # correct parameter submission + plugin_data["Camera0"] = None + renderer_class = get_current_renderer() renderer = str(renderer_class).split(":")[0] From 5fc037880fa7ddee5c65d63679d1db2810469411 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 19 Jun 2023 17:33:16 +0800 Subject: [PATCH 002/198] refactor the collector and deadline for multiple camera --- openpype/hosts/max/plugins/publish/collect_render.py | 2 +- .../modules/deadline/plugins/publish/submit_max_deadline.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/collect_render.py b/openpype/hosts/max/plugins/publish/collect_render.py index cbb3a7b4d6..8e39da0fbb 100644 --- a/openpype/hosts/max/plugins/publish/collect_render.py +++ b/openpype/hosts/max/plugins/publish/collect_render.py @@ -49,7 +49,7 @@ class CollectRender(pyblish.api.InstancePlugin): asset_id) self.log.debug("version_doc: {0}".format(version_doc)) sel_obj = [ - c for c in rt.Objects + c.name for c in rt.Objects if rt.classOf(c) in rt.Camera.classes] version_int = 1 diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index ff5adc39ad..365be7b07b 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -216,9 +216,9 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, if render_cameras: for i, camera in enumerate(render_cameras): cam_name = "Camera%s" % (i + 1) - plugin_data[cam_name] = camera.name - # set the default camera - plugin_data["Camera"] = render_cameras[0].name + plugin_data[cam_name] = camera + # set the default camera + plugin_data["Camera"] = camera # set empty camera of Camera 0 for the ' # correct parameter submission plugin_data["Camera0"] = None From 6b716b8ce92d5e0466ecb92c03aad86e920b8217 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:16:52 +0800 Subject: [PATCH 003/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index a1039b9309..45d7d7134d 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -155,8 +155,8 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) elif renderer == "Redshift_Renderer": render_name = self.get_render_elements_name() @@ -169,15 +169,15 @@ class RenderProducts(object): if name == "RsCryptomatte": render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) else: for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) elif renderer == "Arnold": @@ -186,7 +186,7 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_arnold_product( - output_file, name, start_frame, end_frame, img_fmt) + output_file, name, start_frame, end_frame, img_fmt) }) elif renderer in [ "V_Ray_6_Hotfix_3", @@ -198,8 +198,8 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) # noqa + output_file, name, start_frame, + end_frame, img_fmt) # noqa }) return render_dict From e96bada178f11d8f24d1036746a3f3e519e95b84 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:23:03 +0800 Subject: [PATCH 004/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 44 ++++++++++--------- openpype/hosts/max/api/lib_rendersettings.py | 2 +- .../hosts/max/plugins/create/create_render.py | 2 +- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 45d7d7134d..433214935d 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -33,6 +33,7 @@ class RenderProducts(object): output_file, start_frame, end_frame, img_fmt ) } + def get_multiple_beauty(self, outputs, cameras): beauty_output_frames = dict() for output, camera in zip(outputs, cameras): @@ -68,9 +69,9 @@ class RenderProducts(object): for name in render_name: aovs_frames.update({ f"{camera}_{name}": ( - self.get_expected_render_elements( - filename, name, start_frame, - end_frame, ext) + self.get_expected_render_elements( + filename, name, start_frame, + end_frame, ext) ) }) elif renderer == "Redshift_Renderer": @@ -84,9 +85,9 @@ class RenderProducts(object): if name == "RsCryptomatte": aovs_frames.update({ f"{camera}_{name}": ( - self.get_expected_render_elements( - filename, name, start_frame, - end_frame, ext) + self.get_expected_render_elements( + filename, name, start_frame, + end_frame, ext) ) }) else: @@ -105,9 +106,9 @@ class RenderProducts(object): for name in render_name: aovs_frames.update({ f"{camera}_{name}": ( - self.get_expected_arnold_product( - filename, name, start_frame, - end_frame, ext) + self.get_expected_arnold_product( + filename, name, start_frame, + end_frame, ext) ) }) elif renderer in [ @@ -120,9 +121,9 @@ class RenderProducts(object): for name in render_name: aovs_frames.update({ f"{camera}_{name}": ( - self.get_expected_render_elements( - filename, name, start_frame, - end_frame, ext) + self.get_expected_render_elements( + filename, name, start_frame, + end_frame, ext) ) }) @@ -155,8 +156,8 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) elif renderer == "Redshift_Renderer": render_name = self.get_render_elements_name() @@ -169,15 +170,15 @@ class RenderProducts(object): if name == "RsCryptomatte": render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) else: for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) elif renderer == "Arnold": @@ -186,7 +187,8 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_arnold_product( - output_file, name, start_frame, end_frame, img_fmt) + output_file, name, start_frame, + end_frame, img_fmt) }) elif renderer in [ "V_Ray_6_Hotfix_3", @@ -198,8 +200,8 @@ class RenderProducts(object): for name in render_name: render_dict.update({ name: self.get_expected_render_elements( - output_file, name, start_frame, - end_frame, img_fmt) # noqa + output_file, name, start_frame, + end_frame, img_fmt) # noqa }) return render_dict diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 663f610e45..33cfc6dc4a 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -192,7 +192,7 @@ class RenderSettings(object): renderlayer = rt.batchRenderMgr.GetView(layer_no) # use camera name as renderlayer name renderlayer.name = cam - renderlayer.outputFilename ="{0}_{1}..{2}".format( + renderlayer.outputFilename = "{0}_{1}..{2}".format( output, cam, img_fmt) outputs.append(renderlayer.outputFilename) return outputs diff --git a/openpype/hosts/max/plugins/create/create_render.py b/openpype/hosts/max/plugins/create/create_render.py index 64e97fb941..23397e1a98 100644 --- a/openpype/hosts/max/plugins/create/create_render.py +++ b/openpype/hosts/max/plugins/create/create_render.py @@ -17,7 +17,7 @@ class CreateRender(plugin.MaxCreator): file = rt.maxFileName filename, _ = os.path.splitext(file) instance_data["AssetName"] = filename - num_of_renderlayer = rt.batchRenderMgr.numViews + num_of_renderlayer = rt.batchRenderMgr.numViews if num_of_renderlayer > 0: rt.batchRenderMgr.DeleteView(num_of_renderlayer) From 9ce0d97e48d4313b3d50d6edab36ab3608a98799 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:28:08 +0800 Subject: [PATCH 005/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 433214935d..d2d5fb08da 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -77,7 +77,7 @@ class RenderProducts(object): elif renderer == "Redshift_Renderer": render_name = self.get_render_elements_name() if render_name: - rs_aov_files = rt.Execute("renderers.current.separateAovFiles") + rs_aov_files = rt.Execute("renderers.current.separateAovFiles") # noqa # this doesn't work, always returns False # rs_AovFiles = rt.RedShift_Renderer().separateAovFiles if ext == "exr" and not rs_aov_files: @@ -97,9 +97,8 @@ class RenderProducts(object): self.get_expected_render_elements( filename, name, start_frame, end_frame, ext) - ) - }) - + ) + }) elif renderer == "Arnold": render_name = self.get_arnold_product_name() if render_name: From b182f29c90dd8810ab130331ad370e58fc21ab38 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:32:25 +0800 Subject: [PATCH 006/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 24 ++++++-------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index d2d5fb08da..03dfcf3345 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -68,11 +68,9 @@ class RenderProducts(object): if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": ( - self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_render_elements( filename, name, start_frame, end_frame, ext) - ) }) elif renderer == "Redshift_Renderer": render_name = self.get_render_elements_name() @@ -84,31 +82,25 @@ class RenderProducts(object): for name in render_name: if name == "RsCryptomatte": aovs_frames.update({ - f"{camera}_{name}": ( - self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_render_elements( filename, name, start_frame, end_frame, ext) - ) }) else: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": ( - self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_render_elements( filename, name, start_frame, end_frame, ext) - ) }) elif renderer == "Arnold": render_name = self.get_arnold_product_name() if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": ( - self.get_expected_arnold_product( + f"{camera}_{name}": self.get_expected_arnold_product( filename, name, start_frame, end_frame, ext) - ) }) elif renderer in [ "V_Ray_6_Hotfix_3", @@ -119,11 +111,9 @@ class RenderProducts(object): if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": ( - self.get_expected_render_elements( - filename, name, start_frame, - end_frame, ext) - ) + f"{camera}_{name}": self.get_expected_render_elements( + filename, name, start_frame, + end_frame, ext) }) return aovs_frames From 4c01e09ef9d3ae8f4fb67b724e9c227e9afaa7f1 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:35:01 +0800 Subject: [PATCH 007/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 24 ++++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 03dfcf3345..59417a39fa 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -68,7 +68,7 @@ class RenderProducts(object): if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_aovs( filename, name, start_frame, end_frame, ext) }) @@ -82,14 +82,14 @@ class RenderProducts(object): for name in render_name: if name == "RsCryptomatte": aovs_frames.update({ - f"{camera}_{name}": self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_aovs( filename, name, start_frame, end_frame, ext) }) else: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": self.get_expected_render_elements( + f"{camera}_{name}": self.get_expected_aovs( filename, name, start_frame, end_frame, ext) }) @@ -111,9 +111,9 @@ class RenderProducts(object): if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": self.get_expected_render_elements( - filename, name, start_frame, - end_frame, ext) + f"{camera}_{name}": self.get_expected_aovs( + filename, name, start_frame, + end_frame, ext) }) return aovs_frames @@ -144,7 +144,7 @@ class RenderProducts(object): if render_name: for name in render_name: render_dict.update({ - name: self.get_expected_render_elements( + name: self.get_expected_aovs( output_file, name, start_frame, end_frame, img_fmt) }) @@ -158,14 +158,14 @@ class RenderProducts(object): for name in render_name: if name == "RsCryptomatte": render_dict.update({ - name: self.get_expected_render_elements( + name: self.get_expected_aovs( output_file, name, start_frame, end_frame, img_fmt) }) else: for name in render_name: render_dict.update({ - name: self.get_expected_render_elements( + name: self.get_expected_aovs( output_file, name, start_frame, end_frame, img_fmt) }) @@ -188,7 +188,7 @@ class RenderProducts(object): if render_name: for name in render_name: render_dict.update({ - name: self.get_expected_render_elements( + name: self.get_expected_aovs( output_file, name, start_frame, end_frame, img_fmt) # noqa }) @@ -251,8 +251,8 @@ class RenderProducts(object): return render_name - def get_expected_render_elements(self, folder, name, - start_frame, end_frame, fmt): + def get_expected_aovs(self, folder, name, + start_frame, end_frame, fmt): """Get all the expected render element output files. """ render_elements = [] for f in range(start_frame, end_frame): From 9f90e3a1f15bba7e26303d3fafee5ef5d9bd238e Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 12 Jul 2023 19:35:57 +0800 Subject: [PATCH 008/198] hound fix --- openpype/hosts/max/api/lib_renderproducts.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 59417a39fa..0b8c53dfa0 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -98,7 +98,7 @@ class RenderProducts(object): if render_name: for name in render_name: aovs_frames.update({ - f"{camera}_{name}": self.get_expected_arnold_product( + f"{camera}_{name}": self.get_expected_arnold_product( # noqa filename, name, start_frame, end_frame, ext) }) From c81818d09509b6b85e3259e6bac362717aa1ca1c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 14 Jul 2023 20:25:49 +0800 Subject: [PATCH 009/198] add multi camera options for render creator --- openpype/hosts/max/api/lib_rendersettings.py | 6 +-- .../hosts/max/plugins/create/create_render.py | 19 ++++++++ .../max/plugins/publish/collect_render.py | 46 ++++++++++--------- 3 files changed, 47 insertions(+), 24 deletions(-) diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 33cfc6dc4a..18160c66a0 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -177,8 +177,8 @@ class RenderSettings(object): render_element_list.append(aov_name) return render_element_list - def create_batch_render_layer(self, container, - output_dir, cameras): + def batch_render_layer(self, container, + output_dir, cameras): outputs = list() output = os.path.join(output_dir, container) img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"] # noqa @@ -186,7 +186,7 @@ class RenderSettings(object): camera = rt.getNodeByName(cam) layer_no = rt.batchRenderMgr.FindView(cam) renderlayer = None - if layer_no is None: + if layer_no == 0: renderlayer = rt.batchRenderMgr.CreateView(camera) else: renderlayer = rt.batchRenderMgr.GetView(layer_no) diff --git a/openpype/hosts/max/plugins/create/create_render.py b/openpype/hosts/max/plugins/create/create_render.py index 23397e1a98..617334753a 100644 --- a/openpype/hosts/max/plugins/create/create_render.py +++ b/openpype/hosts/max/plugins/create/create_render.py @@ -2,6 +2,7 @@ """Creator plugin for creating camera.""" import os from openpype.hosts.max.api import plugin +from openpype.lib import BoolDef from openpype.hosts.max.api.lib_rendersettings import RenderSettings @@ -17,6 +18,7 @@ class CreateRender(plugin.MaxCreator): file = rt.maxFileName filename, _ = os.path.splitext(file) instance_data["AssetName"] = filename + instance_data["multiCamera"] = pre_create_data.get("multi_cam") num_of_renderlayer = rt.batchRenderMgr.numViews if num_of_renderlayer > 0: rt.batchRenderMgr.DeleteView(num_of_renderlayer) @@ -29,3 +31,20 @@ class CreateRender(plugin.MaxCreator): container_name = instance.data.get("instance_node") # set output paths for rendering(mandatory for deadline) RenderSettings().render_output(container_name) + # TODO: create multiple camera options + if self.selected_nodes: + selected_nodes_name = [] + for sel in self.selected_nodes: + name = sel.name + selected_nodes_name.append(name) + RenderSettings().batch_render_layer( + container_name, filename, + selected_nodes_name) + + def get_pre_create_attr_defs(self): + attrs = super(CreateRender, self).get_pre_create_attr_defs() + return attrs + [ + BoolDef("multi_cam", + label="Multiple Cameras Submission", + default=False), + ] diff --git a/openpype/hosts/max/plugins/publish/collect_render.py b/openpype/hosts/max/plugins/publish/collect_render.py index 736ffa5865..ca2f2f444f 100644 --- a/openpype/hosts/max/plugins/publish/collect_render.py +++ b/openpype/hosts/max/plugins/publish/collect_render.py @@ -26,22 +26,7 @@ class CollectRender(pyblish.api.InstancePlugin): file = rt.maxFileName current_file = os.path.join(folder, file) filepath = current_file.replace("\\", "/") - container_name = instance.data.get("instance_node") context.data['currentFile'] = current_file - cameras = instance.data.get("members") - sel_cam = [ - c.name for c in cameras - if rt.classOf(c) in rt.Camera.classes] - render_dir = os.path.dirname(rt.rendOutputFilename) - outputs = RenderSettings().create_batch_render_layer( - container_name, render_dir, sel_cam - ) - aov_outputs = RenderSettings().get_batch_render_elements( - container_name, render_dir, sel_cam - ) - files_aov = RenderProducts().get_multiple_beauty(outputs, cameras) - aovs = RenderProducts().get_multiple_aovs(outputs, cameras) - files_aov.update(aovs) asset = get_current_asset_name() files_by_aov = RenderProducts().get_beauty(instance.name) @@ -49,11 +34,33 @@ class CollectRender(pyblish.api.InstancePlugin): aovs = RenderProducts().get_aovs(instance.name) files_by_aov.update(aovs) + if instance.data.get("multiCamera"): + cameras = instance.data.get("members") + if not cameras: + raise RuntimeError("There should be at least" + " one renderable camera in container") + sel_cam = [ + c.name for c in cameras + if rt.classOf(c) in rt.Camera.classes] + container_name = instance.data.get("instance_node") + render_dir = os.path.dirname(rt.rendOutputFilename) + outputs = RenderSettings().batch_render_layer( + container_name, render_dir, sel_cam + ) + + instance.data["cameras"] = sel_cam + + files_by_aov = RenderProducts().get_multiple_beauty( + outputs, sel_cam) + aovs = RenderProducts().get_multiple_aovs( + outputs, sel_cam) + files_by_aov.update(aovs) + if "expectedFiles" not in instance.data: instance.data["expectedFiles"] = list() instance.data["files"] = list() - instance.data["expectedFiles"].append(files_aov) - instance.data["files"].append(files_aov) + instance.data["expectedFiles"].append(files_by_aov) + instance.data["files"].append(files_by_aov) img_format = RenderProducts().image_format() project_name = context.data["projectName"] @@ -94,13 +101,10 @@ class CollectRender(pyblish.api.InstancePlugin): "renderer": renderer, "source": filepath, "plugin": "3dsmax", - "cameras": sel_cam, "frameStart": int(rt.rendStart), "frameEnd": int(rt.rendEnd), "version": version_int, - "farm": True, - "renderoutput": outputs, - "aovoutput": aov_outputs + "farm": True } instance.data.update(data) From 22524c1d8473226b7687626b30b34ab237708fb5 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 17 Jul 2023 17:22:09 +0800 Subject: [PATCH 010/198] add option for multiple job and plugin infos --- openpype/hosts/max/api/lib_rendersettings.py | 21 ++-- .../deadline/abstract_submit_deadline.py | 25 ++++ .../plugins/publish/submit_max_deadline.py | 113 +++++++++++++++--- 3 files changed, 136 insertions(+), 23 deletions(-) diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 18160c66a0..f2294fbf95 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -160,7 +160,7 @@ class RenderSettings(object): return orig_render_elem def get_batch_render_elements(self, container, - output_dir, cameras): + output_dir, camera): render_element_list = list() output = os.path.join(output_dir, container) render_elem = rt.maxOps.GetCurRenderElementMgr() @@ -168,15 +168,20 @@ class RenderSettings(object): if render_elem_num < 0: return img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"] # noqa - for cam in cameras: - for i in range(render_elem_num): - renderlayer_name = render_elem.GetRenderElement(i) - target, renderpass = str(renderlayer_name).split(":") - aov_name = "{0}_{1}_{2}..{3}".format( - output, cam, renderpass, img_fmt) - render_element_list.append(aov_name) + + for i in range(render_elem_num): + renderlayer_name = render_elem.GetRenderElement(i) + target, renderpass = str(renderlayer_name).split(":") + aov_name = "{0}_{1}_{2}..{3}".format( + output, camera, renderpass, img_fmt) + render_element_list.append(aov_name) return render_element_list + def get_batch_render_output(self, camera): + target_layer_no = rt.batchRenderMgr.FindView(camera) + target_layer = rt.batchRenderMgr.GetView(target_layer_no) + return target_layer.outputFilename + def batch_render_layer(self, container, output_dir, cameras): outputs = list() diff --git a/openpype/modules/deadline/abstract_submit_deadline.py b/openpype/modules/deadline/abstract_submit_deadline.py index 551a2f7373..de6babf555 100644 --- a/openpype/modules/deadline/abstract_submit_deadline.py +++ b/openpype/modules/deadline/abstract_submit_deadline.py @@ -592,6 +592,31 @@ class AbstractSubmitDeadline(pyblish.api.InstancePlugin, return file_path + def get_job_info_through_camera(self, camera=None): + """Get the job parameters for deadline submission when + multi-camera is enabled. + Args: + infos(dict): a dictionary with job info. + """ + pass + + def get_plugin_info_through_camera(self, camera=None): + """Get the plugin parameters for deadline submission when + multi-camera is enabled. + Args: + infos(dict): a dictionary with plugin info. + """ + pass + + def _use_published_name_for_multiples(self, data): + """Process the parameters submission for deadline when + user enables multi-cameras option. + Args: + job_info_list (list): A list of multiple job infos + plugin_info_list (list): A list of multiple plugin infos + """ + pass + def assemble_payload( self, job_info=None, plugin_info=None, aux_files=None): """Assemble payload data from its various parts. diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 365be7b07b..6bbc956f55 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -56,7 +56,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, cls.priority) cls.chuck_size = settings.get("chunk_size", cls.chunk_size) cls.group = settings.get("group", cls.group) - + # TODO: multiple camera instance, separate job infos def get_job_info(self): job_info = DeadlineJobInfo(Plugin="3dsmax") @@ -73,7 +73,6 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, src_filepath = context.data["currentFile"] src_filename = os.path.basename(src_filepath) - job_info.Name = "%s - %s" % (src_filename, instance.name) job_info.BatchName = src_filename job_info.Plugin = instance.data["plugin"] @@ -179,9 +178,19 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, } self.log.debug("Submitting 3dsMax render..") - payload = self._use_published_name(payload_data) - job_info, plugin_info = payload - self.submit(self.assemble_payload(job_info, plugin_info)) + #TODO: multiple camera options + if instance.data.get("multiCamera"): + payload = self._use_published_name_for_multiples(payload_data) + job_infos, plugin_infos = payload + for job_info, plugin_info in zip(job_infos, plugin_infos): + self.log.debug(f"job_info: {job_info}") + self.log.debug(f"plugin_info: {plugin_info}") + submission = self.assemble_payload(job_info, plugin_info) + self.submit(submission) + else: + payload = self._use_published_name(payload_data) + job_info, plugin_info = payload + self.submit(self.assemble_payload(job_info, plugin_info)) def _use_published_name(self, data): instance = self._instance @@ -212,16 +221,6 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, plugin_data["RenderOutput"] = beauty_name # as 3dsmax has version with different languages plugin_data["Language"] = "ENU" - render_cameras = instance.data["cameras"] - if render_cameras: - for i, camera in enumerate(render_cameras): - cam_name = "Camera%s" % (i + 1) - plugin_data[cam_name] = camera - # set the default camera - plugin_data["Camera"] = camera - # set empty camera of Camera 0 for the ' - # correct parameter submission - plugin_data["Camera0"] = None renderer_class = get_current_renderer() @@ -250,6 +249,90 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, return job_info, plugin_info + def get_job_info_through_camera(self, camera): + instance = self._instance + context = instance.context + job_info = copy.deepcopy(self.job_info) + exp = instance.data.get("expectedFiles") + + src_filepath = context.data["currentFile"] + src_filename = os.path.basename(src_filepath) + job_info.Name = "%s - %s - %s" % ( + src_filename, instance.name, camera) + for filepath in self._iter_expected_files(exp): + if camera not in filepath: + continue + job_info.OutputDirectory += os.path.dirname(filepath) + job_info.OutputFilename += os.path.basename(filepath) + + return job_info + # set the output filepath with the relative camera + + def get_plugin_info_through_camera(self, camera): + instance = self._instance + # set the target camera + plugin_info = copy.deepcopy(self.plugin_info) + plugin_data = {} + # set the output filepath with the relative camera + files = instance.data.get("expectedFiles") + if not files: + raise RuntimeError("No render elements found") + first_file = next(self._iter_expected_files(files)) + old_output_dir = os.path.dirname(first_file) + rgb_output = RenderSettings().get_batch_render_output(camera) # noqa + rgb_bname = os.path.basename(rgb_output) + dir = os.path.dirname(first_file) + beauty_name = f"{dir}/{rgb_bname}" + beauty_name = beauty_name.replace("\\", "/") + plugin_info["RenderOutput"] = beauty_name + renderer_class = get_current_renderer() + + renderer = str(renderer_class).split(":")[0] + if renderer in [ + "ART_Renderer", + "Redshift_Renderer", + "V_Ray_6_Hotfix_3", + "V_Ray_GPU_6_Hotfix_3", + "Default_Scanline_Renderer", + "Quicksilver_Hardware_Renderer", + ]: + render_elem_list = RenderSettings().get_batch_render_elements( + instance.name, old_output_dir, camera + ) + for i, element in enumerate(render_elem_list): + elem_bname = os.path.basename(element) + new_elem = f"{dir}/{elem_bname}" + new_elem = new_elem.replace("/", "\\") + plugin_info["RenderElementOutputFilename%d" % i] = new_elem # noqa + + if camera: + # set the default camera + plugin_data["Camera"] = camera + + plugin_data["Camera0"] = None + + plugin_info.update(plugin_data) + return plugin_info + + def _use_published_name_for_multiples(self, data): + """Process the parameters submission for deadline when + user enables multi-cameras option. + Args: + job_info_list (list): A list of multiple job infos + plugin_info_list (list): A list of multiple plugin infos + """ + job_info_list = [] + plugin_info_list = [] + instance = self._instance + cameras = instance.data.get("cameras", []) + for cam in cameras: + job_info = self.get_job_info_through_camera(cam) + plugin_info = self.get_plugin_info_through_camera(cam) + job_info_list.append(job_info) + plugin_info_list.append(plugin_info) + + return job_info_list, plugin_info_list + def from_published_scene(self, replace_in_path=True): instance = self._instance if instance.data["renderer"] == "Redshift_Renderer": From 5ad81ea6bff0544cffdf7abe04a29eb64d8ec58c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 17 Jul 2023 17:44:24 +0800 Subject: [PATCH 011/198] make sure camera parameters are being collected accurately --- .../plugins/publish/submit_max_deadline.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 6bbc956f55..23a2b4c679 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -131,11 +131,11 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, # Add list of expected files to job # --------------------------------- - exp = instance.data.get("expectedFiles") - - for filepath in self._iter_expected_files(exp): - job_info.OutputDirectory += os.path.dirname(filepath) - job_info.OutputFilename += os.path.basename(filepath) + if not instance.data.get("multiCamera"): + exp = instance.data.get("expectedFiles") + for filepath in self._iter_expected_files(exp): + job_info.OutputDirectory += os.path.dirname(filepath) + job_info.OutputFilename += os.path.basename(filepath) return job_info @@ -178,7 +178,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, } self.log.debug("Submitting 3dsMax render..") - #TODO: multiple camera options + if instance.data.get("multiCamera"): payload = self._use_published_name_for_multiples(payload_data) job_infos, plugin_infos = payload @@ -306,9 +306,10 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, plugin_info["RenderElementOutputFilename%d" % i] = new_elem # noqa if camera: - # set the default camera + # set the default camera and target camera + # (weird parameters from max) plugin_data["Camera"] = camera - + plugin_data["Camera1"] = camera plugin_data["Camera0"] = None plugin_info.update(plugin_data) From f5c8994fa31039b0549eddaa7bbe5ec8e5c3cee8 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 17 Jul 2023 20:21:34 +0800 Subject: [PATCH 012/198] get the correct naming for all render outputs --- openpype/hosts/max/api/lib_renderproducts.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 5446e4fca3..863dccd99e 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -41,6 +41,8 @@ class RenderProducts(object): beauty_output_frames = dict() for output, camera in zip(outputs, cameras): filename, ext = os.path.splitext(output) + filename = filename.replace(".", "") + ext = ext.replace(".", "") start_frame = int(rt.rendStart) end_frame = int(rt.rendEnd) + 1 new_beauty = self.get_expected_beauty( @@ -57,6 +59,8 @@ class RenderProducts(object): aovs_frames = {} for output, camera in zip(outputs, cameras): filename, ext = os.path.splitext(output) + filename = filename.replace(".", "") + ext = ext.replace(".", "") start_frame = int(rt.rendStart) end_frame = int(rt.rendEnd) + 1 From 523ad0519dcbe52d4821d0981ddc4cc6962aaf60 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 17 Jul 2023 20:44:29 +0800 Subject: [PATCH 013/198] get all beauty as expected files in a correct manner --- openpype/hosts/max/api/lib_renderproducts.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/max/api/lib_renderproducts.py b/openpype/hosts/max/api/lib_renderproducts.py index 863dccd99e..eaf5015ba8 100644 --- a/openpype/hosts/max/api/lib_renderproducts.py +++ b/openpype/hosts/max/api/lib_renderproducts.py @@ -48,9 +48,10 @@ class RenderProducts(object): new_beauty = self.get_expected_beauty( filename, start_frame, end_frame, ext ) - beauty_output_frames = ({ + beauty_output = ({ f"{camera}_beauty": new_beauty }) + beauty_output_frames.update(beauty_output) return beauty_output_frames def get_multiple_aovs(self, outputs, cameras): From 3bb7f871d452fdef0e46db3a92518e8dd8d94afe Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 18 Jul 2023 17:57:04 +0800 Subject: [PATCH 014/198] bug fix camera instance doesn't include anything --- .../deadline/plugins/publish/submit_publish_job.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_job.py index 01a5c55286..1665a05f1e 100644 --- a/openpype/modules/deadline/plugins/publish/submit_publish_job.py +++ b/openpype/modules/deadline/plugins/publish/submit_publish_job.py @@ -361,7 +361,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, self.log.info("Submitting Deadline job ...") url = "{}/api/jobs".format(self.deadline_url) - response = requests.post(url, json=payload, timeout=10) + response = requests.post(url, json=payload, timeout=10, verify=False) if not response.ok: raise Exception(response.text) @@ -472,6 +472,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, host_name = self.context.data["hostName"] subset = instance_data["subset"] cameras = instance_data.get("cameras", []) + self.log.info(f"camera: {cameras}") instances = [] # go through aovs in expected files for aov, files in exp_files[0].items(): @@ -497,7 +498,8 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, task[0].upper(), task[1:], subset[0].upper(), subset[1:]) - cam = [c for c in cameras if c in col.head] + cam = [c for c in cameras if c in cols[0].head] + self.log.debug(f"cam: {cam}") if cam: if aov: subset_name = '{}_{}_{}'.format(group_name, cam, aov) @@ -898,6 +900,12 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, for v in values: instance_skeleton_data[v] = instance.data.get(v) + # if there are cameras, get the camera + # ]data for instance_skeleton_data + cameras = instance.data.get("cameras") + if cameras: + instance_skeleton_data["cameras"] = cameras + # look into instance data if representations are not having any # which are having tag `publish_on_farm` and include them for repre in instance.data.get("representations", []): From f349e720b09c78e6541eb7b10d6eb31f9020b425 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 20 Jul 2023 23:45:08 +0800 Subject: [PATCH 015/198] exporting camera scene through instanceplugin by subprocess --- openpype/hosts/max/api/lib_rendersettings.py | 18 +++ .../publish/save_scenes_for_cameras.py | 110 ++++++++++++++++++ 2 files changed, 128 insertions(+) create mode 100644 openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 0a6f6569bf..2d453b9712 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -182,6 +182,24 @@ class RenderSettings(object): target_layer = rt.batchRenderMgr.GetView(target_layer_no) return target_layer.outputFilename + def batch_render_elements(self, camera): + target_layer_no = rt.batchRenderMgr.FindView(camera) + target_layer = rt.batchRenderMgr.GetView(target_layer_no) + outputfilename = target_layer.outputFilename + directory = os.path.dirname(outputfilename) + render_elem = rt.maxOps.GetCurRenderElementMgr() + render_elem_num = render_elem.NumRenderElements() + if render_elem_num < 0: + return + ext = self._project_settings["max"]["RenderSettings"]["image_format"] # noqa + + for i in range(render_elem_num): + renderlayer_name = render_elem.GetRenderElement(i) + target, renderpass = str(renderlayer_name).split(":") + aov_name = "{0}_{1}_{2}..{3}".format( + directory, camera, renderpass, ext) + render_elem.SetRenderElementFileName(i, aov_name) + def batch_render_layer(self, container, output_dir, cameras): outputs = list() diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py new file mode 100644 index 0000000000..d3357ba478 --- /dev/null +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -0,0 +1,110 @@ +import pyblish.api +import os +import sys +import tempfile + +from pymxs import runtime as rt +from openpype.lib import run_subprocess +from openpype.hosts.max.api.lib import get_max_version +from openpype.hosts.max.api.lib_rendersettings import RenderSettings +from openpype.hosts.max.api.lib_renderproducts import RenderProducts + + +class SaveScenesForCamera(pyblish.api.InstancePlugin): + """Save scene files for multiple cameras before + deadline submission + + """ + + label = "Save Scene files for cameras" + order = pyblish.api.ExtractorOrder - 0.48 + hosts = ["max"] + families = ["maxrender", "workfile"] + + def process(self, instance): + if not instance.data.get("multiCamera"): + self.log.debug("Skipping instance...") + return + current_folder = rt.maxFilePath + current_filename = rt.maxFileName + current_filepath = os.path.join(current_folder, current_filename) + camera_scene_files = [] + repres_list = [] + scripts = [] + filename, ext = os.path.splitext(current_filename) + fmt = RenderProducts().image_format() + cameras = instance.data.get("cameras") + if not cameras: + return + new_folder = "{}_{}".format(current_folder, filename) + os.makedirs(new_folder, exist_ok=True) + for camera in cameras: + new_output = RenderSettings().get_batch_render_output(camera) # noqa + new_output = new_output.replace("\\", "/") + new_filename = "{}_{}{}".format( + filename, camera, ext) + new_filepath = os.path.join(new_folder, new_filename) + new_filepath = new_filepath.replace("\\", "/") + camera_scene_files.append(new_filepath) + RenderSettings().batch_render_elements(camera) + rt.rendOutputFilename = new_output + rt.saveMaxFile(current_filepath) + script = (""" +from pymxs import runtime as rt +import os +new_filepath = "{new_filepath}" +new_output = "{new_output}" +camera = "{camera}" +rt.rendOutputFilename = new_output +directory = os.path.dirname(new_output) +render_elem = rt.maxOps.GetCurRenderElementMgr() +render_elem_num = render_elem.NumRenderElements() +if render_elem_num > 0: + ext = "{ext}" + for i in range(render_elem_num): + renderlayer_name = render_elem.GetRenderElement(i) + target, renderpass = str(renderlayer_name).split(":") + aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext + render_elem.SetRenderElementFileName(i, aov_name) +rt.saveMaxFile(new_filepath) + """).format(new_filepath=new_filepath, + new_output=new_output, + camera=camera, + ext=fmt) + scripts.append(script) + + max_version = get_max_version() + maxBatch_exe = os.path.join(os.getenv(f"ADSK_3DSMAX_x64_{max_version}"), "3dsmaxbatch") + maxBatch_exe = maxBatch_exe.replace("\\", "/") + if sys.platform == "windows": + maxBatch_exe += ".exe" + maxBatch_exe = os.path.normpath(maxBatch_exe) + with tempfile.TemporaryDirectory() as tmp_dir_name: + tmp_script_path = os.path.join(tmp_dir_name, "extract_scene_files.py") + log_file =os.path.join(tmp_dir_name, "fatal.log") + self.log.info("Using script file: {}".format(tmp_script_path)) + + with open(tmp_script_path, "wt") as tmp: + for script in scripts: + tmp.write(script+"\n") + tmp.write("rt.quitMax(quiet=True)"+"\n") + tmp.write("import time"+"\n") + tmp.write("time.sleep(3)") + + try: + current_filepath = current_filepath.replace("\\","/") + log_file = log_file.replace("\\", "/") + tmp_script_path = tmp_script_path.replace("\\","/") + run_subprocess([maxBatch_exe, tmp_script_path, + "-sceneFile", current_filepath]) + except RuntimeError: + self.log.debug("Checking the scene files existing or not") + + for camera_scene in camera_scene_files: + if not os.path.exists(camera_scene): + self.log.error("Camera scene files not existed yet!") + raise RuntimeError("MaxBatch.exe doesn't run as expected") + self.log.debug(f"Found Camera scene:{camera_scene}") + + if "sceneFiles" not in instance.data: + instance.data["sceneFiles"] = camera_scene_files From f4a864c0d2b0141f5cd81e40edb25b77374b22d7 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 20 Jul 2023 23:50:29 +0800 Subject: [PATCH 016/198] cosmetic fix --- .../plugins/publish/save_scenes_for_cameras.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index d3357ba478..2abdb5dba1 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -74,27 +74,27 @@ rt.saveMaxFile(new_filepath) scripts.append(script) max_version = get_max_version() - maxBatch_exe = os.path.join(os.getenv(f"ADSK_3DSMAX_x64_{max_version}"), "3dsmaxbatch") + maxBatch_exe = os.path.join( + os.getenv(f"ADSK_3DSMAX_x64_{max_version}"), "3dsmaxbatch") maxBatch_exe = maxBatch_exe.replace("\\", "/") if sys.platform == "windows": maxBatch_exe += ".exe" maxBatch_exe = os.path.normpath(maxBatch_exe) with tempfile.TemporaryDirectory() as tmp_dir_name: - tmp_script_path = os.path.join(tmp_dir_name, "extract_scene_files.py") - log_file =os.path.join(tmp_dir_name, "fatal.log") + tmp_script_path = os.path.join( + tmp_dir_name, "extract_scene_files.py") self.log.info("Using script file: {}".format(tmp_script_path)) with open(tmp_script_path, "wt") as tmp: for script in scripts: - tmp.write(script+"\n") - tmp.write("rt.quitMax(quiet=True)"+"\n") - tmp.write("import time"+"\n") + tmp.write(script + "\n") + tmp.write("rt.quitMax(quiet=True)" + "\n") + tmp.write("import time" + "\n") tmp.write("time.sleep(3)") try: - current_filepath = current_filepath.replace("\\","/") - log_file = log_file.replace("\\", "/") - tmp_script_path = tmp_script_path.replace("\\","/") + current_filepath = current_filepath.replace("\\", "/") + tmp_script_path = tmp_script_path.replace("\\", "/") run_subprocess([maxBatch_exe, tmp_script_path, "-sceneFile", current_filepath]) except RuntimeError: From 7ae8b86c58ab061daa8b9acefab478adc14651fb Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 20 Jul 2023 23:51:21 +0800 Subject: [PATCH 017/198] hound fix --- openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 2abdb5dba1..af47959f8f 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -64,7 +64,7 @@ if render_elem_num > 0: for i in range(render_elem_num): renderlayer_name = render_elem.GetRenderElement(i) target, renderpass = str(renderlayer_name).split(":") - aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext + aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext # noqa render_elem.SetRenderElementFileName(i, aov_name) rt.saveMaxFile(new_filepath) """).format(new_filepath=new_filepath, From 3377150fe65342a421107fe71d08f72303cd0151 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 16:14:36 +0800 Subject: [PATCH 018/198] clean up the save_scene_camera code --- .../plugins/publish/save_scenes_for_cameras.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index af47959f8f..c6d264de32 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -29,7 +29,6 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): current_filename = rt.maxFileName current_filepath = os.path.join(current_folder, current_filename) camera_scene_files = [] - repres_list = [] scripts = [] filename, ext = os.path.splitext(current_filename) fmt = RenderProducts().image_format() @@ -88,9 +87,6 @@ rt.saveMaxFile(new_filepath) with open(tmp_script_path, "wt") as tmp: for script in scripts: tmp.write(script + "\n") - tmp.write("rt.quitMax(quiet=True)" + "\n") - tmp.write("import time" + "\n") - tmp.write("time.sleep(3)") try: current_filepath = current_filepath.replace("\\", "/") @@ -100,11 +96,23 @@ rt.saveMaxFile(new_filepath) except RuntimeError: self.log.debug("Checking the scene files existing or not") - for camera_scene in camera_scene_files: + for camera_scene, camera in zip(camera_scene_files, cameras): if not os.path.exists(camera_scene): self.log.error("Camera scene files not existed yet!") raise RuntimeError("MaxBatch.exe doesn't run as expected") self.log.debug(f"Found Camera scene:{camera_scene}") + instance.context.data["currentFile"] = camera_scene + representation = { + "name": "max", + "ext": "max", + "files": os.path.basename(camera_scene), + "stagingDir": new_folder, + "outputName": camera + } + self.log.debug(f"representation: {representation}") + if instance.data.get("representations") is None: + instance.data["representations"] = [] + instance.data["representations"].append(representation) if "sceneFiles" not in instance.data: instance.data["sceneFiles"] = camera_scene_files From 4144ca8e18fc2c5cf1e3b4971748cffa57ff3a9a Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 16:45:48 +0800 Subject: [PATCH 019/198] clean up the save_scene_camera code --- .../publish/save_scenes_for_cameras.py | 26 +++++++++---------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index c6d264de32..2369cf78a3 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -22,13 +22,11 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): families = ["maxrender", "workfile"] def process(self, instance): - if not instance.data.get("multiCamera"): - self.log.debug("Skipping instance...") - return current_folder = rt.maxFilePath current_filename = rt.maxFileName current_filepath = os.path.join(current_folder, current_filename) camera_scene_files = [] + repres_list = [] scripts = [] filename, ext = os.path.splitext(current_filename) fmt = RenderProducts().image_format() @@ -94,25 +92,25 @@ rt.saveMaxFile(new_filepath) run_subprocess([maxBatch_exe, tmp_script_path, "-sceneFile", current_filepath]) except RuntimeError: - self.log.debug("Checking the scene files existing or not") + self.log.debug("Checking the scene files existing") for camera_scene, camera in zip(camera_scene_files, cameras): if not os.path.exists(camera_scene): self.log.error("Camera scene files not existed yet!") raise RuntimeError("MaxBatch.exe doesn't run as expected") self.log.debug(f"Found Camera scene:{camera_scene}") - instance.context.data["currentFile"] = camera_scene representation = { - "name": "max", - "ext": "max", - "files": os.path.basename(camera_scene), - "stagingDir": new_folder, - "outputName": camera + "name": camera, + "ext": "max", + "files": os.path.basename(camera_scene), + "stagingDir": os.path.dirname(camera_scene), + "outputName": camera } - self.log.debug(f"representation: {representation}") - if instance.data.get("representations") is None: - instance.data["representations"] = [] - instance.data["representations"].append(representation) + repres_list.append(representation) if "sceneFiles" not in instance.data: instance.data["sceneFiles"] = camera_scene_files + + if instance.data.get("representations") is None: + instance.data["representations"] = [] + instance.data["representations"] = (repres_list) From d62b410efbc3776598d7705c0ee223f672e4a994 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 16:57:51 +0800 Subject: [PATCH 020/198] clean up the save_scene_camera code --- openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 2369cf78a3..3031c0d4cf 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -113,4 +113,4 @@ rt.saveMaxFile(new_filepath) if instance.data.get("representations") is None: instance.data["representations"] = [] - instance.data["representations"] = (repres_list) + instance.data["representations"]= repres_list From 855143d217400b813f128b0804e599332dbe95d6 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 17:11:26 +0800 Subject: [PATCH 021/198] clean up --- .../plugins/publish/save_scenes_for_cameras.py | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 3031c0d4cf..8aff9b58dd 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -11,8 +11,8 @@ from openpype.hosts.max.api.lib_renderproducts import RenderProducts class SaveScenesForCamera(pyblish.api.InstancePlugin): - """Save scene files for multiple cameras before - deadline submission + """Save scene files for multiple cameras without + editing the original scene before deadline submission """ @@ -26,7 +26,6 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): current_filename = rt.maxFileName current_filepath = os.path.join(current_folder, current_filename) camera_scene_files = [] - repres_list = [] scripts = [] filename, ext = os.path.splitext(current_filename) fmt = RenderProducts().image_format() @@ -99,18 +98,6 @@ rt.saveMaxFile(new_filepath) self.log.error("Camera scene files not existed yet!") raise RuntimeError("MaxBatch.exe doesn't run as expected") self.log.debug(f"Found Camera scene:{camera_scene}") - representation = { - "name": camera, - "ext": "max", - "files": os.path.basename(camera_scene), - "stagingDir": os.path.dirname(camera_scene), - "outputName": camera - } - repres_list.append(representation) if "sceneFiles" not in instance.data: instance.data["sceneFiles"] = camera_scene_files - - if instance.data.get("representations") is None: - instance.data["representations"] = [] - instance.data["representations"]= repres_list From 7ecb5ba056f2e5adf5f6ebbc6af19db16b207d56 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 17:14:23 +0800 Subject: [PATCH 022/198] hound fix --- openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 8aff9b58dd..918b6cda43 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -93,7 +93,7 @@ rt.saveMaxFile(new_filepath) except RuntimeError: self.log.debug("Checking the scene files existing") - for camera_scene, camera in zip(camera_scene_files, cameras): + for camera_scene in camera_scene_files: if not os.path.exists(camera_scene): self.log.error("Camera scene files not existed yet!") raise RuntimeError("MaxBatch.exe doesn't run as expected") From 0a7d24ba5f2f3b8dfaaeb7b0fbf8309c27ce5c38 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 18:27:00 +0800 Subject: [PATCH 023/198] use sys.executable to find the directory of maxBatch.exe --- openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 918b6cda43..0ccc69591a 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -5,7 +5,6 @@ import tempfile from pymxs import runtime as rt from openpype.lib import run_subprocess -from openpype.hosts.max.api.lib import get_max_version from openpype.hosts.max.api.lib_rendersettings import RenderSettings from openpype.hosts.max.api.lib_renderproducts import RenderProducts @@ -69,9 +68,8 @@ rt.saveMaxFile(new_filepath) ext=fmt) scripts.append(script) - max_version = get_max_version() maxBatch_exe = os.path.join( - os.getenv(f"ADSK_3DSMAX_x64_{max_version}"), "3dsmaxbatch") + os.path.dirname(sys.executable), "3dsmaxbatch") maxBatch_exe = maxBatch_exe.replace("\\", "/") if sys.platform == "windows": maxBatch_exe += ".exe" From 7692b95f1c113c8f2da8c0ae335398c0f7740a17 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 19:37:00 +0800 Subject: [PATCH 024/198] change the scene_path command in submit 3dsmax renders and make sure render elements have the correct path --- .../publish/save_scenes_for_cameras.py | 19 +++++++++++-------- .../plugins/publish/submit_max_deadline.py | 5 ++++- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 0ccc69591a..9561f53996 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -18,7 +18,7 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): label = "Save Scene files for cameras" order = pyblish.api.ExtractorOrder - 0.48 hosts = ["max"] - families = ["maxrender", "workfile"] + families = ["maxrender"] def process(self, instance): current_folder = rt.maxFilePath @@ -47,11 +47,13 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): script = (""" from pymxs import runtime as rt import os +filename = "{filename}" new_filepath = "{new_filepath}" new_output = "{new_output}" camera = "{camera}" rt.rendOutputFilename = new_output -directory = os.path.dirname(new_output) +directory = os.path.dirname(rt.rendOutputFilename) +directory = os.path.join(directory, filename) render_elem = rt.maxOps.GetCurRenderElementMgr() render_elem_num = render_elem.NumRenderElements() if render_elem_num > 0: @@ -62,18 +64,19 @@ if render_elem_num > 0: aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext # noqa render_elem.SetRenderElementFileName(i, aov_name) rt.saveMaxFile(new_filepath) - """).format(new_filepath=new_filepath, + """).format(filename=filename, + new_filepath=new_filepath, new_output=new_output, camera=camera, ext=fmt) scripts.append(script) - maxBatch_exe = os.path.join( + maxbatch_exe = os.path.join( os.path.dirname(sys.executable), "3dsmaxbatch") - maxBatch_exe = maxBatch_exe.replace("\\", "/") + maxbatch_exe = maxbatch_exe.replace("\\", "/") if sys.platform == "windows": - maxBatch_exe += ".exe" - maxBatch_exe = os.path.normpath(maxBatch_exe) + maxbatch_exe += ".exe" + maxbatch_exe = os.path.normpath(maxbatch_exe) with tempfile.TemporaryDirectory() as tmp_dir_name: tmp_script_path = os.path.join( tmp_dir_name, "extract_scene_files.py") @@ -86,7 +89,7 @@ rt.saveMaxFile(new_filepath) try: current_filepath = current_filepath.replace("\\", "/") tmp_script_path = tmp_script_path.replace("\\", "/") - run_subprocess([maxBatch_exe, tmp_script_path, + run_subprocess([maxbatch_exe, tmp_script_path, "-sceneFile", current_filepath]) except RuntimeError: self.log.debug("Checking the scene files existing") diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 5fed10a7c5..57f4353dcc 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -12,7 +12,6 @@ from openpype.pipeline import ( legacy_io, OpenPypePyblishPluginMixin ) -from openpype.settings import get_project_settings from openpype.hosts.max.api.lib import ( get_current_renderer, get_multipass_setting @@ -272,8 +271,12 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, instance = self._instance # set the target camera plugin_info = copy.deepcopy(self.plugin_info) + plugin_data = {} # set the output filepath with the relative camera + for camera_scene_path in instance.data.get("sceneFiles"): + if camera in camera_scene_path: + plugin_data["SceneFile"] = camera_scene_path files = instance.data.get("expectedFiles") if not files: raise RuntimeError("No render elements found") From b8952629705de15b9fbcc2ca18bba16bd83b7014 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 20:51:16 +0800 Subject: [PATCH 025/198] if multiCamera enabled, the deadline submission wont use the published workfiles to render --- .../modules/deadline/plugins/publish/submit_max_deadline.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 57f4353dcc..f3d873a1db 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -349,7 +349,11 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, if instance.data["renderer"] == "Redshift_Renderer": self.log.debug("Using Redshift...published scene wont be used..") replace_in_path = False - return replace_in_path + + if instance.data["multiCamera"] == True: + self.log.debug("Using Redshift...published scene wont be used..") + replace_in_path = False + return replace_in_path @staticmethod def _iter_expected_files(exp): From 5893675dc0e96dbcef99c5dc89fabc5b9831a783 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 21 Jul 2023 20:53:35 +0800 Subject: [PATCH 026/198] some cosmetic fix --- .../modules/deadline/plugins/publish/submit_max_deadline.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index f3d873a1db..904732c4b4 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -350,7 +350,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, self.log.debug("Using Redshift...published scene wont be used..") replace_in_path = False - if instance.data["multiCamera"] == True: + if instance.data.get("multiCamera"): self.log.debug("Using Redshift...published scene wont be used..") replace_in_path = False return replace_in_path From 9801ad52a0e42fbc2a69e0b5c514453d0a6d4954 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 24 Jul 2023 18:30:58 +0800 Subject: [PATCH 027/198] make sure the renderpass subset name is correct when saving scenes for camera in subprocess --- .../max/plugins/publish/save_scenes_for_cameras.py | 2 +- .../deadline/plugins/publish/submit_max_deadline.py | 13 +++++-------- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 9561f53996..9382a8f4b3 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -64,7 +64,7 @@ if render_elem_num > 0: aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext # noqa render_elem.SetRenderElementFileName(i, aov_name) rt.saveMaxFile(new_filepath) - """).format(filename=filename, + """).format(filename=instance.name, new_filepath=new_filepath, new_output=new_output, camera=camera, diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 904732c4b4..822962b23e 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -303,10 +303,11 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, instance.name, old_output_dir, camera ) for i, element in enumerate(render_elem_list): - elem_bname = os.path.basename(element) - new_elem = f"{dir}/{elem_bname}" - new_elem = new_elem.replace("/", "\\") - plugin_info["RenderElementOutputFilename%d" % i] = new_elem # noqa + if camera in element: + elem_bname = os.path.basename(element) + new_elem = f"{dir}/{elem_bname}" + new_elem = new_elem.replace("/", "\\") + plugin_info["RenderElementOutputFilename%d" % i] = new_elem # noqa if camera: # set the default camera and target camera @@ -349,10 +350,6 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, if instance.data["renderer"] == "Redshift_Renderer": self.log.debug("Using Redshift...published scene wont be used..") replace_in_path = False - - if instance.data.get("multiCamera"): - self.log.debug("Using Redshift...published scene wont be used..") - replace_in_path = False return replace_in_path @staticmethod From ed55100dd19d2f99d572a78999278b73a78b1c76 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 31 Jul 2023 17:37:21 +0800 Subject: [PATCH 028/198] ondrej's comment --- .../publish/save_scenes_for_cameras.py | 3 --- .../deadline/abstract_submit_deadline.py | 25 ------------------ .../plugins/publish/submit_max_deadline.py | 26 ++++++++++++++++--- 3 files changed, 22 insertions(+), 32 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 9382a8f4b3..79e9088ac7 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -99,6 +99,3 @@ rt.saveMaxFile(new_filepath) self.log.error("Camera scene files not existed yet!") raise RuntimeError("MaxBatch.exe doesn't run as expected") self.log.debug(f"Found Camera scene:{camera_scene}") - - if "sceneFiles" not in instance.data: - instance.data["sceneFiles"] = camera_scene_files diff --git a/openpype/modules/deadline/abstract_submit_deadline.py b/openpype/modules/deadline/abstract_submit_deadline.py index ae568c43e3..3fa427204b 100644 --- a/openpype/modules/deadline/abstract_submit_deadline.py +++ b/openpype/modules/deadline/abstract_submit_deadline.py @@ -531,31 +531,6 @@ class AbstractSubmitDeadline(pyblish.api.InstancePlugin, return replace_with_published_scene_path( self._instance, replace_in_path=replace_in_path) - def get_job_info_through_camera(self, camera=None): - """Get the job parameters for deadline submission when - multi-camera is enabled. - Args: - infos(dict): a dictionary with job info. - """ - pass - - def get_plugin_info_through_camera(self, camera=None): - """Get the plugin parameters for deadline submission when - multi-camera is enabled. - Args: - infos(dict): a dictionary with plugin info. - """ - pass - - def _use_published_name_for_multiples(self, data): - """Process the parameters submission for deadline when - user enables multi-cameras option. - Args: - job_info_list (list): A list of multiple job infos - plugin_info_list (list): A list of multiple plugin infos - """ - pass - def assemble_payload( self, job_info=None, plugin_info=None, aux_files=None): """Assemble payload data from its various parts. diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 822962b23e..78e570a780 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -164,7 +164,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, def process_submission(self): instance = self._instance - filepath = self.scene_path + filepath = instance.context.data["currentFile"] files = instance.data["expectedFiles"] if not files: @@ -184,6 +184,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, self.log.debug("Submitting 3dsMax render..") project_settings = instance.context.data["project_settings"] if instance.data.get("multiCamera"): + self.log.debug("Submitting jobs for multiple cameras..") payload = self._use_published_name_for_multiples( payload_data, project_settings) job_infos, plugin_infos = payload @@ -249,6 +250,11 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, return job_info, plugin_info def get_job_info_through_camera(self, camera): + """Get the job parameters for deadline submission when + multi-camera is enabled. + Args: + infos(dict): a dictionary with job info. + """ instance = self._instance context = instance.context job_info = copy.deepcopy(self.job_info) @@ -268,15 +274,27 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, # set the output filepath with the relative camera def get_plugin_info_through_camera(self, camera): + """Get the plugin parameters for deadline submission when + multi-camera is enabled. + Args: + infos(dict): a dictionary with plugin info. + """ instance = self._instance # set the target camera plugin_info = copy.deepcopy(self.plugin_info) plugin_data = {} # set the output filepath with the relative camera - for camera_scene_path in instance.data.get("sceneFiles"): - if camera in camera_scene_path: - plugin_data["SceneFile"] = camera_scene_path + if instance.data.get("multiCamera"): + scene_filepath = instance.context.data["currentFile"] + scene_filename = os.path.basename(scene_filepath) + scene_directory = os.path.dirname(scene_filepath) + current_filename, ext = os.path.splitext(scene_filename) + camera_scene_name = f"{current_filename}_{camera}{ext}" + camera_scene_filepath = os.path.join( + scene_directory, f"_{current_filename}", camera_scene_name) + plugin_data["SceneFile"] = camera_scene_filepath + files = instance.data.get("expectedFiles") if not files: raise RuntimeError("No render elements found") From 0d9873dd41dc71d603b100469a1faa419688a85c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 31 Jul 2023 22:32:19 +0800 Subject: [PATCH 029/198] ondrej's comment --- .../modules/deadline/plugins/publish/submit_max_deadline.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 78e570a780..15019c2647 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -12,6 +12,7 @@ from openpype.pipeline import ( legacy_io, OpenPypePyblishPluginMixin ) +from openpype.pipeline.publish import KnownPublishError from openpype.hosts.max.api.lib import ( get_current_renderer, get_multipass_setting @@ -168,7 +169,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, files = instance.data["expectedFiles"] if not files: - raise RuntimeError("No Render Elements found!") + raise KnownPublishError("No Render Elements found!") first_file = next(self._iter_expected_files(files)) output_dir = os.path.dirname(first_file) instance.data["outputDir"] = output_dir From 3e49e6c642b1813d90111bd4007b039f46fded27 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 31 Jul 2023 23:19:31 +0800 Subject: [PATCH 030/198] use KnownPublishError instead of RuntimeError --- .../modules/deadline/plugins/publish/submit_max_deadline.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py index 15019c2647..29ce315bdc 100644 --- a/openpype/modules/deadline/plugins/publish/submit_max_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_max_deadline.py @@ -210,7 +210,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, files = instance.data.get("expectedFiles") if not files: - raise RuntimeError("No render elements found") + raise KnownPublishError("No render elements found") first_file = next(self._iter_expected_files(files)) old_output_dir = os.path.dirname(first_file) output_beauty = RenderSettings().get_render_output(instance.name, @@ -298,7 +298,7 @@ class MaxSubmitDeadline(abstract_submit_deadline.AbstractSubmitDeadline, files = instance.data.get("expectedFiles") if not files: - raise RuntimeError("No render elements found") + raise KnownPublishError("No render elements found") first_file = next(self._iter_expected_files(files)) old_output_dir = os.path.dirname(first_file) rgb_output = RenderSettings().get_batch_render_output(camera) # noqa From 1e19bfa6949c7340a7ea146d87d66d1f2bb80aa4 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 30 Aug 2023 16:42:58 +0800 Subject: [PATCH 031/198] fix the weird naming of publish render folder --- openpype/pipeline/farm/pyblish_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index fe3ab97de8..61cceb80ad 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -583,7 +583,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, else: # in case of single frame cam = [c for c in cameras if c in col] - if cam: + if cam or subset != "maxrenderMain": if aov: subset_name = '{}_{}_{}'.format(group_name, cam, aov) else: From 960e7a24bc68cb913ef4a6b6857d01b0006f04cd Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 30 Aug 2023 17:32:31 +0800 Subject: [PATCH 032/198] fixing bigroy's comment on camera subset interruption --- openpype/pipeline/farm/pyblish_functions.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 61cceb80ad..fb73e46508 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -583,11 +583,15 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, else: # in case of single frame cam = [c for c in cameras if c in col] - if cam or subset != "maxrenderMain": + if cam: if aov: subset_name = '{}_{}_{}'.format(group_name, cam, aov) + if subset == "maxrenderMain": + subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}_{}'.format(group_name, cam) + if subset == "maxrenderMain": + subset_name = '{}'.format(group_name) else: if aov: subset_name = '{}_{}'.format(group_name, aov) From 749ca64e58caa9b95df2edc0347c72d44e15c151 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 30 Aug 2023 18:54:14 +0800 Subject: [PATCH 033/198] roy's comment on the subset naming based on cameras in multiple camera rendering --- openpype/pipeline/farm/pyblish_functions.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index fb73e46508..0c5d6a2712 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -579,18 +579,24 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, # if there are multiple cameras, we need to add camera name if isinstance(col, (list, tuple)): - cam = [c for c in cameras if c in col[0]] + cam = next((c for c in cameras if c in col[0]), None) else: # in case of single frame - cam = [c for c in cameras if c in col] + cam = next((cam for cam in cameras if cam in col), None) if cam: if aov: subset_name = '{}_{}_{}'.format(group_name, cam, aov) if subset == "maxrenderMain": + # Max submit scenes by cameras for multiple camera + # submission, it results to include the camera name inside + # the original subset and i.e group_name subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}_{}'.format(group_name, cam) if subset == "maxrenderMain": + # Max submit scenes by cameras for multiple camera + # submission, it results to include the camera name inside + # the original subset and i.e group_name subset_name = '{}'.format(group_name) else: if aov: From 1f2e32311f71448d2cc16348871d36ebf0093f04 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 30 Aug 2023 20:34:44 +0800 Subject: [PATCH 034/198] remove camera_name in aov if there is one --- openpype/pipeline/farm/pyblish_functions.py | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 0c5d6a2712..58ffeb937f 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -585,19 +585,13 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, cam = next((cam for cam in cameras if cam in col), None) if cam: if aov: + # if there is duplicatd camera name found in aov, + # it would be removed + if aov.startswith(cam): + aov = aov.replace(f"{cam}_", "") subset_name = '{}_{}_{}'.format(group_name, cam, aov) - if subset == "maxrenderMain": - # Max submit scenes by cameras for multiple camera - # submission, it results to include the camera name inside - # the original subset and i.e group_name - subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}_{}'.format(group_name, cam) - if subset == "maxrenderMain": - # Max submit scenes by cameras for multiple camera - # submission, it results to include the camera name inside - # the original subset and i.e group_name - subset_name = '{}'.format(group_name) else: if aov: subset_name = '{}_{}'.format(group_name, aov) From 30ea0213b72237cdc9bd2920c691fb22cf184338 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 5 Sep 2023 18:40:07 +0800 Subject: [PATCH 035/198] add pattern for clique.assemble function to just iterate through frame ranges --- openpype/pipeline/farm/pyblish_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 58ffeb937f..3f19c3cc95 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -548,7 +548,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, instances = [] # go through AOVs in expected files for aov, files in exp_files[0].items(): - cols, rem = clique.assemble(files) + cols, rem = clique.assemble(files, patterns=[clique.PATTERNS['frames']]) # we shouldn't have any reminders. And if we do, it should # be just one item for single frame renders. if not cols and rem: From 44391391df926316b8c7585e526ebbaffc5ab3d6 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 5 Sep 2023 18:41:00 +0800 Subject: [PATCH 036/198] hound --- openpype/pipeline/farm/pyblish_functions.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 3f19c3cc95..5713c13c4e 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -548,7 +548,8 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, instances = [] # go through AOVs in expected files for aov, files in exp_files[0].items(): - cols, rem = clique.assemble(files, patterns=[clique.PATTERNS['frames']]) + cols, rem = clique.assemble( + files, patterns=[clique.PATTERNS['frames']]) # we shouldn't have any reminders. And if we do, it should # be just one item for single frame renders. if not cols and rem: From 60e5eb74aeee01ad6a621554eac950a5852cdb90 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 5 Sep 2023 18:43:30 +0800 Subject: [PATCH 037/198] big roy's comments on the line 582-583 --- openpype/pipeline/farm/pyblish_functions.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 5713c13c4e..0bdc2b1339 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -579,11 +579,8 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, group_name = subset # if there are multiple cameras, we need to add camera name - if isinstance(col, (list, tuple)): - cam = next((c for c in cameras if c in col[0]), None) - else: - # in case of single frame - cam = next((cam for cam in cameras if cam in col), None) + expected_filepath = col[0] if isinstance(col, (list, tuple)) else col + cam = next((cam for cam in cameras if cam in expected_filepath), None) if cam: if aov: # if there is duplicatd camera name found in aov, From 75d17fcdffb6e10b049110be6defa023b6a5d68e Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 5 Sep 2023 18:56:45 +0800 Subject: [PATCH 038/198] restore the pattern for not breaking the submit publish job --- openpype/pipeline/farm/pyblish_functions.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 0bdc2b1339..181aad6cb5 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -548,8 +548,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, instances = [] # go through AOVs in expected files for aov, files in exp_files[0].items(): - cols, rem = clique.assemble( - files, patterns=[clique.PATTERNS['frames']]) + cols, rem = clique.assemble(files) # we shouldn't have any reminders. And if we do, it should # be just one item for single frame renders. if not cols and rem: From dadc6fa85747cb4790b226e2279fdacd1744064c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 26 Sep 2023 15:12:21 +0800 Subject: [PATCH 039/198] make sure render outputs with all cameras should be in the render publish folder --- openpype/pipeline/farm/pyblish_functions.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 181aad6cb5..5019d01be3 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -582,11 +582,13 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, cam = next((cam for cam in cameras if cam in expected_filepath), None) if cam: if aov: - # if there is duplicatd camera name found in aov, - # it would be removed - if aov.startswith(cam): - aov = aov.replace(f"{cam}_", "") - subset_name = '{}_{}_{}'.format(group_name, cam, aov) + # Multiple cameras publishing in some hosts such as 3dsMax + # have aov data set to "Camera001_beauty" to differentiate + # the render output files + if not aov.startswith(cam): + subset_name = '{}_{}_{}'.format(group_name, cam, aov) + else: + subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}_{}'.format(group_name, cam) else: @@ -594,7 +596,6 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}'.format(group_name) - if isinstance(col, (list, tuple)): staging = os.path.dirname(col[0]) else: From 55555e3078e3289e663f13709334e0ed4e038e72 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 27 Sep 2023 22:00:38 +0800 Subject: [PATCH 040/198] iterate the camera list --- openpype/pipeline/farm/pyblish_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 5019d01be3..1a5cbbf3e2 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -579,7 +579,7 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, # if there are multiple cameras, we need to add camera name expected_filepath = col[0] if isinstance(col, (list, tuple)) else col - cam = next((cam for cam in cameras if cam in expected_filepath), None) + cam = next(iter(cam for cam in cameras if cam in expected_filepath), None) if cam: if aov: # Multiple cameras publishing in some hosts such as 3dsMax From 810b3259d1e7441bda9a147bdf4942a6a9fd101c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 27 Sep 2023 22:29:41 +0800 Subject: [PATCH 041/198] hound --- openpype/pipeline/farm/pyblish_functions.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 1a5cbbf3e2..e5530481d2 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -579,7 +579,8 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, # if there are multiple cameras, we need to add camera name expected_filepath = col[0] if isinstance(col, (list, tuple)) else col - cam = next(iter(cam for cam in cameras if cam in expected_filepath), None) + cam = next( + iter(cam for cam in cameras if cam in expected_filepath), None) if cam: if aov: # Multiple cameras publishing in some hosts such as 3dsMax From 824912dba1e1d6d793d872d93188312bb6e43309 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 28 Sep 2023 19:08:09 +0800 Subject: [PATCH 042/198] update camera subset name condition --- openpype/pipeline/farm/pyblish_functions.py | 22 ++++++++++----------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index e5530481d2..f0d330da71 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -579,24 +579,22 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, # if there are multiple cameras, we need to add camera name expected_filepath = col[0] if isinstance(col, (list, tuple)) else col - cam = next( - iter(cam for cam in cameras if cam in expected_filepath), None) - if cam: - if aov: - # Multiple cameras publishing in some hosts such as 3dsMax - # have aov data set to "Camera001_beauty" to differentiate - # the render output files - if not aov.startswith(cam): - subset_name = '{}_{}_{}'.format(group_name, cam, aov) + cams = [cam for cam in cameras if cam in expected_filepath] + if cams: + for cam in cams: + if aov: + if not aov.startswith(cam): + subset_name = '{}_{}_{}'.format(group_name, cam, aov) + else: + subset_name = "{}_{}".format(group_name, aov) else: - subset_name = '{}_{}'.format(group_name, aov) - else: - subset_name = '{}_{}'.format(group_name, cam) + subset_name = '{}_{}'.format(group_name, cam) else: if aov: subset_name = '{}_{}'.format(group_name, aov) else: subset_name = '{}'.format(group_name) + if isinstance(col, (list, tuple)): staging = os.path.dirname(col[0]) else: From 5b2e5faccdbd0e425e0d9f438f0e82f96fe15c24 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 19 Oct 2023 18:30:03 +0800 Subject: [PATCH 043/198] remove if condition of cameras --- openpype/pipeline/farm/pyblish_functions.py | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index f0d330da71..8ae46ae1a1 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -580,20 +580,17 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, # if there are multiple cameras, we need to add camera name expected_filepath = col[0] if isinstance(col, (list, tuple)) else col cams = [cam for cam in cameras if cam in expected_filepath] - if cams: - for cam in cams: - if aov: - if not aov.startswith(cam): - subset_name = '{}_{}_{}'.format(group_name, cam, aov) - else: - subset_name = "{}_{}".format(group_name, aov) - else: - subset_name = '{}_{}'.format(group_name, cam) - else: + for cam in cams: if aov: - subset_name = '{}_{}'.format(group_name, aov) + if aov.startswith(cam): + subset_name = '{}_{}_{}'.format(group_name, cam, aov) + else: + subset_name = "{}_{}".format(group_name, aov) else: - subset_name = '{}'.format(group_name) + if aov.startswith(cam): + subset_name = '{}_{}'.format(group_name, cam) + else: + subset_name = '{}'.format(group_name) if isinstance(col, (list, tuple)): staging = os.path.dirname(col[0]) From 5bb6f304d381938d1effa7cc089971ab85f46352 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 19 Oct 2023 19:26:42 +0800 Subject: [PATCH 044/198] use known publish error instead of runtime error --- openpype/hosts/max/plugins/publish/collect_render.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/max/plugins/publish/collect_render.py b/openpype/hosts/max/plugins/publish/collect_render.py index 78ab02ef5e..01d7cff32d 100644 --- a/openpype/hosts/max/plugins/publish/collect_render.py +++ b/openpype/hosts/max/plugins/publish/collect_render.py @@ -5,6 +5,7 @@ import pyblish.api from pymxs import runtime as rt from openpype.pipeline import get_current_asset_name +from openpype.pipeline.publish import KnownPublishError from openpype.hosts.max.api import colorspace from openpype.hosts.max.api.lib import get_max_version, get_current_renderer from openpype.hosts.max.api.lib_rendersettings import RenderSettings @@ -45,8 +46,8 @@ class CollectRender(pyblish.api.InstancePlugin): if instance.data.get("multiCamera"): cameras = instance.data.get("members") if not cameras: - raise RuntimeError("There should be at least" - " one renderable camera in container") + raise KnownPublishError("There should be at least" + " one renderable camera in container") sel_cam = [ c.name for c in cameras if rt.classOf(c) in rt.Camera.classes] From e3e8770ffefb25a2b89388f70f51d385a10b0cb5 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 19 Oct 2023 20:31:06 +0800 Subject: [PATCH 045/198] restore the function code for test --- openpype/pipeline/farm/pyblish_functions.py | 25 +++++++++++---------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index 3254fbdfda..c9e013a09a 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -578,20 +578,21 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, else: group_name = subset - # if there are multiple cameras, we need to add camera name - expected_filepath = col[0] if isinstance(col, (list, tuple)) else col - cams = [cam for cam in cameras if cam in expected_filepath] - for cam in cams: + if isinstance(col, (list, tuple)): + cam = [c for c in cameras if c in col[0]] + else: + # in case of single frame + cam = [c for c in cameras if c in col] + if cam: if aov: - if aov.startswith(cam): - subset_name = '{}_{}_{}'.format(group_name, cam, aov) - else: - subset_name = "{}_{}".format(group_name, aov) + subset_name = '{}_{}_{}'.format(group_name, cam, aov) else: - if aov.startswith(cam): - subset_name = '{}_{}'.format(group_name, cam) - else: - subset_name = '{}'.format(group_name) + subset_name = '{}_{}'.format(group_name, cam) + else: + if aov: + subset_name = '{}_{}'.format(group_name, aov) + else: + subset_name = '{}'.format(group_name) if isinstance(col, (list, tuple)): staging = os.path.dirname(col[0]) From e9005c66184c5b6145a342e5258256c1929b111a Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 31 Oct 2023 12:59:24 +0800 Subject: [PATCH 046/198] make sure subset name conditions are applicable for other hosts such as maya --- openpype/pipeline/farm/pyblish_functions.py | 22 +++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/openpype/pipeline/farm/pyblish_functions.py b/openpype/pipeline/farm/pyblish_functions.py index c9e013a09a..6265449515 100644 --- a/openpype/pipeline/farm/pyblish_functions.py +++ b/openpype/pipeline/farm/pyblish_functions.py @@ -578,16 +578,18 @@ def _create_instances_for_aov(instance, skeleton, aov_filter, additional_data, else: group_name = subset - if isinstance(col, (list, tuple)): - cam = [c for c in cameras if c in col[0]] - else: - # in case of single frame - cam = [c for c in cameras if c in col] - if cam: - if aov: - subset_name = '{}_{}_{}'.format(group_name, cam, aov) - else: - subset_name = '{}_{}'.format(group_name, cam) + # if there are multiple cameras, we need to add camera name + expected_filepath = col[0] if isinstance(col, (list, tuple)) else col + cams = [cam for cam in cameras if cam in expected_filepath] + if cams: + for cam in cams: + if aov: + if not aov.startswith(cam): + subset_name = '{}_{}_{}'.format(group_name, cam, aov) + else: + subset_name = "{}_{}".format(group_name, aov) + else: + subset_name = '{}_{}'.format(group_name, cam) else: if aov: subset_name = '{}_{}'.format(group_name, aov) From 55dab6dc0c01cddf7b920e363e554e0439f78875 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 23 Nov 2023 19:29:39 +0800 Subject: [PATCH 047/198] add loader for redshift proxy family(contributed by big Roy) --- .../plugins/load/load_redshift_proxy.py | 131 ++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 openpype/hosts/houdini/plugins/load/load_redshift_proxy.py diff --git a/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py new file mode 100644 index 0000000000..914154be06 --- /dev/null +++ b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py @@ -0,0 +1,131 @@ +import os +from openpype.pipeline import ( + load, + get_representation_path, +) +from openpype.hosts.houdini.api import pipeline + +import clique +import hou + + +class RedshiftProxyLoader(load.LoaderPlugin): + """Load Redshift Proxy""" + + families = ["redshiftproxy"] + label = "Load Redshift Proxy" + representations = ["rs"] + order = -10 + icon = "code-fork" + color = "orange" + + def load(self, context, name=None, namespace=None, data=None): + + # Get the root node + obj = hou.node("/obj") + + # Define node name + namespace = namespace if namespace else context["asset"]["name"] + node_name = "{}_{}".format(namespace, name) if namespace else name + + # Create a new geo node + container = obj.createNode("geo", node_name=node_name) + + # Check whether the Redshift parameters exist - if not, then likely + # redshift is not set up or initialized correctly + if not container.parm("RS_objprop_proxy_enable"): + container.destroy() + raise RuntimeError("Unable to initialize geo node with Redshift " + "attributes. Make sure you have the Redshift " + "plug-in set up correctly for Houdini.") + + # Enable by default + container.setParms({ + "RS_objprop_proxy_enable": True, + "RS_objprop_proxy_file": self.format_path(self.fname) + }) + + # Remove the file node, it only loads static meshes + # Houdini 17 has removed the file node from the geo node + file_node = container.node("file1") + if file_node: + file_node.destroy() + + # Add this stub node inside so it previews ok + proxy_sop = container.createNode("redshift_proxySOP", + node_name=node_name) + proxy_sop.setDisplayFlag(True) + + nodes = [container, proxy_sop] + + self[:] = nodes + + return pipeline.containerise( + node_name, + namespace, + nodes, + context, + self.__class__.__name__, + suffix="", + ) + + def update(self, container, representation): + + # Update the file path + file_path = get_representation_path(representation) + + node = container["node"] + node.setParms({ + "RS_objprop_proxy_file": self.format_path(file_path) + }) + + # Update attribute + node.setParms({"representation": str(representation["_id"])}) + + def remove(self, container): + + node = container["node"] + node.destroy() + + def format_path(self, path): + """Format using $F{padding} token if sequence, otherwise just path.""" + + # Find all frames in the folder + ext = ".rs" + folder = os.path.dirname(path) + frames = [f for f in os.listdir(folder) if f.endswith(ext)] + + # Get the collection of frames to detect frame padding + patterns = [clique.PATTERNS["frames"]] + collections, remainder = clique.assemble(frames, + minimum_items=1, + patterns=patterns) + self.log.debug("Detected collections: {}".format(collections)) + self.log.debug("Detected remainder: {}".format(remainder)) + + if not collections and remainder: + if len(remainder) != 1: + raise ValueError("Frames not correctly detected " + "in: {}".format(remainder)) + + # A single frame without frame range detected + return os.path.normpath(path).replace("\\", "/") + + # Frames detected with a valid "frame" number pattern + # Then we don't want to have any remainder files found + assert len(collections) == 1 and not remainder + collection = collections[0] + + num_frames = len(collection.indexes) + if num_frames == 1: + # Return the input path without dynamic $F variable + result = path + else: + # More than a single frame detected - use $F{padding} + fname = "{}$F{}{}".format(collection.head, + collection.padding, + collection.tail) + result = os.path.join(folder, fname) + + # Format file name, Houdini only wants forward slashes + return os.path.normpath(result).replace("\\", "/") From 323d2409d349cbb5339457661d0ba4211f256722 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 24 Nov 2023 17:14:49 +0800 Subject: [PATCH 048/198] unified the code style of the loader with other loaders such as ass and bgeo loader --- .../plugins/load/load_redshift_proxy.py | 64 +++++++------------ 1 file changed, 22 insertions(+), 42 deletions(-) diff --git a/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py index 914154be06..8a3cc04eab 100644 --- a/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py @@ -5,7 +5,6 @@ from openpype.pipeline import ( ) from openpype.hosts.houdini.api import pipeline -import clique import hou @@ -42,7 +41,8 @@ class RedshiftProxyLoader(load.LoaderPlugin): # Enable by default container.setParms({ "RS_objprop_proxy_enable": True, - "RS_objprop_proxy_file": self.format_path(self.fname) + "RS_objprop_proxy_file": self.format_path( + self.fname, context["representation"]) }) # Remove the file node, it only loads static meshes @@ -76,7 +76,8 @@ class RedshiftProxyLoader(load.LoaderPlugin): node = container["node"] node.setParms({ - "RS_objprop_proxy_file": self.format_path(file_path) + "RS_objprop_proxy_file": self.format_path( + file_path, representation) }) # Update attribute @@ -87,45 +88,24 @@ class RedshiftProxyLoader(load.LoaderPlugin): node = container["node"] node.destroy() - def format_path(self, path): - """Format using $F{padding} token if sequence, otherwise just path.""" + @staticmethod + def format_path(path, representation): + """Format file path correctly for single redshift proxy + or redshift proxy sequence.""" + import re + if not os.path.exists(path): + raise RuntimeError("Path does not exist: %s" % path) - # Find all frames in the folder - ext = ".rs" - folder = os.path.dirname(path) - frames = [f for f in os.listdir(folder) if f.endswith(ext)] - - # Get the collection of frames to detect frame padding - patterns = [clique.PATTERNS["frames"]] - collections, remainder = clique.assemble(frames, - minimum_items=1, - patterns=patterns) - self.log.debug("Detected collections: {}".format(collections)) - self.log.debug("Detected remainder: {}".format(remainder)) - - if not collections and remainder: - if len(remainder) != 1: - raise ValueError("Frames not correctly detected " - "in: {}".format(remainder)) - - # A single frame without frame range detected - return os.path.normpath(path).replace("\\", "/") - - # Frames detected with a valid "frame" number pattern - # Then we don't want to have any remainder files found - assert len(collections) == 1 and not remainder - collection = collections[0] - - num_frames = len(collection.indexes) - if num_frames == 1: - # Return the input path without dynamic $F variable - result = path + is_sequence = bool(representation["context"].get("frame")) + # The path is either a single file or sequence in a folder. + if not is_sequence: + filename = path else: - # More than a single frame detected - use $F{padding} - fname = "{}$F{}{}".format(collection.head, - collection.padding, - collection.tail) - result = os.path.join(folder, fname) + filename = re.sub(r"(.*)\.(\d+)\.(rs.*)", "\\1.$F4.\\3", path) - # Format file name, Houdini only wants forward slashes - return os.path.normpath(result).replace("\\", "/") + filename = os.path.join(path, filename) + + filename = os.path.normpath(filename) + filename = filename.replace("\\", "/") + + return filename From 9ae1e7950915adab798840520455618c32f18cf0 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 24 Nov 2023 18:35:07 +0800 Subject: [PATCH 049/198] replace deprecated self.fname by self.filepath_from_context --- .../plugins/load/load_redshift_proxy.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py index 8a3cc04eab..efd7c6d0ca 100644 --- a/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/houdini/plugins/load/load_redshift_proxy.py @@ -1,9 +1,11 @@ import os +import re from openpype.pipeline import ( load, get_representation_path, ) from openpype.hosts.houdini.api import pipeline +from openpype.pipeline.load import LoadError import hou @@ -34,15 +36,16 @@ class RedshiftProxyLoader(load.LoaderPlugin): # redshift is not set up or initialized correctly if not container.parm("RS_objprop_proxy_enable"): container.destroy() - raise RuntimeError("Unable to initialize geo node with Redshift " - "attributes. Make sure you have the Redshift " - "plug-in set up correctly for Houdini.") + raise LoadError("Unable to initialize geo node with Redshift " + "attributes. Make sure you have the Redshift " + "plug-in set up correctly for Houdini.") # Enable by default container.setParms({ "RS_objprop_proxy_enable": True, "RS_objprop_proxy_file": self.format_path( - self.fname, context["representation"]) + self.filepath_from_context(context), + context["representation"]) }) # Remove the file node, it only loads static meshes @@ -92,18 +95,16 @@ class RedshiftProxyLoader(load.LoaderPlugin): def format_path(path, representation): """Format file path correctly for single redshift proxy or redshift proxy sequence.""" - import re if not os.path.exists(path): raise RuntimeError("Path does not exist: %s" % path) is_sequence = bool(representation["context"].get("frame")) # The path is either a single file or sequence in a folder. - if not is_sequence: - filename = path - else: + if is_sequence: filename = re.sub(r"(.*)\.(\d+)\.(rs.*)", "\\1.$F4.\\3", path) - filename = os.path.join(path, filename) + else: + filename = path filename = os.path.normpath(filename) filename = filename.replace("\\", "/") From 57197cc37ab994ab814cbc1fc8b6368f64165ef7 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Mon, 18 Dec 2023 15:16:10 +0000 Subject: [PATCH 050/198] Use only the final part of folderPath in the instance name --- openpype/hosts/blender/api/plugin.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py index 568d8f6695..18d2aa5362 100644 --- a/openpype/hosts/blender/api/plugin.py +++ b/openpype/hosts/blender/api/plugin.py @@ -226,7 +226,7 @@ class BaseCreator(Creator): # Create asset group if AYON_SERVER_ENABLED: - asset_name = instance_data["folderPath"] + asset_name = instance_data["folderPath"].split("/")[-1] else: asset_name = instance_data["asset"] @@ -311,6 +311,8 @@ class BaseCreator(Creator): or asset_name_key in changes.changed_keys ): asset_name = data[asset_name_key] + if AYON_SERVER_ENABLED: + asset_name = asset_name.split("/")[-1] name = prepare_scene_name( asset=asset_name, subset=data["subset"] ) From 73614e08a8de37018b0143edafed558c0cf8e879 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Mon, 18 Dec 2023 16:14:10 +0000 Subject: [PATCH 051/198] Add warning if name is too long for Blender --- openpype/hosts/blender/api/plugin.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py index 18d2aa5362..d50bfad53d 100644 --- a/openpype/hosts/blender/api/plugin.py +++ b/openpype/hosts/blender/api/plugin.py @@ -36,6 +36,12 @@ def prepare_scene_name( if namespace: name = f"{name}_{namespace}" name = f"{name}_{subset}" + + # Blender name for a collection or object cannot be longer than 63 + # characters. If the name is longer, it will raise an error. + if len(name) > 63: + raise ValueError(f"Asset name '{name}' is too long.") + return name From 55c3bdbd06f0baa06550654342ea7a66bd31c6e4 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 21 Dec 2023 17:30:37 +0800 Subject: [PATCH 052/198] add the contextmanager functions for 'reverting lock attributes' --- openpype/hosts/maya/api/lib.py | 139 +++++++++++++++++++-------------- 1 file changed, 79 insertions(+), 60 deletions(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index af726409d4..64cd5b6b6d 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2565,6 +2565,66 @@ def bake_to_world_space(nodes, list: The newly created and baked node names. """ + @contextlib.contextmanager + def _revert_lock_attributes(node, new_node): + # Connect all attributes on the node except for transform + # attributes + attrs = _get_attrs(node) + attrs = set(attrs) - transform_attrs if attrs else [] + original_attrs_lock = {} + try: + for attr in attrs: + orig_node_attr = '{0}.{1}'.format(node, attr) + new_node_attr = '{0}.{1}'.format(new_node, attr) + original_attrs_lock[new_node_attr] = ( + cmds.getAttr(new_node_attr, lock=True) + ) + + # unlock to avoid connection errors + cmds.setAttr(new_node_attr, lock=False) + + cmds.connectAttr(orig_node_attr, + new_node_attr, + force=True) + yield + finally: + for attr, lock_state in original_attrs_lock.items(): + cmds.setAttr(attr, lock=lock_state) + + @contextlib.contextmanager + def _revert_lock_shape_attributes(node, new_node, shape): + # If shapes are also baked then connect those keyable attributes + if shape: + children_shapes = cmds.listRelatives(new_node, + children=True, + fullPath=True, + shapes=True) + if children_shapes: + orig_children_shapes = cmds.listRelatives(node, + children=True, + fullPath=True, + shapes=True) + original_shape_lock_attrs = {} + try: + for orig_shape, new_shape in zip(orig_children_shapes, + children_shapes): + attrs = _get_attrs(orig_shape) + for attr in attrs: + orig_node_attr = '{0}.{1}'.format(orig_shape, attr) + new_node_attr = '{0}.{1}'.format(new_shape, attr) + original_shape_lock_attrs[new_node_attr] = ( + cmds.getAttr(new_node_attr, lock=True) + ) + # unlock to avoid connection errors + cmds.setAttr(new_node_attr, lock=False) + + cmds.connectAttr(orig_node_attr, + new_node_attr, + force=True) + yield + finally: + for attr, lock_state in original_shape_lock_attrs.items(): + cmds.setAttr(attr, lock=lock_state) def _get_attrs(node): """Workaround for buggy shape attribute listing with listAttr""" @@ -2599,7 +2659,6 @@ def bake_to_world_space(nodes, world_space_nodes = [] with delete_after() as delete_bin: - # Create the duplicate nodes that are in world-space connected to # the originals for node in nodes: @@ -2610,69 +2669,29 @@ def bake_to_world_space(nodes, new_node = cmds.duplicate(node, name=new_name, renameChildren=True)[0] # noqa + with _revert_lock_attributes(node, new_node): + with _revert_lock_shape_attributes(node, new_node): + # Parent to world + if cmds.listRelatives(new_node, parent=True): + new_node = cmds.parent(new_node, world=True)[0] - # Connect all attributes on the node except for transform - # attributes - attrs = _get_attrs(node) - attrs = set(attrs) - transform_attrs if attrs else [] + # Unlock transform attributes so constraint can be created + for attr in transform_attrs: + cmds.setAttr('{0}.{1}'.format(new_node, attr), lock=False) - for attr in attrs: - orig_node_attr = '{0}.{1}'.format(node, attr) - new_node_attr = '{0}.{1}'.format(new_node, attr) + # Constraints + delete_bin.extend(cmds.parentConstraint(node, new_node, mo=False)) + delete_bin.extend(cmds.scaleConstraint(node, new_node, mo=False)) - # unlock to avoid connection errors - cmds.setAttr(new_node_attr, lock=False) + world_space_nodes.append(new_node) - cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) - - # If shapes are also baked then connect those keyable attributes - if shape: - children_shapes = cmds.listRelatives(new_node, - children=True, - fullPath=True, - shapes=True) - if children_shapes: - orig_children_shapes = cmds.listRelatives(node, - children=True, - fullPath=True, - shapes=True) - for orig_shape, new_shape in zip(orig_children_shapes, - children_shapes): - attrs = _get_attrs(orig_shape) - for attr in attrs: - orig_node_attr = '{0}.{1}'.format(orig_shape, attr) - new_node_attr = '{0}.{1}'.format(new_shape, attr) - - # unlock to avoid connection errors - cmds.setAttr(new_node_attr, lock=False) - - cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) - - # Parent to world - if cmds.listRelatives(new_node, parent=True): - new_node = cmds.parent(new_node, world=True)[0] - - # Unlock transform attributes so constraint can be created - for attr in transform_attrs: - cmds.setAttr('{0}.{1}'.format(new_node, attr), lock=False) - - # Constraints - delete_bin.extend(cmds.parentConstraint(node, new_node, mo=False)) - delete_bin.extend(cmds.scaleConstraint(node, new_node, mo=False)) - - world_space_nodes.append(new_node) - - bake(world_space_nodes, - frame_range=frame_range, - step=step, - simulation=simulation, - preserve_outside_keys=preserve_outside_keys, - disable_implicit_control=disable_implicit_control, - shape=shape) + bake(world_space_nodes, + frame_range=frame_range, + step=step, + simulation=simulation, + preserve_outside_keys=preserve_outside_keys, + disable_implicit_control=disable_implicit_control, + shape=shape) return world_space_nodes From ac7b2963dd928f04cce701e8d6ef3b74b26a02ed Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 21 Dec 2023 17:34:07 +0800 Subject: [PATCH 053/198] hound --- openpype/hosts/maya/api/lib.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index 64cd5b6b6d..959a615ef9 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2584,8 +2584,8 @@ def bake_to_world_space(nodes, cmds.setAttr(new_node_attr, lock=False) cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) + new_node_attr, + force=True) yield finally: for attr, lock_state in original_attrs_lock.items(): @@ -2596,18 +2596,18 @@ def bake_to_world_space(nodes, # If shapes are also baked then connect those keyable attributes if shape: children_shapes = cmds.listRelatives(new_node, - children=True, - fullPath=True, - shapes=True) + children=True, + fullPath=True, + shapes=True) if children_shapes: orig_children_shapes = cmds.listRelatives(node, - children=True, - fullPath=True, - shapes=True) + children=True, + fullPath=True, + shapes=True) original_shape_lock_attrs = {} try: for orig_shape, new_shape in zip(orig_children_shapes, - children_shapes): + children_shapes): attrs = _get_attrs(orig_shape) for attr in attrs: orig_node_attr = '{0}.{1}'.format(orig_shape, attr) @@ -2619,8 +2619,8 @@ def bake_to_world_space(nodes, cmds.setAttr(new_node_attr, lock=False) cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) + new_node_attr, + force=True) yield finally: for attr, lock_state in original_shape_lock_attrs.items(): From a75ff0f71aab21daa86ffd40ce45ff0e8b9aee20 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 21 Dec 2023 17:36:35 +0800 Subject: [PATCH 054/198] hound --- openpype/hosts/maya/api/lib.py | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index 959a615ef9..3bc8b67a81 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2671,27 +2671,30 @@ def bake_to_world_space(nodes, renameChildren=True)[0] # noqa with _revert_lock_attributes(node, new_node): with _revert_lock_shape_attributes(node, new_node): - # Parent to world + # Parent to world if cmds.listRelatives(new_node, parent=True): new_node = cmds.parent(new_node, world=True)[0] # Unlock transform attributes so constraint can be created for attr in transform_attrs: - cmds.setAttr('{0}.{1}'.format(new_node, attr), lock=False) + cmds.setAttr( + '{0}.{1}'.format(new_node, attr), lock=False) # Constraints - delete_bin.extend(cmds.parentConstraint(node, new_node, mo=False)) - delete_bin.extend(cmds.scaleConstraint(node, new_node, mo=False)) + delete_bin.extend( + cmds.parentConstraint(node, new_node, mo=False)) + delete_bin.extend( + cmds.scaleConstraint(node, new_node, mo=False)) world_space_nodes.append(new_node) bake(world_space_nodes, - frame_range=frame_range, - step=step, - simulation=simulation, - preserve_outside_keys=preserve_outside_keys, - disable_implicit_control=disable_implicit_control, - shape=shape) + frame_range=frame_range, + step=step, + simulation=simulation, + preserve_outside_keys=preserve_outside_keys, + disable_implicit_control=disable_implicit_control, + shape=shape) return world_space_nodes From a8b93ec8fe5f30f1f15444df90b9bcb7f0d496f0 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Thu, 21 Dec 2023 10:15:05 +0000 Subject: [PATCH 055/198] Fixes long library names --- openpype/hosts/blender/plugins/load/load_animation.py | 7 ++++++- openpype/hosts/blender/plugins/load/load_blend.py | 7 ++++++- openpype/hosts/blender/plugins/load/load_blendscene.py | 7 ++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/openpype/hosts/blender/plugins/load/load_animation.py b/openpype/hosts/blender/plugins/load/load_animation.py index 3e7f808903..0f968c75e5 100644 --- a/openpype/hosts/blender/plugins/load/load_animation.py +++ b/openpype/hosts/blender/plugins/load/load_animation.py @@ -61,5 +61,10 @@ class BlendAnimationLoader(plugin.AssetLoader): bpy.data.objects.remove(container) - library = bpy.data.libraries.get(bpy.path.basename(libpath)) + filepath = bpy.path.basename(libpath) + # Blender has a limit of 63 characters for any data name. + # If the filepath is longer, it will be truncated. + if len(filepath) > 63: + filepath = filepath[:63] + library = bpy.data.libraries.get(filepath) bpy.data.libraries.remove(library) diff --git a/openpype/hosts/blender/plugins/load/load_blend.py b/openpype/hosts/blender/plugins/load/load_blend.py index f437e66795..2d5ac18149 100644 --- a/openpype/hosts/blender/plugins/load/load_blend.py +++ b/openpype/hosts/blender/plugins/load/load_blend.py @@ -106,7 +106,12 @@ class BlendLoader(plugin.AssetLoader): bpy.context.scene.collection.objects.link(obj) # Remove the library from the blend file - library = bpy.data.libraries.get(bpy.path.basename(libpath)) + filepath = bpy.path.basename(libpath) + # Blender has a limit of 63 characters for any data name. + # If the filepath is longer, it will be truncated. + if len(filepath) > 63: + filepath = filepath[:63] + library = bpy.data.libraries.get(filepath) bpy.data.libraries.remove(library) return container, members diff --git a/openpype/hosts/blender/plugins/load/load_blendscene.py b/openpype/hosts/blender/plugins/load/load_blendscene.py index 6cc7f39d03..fba0245af1 100644 --- a/openpype/hosts/blender/plugins/load/load_blendscene.py +++ b/openpype/hosts/blender/plugins/load/load_blendscene.py @@ -60,7 +60,12 @@ class BlendSceneLoader(plugin.AssetLoader): bpy.context.scene.collection.children.link(container) # Remove the library from the blend file - library = bpy.data.libraries.get(bpy.path.basename(libpath)) + filepath = bpy.path.basename(libpath) + # Blender has a limit of 63 characters for any data name. + # If the filepath is longer, it will be truncated. + if len(filepath) > 63: + filepath = filepath[:63] + library = bpy.data.libraries.get(filepath) bpy.data.libraries.remove(library) return container, members From 9ff27b51b50e6d32d047b422ea6c54ea727f962e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Thu, 21 Dec 2023 14:27:35 +0100 Subject: [PATCH 056/198] :fire: remove Muster --- openpype/lib/connections.py | 12 +- openpype/modules/base.py | 1 - .../deadline/abstract_submit_deadline.py | 8 +- .../publish/submit_publish_cache_job.py | 4 - .../plugins/publish/submit_publish_job.py | 65 +- openpype/modules/muster/__init__.py | 6 - openpype/modules/muster/muster.py | 147 ----- .../plugins/publish/submit_maya_muster.py | 555 ------------------ .../publish/validate_muster_connection.py | 96 --- openpype/modules/muster/rest_api.py | 22 - openpype/modules/muster/widget_login.py | 165 ------ .../plugins/publish/collect_farm_target.py | 2 +- .../plugins/publish/collect_rendered_files.py | 8 - openpype/settings/ayon_settings.py | 17 - .../defaults/system_settings/modules.json | 17 - openpype/settings/entities/schemas/README.md | 4 +- .../schemas/system_schema/schema_modules.json | 31 - openpype/tools/settings/settings/README.md | 4 +- server_addon/muster/server/__init__.py | 17 - server_addon/muster/server/settings.py | 41 -- server_addon/muster/server/version.py | 1 - start.py | 4 - website/docs/admin_settings_system.md | 7 - website/docs/artist_hosts_maya.md | 14 +- website/docs/dev_settings.md | 6 +- website/docs/features.md | 10 +- website/docs/module_muster.md | 10 - website/docs/pype2/admin_hosts.md | 4 + website/sidebars.js | 1 - website/src/pages/index.js | 15 +- 30 files changed, 49 insertions(+), 1245 deletions(-) delete mode 100644 openpype/modules/muster/__init__.py delete mode 100644 openpype/modules/muster/muster.py delete mode 100644 openpype/modules/muster/plugins/publish/submit_maya_muster.py delete mode 100644 openpype/modules/muster/plugins/publish/validate_muster_connection.py delete mode 100644 openpype/modules/muster/rest_api.py delete mode 100644 openpype/modules/muster/widget_login.py delete mode 100644 server_addon/muster/server/__init__.py delete mode 100644 server_addon/muster/server/settings.py delete mode 100644 server_addon/muster/server/version.py delete mode 100644 website/docs/module_muster.md diff --git a/openpype/lib/connections.py b/openpype/lib/connections.py index 91b745a4c1..6a0cf4ae1c 100644 --- a/openpype/lib/connections.py +++ b/openpype/lib/connections.py @@ -6,13 +6,13 @@ def requests_post(*args, **kwargs): """Wrap request post method. Disabling SSL certificate validation if ``DONT_VERIFY_SSL`` environment - variable is found. This is useful when Deadline or Muster server are - running with self-signed certificates and their certificate is not + variable is found. This is useful when Deadline server is + running with self-signed certificates and its certificate is not added to trusted certificates on client machines. Warning: Disabling SSL certificate validation is defeating one line - of defense SSL is providing and it is not recommended. + of defense SSL is providing, and it is not recommended. """ if "verify" not in kwargs: @@ -24,13 +24,13 @@ def requests_get(*args, **kwargs): """Wrap request get method. Disabling SSL certificate validation if ``DONT_VERIFY_SSL`` environment - variable is found. This is useful when Deadline or Muster server are - running with self-signed certificates and their certificate is not + variable is found. This is useful when Deadline server is + running with self-signed certificates and its certificate is not added to trusted certificates on client machines. Warning: Disabling SSL certificate validation is defeating one line - of defense SSL is providing and it is not recommended. + of defense SSL is providing, and it is not recommended. """ if "verify" not in kwargs: diff --git a/openpype/modules/base.py b/openpype/modules/base.py index 1a2513b4b4..c69bff7002 100644 --- a/openpype/modules/base.py +++ b/openpype/modules/base.py @@ -1332,7 +1332,6 @@ class TrayModulesManager(ModulesManager): "user", "ftrack", "kitsu", - "muster", "launcher_tool", "avalon", "clockify", diff --git a/openpype/modules/deadline/abstract_submit_deadline.py b/openpype/modules/deadline/abstract_submit_deadline.py index 187feb9b1a..dbf8a32f96 100644 --- a/openpype/modules/deadline/abstract_submit_deadline.py +++ b/openpype/modules/deadline/abstract_submit_deadline.py @@ -34,8 +34,8 @@ def requests_post(*args, **kwargs): """Wrap request post method. Disabling SSL certificate validation if ``DONT_VERIFY_SSL`` environment - variable is found. This is useful when Deadline or Muster server are - running with self-signed certificates and their certificate is not + variable is found. This is useful when Deadline server is + running with self-signed certificates and its certificate is not added to trusted certificates on client machines. Warning: @@ -55,8 +55,8 @@ def requests_get(*args, **kwargs): """Wrap request get method. Disabling SSL certificate validation if ``DONT_VERIFY_SSL`` environment - variable is found. This is useful when Deadline or Muster server are - running with self-signed certificates and their certificate is not + variable is found. This is useful when Deadline server is + running with self-signed certificates and its certificate is not added to trusted certificates on client machines. Warning: diff --git a/openpype/modules/deadline/plugins/publish/submit_publish_cache_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_cache_job.py index b2ebebc303..1bb45b77cc 100644 --- a/openpype/modules/deadline/plugins/publish/submit_publish_cache_job.py +++ b/openpype/modules/deadline/plugins/publish/submit_publish_cache_job.py @@ -99,10 +99,6 @@ class ProcessSubmittedCacheJobOnFarm(pyblish.api.InstancePlugin, def _submit_deadline_post_job(self, instance, job): """Submit publish job to Deadline. - Deadline specific code separated from :meth:`process` for sake of - more universal code. Muster post job is sent directly by Muster - submitter, so this type of code isn't necessary for it. - Returns: (str): deadline_publish_job_id """ diff --git a/openpype/modules/deadline/plugins/publish/submit_publish_job.py b/openpype/modules/deadline/plugins/publish/submit_publish_job.py index c9019b496b..f5866576e6 100644 --- a/openpype/modules/deadline/plugins/publish/submit_publish_job.py +++ b/openpype/modules/deadline/plugins/publish/submit_publish_job.py @@ -59,21 +59,15 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, publish.ColormanagedPyblishPluginMixin): """Process Job submitted on farm. - These jobs are dependent on a deadline or muster job + These jobs are dependent on a deadline job submission prior to this plug-in. - - In case of Deadline, it creates dependent job on farm publishing - rendered image sequence. - - - In case of Muster, there is no need for such thing as dependent job, - post action will be executed and rendered sequence will be published. + It creates dependent job on farm publishing rendered image sequence. Options in instance.data: - deadlineSubmissionJob (dict, Required): The returned .json data from the job submission to deadline. - - musterSubmissionJob (dict, Required): same as deadline. - - outputDir (str, Required): The output directory where the metadata file should be generated. It's assumed that this will also be final folder containing the output files. @@ -89,7 +83,7 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, """ - label = "Submit image sequence jobs to Deadline or Muster" + label = "Submit image sequence jobs to Deadline" order = pyblish.api.IntegratorOrder + 0.2 icon = "tractor" @@ -161,10 +155,6 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, def _submit_deadline_post_job(self, instance, job, instances): """Submit publish job to Deadline. - Deadline specific code separated from :meth:`process` for sake of - more universal code. Muster post job is sent directly by Muster - submitter, so this type of code isn't necessary for it. - Returns: (str): deadline_publish_job_id """ @@ -581,21 +571,11 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, ._____. ''' - - render_job = None - submission_type = "" - if instance.data.get("toBeRenderedOn") == "deadline": - render_job = instance.data.pop("deadlineSubmissionJob", None) - submission_type = "deadline" - - if instance.data.get("toBeRenderedOn") == "muster": - render_job = instance.data.pop("musterSubmissionJob", None) - submission_type = "muster" + render_job = instance.data.pop("deadlineSubmissionJob", None) if not render_job and instance.data.get("tileRendering") is False: - raise AssertionError(("Cannot continue without valid Deadline " - "or Muster submission.")) - + raise AssertionError(("Cannot continue without valid " + "Deadline submission.")) if not render_job: import getpass @@ -624,21 +604,19 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, "FTRACK_SERVER": os.environ.get("FTRACK_SERVER"), } - deadline_publish_job_id = None - if submission_type == "deadline": - # get default deadline webservice url from deadline module - self.deadline_url = instance.context.data["defaultDeadline"] - # if custom one is set in instance, use that - if instance.data.get("deadlineUrl"): - self.deadline_url = instance.data.get("deadlineUrl") - assert self.deadline_url, "Requires Deadline Webservice URL" + # get default deadline webservice url from deadline module + self.deadline_url = instance.context.data["defaultDeadline"] + # if custom one is set in instance, use that + if instance.data.get("deadlineUrl"): + self.deadline_url = instance.data.get("deadlineUrl") + assert self.deadline_url, "Requires Deadline Webservice URL" - deadline_publish_job_id = \ - self._submit_deadline_post_job(instance, render_job, instances) + deadline_publish_job_id = \ + self._submit_deadline_post_job(instance, render_job, instances) - # Inject deadline url to instances. - for inst in instances: - inst["deadlineUrl"] = self.deadline_url + # Inject deadline url to instances. + for inst in instances: + inst["deadlineUrl"] = self.deadline_url # publish job file publish_job = { @@ -664,15 +642,6 @@ class ProcessSubmittedJobOnFarm(pyblish.api.InstancePlugin, if audio_file and os.path.isfile(audio_file): publish_job.update({"audio": audio_file}) - # pass Ftrack credentials in case of Muster - if submission_type == "muster": - ftrack = { - "FTRACK_API_USER": os.environ.get("FTRACK_API_USER"), - "FTRACK_API_KEY": os.environ.get("FTRACK_API_KEY"), - "FTRACK_SERVER": os.environ.get("FTRACK_SERVER"), - } - publish_job.update({"ftrack": ftrack}) - metadata_path, rootless_metadata_path = \ create_metadata_path(instance, anatomy) diff --git a/openpype/modules/muster/__init__.py b/openpype/modules/muster/__init__.py deleted file mode 100644 index d194f8f3c2..0000000000 --- a/openpype/modules/muster/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -from .muster import MusterModule - - -__all__ = ( - "MusterModule", -) diff --git a/openpype/modules/muster/muster.py b/openpype/modules/muster/muster.py deleted file mode 100644 index 0cdb1230c8..0000000000 --- a/openpype/modules/muster/muster.py +++ /dev/null @@ -1,147 +0,0 @@ -import os -import json - -import appdirs -import requests - -from openpype.modules import OpenPypeModule, ITrayModule - - -class MusterModule(OpenPypeModule, ITrayModule): - """ - Module handling Muster Render credentials. This will display dialog - asking for user credentials for Muster if not already specified. - """ - cred_folder_path = os.path.normpath( - appdirs.user_data_dir('pype-app', 'pype') - ) - cred_filename = 'muster_cred.json' - - name = "muster" - - def initialize(self, modules_settings): - muster_settings = modules_settings[self.name] - self.enabled = muster_settings["enabled"] - self.muster_url = muster_settings["MUSTER_REST_URL"] - - self.cred_path = os.path.join( - self.cred_folder_path, self.cred_filename - ) - # Tray attributes - self.widget_login = None - self.action_show_login = None - self.rest_api_obj = None - - def get_global_environments(self): - return { - "MUSTER_REST_URL": self.muster_url - } - - def tray_init(self): - from .widget_login import MusterLogin - self.widget_login = MusterLogin(self) - - def tray_start(self): - """Show login dialog if credentials not found.""" - # This should be start of module in tray - cred = self.load_credentials() - if not cred: - self.show_login() - - def tray_exit(self): - """Nothing special for Muster.""" - return - - # Definition of Tray menu - def tray_menu(self, parent): - """Add **change credentials** option to tray menu.""" - from qtpy import QtWidgets - - # Menu for Tray App - menu = QtWidgets.QMenu('Muster', parent) - menu.setProperty('submenu', 'on') - - # Actions - self.action_show_login = QtWidgets.QAction( - "Change login", menu - ) - - menu.addAction(self.action_show_login) - self.action_show_login.triggered.connect(self.show_login) - - parent.addMenu(menu) - - def load_credentials(self): - """ - Get credentials from JSON file - """ - credentials = {} - try: - file = open(self.cred_path, 'r') - credentials = json.load(file) - except Exception: - file = open(self.cred_path, 'w+') - file.close() - - return credentials - - def get_auth_token(self, username, password): - """ - Authenticate user with Muster and get authToken from server. - """ - if not self.muster_url: - raise AttributeError("Muster REST API url not set") - params = { - 'username': username, - 'password': password - } - api_entry = '/api/login' - response = self._requests_post( - self.muster_url + api_entry, params=params) - if response.status_code != 200: - self.log.error( - 'Cannot log into Muster: {}'.format(response.status_code)) - raise Exception('Cannot login into Muster.') - - try: - token = response.json()['ResponseData']['authToken'] - except ValueError as e: - self.log.error('Invalid response from Muster server {}'.format(e)) - raise Exception('Invalid response from Muster while logging in.') - - self.save_credentials(token) - - def save_credentials(self, token): - """Save credentials to JSON file.""" - - with open(self.cred_path, "w") as f: - json.dump({'token': token}, f) - - def show_login(self): - """ - Show dialog to enter credentials - """ - if self.widget_login: - self.widget_login.show() - - # Webserver module implementation - def webserver_initialization(self, server_manager): - """Add routes for Muster login.""" - if self.tray_initialized: - from .rest_api import MusterModuleRestApi - - self.rest_api_obj = MusterModuleRestApi(self, server_manager) - - def _requests_post(self, *args, **kwargs): - """ Wrapper for requests, disabling SSL certificate validation if - DONT_VERIFY_SSL environment variable is found. This is useful when - Deadline or Muster server are running with self-signed certificates - and their certificate is not added to trusted certificates on - client machines. - - WARNING: disabling SSL certificate validation is defeating one line - of defense SSL is providing and it is not recommended. - """ - if 'verify' not in kwargs: - kwargs['verify'] = False if os.getenv("OPENPYPE_DONT_VERIFY_SSL", True) else True # noqa - return requests.post(*args, **kwargs) diff --git a/openpype/modules/muster/plugins/publish/submit_maya_muster.py b/openpype/modules/muster/plugins/publish/submit_maya_muster.py deleted file mode 100644 index f6b3bfbbfd..0000000000 --- a/openpype/modules/muster/plugins/publish/submit_maya_muster.py +++ /dev/null @@ -1,555 +0,0 @@ -import os -import json -import getpass -import platform - -import appdirs - -from maya import cmds - -import pyblish.api -from openpype.lib import requests_post -from openpype.hosts.maya.api import lib -from openpype.hosts.maya.api.lib_rendersettings import RenderSettings -from openpype.pipeline import legacy_io -from openpype.settings import get_system_settings - - -# mapping between Maya renderer names and Muster template ids -def _get_template_id(renderer): - """ - Return muster template ID based on renderer name. - - :param renderer: renderer name - :type renderer: str - :returns: muster template id - :rtype: int - """ - - # TODO: Use settings from context? - templates = get_system_settings()["modules"]["muster"]["templates_mapping"] - if not templates: - raise RuntimeError(("Muster template mapping missing in " - "pype-settings")) - try: - template_id = templates[renderer] - except KeyError: - raise RuntimeError("Unmapped renderer - missing template id") - - return template_id - - -def _get_script(): - """Get path to the image sequence script""" - try: - from openpype.scripts import publish_filesequence - except Exception: - raise RuntimeError("Expected module 'publish_deadline'" - "to be available") - - module_path = publish_filesequence.__file__ - if module_path.endswith(".pyc"): - module_path = module_path[:-len(".pyc")] + ".py" - - return module_path - - -def get_renderer_variables(renderlayer=None): - """Retrieve the extension which has been set in the VRay settings - - Will return None if the current renderer is not VRay - For Maya 2016.5 and up the renderSetup creates renderSetupLayer node which - start with `rs`. Use the actual node name, do NOT use the `nice name` - - Args: - renderlayer (str): the node name of the renderlayer. - - Returns: - dict - """ - - renderer = lib.get_renderer(renderlayer or lib.get_current_renderlayer()) - - padding = cmds.getAttr(RenderSettings.get_padding_attr(renderer)) - - filename_0 = cmds.renderSettings(fullPath=True, firstImageName=True)[0] - - if renderer == "vray": - # Maya's renderSettings function does not return V-Ray file extension - # so we get the extension from vraySettings - extension = cmds.getAttr("vraySettings.imageFormatStr") - - # When V-Ray image format has not been switched once from default .png - # the getAttr command above returns None. As such we explicitly set - # it to `.png` - if extension is None: - extension = "png" - - filename_prefix = "/_/" - else: - # Get the extension, getAttr defaultRenderGlobals.imageFormat - # returns an index number. - filename_base = os.path.basename(filename_0) - extension = os.path.splitext(filename_base)[-1].strip(".") - filename_prefix = "//" - - return {"ext": extension, - "filename_prefix": filename_prefix, - "padding": padding, - "filename_0": filename_0} - - -def preview_fname(folder, scene, layer, padding, ext): - """Return output file path with #### for padding. - - Deadline requires the path to be formatted with # in place of numbers. - For example `/path/to/render.####.png` - - Args: - folder (str): The root output folder (image path) - scene (str): The scene name - layer (str): The layer name to be rendered - padding (int): The padding length - ext(str): The output file extension - - Returns: - str - - """ - - # Following hardcoded "/_/" - output = "{scene}/{layer}/{layer}.{number}.{ext}".format( - scene=scene, - layer=layer, - number="#" * padding, - ext=ext - ) - - return os.path.join(folder, output) - - -class MayaSubmitMuster(pyblish.api.InstancePlugin): - """Submit available render layers to Muster - - Renders are submitted to a Muster via HTTP API as - supplied via the environment variable ``MUSTER_REST_URL``. - - Also needed is ``MUSTER_USER`` and ``MUSTER_PASSWORD``. - """ - - label = "Submit to Muster" - order = pyblish.api.IntegratorOrder + 0.1 - hosts = ["maya"] - families = ["renderlayer"] - icon = "satellite-dish" - if not os.environ.get("MUSTER_REST_URL"): - optional = False - active = False - else: - optional = True - - _token = None - - def _load_credentials(self): - """ - Load Muster credentials from file and set `MUSTER_USER`, - `MUSTER_PASSWORD`, `MUSTER_REST_URL` is loaded from settings. - - .. todo:: - - Show login dialog if access token is invalid or missing. - """ - app_dir = os.path.normpath( - appdirs.user_data_dir('pype-app', 'pype') - ) - file_name = 'muster_cred.json' - fpath = os.path.join(app_dir, file_name) - file = open(fpath, 'r') - muster_json = json.load(file) - self._token = muster_json.get('token', None) - if not self._token: - raise RuntimeError("Invalid access token for Muster") - file.close() - self.MUSTER_REST_URL = os.environ.get("MUSTER_REST_URL") - if not self.MUSTER_REST_URL: - raise AttributeError("Muster REST API url not set") - - def _get_templates(self): - """ - Get Muster templates from server. - """ - params = { - "authToken": self._token, - "select": "name" - } - api_entry = '/api/templates/list' - response = requests_post( - self.MUSTER_REST_URL + api_entry, params=params) - if response.status_code != 200: - self.log.error( - 'Cannot get templates from Muster: {}'.format( - response.status_code)) - raise Exception('Cannot get templates from Muster.') - - try: - response_templates = response.json()["ResponseData"]["templates"] - except ValueError as e: - self.log.error( - 'Muster server returned unexpected data {}'.format(e) - ) - raise Exception('Muster server returned unexpected data') - - templates = {} - for t in response_templates: - templates[t.get("name")] = t.get("id") - - self._templates = templates - - def _resolve_template(self, renderer): - """ - Returns template ID based on renderer string. - - :param renderer: Name of renderer to match against template names - :type renderer: str - :returns: ID of template - :rtype: int - :raises: Exception if template ID isn't found - """ - self.log.debug("Trying to find template for [{}]".format(renderer)) - mapped = _get_template_id(renderer) - self.log.debug("got id [{}]".format(mapped)) - return self._templates.get(mapped) - - def _submit(self, payload): - """ - Submit job to Muster - - :param payload: json with job to submit - :type payload: str - :returns: response - :raises: Exception status is wrong - """ - params = { - "authToken": self._token, - "name": "submit" - } - api_entry = '/api/queue/actions' - response = requests_post( - self.MUSTER_REST_URL + api_entry, params=params, json=payload) - - if response.status_code != 200: - self.log.error( - 'Cannot submit job to Muster: {}'.format(response.text)) - raise Exception('Cannot submit job to Muster.') - - return response - - def process(self, instance): - """ - Authenticate with Muster, collect all data, prepare path for post - render publish job and submit job to farm. - """ - # setup muster environment - self.MUSTER_REST_URL = os.environ.get("MUSTER_REST_URL") - - if self.MUSTER_REST_URL is None: - self.log.error( - "\"MUSTER_REST_URL\" is not found. Skipping " - "[{}]".format(instance) - ) - raise RuntimeError("MUSTER_REST_URL not set") - - self._load_credentials() - # self._get_templates() - - context = instance.context - workspace = context.data["workspaceDir"] - project_name = context.data["projectName"] - asset_name = context.data["asset"] - - filepath = None - - allInstances = [] - for result in context.data["results"]: - if ((result["instance"] is not None) and - (result["instance"] not in allInstances)): - allInstances.append(result["instance"]) - - for inst in allInstances: - print(inst) - if inst.data['family'] == 'scene': - filepath = inst.data['destination_list'][0] - - if not filepath: - filepath = context.data["currentFile"] - - self.log.debug(filepath) - - filename = os.path.basename(filepath) - comment = context.data.get("comment", "") - scene = os.path.splitext(filename)[0] - dirname = os.path.join(workspace, "renders") - renderlayer = instance.data['renderlayer'] # rs_beauty - renderlayer_name = instance.data['subset'] # beauty - renderglobals = instance.data["renderGlobals"] - # legacy_layers = renderlayer_globals["UseLegacyRenderLayers"] - # deadline_user = context.data.get("deadlineUser", getpass.getuser()) - jobname = "%s - %s" % (filename, instance.name) - - # Get the variables depending on the renderer - render_variables = get_renderer_variables(renderlayer) - output_filename_0 = preview_fname(folder=dirname, - scene=scene, - layer=renderlayer_name, - padding=render_variables["padding"], - ext=render_variables["ext"]) - - instance.data["outputDir"] = os.path.dirname(output_filename_0) - self.log.debug("output: {}".format(filepath)) - # build path for metadata file - metadata_filename = "{}_metadata.json".format(instance.data["subset"]) - output_dir = instance.data["outputDir"] - metadata_path = os.path.join(output_dir, metadata_filename) - - pype_root = os.environ["OPENPYPE_SETUP_PATH"] - - # we must provide either full path to executable or use musters own - # python named MPython.exe, residing directly in muster bin - # directory. - if platform.system().lower() == "windows": - # for muster, those backslashes must be escaped twice - muster_python = ("\"C:\\\\Program Files\\\\Virtual Vertex\\\\" - "Muster 9\\\\MPython.exe\"") - else: - # we need to run pype as different user then Muster dispatcher - # service is running (usually root). - muster_python = ("/usr/sbin/runuser -u {}" - " -- /usr/bin/python3".format(getpass.getuser())) - - # build the path and argument. We are providing separate --pype - # argument with network path to pype as post job actions are run - # but dispatcher (Server) and not render clients. Render clients - # inherit environment from publisher including PATH, so there's - # no problem finding PYPE, but there is now way (as far as I know) - # to set environment dynamically for dispatcher. Therefore this hack. - args = [muster_python, - _get_script().replace('\\', '\\\\'), - "--paths", - metadata_path.replace('\\', '\\\\'), - "--pype", - pype_root.replace('\\', '\\\\')] - - postjob_command = " ".join(args) - - try: - # Ensure render folder exists - os.makedirs(dirname) - except OSError: - pass - - env = self.clean_environment() - - payload = { - "RequestData": { - "platform": 0, - "job": { - "jobName": jobname, - "templateId": _get_template_id( - instance.data["renderer"]), - "chunksInterleave": 2, - "chunksPriority": "0", - "chunksTimeoutValue": 320, - "department": "", - "dependIds": [""], - "dependLinkMode": 0, - "dependMode": 0, - "emergencyQueue": False, - "excludedPools": [""], - "includedPools": [renderglobals["Pool"]], - "packetSize": 4, - "packetType": 1, - "priority": 1, - "jobId": -1, - "startOn": 0, - "parentId": -1, - "project": project_name or scene, - "shot": asset_name or scene, - "camera": instance.data.get("cameras")[0], - "dependMode": 0, - "packetSize": 4, - "packetType": 1, - "priority": 1, - "maximumInstances": 0, - "assignedInstances": 0, - "attributes": { - "environmental_variables": { - "value": ", ".join("{!s}={!r}".format(k, v) - for (k, v) in env.items()), - - "state": True, - "subst": False - }, - "memo": { - "value": comment, - "state": True, - "subst": False - }, - "frames_range": { - "value": "{start}-{end}".format( - start=int(instance.data["frameStart"]), - end=int(instance.data["frameEnd"])), - "state": True, - "subst": False - }, - "job_file": { - "value": filepath, - "state": True, - "subst": True - }, - "job_project": { - "value": workspace, - "state": True, - "subst": True - }, - "output_folder": { - "value": dirname.replace("\\", "/"), - "state": True, - "subst": True - }, - "post_job_action": { - "value": postjob_command, - "state": True, - "subst": True - }, - "MAYADIGITS": { - "value": 1, - "state": True, - "subst": False - }, - "ARNOLDMODE": { - "value": "0", - "state": True, - "subst": False - }, - "ABORTRENDER": { - "value": "0", - "state": True, - "subst": True - }, - "ARNOLDLICENSE": { - "value": "0", - "state": False, - "subst": False - }, - "ADD_FLAGS": { - "value": "-rl {}".format(renderlayer), - "state": True, - "subst": True - } - } - } - } - } - - self.preflight_check(instance) - - self.log.debug("Submitting ...") - self.log.debug(json.dumps(payload, indent=4, sort_keys=True)) - - response = self._submit(payload) - # response = requests.post(url, json=payload) - if not response.ok: - raise Exception(response.text) - - # Store output dir for unified publisher (filesequence) - - instance.data["musterSubmissionJob"] = response.json() - - def clean_environment(self): - """ - Clean and set environment variables for render job so render clients - work in more or less same environment as publishing machine. - - .. warning:: This is not usable for **post job action** as this is - executed on dispatcher machine (server) and not render clients. - """ - keys = [ - # This will trigger `userSetup.py` on the slave - # such that proper initialisation happens the same - # way as it does on a local machine. - # TODO(marcus): This won't work if the slaves don't - # have access to these paths, such as if slaves are - # running Linux and the submitter is on Windows. - "PYTHONPATH", - "PATH", - - "MTOA_EXTENSIONS_PATH", - "MTOA_EXTENSIONS", - "DYLD_LIBRARY_PATH", - "MAYA_RENDER_DESC_PATH", - "MAYA_MODULE_PATH", - "ARNOLD_PLUGIN_PATH", - "FTRACK_API_KEY", - "FTRACK_API_USER", - "FTRACK_SERVER", - "PYBLISHPLUGINPATH", - - # todo: This is a temporary fix for yeti variables - "PEREGRINEL_LICENSE", - "SOLIDANGLE_LICENSE", - "ARNOLD_LICENSE" - "MAYA_MODULE_PATH", - "TOOL_ENV" - ] - environment = dict({key: os.environ[key] for key in keys - if key in os.environ}, **legacy_io.Session) - # self.log.debug("enviro: {}".format(pprint(environment))) - for path in os.environ: - if path.lower().startswith('pype_'): - environment[path] = os.environ[path] - - environment["PATH"] = os.environ["PATH"] - # self.log.debug("enviro: {}".format(environment['OPENPYPE_SCRIPTS'])) - clean_environment = {} - for key, value in environment.items(): - clean_path = "" - self.log.debug("key: {}".format(key)) - if "://" in value: - clean_path = value - else: - valid_paths = [] - for path in value.split(os.pathsep): - if not path: - continue - try: - path.decode('UTF-8', 'strict') - valid_paths.append(os.path.normpath(path)) - except UnicodeDecodeError: - print('path contains non UTF characters') - - if valid_paths: - clean_path = os.pathsep.join(valid_paths) - - clean_environment[key] = clean_path - - return clean_environment - - def preflight_check(self, instance): - """Ensure the startFrame, endFrame and byFrameStep are integers""" - - for key in ("frameStart", "frameEnd", "byFrameStep"): - value = instance.data[key] - - if int(value) == value: - continue - - self.log.warning( - "%f=%d was rounded off to nearest integer" - % (value, int(value)) - ) - - -# TODO: Remove hack to avoid this plug-in in new publisher -# This plug-in should actually be in dedicated module -if not os.environ.get("MUSTER_REST_URL"): - del MayaSubmitMuster diff --git a/openpype/modules/muster/plugins/publish/validate_muster_connection.py b/openpype/modules/muster/plugins/publish/validate_muster_connection.py deleted file mode 100644 index c31ccf405c..0000000000 --- a/openpype/modules/muster/plugins/publish/validate_muster_connection.py +++ /dev/null @@ -1,96 +0,0 @@ -import os -import json - -import appdirs - -import pyblish.api -from openpype.lib import requests_get -from openpype.pipeline.publish import ( - context_plugin_should_run, - RepairAction, -) - - -class ValidateMusterConnection(pyblish.api.ContextPlugin): - """ - Validate Muster REST API Service is running and we have valid auth token - """ - - label = "Validate Muster REST API Service" - order = pyblish.api.ValidatorOrder - hosts = ["maya"] - families = ["renderlayer"] - token = None - if not os.environ.get("MUSTER_REST_URL"): - active = False - actions = [RepairAction] - - def process(self, context): - - # Workaround bug pyblish-base#250 - if not context_plugin_should_run(self, context): - return - - # test if we have environment set (redundant as this plugin shouldn' - # be active otherwise). - try: - MUSTER_REST_URL = os.environ["MUSTER_REST_URL"] - except KeyError: - self.log.error("Muster REST API url not found.") - raise ValueError("Muster REST API url not found.") - - # Load credentials - try: - self._load_credentials() - except RuntimeError: - self.log.error("invalid or missing access token") - - assert self._token is not None, "Invalid or missing token" - - # We have token, lets do trivial query to web api to see if we can - # connect and access token is valid. - params = { - 'authToken': self._token - } - api_entry = '/api/pools/list' - response = requests_get( - MUSTER_REST_URL + api_entry, params=params) - assert response.status_code == 200, "invalid response from server" - assert response.json()['ResponseData'], "invalid data in response" - - def _load_credentials(self): - """ - Load Muster credentials from file and set `MUSTER_USER`, - `MUSTER_PASSWORD`, `MUSTER_REST_URL` is loaded from settings. - - .. todo:: - - Show login dialog if access token is invalid or missing. - """ - app_dir = os.path.normpath( - appdirs.user_data_dir('pype-app', 'pype') - ) - file_name = 'muster_cred.json' - fpath = os.path.join(app_dir, file_name) - file = open(fpath, 'r') - muster_json = json.load(file) - self._token = muster_json.get('token', None) - if not self._token: - raise RuntimeError("Invalid access token for Muster") - file.close() - self.MUSTER_REST_URL = os.environ.get("MUSTER_REST_URL") - if not self.MUSTER_REST_URL: - raise AttributeError("Muster REST API url not set") - - @classmethod - def repair(cls, instance): - """ - Renew authentication token by logging into Muster - """ - api_url = "{}/muster/show_login".format( - os.environ["OPENPYPE_WEBSERVER_URL"]) - cls.log.debug(api_url) - response = requests_get(api_url, timeout=1) - if response.status_code != 200: - cls.log.error('Cannot show login form to Muster') - raise Exception('Cannot show login form to Muster') diff --git a/openpype/modules/muster/rest_api.py b/openpype/modules/muster/rest_api.py deleted file mode 100644 index bea759919d..0000000000 --- a/openpype/modules/muster/rest_api.py +++ /dev/null @@ -1,22 +0,0 @@ -from aiohttp.web_response import Response - - -class MusterModuleRestApi: - def __init__(self, user_module, server_manager): - self.module = user_module - self.server_manager = server_manager - - self.prefix = "/muster" - - self.register() - - def register(self): - self.server_manager.add_route( - "GET", - self.prefix + "/show_login", - self.show_login_widget - ) - - async def show_login_widget(self, request): - self.module.action_show_login.trigger() - return Response(status=200) diff --git a/openpype/modules/muster/widget_login.py b/openpype/modules/muster/widget_login.py deleted file mode 100644 index f38f43fb7f..0000000000 --- a/openpype/modules/muster/widget_login.py +++ /dev/null @@ -1,165 +0,0 @@ -from qtpy import QtCore, QtGui, QtWidgets -from openpype import resources, style - - -class MusterLogin(QtWidgets.QWidget): - - SIZE_W = 300 - SIZE_H = 150 - - loginSignal = QtCore.Signal(object, object, object) - - def __init__(self, module, parent=None): - - super(MusterLogin, self).__init__(parent) - - self.module = module - - # Icon - icon = QtGui.QIcon(resources.get_openpype_icon_filepath()) - self.setWindowIcon(icon) - - self.setWindowFlags( - QtCore.Qt.WindowCloseButtonHint | - QtCore.Qt.WindowMinimizeButtonHint - ) - - self._translate = QtCore.QCoreApplication.translate - - # Font - self.font = QtGui.QFont() - self.font.setFamily("DejaVu Sans Condensed") - self.font.setPointSize(9) - self.font.setBold(True) - self.font.setWeight(50) - self.font.setKerning(True) - - # Size setting - self.resize(self.SIZE_W, self.SIZE_H) - self.setMinimumSize(QtCore.QSize(self.SIZE_W, self.SIZE_H)) - self.setMaximumSize(QtCore.QSize(self.SIZE_W+100, self.SIZE_H+100)) - self.setStyleSheet(style.load_stylesheet()) - - self.setLayout(self._main()) - self.setWindowTitle('Muster login') - - def _main(self): - self.main = QtWidgets.QVBoxLayout() - self.main.setObjectName("main") - - self.form = QtWidgets.QFormLayout() - self.form.setContentsMargins(10, 15, 10, 5) - self.form.setObjectName("form") - - self.label_username = QtWidgets.QLabel("Username:") - self.label_username.setFont(self.font) - self.label_username.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor)) - self.label_username.setTextFormat(QtCore.Qt.RichText) - - self.input_username = QtWidgets.QLineEdit() - self.input_username.setEnabled(True) - self.input_username.setFrame(True) - self.input_username.setPlaceholderText( - self._translate("main", "e.g. John Smith") - ) - - self.label_password = QtWidgets.QLabel("Password:") - self.label_password.setFont(self.font) - self.label_password.setCursor(QtGui.QCursor(QtCore.Qt.ArrowCursor)) - self.label_password.setTextFormat(QtCore.Qt.RichText) - - self.input_password = QtWidgets.QLineEdit() - self.input_password.setEchoMode(QtWidgets.QLineEdit.Password) - self.input_password.setEnabled(True) - self.input_password.setFrame(True) - self.input_password.setPlaceholderText( - self._translate("main", "e.g. ********") - ) - - self.error_label = QtWidgets.QLabel("") - self.error_label.setFont(self.font) - self.error_label.setStyleSheet('color: #FC6000') - self.error_label.setWordWrap(True) - self.error_label.hide() - - self.form.addRow(self.label_username, self.input_username) - self.form.addRow(self.label_password, self.input_password) - self.form.addRow(self.error_label) - - self.btn_group = QtWidgets.QHBoxLayout() - self.btn_group.addStretch(1) - self.btn_group.setObjectName("btn_group") - - self.btn_ok = QtWidgets.QPushButton("Ok") - self.btn_ok.clicked.connect(self.click_ok) - - self.btn_cancel = QtWidgets.QPushButton("Cancel") - QtWidgets.QShortcut( - QtGui.QKeySequence( - QtCore.Qt.Key_Escape), self).activated.connect(self.close) - self.btn_cancel.clicked.connect(self.close) - - self.btn_group.addWidget(self.btn_ok) - self.btn_group.addWidget(self.btn_cancel) - - self.main.addLayout(self.form) - self.main.addLayout(self.btn_group) - - return self.main - - def keyPressEvent(self, key_event): - if key_event.key() == QtCore.Qt.Key_Return: - if self.input_username.hasFocus(): - self.input_password.setFocus() - - elif self.input_password.hasFocus() or self.btn_ok.hasFocus(): - self.click_ok() - - elif self.btn_cancel.hasFocus(): - self.close() - else: - super().keyPressEvent(key_event) - - def setError(self, msg): - self.error_label.setText(msg) - self.error_label.show() - - def invalid_input(self, entity): - entity.setStyleSheet("border: 1px solid red;") - - def click_ok(self): - # all what should happen - validations and saving into appsdir - username = self.input_username.text() - password = self.input_password.text() - # TODO: more robust validation. Password can be empty in muster? - if not username: - self.setError("Username cannot be empty") - self.invalid_input(self.input_username) - try: - self.save_credentials(username, password) - except Exception as e: - self.setError( - "Cannot get auth token:\n{}".format(e)) - else: - self._close_widget() - - def save_credentials(self, username, password): - self.module.get_auth_token(username, password) - - def showEvent(self, event): - super(MusterLogin, self).showEvent(event) - - # Make btns same width - max_width = max( - self.btn_ok.sizeHint().width(), - self.btn_cancel.sizeHint().width() - ) - self.btn_ok.setMinimumWidth(max_width) - self.btn_cancel.setMinimumWidth(max_width) - - def closeEvent(self, event): - event.ignore() - self._close_widget() - - def _close_widget(self): - self.hide() diff --git a/openpype/plugins/publish/collect_farm_target.py b/openpype/plugins/publish/collect_farm_target.py index adcd842b48..2f77c823d7 100644 --- a/openpype/plugins/publish/collect_farm_target.py +++ b/openpype/plugins/publish/collect_farm_target.py @@ -19,7 +19,7 @@ class CollectFarmTarget(pyblish.api.InstancePlugin): farm_name = "" op_modules = context.data.get("openPypeModules") - for farm_renderer in ["deadline", "royalrender", "muster"]: + for farm_renderer in ["deadline", "royalrender"]: op_module = op_modules.get(farm_renderer, False) if op_module and op_module.enabled: diff --git a/openpype/plugins/publish/collect_rendered_files.py b/openpype/plugins/publish/collect_rendered_files.py index 6160b4f5c8..baaf454a11 100644 --- a/openpype/plugins/publish/collect_rendered_files.py +++ b/openpype/plugins/publish/collect_rendered_files.py @@ -93,14 +93,6 @@ class CollectRenderedFiles(pyblish.api.ContextPlugin): assert ctx.get("user") == data.get("user"), ctx_err % "user" assert ctx.get("version") == data.get("version"), ctx_err % "version" - # ftrack credentials are passed as environment variables by Deadline - # to publish job, but Muster doesn't pass them. - if data.get("ftrack") and not os.environ.get("FTRACK_API_USER"): - ftrack = data.get("ftrack") - os.environ["FTRACK_API_USER"] = ftrack["FTRACK_API_USER"] - os.environ["FTRACK_API_KEY"] = ftrack["FTRACK_API_KEY"] - os.environ["FTRACK_SERVER"] = ftrack["FTRACK_SERVER"] - # now we can just add instances from json file and we are done any_staging_dir_persistent = False for instance_data in data.get("instances"): diff --git a/openpype/settings/ayon_settings.py b/openpype/settings/ayon_settings.py index a6d90d1cf0..9d3366961f 100644 --- a/openpype/settings/ayon_settings.py +++ b/openpype/settings/ayon_settings.py @@ -220,22 +220,6 @@ def _convert_deadline_system_settings( output["modules"]["deadline"] = deadline_settings -def _convert_muster_system_settings( - ayon_settings, output, addon_versions, default_settings -): - enabled = addon_versions.get("muster") is not None - muster_settings = default_settings["modules"]["muster"] - muster_settings["enabled"] = enabled - if enabled: - ayon_muster = ayon_settings["muster"] - muster_settings["MUSTER_REST_URL"] = ayon_muster["MUSTER_REST_URL"] - muster_settings["templates_mapping"] = { - item["name"]: item["value"] - for item in ayon_muster["templates_mapping"] - } - output["modules"]["muster"] = muster_settings - - def _convert_royalrender_system_settings( ayon_settings, output, addon_versions, default_settings ): @@ -261,7 +245,6 @@ def _convert_modules_system( _convert_timers_manager_system_settings, _convert_clockify_system_settings, _convert_deadline_system_settings, - _convert_muster_system_settings, _convert_royalrender_system_settings, ): func(ayon_settings, output, addon_versions, default_settings) diff --git a/openpype/settings/defaults/system_settings/modules.json b/openpype/settings/defaults/system_settings/modules.json index bb943524f1..22daae3b34 100644 --- a/openpype/settings/defaults/system_settings/modules.json +++ b/openpype/settings/defaults/system_settings/modules.json @@ -164,23 +164,6 @@ "default": "http://127.0.0.1:8082" } }, - "muster": { - "enabled": false, - "MUSTER_REST_URL": "http://127.0.0.1:9890", - "templates_mapping": { - "file_layers": 7, - "mentalray": 2, - "mentalray_sf": 6, - "redshift": 55, - "renderman": 29, - "software": 1, - "software_sf": 5, - "turtle": 10, - "vector": 4, - "vray": 37, - "ffmpeg": 48 - } - }, "royalrender": { "enabled": false, "rr_paths": { diff --git a/openpype/settings/entities/schemas/README.md b/openpype/settings/entities/schemas/README.md index c333628b25..eb74dd7a9c 100644 --- a/openpype/settings/entities/schemas/README.md +++ b/openpype/settings/entities/schemas/README.md @@ -645,7 +645,7 @@ How output of the schema could look like on save: }, "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` @@ -657,7 +657,7 @@ How output of the schema could look like on save: "object_type": "text", "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` diff --git a/openpype/settings/entities/schemas/system_schema/schema_modules.json b/openpype/settings/entities/schemas/system_schema/schema_modules.json index 5b189eae88..88ef6f7515 100644 --- a/openpype/settings/entities/schemas/system_schema/schema_modules.json +++ b/openpype/settings/entities/schemas/system_schema/schema_modules.json @@ -207,37 +207,6 @@ } ] }, - { - "type": "dict", - "key": "muster", - "label": "Muster", - "require_restart": true, - "collapsible": true, - "checkbox_key": "enabled", - "children": [ - { - "type": "boolean", - "key": "enabled", - "label": "Enabled" - }, - { - "type": "text", - "key": "MUSTER_REST_URL", - "label": "Muster Rest URL" - }, - { - "type": "dict-modifiable", - "object_type": { - "type": "number", - "minimum": 0, - "maximum": 300 - }, - "is_group": true, - "key": "templates_mapping", - "label": "Templates mapping" - } - ] - }, { "type": "dict", "key": "royalrender", diff --git a/openpype/tools/settings/settings/README.md b/openpype/tools/settings/settings/README.md index c29664a907..8f4ec00a76 100644 --- a/openpype/tools/settings/settings/README.md +++ b/openpype/tools/settings/settings/README.md @@ -334,7 +334,7 @@ }, "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` @@ -346,7 +346,7 @@ "object_type": "text", "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` diff --git a/server_addon/muster/server/__init__.py b/server_addon/muster/server/__init__.py deleted file mode 100644 index 2cb8943554..0000000000 --- a/server_addon/muster/server/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -from typing import Type - -from ayon_server.addons import BaseServerAddon - -from .version import __version__ -from .settings import MusterSettings, DEFAULT_VALUES - - -class MusterAddon(BaseServerAddon): - name = "muster" - version = __version__ - title = "Muster" - settings_model: Type[MusterSettings] = MusterSettings - - async def get_default_settings(self): - settings_model_cls = self.get_settings_model() - return settings_model_cls(**DEFAULT_VALUES) diff --git a/server_addon/muster/server/settings.py b/server_addon/muster/server/settings.py deleted file mode 100644 index e37c762870..0000000000 --- a/server_addon/muster/server/settings.py +++ /dev/null @@ -1,41 +0,0 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel - - -class TemplatesMapping(BaseSettingsModel): - _layout = "compact" - name: str = Field(title="Name") - value: int = Field(title="mapping") - - -class MusterSettings(BaseSettingsModel): - enabled: bool = True - MUSTER_REST_URL: str = Field( - "", - title="Muster Rest URL", - scope=["studio"], - ) - - templates_mapping: list[TemplatesMapping] = Field( - default_factory=list, - title="Templates mapping", - ) - - -DEFAULT_VALUES = { - "enabled": False, - "MUSTER_REST_URL": "http://127.0.0.1:9890", - "templates_mapping": [ - {"name": "file_layers", "value": 7}, - {"name": "mentalray", "value": 2}, - {"name": "mentalray_sf", "value": 6}, - {"name": "redshift", "value": 55}, - {"name": "renderman", "value": 29}, - {"name": "software", "value": 1}, - {"name": "software_sf", "value": 5}, - {"name": "turtle", "value": 10}, - {"name": "vector", "value": 4}, - {"name": "vray", "value": 37}, - {"name": "ffmpeg", "value": 48} - ] -} diff --git a/server_addon/muster/server/version.py b/server_addon/muster/server/version.py deleted file mode 100644 index 485f44ac21..0000000000 --- a/server_addon/muster/server/version.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.1.1" diff --git a/start.py b/start.py index 54a252ccf3..e4ada05822 100644 --- a/start.py +++ b/start.py @@ -1186,10 +1186,6 @@ def get_info(use_staging=None) -> list: inf.append(("Using Deadline webservice at", os.environ.get("DEADLINE_REST_URL"))) - if os.environ.get('MUSTER_REST_URL'): - inf.append(("Using Muster at", - os.environ.get("MUSTER_REST_URL"))) - # Reinitialize Logger.initialize() diff --git a/website/docs/admin_settings_system.md b/website/docs/admin_settings_system.md index 8abcefd24d..aefeaf893a 100644 --- a/website/docs/admin_settings_system.md +++ b/website/docs/admin_settings_system.md @@ -95,13 +95,6 @@ Disable/Enable Standalone Publisher option **`Deadline Rest URL`** - URL to deadline webservice that. This URL must be reachable from every workstation that should be submitting render jobs to deadline via OpenPype. -### Muster - -**`Muster Rest URL`** - URL to Muster webservice that. This URL must be reachable from every -workstation that should be submitting render jobs to muster via OpenPype. - -**`templates mapping`** - you can customize Muster templates to match your existing setup here. - ### Royal Render **`Royal Render Root Paths`** - multi platform paths to Royal Render installation. diff --git a/website/docs/artist_hosts_maya.md b/website/docs/artist_hosts_maya.md index e36ccb77d2..364461f4b6 100644 --- a/website/docs/artist_hosts_maya.md +++ b/website/docs/artist_hosts_maya.md @@ -386,14 +386,11 @@ models you've put into layout. OpenPype in Maya can be used for submitting renders to render farm and for their subsequent publishing. Right now OpenPype support [AWS Thinkbox Deadline](https://www.awsthinkbox.com/deadline) -and [Virtual Vertex Muster](https://www.vvertex.com/overview/). +and [Royal Render](https://www.royalrender.de/). -* For setting up Muster support see [admin section](module_muster.md) +* For setting up Royal Render support see [admin section](module_royalrender.md) * For setting up Deadline support see [here](module_deadline.md) -:::note Muster login -Muster is now configured so every user must log in to get authentication support. If OpenPype founds out this token is missing or expired, it will ask again for credentials. -::: ### Creating basic render setup @@ -436,12 +433,7 @@ checked **Use selection** it will use your current Render Layers (if you have th if no render layers is present in scene, it will create one for you named **Main** and under it default collection with `*` selector. -No matter if you use *Deadline* or *Muster*, OpenPype will try to connect to render farm and -fetch machine pool list. - -:::note Muster login -This might fail on *Muster* in the event that you have expired authentication token. In that case, you'll be presented with login window. Nothing will be created in the scene until you log in again and do create **Render** again. -::: +OpenPype will try to connect to render farm and fetch machine pool list. So now my scene now looks like this: diff --git a/website/docs/dev_settings.md b/website/docs/dev_settings.md index 1010169a5f..831536c460 100644 --- a/website/docs/dev_settings.md +++ b/website/docs/dev_settings.md @@ -34,7 +34,7 @@ As was mentioned schema items define output type of values, how they are stored - `"is_file"` - this key is used when defaults values are stored in the file. Its value matches the filename where values are stored - key is validated, must be unique in hierarchy otherwise it won't be possible to store default values - make sense to fill it only if it's value if `true` - + - `"is_group"` - define that all values under a key in settings hierarchy will be overridden if any value is modified - this key is not allowed for all inputs as they may not have technical ability to handle it - key is validated, must be unique in hierarchy and is automatically filled on last possible item if is not defined in schemas @@ -710,7 +710,7 @@ How output of the schema could look like on save: "object_type": "text", "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` @@ -726,7 +726,7 @@ How output of the schema could look like on save: }, "is_group": true, "key": "templates_mapping", - "label": "Muster - Templates mapping", + "label": "Deadline - Templates mapping", "is_file": true } ``` diff --git a/website/docs/features.md b/website/docs/features.md index fd6196f71f..43fd522346 100644 --- a/website/docs/features.md +++ b/website/docs/features.md @@ -238,17 +238,11 @@ Create preview quicktimes from rendered frames publish rendered outputs to Avalon and Ftrack - ## Muster - -Publish to deadline from - +## Royal Render +Publish to Royal Render from Maya - Nuke -Create preview quicktimes from rendered frames - -publish rendered outputs to Avalon and Ftrack ## Clockify diff --git a/website/docs/module_muster.md b/website/docs/module_muster.md deleted file mode 100644 index 28c4b33aa8..0000000000 --- a/website/docs/module_muster.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -id: module_muster -title: Muster Administration -sidebar_label: Muster ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - - diff --git a/website/docs/pype2/admin_hosts.md b/website/docs/pype2/admin_hosts.md index 24efef7f05..f7aa5bd54a 100644 --- a/website/docs/pype2/admin_hosts.md +++ b/website/docs/pype2/admin_hosts.md @@ -157,6 +157,10 @@ machine setup on farm. If there is no mix of windows/linux machines on farm, the ## Virtual Vertex Muster +:::warning +Support for Muster was removed from OpenPype and AYON. +::: + Pype supports rendering with [Muster](https://www.vvertex.com/). To enable it: 1. Add `muster` to **init_env** to your `deploy.json` file: diff --git a/website/sidebars.js b/website/sidebars.js index b885181fb6..0d151433ea 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -110,7 +110,6 @@ module.exports = { "module_kitsu", "module_site_sync", "module_deadline", - "module_muster", "module_royalrender", "module_clockify", "module_slack" diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 52302ec285..92ed404c35 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -29,7 +29,7 @@ const services = [ title: <>Extensible, description: ( <> - Project needs differ, clients differ and studios differ. OpenPype is designed to fit into your workflow and bend to your will. If a feature is missing, it can most probably be added. + Project needs differ, clients differ and studios differ. OpenPype is designed to fit into your workflow and bend to your will. If a feature is missing, it can most probably be added. ), }, @@ -310,7 +310,7 @@ function Home() {

Why choose openPype?

- Pipeline is the technical backbone of your production. It means, that whatever solution you use, it will cause vendor-lock to some extend. + Pipeline is the technical backbone of your production. It means, that whatever solution you use, it will cause vendor-lock to some extend. You can mitigate this risk by developing purely in-house tools, however, that just shifts the problem from a software vendor to your developers. Sooner or later, you'll hit the limits of such solution. In-house tools tend to be undocumented, narrow focused and heavily dependent on a very few or even a single developer.

@@ -332,7 +332,7 @@ function Home() { Maya - + Flame @@ -422,7 +422,7 @@ function Home() { Deadline - + Royal Render @@ -443,17 +443,12 @@ function Home() {

Planned or in development by us and OpenPype community.

- + Aquarium - - - Muster - - Hi Bob Bob From b012e169d413eb632fd347cdd8b52325034e7f50 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Thu, 21 Dec 2023 15:23:59 +0000 Subject: [PATCH 057/198] Changed error message Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- openpype/hosts/blender/api/plugin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py index d50bfad53d..1037854a2d 100644 --- a/openpype/hosts/blender/api/plugin.py +++ b/openpype/hosts/blender/api/plugin.py @@ -40,7 +40,7 @@ def prepare_scene_name( # Blender name for a collection or object cannot be longer than 63 # characters. If the name is longer, it will raise an error. if len(name) > 63: - raise ValueError(f"Asset name '{name}' is too long.") + raise ValueError(f"Scene name '{name}' would be too long.") return name From 1a39a5cc99ca18fcd2354a5e5d8e928ce67bc4df Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Fri, 22 Dec 2023 11:09:46 +0100 Subject: [PATCH 058/198] Unlock attributes only during the bake context, make sure attributes are relocked after to preserve the lock state of the original node being baked --- openpype/hosts/maya/api/lib.py | 171 +++++++++++++++++---------------- 1 file changed, 87 insertions(+), 84 deletions(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index 3bc8b67a81..63f0812785 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2566,68 +2566,36 @@ def bake_to_world_space(nodes, """ @contextlib.contextmanager - def _revert_lock_attributes(node, new_node): - # Connect all attributes on the node except for transform - # attributes - attrs = _get_attrs(node) - attrs = set(attrs) - transform_attrs if attrs else [] - original_attrs_lock = {} + def _unlock_attr(attr): + """Unlock attribute during context if it is locked""" + if not cmds.getAttr(attr, lock=True): + # If not locked, do nothing + yield + return try: - for attr in attrs: - orig_node_attr = '{0}.{1}'.format(node, attr) - new_node_attr = '{0}.{1}'.format(new_node, attr) - original_attrs_lock[new_node_attr] = ( - cmds.getAttr(new_node_attr, lock=True) - ) - - # unlock to avoid connection errors - cmds.setAttr(new_node_attr, lock=False) - - cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) + cmds.setAttr(attr, lock=False) yield finally: - for attr, lock_state in original_attrs_lock.items(): - cmds.setAttr(attr, lock=lock_state) - - @contextlib.contextmanager - def _revert_lock_shape_attributes(node, new_node, shape): - # If shapes are also baked then connect those keyable attributes - if shape: - children_shapes = cmds.listRelatives(new_node, - children=True, - fullPath=True, - shapes=True) - if children_shapes: - orig_children_shapes = cmds.listRelatives(node, - children=True, - fullPath=True, - shapes=True) - original_shape_lock_attrs = {} - try: - for orig_shape, new_shape in zip(orig_children_shapes, - children_shapes): - attrs = _get_attrs(orig_shape) - for attr in attrs: - orig_node_attr = '{0}.{1}'.format(orig_shape, attr) - new_node_attr = '{0}.{1}'.format(new_shape, attr) - original_shape_lock_attrs[new_node_attr] = ( - cmds.getAttr(new_node_attr, lock=True) - ) - # unlock to avoid connection errors - cmds.setAttr(new_node_attr, lock=False) - - cmds.connectAttr(orig_node_attr, - new_node_attr, - force=True) - yield - finally: - for attr, lock_state in original_shape_lock_attrs.items(): - cmds.setAttr(attr, lock=lock_state) + cmds.setAttr(attr, lock=True) def _get_attrs(node): - """Workaround for buggy shape attribute listing with listAttr""" + """Workaround for buggy shape attribute listing with listAttr + + This will only return keyable settable attributes that have an + incoming connections (those that have a reason to be baked). + + Technically this *may* fail to return attributes driven by complex + expressions for which maya makes no connections, e.g. doing actual + `setAttr` calls in expressions. + + Arguments: + node (str): The node to list attributes for. + + Returns: + list: Keyable attributes with incoming connections. + The attribute may be locked. + + """ attrs = cmds.listAttr(node, write=True, scalar=True, @@ -2652,13 +2620,14 @@ def bake_to_world_space(nodes, return valid_attrs - transform_attrs = set(["t", "r", "s", - "tx", "ty", "tz", - "rx", "ry", "rz", - "sx", "sy", "sz"]) + transform_attrs = {"t", "r", "s", + "tx", "ty", "tz", + "rx", "ry", "rz", + "sx", "sy", "sz"} world_space_nodes = [] - with delete_after() as delete_bin: + with contextlib.ExitStack() as stack: + delete_bin = stack.enter_context(delete_after()) # Create the duplicate nodes that are in world-space connected to # the originals for node in nodes: @@ -2669,32 +2638,66 @@ def bake_to_world_space(nodes, new_node = cmds.duplicate(node, name=new_name, renameChildren=True)[0] # noqa - with _revert_lock_attributes(node, new_node): - with _revert_lock_shape_attributes(node, new_node): - # Parent to world - if cmds.listRelatives(new_node, parent=True): - new_node = cmds.parent(new_node, world=True)[0] - # Unlock transform attributes so constraint can be created - for attr in transform_attrs: - cmds.setAttr( - '{0}.{1}'.format(new_node, attr), lock=False) + # Parent new node to world + if cmds.listRelatives(new_node, parent=True): + new_node = cmds.parent(new_node, world=True)[0] - # Constraints - delete_bin.extend( - cmds.parentConstraint(node, new_node, mo=False)) - delete_bin.extend( - cmds.scaleConstraint(node, new_node, mo=False)) + # Temporarily unlock and passthrough connect all attributes + # so we can bake them over time + # Skip transform attributes because we will constrain them later + attrs = set(_get_attrs(node)) - transform_attrs + for attr in attrs: + orig_node_attr = "{}.{}".format(node, attr) + new_node_attr = "{}.{}".format(new_node, attr) - world_space_nodes.append(new_node) + # unlock during context to avoid connection errors + stack.enter_context(_unlock_attr(new_node_attr)) + cmds.connectAttr(orig_node_attr, + new_node_attr, + force=True) - bake(world_space_nodes, - frame_range=frame_range, - step=step, - simulation=simulation, - preserve_outside_keys=preserve_outside_keys, - disable_implicit_control=disable_implicit_control, - shape=shape) + # If shapes are also baked then also temporarily unlock and + # passthrough connect all shape attributes for baking + if shape: + children_shapes = cmds.listRelatives(new_node, + children=True, + fullPath=True, + shapes=True) + if children_shapes: + orig_children_shapes = cmds.listRelatives(node, + children=True, + fullPath=True, + shapes=True) + for orig_shape, new_shape in zip(orig_children_shapes, + children_shapes): + attrs = _get_attrs(orig_shape) + for attr in attrs: + orig_node_attr = "{}.{}".format(orig_shape, attr) + new_node_attr = "{}.{}".format(new_shape, attr) + + # unlock during context to avoid connection errors + stack.enter_context(_unlock_attr(new_node_attr)) + cmds.connectAttr(orig_node_attr, + new_node_attr, + force=True) + + # Constraint transforms + for attr in transform_attrs: + transform_attr = "{}.{}".format(new_node, attr) + stack.enter_context(_unlock_attr(transform_attr)) + delete_bin.extend(cmds.parentConstraint(node, new_node, mo=False)) + delete_bin.extend(cmds.scaleConstraint(node, new_node, mo=False)) + + world_space_nodes.append(new_node) + + bake(world_space_nodes, + frame_range=frame_range, + step=step, + simulation=simulation, + preserve_outside_keys=preserve_outside_keys, + disable_implicit_control=disable_implicit_control, + shape=shape) return world_space_nodes From eaa0a8f60eeac2e3441d2bf83aa395dca4222326 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 22 Dec 2023 22:21:47 +0800 Subject: [PATCH 059/198] make sure not overindented when calling bake function --- openpype/hosts/maya/api/lib.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index 63f0812785..06cefbf793 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2691,13 +2691,13 @@ def bake_to_world_space(nodes, world_space_nodes.append(new_node) - bake(world_space_nodes, - frame_range=frame_range, - step=step, - simulation=simulation, - preserve_outside_keys=preserve_outside_keys, - disable_implicit_control=disable_implicit_control, - shape=shape) + bake(world_space_nodes, + frame_range=frame_range, + step=step, + simulation=simulation, + preserve_outside_keys=preserve_outside_keys, + disable_implicit_control=disable_implicit_control, + shape=shape) return world_space_nodes From 7f4f32f450807978567360fab2faf59d19c945df Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:21:16 +0100 Subject: [PATCH 060/198] add 'create_at' information to report item data --- openpype/tools/publisher/control.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openpype/tools/publisher/control.py b/openpype/tools/publisher/control.py index b02d83e4f6..125d93b6fd 100644 --- a/openpype/tools/publisher/control.py +++ b/openpype/tools/publisher/control.py @@ -4,6 +4,7 @@ import logging import traceback import collections import uuid +import datetime import tempfile import shutil import inspect @@ -285,6 +286,8 @@ class PublishReportMaker: def get_report(self, publish_plugins=None): """Report data with all details of current state.""" + + now = datetime.datetime.now() instances_details = {} for instance in self._all_instances_by_id.values(): instances_details[instance.id] = self._extract_instance_data( @@ -334,7 +337,8 @@ class PublishReportMaker: "context": self._extract_context_data(self._current_context), "crashed_file_paths": crashed_file_paths, "id": uuid.uuid4().hex, - "report_version": "1.0.0" + "created_at": now.strftime("%Y-%m-%d %H:%M:%S"), + "report_version": "1.0.1", } def _extract_context_data(self, context): From 1e78259d3a3c7f7a8ca50fb470957772d6d9fdd8 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:23:44 +0100 Subject: [PATCH 061/198] added 'created_at' with auto fix for older report items --- .../publisher/publish_report_viewer/window.py | 149 +++++++++++++++--- 1 file changed, 129 insertions(+), 20 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index dc4ad70934..533b9de15f 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -2,6 +2,7 @@ import os import json import six import uuid +import datetime import appdirs from qtpy import QtWidgets, QtCore, QtGui @@ -47,47 +48,79 @@ class PublishReportItem: """Report item representing one file in report directory.""" def __init__(self, content): - item_id = content.get("id") - changed = False - if not item_id: - item_id = str(uuid.uuid4()) - changed = True - content["id"] = item_id + changed = self._fix_content(content) - if not content.get("report_version"): - changed = True - content["report_version"] = "0.0.1" - - report_path = os.path.join(get_reports_dir(), item_id) + report_path = os.path.join(get_reports_dir(), content["id"]) file_modified = None if os.path.exists(report_path): file_modified = os.path.getmtime(report_path) + + created_at_obj = datetime.datetime.strptime( + content["created_at"], "%Y-%m-%d %H:%M:%S" + ) + created_at = self.date_obj_to_timestamp(created_at_obj) + self.content = content self.report_path = report_path self.file_modified = file_modified + self.created_at = float(created_at) self._loaded_label = content.get("label") self._changed = changed self.publish_report = PublishReport(content) @property def version(self): + """Publish report version. + + Returns: + str: Publish report version. + """ return self.content["report_version"] @property def id(self): + """Publish report id. + + Returns: + str: Publish report id. + """ + return self.content["id"] def get_label(self): + """Publish report label. + + Returns: + str: Publish report label showed in UI. + """ + return self.content.get("label") or "Unfilled label" def set_label(self, label): + """Set publish report label. + + Args: + label (str): New publish report label. + """ + if not label: self.content.pop("label", None) self.content["label"] = label label = property(get_label, set_label) + @property + def loaded_label(self): + return self._loaded_label + + def mark_as_changed(self): + """Mark report as changed.""" + + self._changed = True + def save(self): + """Save publish report to file.""" + save = False if ( self._changed @@ -109,6 +142,15 @@ class PublishReportItem: @classmethod def from_filepath(cls, filepath): + """Create report item from file. + + Args: + filepath (str): Path to report file. Content must be json. + + Returns: + PublishReportItem: Report item. + """ + if not os.path.exists(filepath): return None @@ -116,15 +158,25 @@ class PublishReportItem: with open(filepath, "r") as stream: content = json.load(stream) - return cls(content) + file_modified = os.path.getmtime(filepath) + changed = cls._fix_content(content, file_modified=file_modified) + obj = cls(content) + if changed: + obj.mark_as_changed() + return obj + except Exception: return None def remove_file(self): + """Remove report file.""" + if os.path.exists(self.report_path): os.remove(self.report_path) def update_file_content(self): + """Update report content in file.""" + if not os.path.exists(self.report_path): return @@ -148,6 +200,63 @@ class PublishReportItem: self.content = content self.file_modified = file_modified + @staticmethod + def date_obj_to_timestamp(date_obj): + if hasattr(date_obj, "timestamp"): + return date_obj.timestamp() + + # Python 2 support + epoch = datetime.datetime.fromtimestamp(0) + return (date_obj - epoch).total_seconds() + + @classmethod + def _fix_content(cls, content, file_modified=None): + """Fix content for backward compatibility of older report items. + + Args: + content (dict[str, Any]): Report content. + file_modified (Optional[float]): File modification time. + + Returns: + bool: True if content was changed, False otherwise. + """ + + # Fix created_at key + changed = cls._fix_created_at(content, file_modified) + + # NOTE backward compatibility for 'id' and 'report_version' is from + # 28.10.2022 https://github.com/ynput/OpenPype/pull/4040 + # We can probably safely remove it + + # Fix missing 'id' + item_id = content.get("id") + if not item_id: + item_id = str(uuid.uuid4()) + changed = True + content["id"] = item_id + + # Fix missing 'report_version' + if not content.get("report_version"): + changed = True + content["report_version"] = "0.0.1" + return changed + + @classmethod + def _fix_created_at(cls, content, file_modified): + # Key 'create_at' was added in report version 1.0.1 + created_at = content.get("created_at") + if created_at: + return False + + # Auto fix 'created_at', use file modification time if it is not set + # , or current time if modification could not be received. + if file_modified is not None: + created_at_obj = datetime.datetime.fromtimestamp(file_modified) + else: + created_at_obj = datetime.datetime.now() + content["created_at"] = created_at_obj.strftime("%Y-%m-%d %H:%M:%S") + return True + class PublisherReportHandler: """Class handling storing publish report tool.""" @@ -278,16 +387,16 @@ class LoadedFilesModel(QtGui.QStandardItemModel): new_items = [] for normalized_path in filtered_paths: - try: - with open(normalized_path, "r") as stream: - data = json.load(stream) - report_item = PublishReportItem(data) - except Exception: - # TODO handle errors + report_item = PublishReportItem.from_filepath(normalized_path) + if report_item is None: continue - label = data.get("label") - if not label: + # Skip already added report items + # QUESTION: Should we replace existing or skip the item? + if report_item.id in self._items_by_id: + continue + + if not report_item.loaded_label: report_item.label = ( os.path.splitext(os.path.basename(filepath))[0] ) From 5f6d6ca1b3b55011735d468f7839c2076a4c0c8a Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:24:55 +0100 Subject: [PATCH 062/198] use created at as sorting value --- .../publisher/publish_report_viewer/window.py | 50 ++++++++++++++----- 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 533b9de15f..0d7042a69c 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -26,6 +26,7 @@ else: ITEM_ID_ROLE = QtCore.Qt.UserRole + 1 +ITEM_CREATED_AT_ROLE = QtCore.Qt.UserRole + 2 def get_reports_dir(): @@ -300,9 +301,16 @@ class PublisherReportHandler: class LoadedFilesModel(QtGui.QStandardItemModel): + header_labels = ("Reports", "Created") + def __init__(self, *args, **kwargs): super(LoadedFilesModel, self).__init__(*args, **kwargs) + # Column count must be set before setting header data + self.setColumnCount(len(self.header_labels)) + for col, label in enumerate(self.header_labels): + self.setHeaderData(col, QtCore.Qt.Horizontal, label) + self._items_by_id = {} self._report_items_by_id = {} @@ -311,10 +319,15 @@ class LoadedFilesModel(QtGui.QStandardItemModel): self._loading_registry = False def refresh(self): - self._handler.reset() + root_item = self.invisibleRootItem() + if root_item.rowCount(): + root_item.removeRows(0, root_item.rowCount()) + self._items_by_id = {} self._report_items_by_id = {} + self._handler.reset() + new_items = [] for report_item in self._handler.list_reports(): item = self._create_item(report_item) @@ -326,26 +339,26 @@ class LoadedFilesModel(QtGui.QStandardItemModel): root_item = self.invisibleRootItem() root_item.appendRows(new_items) - def headerData(self, section, orientation, role): - if role in (QtCore.Qt.DisplayRole, QtCore.Qt.EditRole): - if section == 0: - return "Exports" - if section == 1: - return "Modified" - return "" - super(LoadedFilesModel, self).headerData(section, orientation, role) - def data(self, index, role=None): if role is None: role = QtCore.Qt.DisplayRole col = index.column() + if col == 1: + if role in ( + QtCore.Qt.DisplayRole, QtCore.Qt.InitialSortOrderRole + ): + role = ITEM_CREATED_AT_ROLE + if col != 0: index = self.index(index.row(), 0, index.parent()) return super(LoadedFilesModel, self).data(index, role) - def setData(self, index, value, role): + def setData(self, index, value, role=None): + if role is None: + role = QtCore.Qt.EditRole + if role == QtCore.Qt.EditRole: item_id = index.data(ITEM_ID_ROLE) report_item = self._report_items_by_id.get(item_id) @@ -356,6 +369,12 @@ class LoadedFilesModel(QtGui.QStandardItemModel): return super(LoadedFilesModel, self).setData(index, value, role) + def flags(self, index): + # Allow editable flag only for first column + if index.column() > 0: + return QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled + return super(LoadedFilesModel, self).flags(index) + def _create_item(self, report_item): if report_item.id in self._items_by_id: return None @@ -363,6 +382,7 @@ class LoadedFilesModel(QtGui.QStandardItemModel): item = QtGui.QStandardItem(report_item.label) item.setColumnCount(self.columnCount()) item.setData(report_item.id, ITEM_ID_ROLE) + item.setData(report_item.created_at, ITEM_CREATED_AT_ROLE) return item @@ -444,13 +464,18 @@ class LoadedFilesView(QtWidgets.QTreeView): ) self.setIndentation(0) self.setAlternatingRowColors(True) + self.setSortingEnabled(True) model = LoadedFilesModel() - self.setModel(model) + proxy_model = QtCore.QSortFilterProxyModel() + proxy_model.setSourceModel(model) + self.setModel(proxy_model) time_delegate = PrettyTimeDelegate() self.setItemDelegateForColumn(1, time_delegate) + self.sortByColumn(1, QtCore.Qt.AscendingOrder) + remove_btn = IconButton(self) remove_icon_path = resources.get_icon_path("delete") loaded_remove_image = QtGui.QImage(remove_icon_path) @@ -465,6 +490,7 @@ class LoadedFilesView(QtWidgets.QTreeView): ) self._model = model + self._proxy_model = proxy_model self._time_delegate = time_delegate self._remove_btn = remove_btn From 8bb497e64b91936e71b5b2263e34e937ac875022 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:25:13 +0100 Subject: [PATCH 063/198] renamed 'remove_report_items' tp 'remove_report_item' --- .../tools/publisher/publish_report_viewer/window.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 0d7042a69c..1557f2bd0b 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -290,7 +290,15 @@ class PublisherReportHandler: self._reports_by_id = reports_by_id return reports - def remove_report_items(self, item_id): + def remove_report_item(self, item_id): + """Remove report item by id. + + Remove from cache and also remove the file with the content. + + Args: + item_id (str): Report item id. + """ + item = self._reports_by_id.get(item_id) if item: try: @@ -439,7 +447,7 @@ class LoadedFilesModel(QtGui.QStandardItemModel): if not report_item: return - self._handler.remove_report_items(item_id) + self._handler.remove_report_item(item_id) item = self._items_by_id.get(item_id) parent = self.invisibleRootItem() From 64ef575ccecee9af8715fbcdaf8aca1c10825fcc Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:25:29 +0100 Subject: [PATCH 064/198] modified docstring --- openpype/tools/publisher/publish_report_viewer/window.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 1557f2bd0b..ffb2d64be6 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -260,7 +260,7 @@ class PublishReportItem: class PublisherReportHandler: - """Class handling storing publish report tool.""" + """Class handling storing publish report items.""" def __init__(self): self._reports = None From 46f05968bcabf82e05b8f9d693ce23629abbd066 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 12:25:44 +0100 Subject: [PATCH 065/198] add loaded report item only if could be created --- openpype/tools/publisher/publish_report_viewer/window.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index ffb2d64be6..84b25467b4 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -283,8 +283,9 @@ class PublisherReportHandler: continue filepath = os.path.join(report_dir, filename) item = PublishReportItem.from_filepath(filepath) - reports.append(item) - reports_by_id[item.id] = item + if item is not None: + reports.append(item) + reports_by_id[item.id] = item self._reports = reports self._reports_by_id = reports_by_id From 25a0e64a068f50d2f955b6e2a95c743d7d742abc Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 15:51:05 +0100 Subject: [PATCH 066/198] removed unnecessary 'date_obj_to_timestamp' --- .../tools/publisher/publish_report_viewer/window.py | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 84b25467b4..9dbe991201 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -59,7 +59,7 @@ class PublishReportItem: created_at_obj = datetime.datetime.strptime( content["created_at"], "%Y-%m-%d %H:%M:%S" ) - created_at = self.date_obj_to_timestamp(created_at_obj) + created_at = created_at_obj.timestamp() self.content = content self.report_path = report_path @@ -201,15 +201,6 @@ class PublishReportItem: self.content = content self.file_modified = file_modified - @staticmethod - def date_obj_to_timestamp(date_obj): - if hasattr(date_obj, "timestamp"): - return date_obj.timestamp() - - # Python 2 support - epoch = datetime.datetime.fromtimestamp(0) - return (date_obj - epoch).total_seconds() - @classmethod def _fix_content(cls, content, file_modified=None): """Fix content for backward compatibility of older report items. From 6db0dcbb44cc63c83113ef04af56e6e999cd5d41 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 27 Dec 2023 15:55:39 +0100 Subject: [PATCH 067/198] Fix weird comment --- openpype/tools/publisher/publish_report_viewer/window.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 9dbe991201..7cc7c6366a 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -241,7 +241,7 @@ class PublishReportItem: return False # Auto fix 'created_at', use file modification time if it is not set - # , or current time if modification could not be received. + # or current time if modification could not be received. if file_modified is not None: created_at_obj = datetime.datetime.fromtimestamp(file_modified) else: From f7fba84aeec00977ef893f6696eeb7c2ab8e749d Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 16:33:22 +0100 Subject: [PATCH 068/198] fix '_fill_selection' by accessing model method --- openpype/tools/publisher/publish_report_viewer/window.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 7cc7c6366a..ea78571223 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -538,7 +538,8 @@ class LoadedFilesView(QtWidgets.QTreeView): if index.isValid(): return - index = self._model.index(0, 0) + model = self.model() + index = model.index(0, 0) if index.isValid(): self.setCurrentIndex(index) From 78460c2d38d4111e3b3dd0403b2148eaa3159e88 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 16:43:00 +0100 Subject: [PATCH 069/198] remove items from _report_items_by_id and _items_by_id --- .../tools/publisher/publish_report_viewer/window.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index ea78571223..283d6284d6 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -435,15 +435,13 @@ class LoadedFilesModel(QtGui.QStandardItemModel): root_item.appendRows(new_items) def remove_item_by_id(self, item_id): - report_item = self._report_items_by_id.get(item_id) - if not report_item: - return - self._handler.remove_report_item(item_id) - item = self._items_by_id.get(item_id) - parent = self.invisibleRootItem() - parent.removeRow(item.row()) + self._report_items_by_id.pop(item_id, None) + item = self._items_by_id.pop(item_id) + if item is not None: + parent = self.invisibleRootItem() + parent.removeRow(item.row()) def get_report_by_id(self, item_id): report_item = self._report_items_by_id.get(item_id) From 10125a40784e97e0a46f1e87063833ff98ccd7c2 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 16:45:49 +0100 Subject: [PATCH 070/198] avoid usage of 'clear' method --- .../tools/publisher/publish_report_viewer/model.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/model.py b/openpype/tools/publisher/publish_report_viewer/model.py index 663a67ac70..9d3c90d18f 100644 --- a/openpype/tools/publisher/publish_report_viewer/model.py +++ b/openpype/tools/publisher/publish_report_viewer/model.py @@ -26,14 +26,15 @@ class InstancesModel(QtGui.QStandardItemModel): return self._items_by_id def set_report(self, report_item): - self.clear() + root_item = self.invisibleRootItem() + if root_item.rowCount(): + root_item.removeRows(0, root_item.rowCount()) + self._items_by_id.clear() self._plugin_items_by_id.clear() if not report_item: return - root_item = self.invisibleRootItem() - families = set(report_item.instance_items_by_family.keys()) families.remove(None) all_families = list(sorted(families)) @@ -125,14 +126,14 @@ class PluginsModel(QtGui.QStandardItemModel): return self._items_by_id def set_report(self, report_item): - self.clear() + root_item = self.invisibleRootItem() + if root_item.rowCount() > 0: + root_item.removeRows(0, root_item.rowCount()) self._items_by_id.clear() self._plugin_items_by_id.clear() if not report_item: return - root_item = self.invisibleRootItem() - labels_iter = iter(self.order_label_mapping) cur_order, cur_label = next(labels_iter) cur_plugin_items = [] From 79f592aaf375282892d5e5e9e4951073e28bd482 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 16:52:29 +0100 Subject: [PATCH 071/198] fix 'pop' of item by id --- openpype/tools/publisher/publish_report_viewer/window.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 283d6284d6..8422f3aeab 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -438,7 +438,7 @@ class LoadedFilesModel(QtGui.QStandardItemModel): self._handler.remove_report_item(item_id) self._report_items_by_id.pop(item_id, None) - item = self._items_by_id.pop(item_id) + item = self._items_by_id.pop(item_id, None) if item is not None: parent = self.invisibleRootItem() parent.removeRow(item.row()) From 3d7e02a550c70ffa07e68c7c4c0950431681707f Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 18:21:41 +0100 Subject: [PATCH 072/198] use utc isoformat with help of 'arrow' --- openpype/tools/publisher/control.py | 5 +++-- .../publisher/publish_report_viewer/window.py | 17 +++++++---------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/openpype/tools/publisher/control.py b/openpype/tools/publisher/control.py index 125d93b6fd..23456579ca 100644 --- a/openpype/tools/publisher/control.py +++ b/openpype/tools/publisher/control.py @@ -11,6 +11,7 @@ import inspect from abc import ABCMeta, abstractmethod import six +import arrow import pyblish.api from openpype import AYON_SERVER_ENABLED @@ -287,7 +288,7 @@ class PublishReportMaker: def get_report(self, publish_plugins=None): """Report data with all details of current state.""" - now = datetime.datetime.now() + now = arrow.utcnow().to("local") instances_details = {} for instance in self._all_instances_by_id.values(): instances_details[instance.id] = self._extract_instance_data( @@ -337,7 +338,7 @@ class PublishReportMaker: "context": self._extract_context_data(self._current_context), "crashed_file_paths": crashed_file_paths, "id": uuid.uuid4().hex, - "created_at": now.strftime("%Y-%m-%d %H:%M:%S"), + "created_at": now.isoformat(), "report_version": "1.0.1", } diff --git a/openpype/tools/publisher/publish_report_viewer/window.py b/openpype/tools/publisher/publish_report_viewer/window.py index 8422f3aeab..f9c8c05802 100644 --- a/openpype/tools/publisher/publish_report_viewer/window.py +++ b/openpype/tools/publisher/publish_report_viewer/window.py @@ -2,9 +2,9 @@ import os import json import six import uuid -import datetime import appdirs +import arrow from qtpy import QtWidgets, QtCore, QtGui from openpype import style @@ -56,10 +56,8 @@ class PublishReportItem: if os.path.exists(report_path): file_modified = os.path.getmtime(report_path) - created_at_obj = datetime.datetime.strptime( - content["created_at"], "%Y-%m-%d %H:%M:%S" - ) - created_at = created_at_obj.timestamp() + created_at_obj = arrow.get(content["created_at"]).to("local") + created_at = created_at_obj.float_timestamp self.content = content self.report_path = report_path @@ -243,10 +241,10 @@ class PublishReportItem: # Auto fix 'created_at', use file modification time if it is not set # or current time if modification could not be received. if file_modified is not None: - created_at_obj = datetime.datetime.fromtimestamp(file_modified) + created_at_obj = arrow.Arrow.fromtimestamp(file_modified) else: - created_at_obj = datetime.datetime.now() - content["created_at"] = created_at_obj.strftime("%Y-%m-%d %H:%M:%S") + created_at_obj = arrow.utcnow() + content["created_at"] = created_at_obj.to("local").isoformat() return True @@ -320,9 +318,8 @@ class LoadedFilesModel(QtGui.QStandardItemModel): def refresh(self): root_item = self.invisibleRootItem() - if root_item.rowCount(): + if root_item.rowCount() > 0: root_item.removeRows(0, root_item.rowCount()) - self._items_by_id = {} self._report_items_by_id = {} From 3a22c1dd154fc15409d1a80930861335e5a98b88 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 18:35:27 +0100 Subject: [PATCH 073/198] use explicit condition --- openpype/tools/publisher/publish_report_viewer/model.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/tools/publisher/publish_report_viewer/model.py b/openpype/tools/publisher/publish_report_viewer/model.py index 9d3c90d18f..460a269f1a 100644 --- a/openpype/tools/publisher/publish_report_viewer/model.py +++ b/openpype/tools/publisher/publish_report_viewer/model.py @@ -27,9 +27,8 @@ class InstancesModel(QtGui.QStandardItemModel): def set_report(self, report_item): root_item = self.invisibleRootItem() - if root_item.rowCount(): + if root_item.rowCount() > 0: root_item.removeRows(0, root_item.rowCount()) - self._items_by_id.clear() self._plugin_items_by_id.clear() if not report_item: From 53c593d41dae53d25c879ebcb4965c558278737b Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Wed, 27 Dec 2023 18:53:09 +0100 Subject: [PATCH 074/198] removed unused import --- openpype/tools/publisher/control.py | 1 - 1 file changed, 1 deletion(-) diff --git a/openpype/tools/publisher/control.py b/openpype/tools/publisher/control.py index 23456579ca..47e374edf2 100644 --- a/openpype/tools/publisher/control.py +++ b/openpype/tools/publisher/control.py @@ -4,7 +4,6 @@ import logging import traceback import collections import uuid -import datetime import tempfile import shutil import inspect From 333433057ea2728f1646a20ee602b72c40e5c1ba Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Wed, 3 Jan 2024 21:48:38 +0800 Subject: [PATCH 075/198] cosmetic tweaks regarding to Ondrej's comment --- openpype/hosts/max/api/lib_rendersettings.py | 15 ++++++--------- .../plugins/publish/save_scenes_for_cameras.py | 7 +++---- 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/openpype/hosts/max/api/lib_rendersettings.py b/openpype/hosts/max/api/lib_rendersettings.py index 166076f008..be50e296eb 100644 --- a/openpype/hosts/max/api/lib_rendersettings.py +++ b/openpype/hosts/max/api/lib_rendersettings.py @@ -80,7 +80,7 @@ class RenderSettings(object): )] except KeyError: aov_separator = "." - output_filename = "{0}..{1}".format(output, img_fmt) + output_filename = f"{output}..{img_fmt}" output_filename = output_filename.replace("{aov_separator}", aov_separator) rt.rendOutputFilename = output_filename @@ -146,13 +146,13 @@ class RenderSettings(object): for i in range(render_elem_num): renderlayer_name = render_elem.GetRenderElement(i) target, renderpass = str(renderlayer_name).split(":") - aov_name = "{0}_{1}..{2}".format(dir, renderpass, ext) + aov_name = f"{dir}_{renderpass}..{ext}" render_elem.SetRenderElementFileName(i, aov_name) def get_render_output(self, container, output_dir): output = os.path.join(output_dir, container) img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"] # noqa - output_filename = "{0}..{1}".format(output, img_fmt) + output_filename = f"{output}..{img_fmt}" return output_filename def get_render_element(self): @@ -181,8 +181,7 @@ class RenderSettings(object): for i in range(render_elem_num): renderlayer_name = render_elem.GetRenderElement(i) target, renderpass = str(renderlayer_name).split(":") - aov_name = "{0}_{1}_{2}..{3}".format( - output, camera, renderpass, img_fmt) + aov_name = f"{output}_{camera}_{renderpass}..{img_fmt}" render_element_list.append(aov_name) return render_element_list @@ -205,8 +204,7 @@ class RenderSettings(object): for i in range(render_elem_num): renderlayer_name = render_elem.GetRenderElement(i) target, renderpass = str(renderlayer_name).split(":") - aov_name = "{0}_{1}_{2}..{3}".format( - directory, camera, renderpass, ext) + aov_name = f"{directory}_{camera}_{renderpass}..{ext}" render_elem.SetRenderElementFileName(i, aov_name) def batch_render_layer(self, container, @@ -224,7 +222,6 @@ class RenderSettings(object): renderlayer = rt.batchRenderMgr.GetView(layer_no) # use camera name as renderlayer name renderlayer.name = cam - renderlayer.outputFilename = "{0}_{1}..{2}".format( - output, cam, img_fmt) + renderlayer.outputFilename = f"{output}_{cam}..{img_fmt}" outputs.append(renderlayer.outputFilename) return outputs diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index 79e9088ac7..c39109417b 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -31,13 +31,12 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): cameras = instance.data.get("cameras") if not cameras: return - new_folder = "{}_{}".format(current_folder, filename) + new_folder = f"{current_folder}_{filename}" os.makedirs(new_folder, exist_ok=True) for camera in cameras: new_output = RenderSettings().get_batch_render_output(camera) # noqa new_output = new_output.replace("\\", "/") - new_filename = "{}_{}{}".format( - filename, camera, ext) + new_filename = f"{filename}_{camera}{ext}" new_filepath = os.path.join(new_folder, new_filename) new_filepath = new_filepath.replace("\\", "/") camera_scene_files.append(new_filepath) @@ -61,7 +60,7 @@ if render_elem_num > 0: for i in range(render_elem_num): renderlayer_name = render_elem.GetRenderElement(i) target, renderpass = str(renderlayer_name).split(":") - aov_name = directory + "_" + camera + "_" + renderpass + "." + "." + ext # noqa + aov_name = f"{{directory}}_{camera}_{{renderpass}}..{ext}" render_elem.SetRenderElementFileName(i, aov_name) rt.saveMaxFile(new_filepath) """).format(filename=instance.name, From 9be69c3f304428792a454f1831a6d090ddf86231 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 00:25:34 +0800 Subject: [PATCH 076/198] implement exitstack functions from exitstack.py --- openpype/hosts/maya/api/lib.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/maya/api/lib.py b/openpype/hosts/maya/api/lib.py index eb83a44cde..da34896c3f 100644 --- a/openpype/hosts/maya/api/lib.py +++ b/openpype/hosts/maya/api/lib.py @@ -2839,7 +2839,7 @@ def bake_to_world_space(nodes, "sx", "sy", "sz"} world_space_nodes = [] - with contextlib.ExitStack() as stack: + with ExitStack() as stack: delete_bin = stack.enter_context(delete_after()) # Create the duplicate nodes that are in world-space connected to # the originals From 989ec8beb2947c8abef969c9e2922bea0eec2f8f Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 18:03:05 +0800 Subject: [PATCH 077/198] make sure the default shader assigned to the redshift proxy --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index b3fbfb2ed9..0ed09c6007 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -137,6 +137,14 @@ class RedshiftProxyLoader(load.LoaderPlugin): cmds.connectAttr("{}.outMesh".format(rs_mesh), "{}.inMesh".format(mesh_shape)) + # TODO: use the assigned shading group as shaders if existed + # assign default shader to redshift proxy + shader_grp = next( + (shader_group for shader_group in cmds.ls(type="shadingEngine") + if shader_group=="initialShadingGroup") + ) + cmds.sets(mesh_shape, forceElement=shader_grp) + group_node = cmds.group(empty=True, name="{}_GRP".format(name)) mesh_transform = cmds.listRelatives(mesh_shape, parent=True, fullPath=True) From fba52796d61c9968543a5ccaec3b4cf23459535d Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 18:04:03 +0800 Subject: [PATCH 078/198] assign the textures when the initial shading group is located --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index 0ed09c6007..340533ccbd 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -143,7 +143,8 @@ class RedshiftProxyLoader(load.LoaderPlugin): (shader_group for shader_group in cmds.ls(type="shadingEngine") if shader_group=="initialShadingGroup") ) - cmds.sets(mesh_shape, forceElement=shader_grp) + if shader_grp: + cmds.sets(mesh_shape, forceElement=shader_grp) group_node = cmds.group(empty=True, name="{}_GRP".format(name)) mesh_transform = cmds.listRelatives(mesh_shape, From a7efe2ea759a6775c42bb0b53a3992201e0f00a3 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 18:14:26 +0800 Subject: [PATCH 079/198] hound --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index 340533ccbd..f67fe1c529 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -139,10 +139,9 @@ class RedshiftProxyLoader(load.LoaderPlugin): # TODO: use the assigned shading group as shaders if existed # assign default shader to redshift proxy - shader_grp = next( - (shader_group for shader_group in cmds.ls(type="shadingEngine") - if shader_group=="initialShadingGroup") - ) + shader_grp = next((shader_group for shader_group + in cmds.ls(type="shadingEngine") + if shader_group=="initialShadingGroup")) if shader_grp: cmds.sets(mesh_shape, forceElement=shader_grp) From 3af7795f19e93082824e0162f0436687f13dee51 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 18:18:13 +0800 Subject: [PATCH 080/198] hound --- .../hosts/maya/plugins/load/load_redshift_proxy.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index f67fe1c529..7f88f1b152 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -139,11 +139,11 @@ class RedshiftProxyLoader(load.LoaderPlugin): # TODO: use the assigned shading group as shaders if existed # assign default shader to redshift proxy - shader_grp = next((shader_group for shader_group - in cmds.ls(type="shadingEngine") - if shader_group=="initialShadingGroup")) - if shader_grp: - cmds.sets(mesh_shape, forceElement=shader_grp) + shader_grp = next( + (shader_group for shader_group in cmds.ls(type="shadingEngine") + if shader_group == "initialShadingGroup") + ) + cmds.sets(mesh_shape, forceElement=shader_grp) group_node = cmds.group(empty=True, name="{}_GRP".format(name)) mesh_transform = cmds.listRelatives(mesh_shape, From bcea8967acab10bbc406fdfb0d7db4b12680f121 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 19:18:33 +0800 Subject: [PATCH 081/198] code tweaks on shader_grp's variable --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index 7f88f1b152..7b657f9184 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -140,8 +140,9 @@ class RedshiftProxyLoader(load.LoaderPlugin): # TODO: use the assigned shading group as shaders if existed # assign default shader to redshift proxy shader_grp = next( - (shader_group for shader_group in cmds.ls(type="shadingEngine") - if shader_group == "initialShadingGroup") + (shader_group for shader_group in + cmds.ls("initialShadingGroup", type="shadingEngine") + ) ) cmds.sets(mesh_shape, forceElement=shader_grp) From b40cba08016a9607d4e5f82ac534e0970079bae8 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 19:20:43 +0800 Subject: [PATCH 082/198] hound --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index 7b657f9184..33f39ebf38 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -140,8 +140,9 @@ class RedshiftProxyLoader(load.LoaderPlugin): # TODO: use the assigned shading group as shaders if existed # assign default shader to redshift proxy shader_grp = next( - (shader_group for shader_group in - cmds.ls("initialShadingGroup", type="shadingEngine") + ( + shader_group for shader_group in + cmds.ls("initialShadingGroup", type="shadingEngine") ) ) cmds.sets(mesh_shape, forceElement=shader_grp) From 584341dcef9a4d4185ba1d159d60fcba9d0dc755 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 4 Jan 2024 19:30:43 +0800 Subject: [PATCH 083/198] code tweaks on default shader grp --- openpype/hosts/maya/plugins/load/load_redshift_proxy.py | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py index 33f39ebf38..40385f34d6 100644 --- a/openpype/hosts/maya/plugins/load/load_redshift_proxy.py +++ b/openpype/hosts/maya/plugins/load/load_redshift_proxy.py @@ -139,13 +139,8 @@ class RedshiftProxyLoader(load.LoaderPlugin): # TODO: use the assigned shading group as shaders if existed # assign default shader to redshift proxy - shader_grp = next( - ( - shader_group for shader_group in - cmds.ls("initialShadingGroup", type="shadingEngine") - ) - ) - cmds.sets(mesh_shape, forceElement=shader_grp) + if cmds.ls("initialShadingGroup", type="shadingEngine"): + cmds.sets(mesh_shape, forceElement="initialShadingGroup") group_node = cmds.group(empty=True, name="{}_GRP".format(name)) mesh_transform = cmds.listRelatives(mesh_shape, From fd87751c36dc2c1fe1565dc8d782d8dcd786bf3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Sat, 6 Jan 2024 00:01:14 +0100 Subject: [PATCH 084/198] :art: add split export support for redshift --- .../plugins/publish/collect_redshift_rop.py | 19 +++++++++++++++++++ .../publish/submit_houdini_render_deadline.py | 10 ++++++++++ server_addon/deadline/server/version.py | 2 +- server_addon/houdini/server/version.py | 2 +- 4 files changed, 31 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py index 0acddab011..cd3bb2bb7a 100644 --- a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py @@ -45,6 +45,25 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): beauty_suffix = rop.evalParm("RS_outputBeautyAOVSuffix") render_products = [] + # Store whether we are splitting the render job (export + render) + split_render = bool(rop.parm("RS_archive_enable").eval()) + instance.data["splitRender"] = split_render + export_prefix = None + export_products = [] + if split_render: + export_prefix = evalParmNoFrame( + rop, "RS_archive_file", pad_character="0" + ) + beauty_export_product = self.get_render_product_name( + prefix=export_prefix, + suffix=None) + export_products.append(beauty_export_product) + self.log.debug( + "Found export product: {}".format(beauty_export_product) + ) + instance.data["ifdFile"] = beauty_export_product + instance.data["exportFiles"] = list(export_products) + # Default beauty AOV beauty_product = self.get_render_product_name( prefix=default_prefix, suffix=beauty_suffix diff --git a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index c8960185b2..0bfb37ee1c 100644 --- a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -41,6 +41,11 @@ class VrayRenderPluginInfo(): SeparateFilesPerFrame = attr.ib(default=True) +@attr.s +class RedshiftRenderPluginInfo(): + SceneFile = attr.ib(default=None) + Version = attr.ib(default=None) + class HoudiniSubmitDeadline( abstract_submit_deadline.AbstractSubmitDeadline, OpenPypePyblishPluginMixin @@ -262,6 +267,11 @@ class HoudiniSubmitDeadline( plugin_info = VrayRenderPluginInfo( InputFilename=instance.data["ifdFile"], ) + elif family == "redshift_rop": + plugin_info = RedshiftRenderPluginInfo( + SceneFile=instance.data["ifdFile"], + Version=os.getenv("REDSHIFT_VERSION", "3.5.22"), + ) else: self.log.error( "Family '%s' not supported yet to split render job", diff --git a/server_addon/deadline/server/version.py b/server_addon/deadline/server/version.py index 1276d0254f..0a8da88258 100644 --- a/server_addon/deadline/server/version.py +++ b/server_addon/deadline/server/version.py @@ -1 +1 @@ -__version__ = "0.1.5" +__version__ = "0.1.6" diff --git a/server_addon/houdini/server/version.py b/server_addon/houdini/server/version.py index 6232f7ab18..5635676f6b 100644 --- a/server_addon/houdini/server/version.py +++ b/server_addon/houdini/server/version.py @@ -1 +1 @@ -__version__ = "0.2.10" +__version__ = "0.2.11" From 8f43b87d3628f1eb0ca97f5c017c64e0407bb3bb Mon Sep 17 00:00:00 2001 From: Ynbot Date: Sat, 6 Jan 2024 03:25:10 +0000 Subject: [PATCH 085/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index 4d7b8f372f..dba782ded4 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.2" +__version__ = "3.18.3-nightly.1" From 9df4160595cd6678a6501bdc2dc79e40ba4b264b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 6 Jan 2024 03:25:49 +0000 Subject: [PATCH 086/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 132e960885..2e854061d5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.3-nightly.1 - 3.18.2 - 3.18.2-nightly.6 - 3.18.2-nightly.5 @@ -134,7 +135,6 @@ body: - 3.15.6-nightly.3 - 3.15.6-nightly.2 - 3.15.6-nightly.1 - - 3.15.5 validations: required: true - type: dropdown From 18e1f62ba29ff796e35b6e8da6bba3ce1f113e29 Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Mon, 8 Jan 2024 11:27:43 +0200 Subject: [PATCH 087/198] add split setting in redshift rop creator --- .../plugins/create/create_redshift_rop.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py index 1b8826a932..d790aaa340 100644 --- a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py @@ -15,6 +15,9 @@ class CreateRedshiftROP(plugin.HoudiniCreator): icon = "magic" ext = "exr" + # Default to split export and render jobs + split_render = True + def create(self, subset_name, instance_data, pre_create_data): instance_data.pop("active", None) @@ -76,6 +79,16 @@ class CreateRedshiftROP(plugin.HoudiniCreator): camera = node.path() parms.update({ "RS_renderCamera": camera or ""}) + + if pre_create_data.get("split_render"): + rs_filepath = \ + "{export_dir}{subset_name}/{subset_name}.$F4.rs".format( + export_dir=hou.text.expandString("$HIP/pyblish/rs/"), + subset_name=subset_name, + ) + parms["RS_archive_enable"] = 1 + parms["RS_archive_file"] = rs_filepath + instance_node.setParms(parms) # Lock some Avalon attributes @@ -102,6 +115,9 @@ class CreateRedshiftROP(plugin.HoudiniCreator): BoolDef("farm", label="Submitting to Farm", default=True), + BoolDef("split_render", + label="Split export and render jobs", + default=self.split_render), EnumDef("image_format", image_format_enum, default=self.ext, From 808a2b7031d0ec81516ee170fd3bcef1fa5e3b1c Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Mon, 8 Jan 2024 11:43:04 +0200 Subject: [PATCH 088/198] BigRoy's comments --- .../plugins/create/create_redshift_rop.py | 16 +++++++++------- .../plugins/publish/collect_redshift_rop.py | 1 - 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py index d790aaa340..097c703283 100644 --- a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py @@ -80,14 +80,16 @@ class CreateRedshiftROP(plugin.HoudiniCreator): parms.update({ "RS_renderCamera": camera or ""}) - if pre_create_data.get("split_render"): - rs_filepath = \ - "{export_dir}{subset_name}/{subset_name}.$F4.rs".format( - export_dir=hou.text.expandString("$HIP/pyblish/rs/"), - subset_name=subset_name, - ) + rs_filepath = \ + "{export_dir}{subset_name}/{subset_name}.$F4.rs".format( + export_dir=hou.text.expandString("$HIP/pyblish/rs/"), + subset_name=subset_name, + ) + parms["RS_archive_file"] = rs_filepath + + if pre_create_data.get("split_render", self.split_render): parms["RS_archive_enable"] = 1 - parms["RS_archive_file"] = rs_filepath + instance_node.setParms(parms) diff --git a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py index cd3bb2bb7a..056684b3a3 100644 --- a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py @@ -48,7 +48,6 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): # Store whether we are splitting the render job (export + render) split_render = bool(rop.parm("RS_archive_enable").eval()) instance.data["splitRender"] = split_render - export_prefix = None export_products = [] if split_render: export_prefix = evalParmNoFrame( From 938d9126a2bf76df4f9a3e5ccde2231dfd6507c3 Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Mon, 8 Jan 2024 11:48:23 +0200 Subject: [PATCH 089/198] BigRoy's comment - stick to code style --- .../deadline/plugins/publish/submit_houdini_render_deadline.py | 1 + 1 file changed, 1 insertion(+) diff --git a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index 0bfb37ee1c..8b03f682fc 100644 --- a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -46,6 +46,7 @@ class RedshiftRenderPluginInfo(): SceneFile = attr.ib(default=None) Version = attr.ib(default=None) + class HoudiniSubmitDeadline( abstract_submit_deadline.AbstractSubmitDeadline, OpenPypePyblishPluginMixin From 1e3fad27b0147691a3e535b9473ff330e84cfd51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 10:57:05 +0100 Subject: [PATCH 090/198] :recycle: some code style changes --- .../plugins/create/create_redshift_rop.py | 25 ++++++++----------- .../plugins/publish/collect_redshift_rop.py | 13 ++++------ .../publish/submit_houdini_render_deadline.py | 1 + 3 files changed, 17 insertions(+), 22 deletions(-) diff --git a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py index 097c703283..b36580f67e 100644 --- a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py @@ -39,12 +39,15 @@ class CreateRedshiftROP(plugin.HoudiniCreator): # Also create the linked Redshift IPR Rop try: ipr_rop = instance_node.parent().createNode( - "Redshift_IPR", node_name=basename + "_IPR" + "Redshift_IPR", node_name=f"{basename}_IPR" ) - except hou.OperationFailed: + except hou.OperationFailed as e: raise plugin.OpenPypeCreatorError( - ("Cannot create Redshift node. Is Redshift " - "installed and enabled?")) + ( + "Cannot create Redshift node. Is Redshift " + "installed and enabled?" + ) + ) from e # Move it to directly under the Redshift ROP ipr_rop.setPosition(instance_node.position() + hou.Vector2(0, -1)) @@ -77,22 +80,16 @@ class CreateRedshiftROP(plugin.HoudiniCreator): for node in self.selected_nodes: if node.type().name() == "cam": camera = node.path() - parms.update({ - "RS_renderCamera": camera or ""}) + parms["RS_renderCamera"] = camera or "" - rs_filepath = \ - "{export_dir}{subset_name}/{subset_name}.$F4.rs".format( - export_dir=hou.text.expandString("$HIP/pyblish/rs/"), - subset_name=subset_name, - ) + export_dir=hou.text.expandString("$HIP/pyblish/rs/") + rs_filepath = f"{export_dir}{subset_name}/{subset_name}.$F4.rs" parms["RS_archive_file"] = rs_filepath + instance_node.setParms(parms) if pre_create_data.get("split_render", self.split_render): parms["RS_archive_enable"] = 1 - - instance_node.setParms(parms) - # Lock some Avalon attributes to_lock = ["family", "id"] self.lock_parameters(instance_node, to_lock) diff --git a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py index 056684b3a3..aec7e07fbc 100644 --- a/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/publish/collect_redshift_rop.py @@ -31,7 +31,6 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): families = ["redshift_rop"] def process(self, instance): - rop = hou.node(instance.data.get("instance_node")) # Collect chunkSize @@ -43,8 +42,6 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): default_prefix = evalParmNoFrame(rop, "RS_outputFileNamePrefix") beauty_suffix = rop.evalParm("RS_outputBeautyAOVSuffix") - render_products = [] - # Store whether we are splitting the render job (export + render) split_render = bool(rop.parm("RS_archive_enable").eval()) instance.data["splitRender"] = split_render @@ -67,7 +64,7 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): beauty_product = self.get_render_product_name( prefix=default_prefix, suffix=beauty_suffix ) - render_products.append(beauty_product) + render_products = [beauty_product] files_by_aov = { "_": self.generate_expected_files(instance, beauty_product)} @@ -77,11 +74,11 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): i = index + 1 # Skip disabled AOVs - if not rop.evalParm("RS_aovEnable_%s" % i): + if not rop.evalParm(f"RS_aovEnable_{i}"): continue - aov_suffix = rop.evalParm("RS_aovSuffix_%s" % i) - aov_prefix = evalParmNoFrame(rop, "RS_aovCustomPrefix_%s" % i) + aov_suffix = rop.evalParm(f"RS_aovSuffix_{i}") + aov_prefix = evalParmNoFrame(rop, f"RS_aovCustomPrefix_{i}") if not aov_prefix: aov_prefix = default_prefix @@ -103,7 +100,7 @@ class CollectRedshiftROPRenderProducts(pyblish.api.InstancePlugin): instance.data["attachTo"] = [] # stub required data if "expectedFiles" not in instance.data: - instance.data["expectedFiles"] = list() + instance.data["expectedFiles"] = [] instance.data["expectedFiles"].append(files_by_aov) # update the colorspace data diff --git a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index 8b03f682fc..fd5e789d0e 100644 --- a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -15,6 +15,7 @@ from openpype.lib import ( NumberDef ) + @attr.s class DeadlinePluginInfo(): SceneFile = attr.ib(default=None) From 3e4b8a152217af7473d38e8de4dd6f11ec84170b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 11:16:33 +0100 Subject: [PATCH 091/198] :dog: fix hound --- openpype/hosts/houdini/plugins/create/create_redshift_rop.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py index b36580f67e..151fd26074 100644 --- a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py @@ -82,7 +82,7 @@ class CreateRedshiftROP(plugin.HoudiniCreator): camera = node.path() parms["RS_renderCamera"] = camera or "" - export_dir=hou.text.expandString("$HIP/pyblish/rs/") + export_dir = hou.text.expandString("$HIP/pyblish/rs/") rs_filepath = f"{export_dir}{subset_name}/{subset_name}.$F4.rs" parms["RS_archive_file"] = rs_filepath From 5d787d3fc3c77b2977f18b6da1ee7161610e4a8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 11:17:12 +0100 Subject: [PATCH 092/198] :recycle: change how redshift version is passed --- .../plugins/publish/submit_houdini_render_deadline.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index fd5e789d0e..abcc3378da 100644 --- a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -271,9 +271,11 @@ class HoudiniSubmitDeadline( ) elif family == "redshift_rop": plugin_info = RedshiftRenderPluginInfo( - SceneFile=instance.data["ifdFile"], - Version=os.getenv("REDSHIFT_VERSION", "3.5.22"), + SceneFile=instance.data["ifdFile"] ) + if os.getenv("REDSHIFT_VERSION"): + plugin_info.Version = os.getenv("REDSHIFT_VERSION"), + else: self.log.error( "Family '%s' not supported yet to split render job", From 5f837d6f0b381f0ffc4db488c563bac10127b481 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Mon, 8 Jan 2024 11:51:28 +0100 Subject: [PATCH 093/198] AfterEffects: exposing Deadline pools fields in Publisher UI (#6079) * OP-6421 - added render family to families filter As published instances follow product type `render` now, fields wouldn't be shown for them. * OP-6421 - updated documentation * OP-6421 - added hosts filter Limits this with higher precision. --- .../deadline/plugins/publish/collect_pools.py | 40 +++++++++++++++---- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/collect_pools.py b/openpype/modules/deadline/plugins/publish/collect_pools.py index a25b149f11..9ee079b892 100644 --- a/openpype/modules/deadline/plugins/publish/collect_pools.py +++ b/openpype/modules/deadline/plugins/publish/collect_pools.py @@ -1,7 +1,4 @@ # -*- coding: utf-8 -*- -"""Collect Deadline pools. Choose default one from Settings - -""" import pyblish.api from openpype.lib import TextDef from openpype.pipeline.publish import OpenPypePyblishPluginMixin @@ -9,11 +6,35 @@ from openpype.pipeline.publish import OpenPypePyblishPluginMixin class CollectDeadlinePools(pyblish.api.InstancePlugin, OpenPypePyblishPluginMixin): - """Collect pools from instance if present, from Setting otherwise.""" + """Collect pools from instance or Publisher attributes, from Setting + otherwise. + + Pools are used to control which DL workers could render the job. + + Pools might be set: + - directly on the instance (set directly in DCC) + - from Publisher attributes + - from defaults from Settings. + + Publisher attributes could be shown even for instances that should be + rendered locally as visibility is driven by product type of the instance + (which will be `render` most likely). + (Might be resolved in the future and class attribute 'families' should + be cleaned up.) + + """ order = pyblish.api.CollectorOrder + 0.420 label = "Collect Deadline Pools" - families = ["rendering", + hosts = ["aftereffects", + "fusion", + "harmony" + "nuke", + "maya", + "max"] + + families = ["render", + "rendering", "render.farm", "renderFarm", "renderlayer", @@ -30,7 +51,6 @@ class CollectDeadlinePools(pyblish.api.InstancePlugin, cls.secondary_pool = settings.get("secondary_pool", None) def process(self, instance): - attr_values = self.get_attr_values_from_data(instance.data) if not instance.data.get("primaryPool"): instance.data["primaryPool"] = ( @@ -60,8 +80,12 @@ class CollectDeadlinePools(pyblish.api.InstancePlugin, return [ TextDef("primaryPool", label="Primary Pool", - default=cls.primary_pool), + default=cls.primary_pool, + tooltip="Deadline primary pool, " + "applicable for farm rendering"), TextDef("secondaryPool", label="Secondary Pool", - default=cls.secondary_pool) + default=cls.secondary_pool, + tooltip="Deadline secondary pool, " + "applicable for farm rendering") ] From cf17ea8377e21c4820756c83f03cd43f2eafeeeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 12:09:06 +0100 Subject: [PATCH 094/198] :memo: add comment and warning about unspecified RS version --- .../publish/submit_houdini_render_deadline.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py index abcc3378da..bf7fb45a8b 100644 --- a/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_houdini_render_deadline.py @@ -273,8 +273,20 @@ class HoudiniSubmitDeadline( plugin_info = RedshiftRenderPluginInfo( SceneFile=instance.data["ifdFile"] ) + # Note: To use different versions of Redshift on Deadline + # set the `REDSHIFT_VERSION` env variable in the Tools + # settings in the AYON Application plugin. You will also + # need to set that version in `Redshift.param` file + # of the Redshift Deadline plugin: + # [Redshift_Executable_*] + # where * is the version number. if os.getenv("REDSHIFT_VERSION"): - plugin_info.Version = os.getenv("REDSHIFT_VERSION"), + plugin_info.Version = os.getenv("REDSHIFT_VERSION") + else: + self.log.warning(( + "REDSHIFT_VERSION env variable is not set" + " - using version configured in Deadline" + )) else: self.log.error( From 9d8378502436c1188fdb03be0185552cdfae2a92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 12:41:22 +0100 Subject: [PATCH 095/198] :bug: fix render archive enable flag settings --- openpype/hosts/houdini/plugins/create/create_redshift_rop.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py index 151fd26074..9d1c7bc90d 100644 --- a/openpype/hosts/houdini/plugins/create/create_redshift_rop.py +++ b/openpype/hosts/houdini/plugins/create/create_redshift_rop.py @@ -86,10 +86,11 @@ class CreateRedshiftROP(plugin.HoudiniCreator): rs_filepath = f"{export_dir}{subset_name}/{subset_name}.$F4.rs" parms["RS_archive_file"] = rs_filepath - instance_node.setParms(parms) if pre_create_data.get("split_render", self.split_render): parms["RS_archive_enable"] = 1 + instance_node.setParms(parms) + # Lock some Avalon attributes to_lock = ["family", "id"] self.lock_parameters(instance_node, to_lock) From 05cbb8b019d2e14fdcde07c38d4a7d80dfc2c3cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Mon, 8 Jan 2024 13:33:51 +0100 Subject: [PATCH 096/198] :wrench: fix and update pydocstyle configuration --- pyproject.toml | 5 +++++ setup.cfg | 4 ---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 38236f88bc..ee8e8017e3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -181,3 +181,8 @@ reportMissingTypeStubs = false [tool.poetry.extras] docs = ["Sphinx", "furo", "sphinxcontrib-napoleon"] + +[tool.pydocstyle] +inherit = false +convetion = "google" +match = "(?!test_).*\\.py" diff --git a/setup.cfg b/setup.cfg index ead9b25164..f0f754fb24 100644 --- a/setup.cfg +++ b/setup.cfg @@ -16,10 +16,6 @@ max-complexity = 30 [pylint.'MESSAGES CONTROL'] disable = no-member -[pydocstyle] -convention = google -ignore = D107 - [coverage:run] branch = True omit = /tests From 86cf80027c039a9a353911760eaf13ae78279ea0 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 9 Jan 2024 11:16:28 +0100 Subject: [PATCH 097/198] Chore: Remove deprecated templates profiles (#6103) * do not use 'IntegrateAssetNew' settings which are not available anymore * don't use 'IntegrateHeroVersion' settings to get hero version template name * remove 'template_name_profiles' from 'IntegrateHeroVersion' * remove unused attribute --- openpype/pipeline/publish/lib.py | 55 +------------------ .../plugins/publish/integrate_hero_version.py | 1 - .../schemas/schema_global_publish.json | 43 --------------- .../core/server/settings/publish_plugins.py | 20 ------- 4 files changed, 2 insertions(+), 117 deletions(-) diff --git a/openpype/pipeline/publish/lib.py b/openpype/pipeline/publish/lib.py index 4ea2f932f1..40cb94e2bf 100644 --- a/openpype/pipeline/publish/lib.py +++ b/openpype/pipeline/publish/lib.py @@ -58,41 +58,13 @@ def get_template_name_profiles( if not project_settings: project_settings = get_project_settings(project_name) - profiles = ( + return copy.deepcopy( project_settings ["global"] ["tools"] ["publish"] ["template_name_profiles"] ) - if profiles: - return copy.deepcopy(profiles) - - # Use legacy approach for cases new settings are not filled yet for the - # project - legacy_profiles = ( - project_settings - ["global"] - ["publish"] - ["IntegrateAssetNew"] - ["template_name_profiles"] - ) - if legacy_profiles: - if not logger: - logger = Logger.get_logger("get_template_name_profiles") - - logger.warning(( - "Project \"{}\" is using legacy access to publish template." - " It is recommended to move settings to new location" - " 'project_settings/global/tools/publish/template_name_profiles'." - ).format(project_name)) - - # Replace "tasks" key with "task_names" - profiles = [] - for profile in copy.deepcopy(legacy_profiles): - profile["task_names"] = profile.pop("tasks", []) - profiles.append(profile) - return profiles def get_hero_template_name_profiles( @@ -121,36 +93,13 @@ def get_hero_template_name_profiles( if not project_settings: project_settings = get_project_settings(project_name) - profiles = ( + return copy.deepcopy( project_settings ["global"] ["tools"] ["publish"] ["hero_template_name_profiles"] ) - if profiles: - return copy.deepcopy(profiles) - - # Use legacy approach for cases new settings are not filled yet for the - # project - legacy_profiles = copy.deepcopy( - project_settings - ["global"] - ["publish"] - ["IntegrateHeroVersion"] - ["template_name_profiles"] - ) - if legacy_profiles: - if not logger: - logger = Logger.get_logger("get_hero_template_name_profiles") - - logger.warning(( - "Project \"{}\" is using legacy access to hero publish template." - " It is recommended to move settings to new location" - " 'project_settings/global/tools/publish/" - "hero_template_name_profiles'." - ).format(project_name)) - return legacy_profiles def get_publish_template_name( diff --git a/openpype/plugins/publish/integrate_hero_version.py b/openpype/plugins/publish/integrate_hero_version.py index 9f0f7fe7f3..59dc6b5c64 100644 --- a/openpype/plugins/publish/integrate_hero_version.py +++ b/openpype/plugins/publish/integrate_hero_version.py @@ -54,7 +54,6 @@ class IntegrateHeroVersion(pyblish.api.InstancePlugin): # permissions error on files (files were used or user didn't have perms) # *but all other plugins must be sucessfully completed - template_name_profiles = [] _default_template_name = "hero" def process(self, instance): 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 ac2d9e190d..64f292a140 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 @@ -1023,49 +1023,6 @@ { "type": "label", "label": "NOTE: Hero publish template profiles settings were moved to Tools/Publish/Hero template name profiles. Please move values there." - }, - { - "type": "list", - "key": "template_name_profiles", - "label": "Template name profiles (DEPRECATED)", - "use_label_wrap": true, - "object_type": { - "type": "dict", - "children": [ - { - "key": "families", - "label": "Families", - "type": "list", - "object_type": "text" - }, - { - "type": "hosts-enum", - "key": "hosts", - "label": "Hosts", - "multiselection": true - }, - { - "key": "task_types", - "label": "Task types", - "type": "task-types-enum" - }, - { - "key": "task_names", - "label": "Task names", - "type": "list", - "object_type": "text" - }, - { - "type": "separator" - }, - { - "type": "text", - "key": "template_name", - "label": "Template name", - "tooltip": "Name of template from Anatomy templates" - } - ] - } } ] }, diff --git a/server_addon/core/server/settings/publish_plugins.py b/server_addon/core/server/settings/publish_plugins.py index ef52416369..0c9b9c96ef 100644 --- a/server_addon/core/server/settings/publish_plugins.py +++ b/server_addon/core/server/settings/publish_plugins.py @@ -697,13 +697,6 @@ class IntegrateHeroVersionModel(BaseSettingsModel): optional: bool = Field(False, title="Optional") active: bool = Field(True, title="Active") families: list[str] = Field(default_factory=list, title="Families") - # TODO remove when removed from client code - template_name_profiles: list[IntegrateHeroTemplateNameProfileModel] = ( - Field( - default_factory=list, - title="Template name profiles" - ) - ) class CleanUpModel(BaseSettingsModel): @@ -1049,19 +1042,6 @@ DEFAULT_PUBLISH_VALUES = { "layout", "mayaScene", "simpleUnrealTexture" - ], - "template_name_profiles": [ - { - "product_types": [ - "simpleUnrealTexture" - ], - "hosts": [ - "standalonepublisher" - ], - "task_types": [], - "task_names": [], - "template_name": "simpleUnrealTextureHero" - } ] }, "CleanUp": { From faf22c7c6df76247af2ed7a653bbfe0b84220116 Mon Sep 17 00:00:00 2001 From: Ynbot Date: Wed, 10 Jan 2024 03:25:43 +0000 Subject: [PATCH 098/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index dba782ded4..279575d110 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.3-nightly.1" +__version__ = "3.18.3-nightly.2" From 4aec54f577f42b08fb4006c657ff4c94e109fa27 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 10 Jan 2024 03:26:22 +0000 Subject: [PATCH 099/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2e854061d5..7d6c5650d1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.3-nightly.2 - 3.18.3-nightly.1 - 3.18.2 - 3.18.2-nightly.6 @@ -134,7 +135,6 @@ body: - 3.15.6 - 3.15.6-nightly.3 - 3.15.6-nightly.2 - - 3.15.6-nightly.1 validations: required: true - type: dropdown From 0a6edc648c0b5866b6025d82e091494840b17878 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Wed, 10 Jan 2024 12:03:08 +0000 Subject: [PATCH 100/198] Fix problem with AVALON_CONTAINER collection and workfile instance --- openpype/hosts/blender/api/plugin.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/blender/api/plugin.py b/openpype/hosts/blender/api/plugin.py index 1037854a2d..b1ff3e4a09 100644 --- a/openpype/hosts/blender/api/plugin.py +++ b/openpype/hosts/blender/api/plugin.py @@ -311,11 +311,13 @@ class BaseCreator(Creator): ) return - # Rename the instance node in the scene if subset or asset changed + # Rename the instance node in the scene if subset or asset changed. + # Do not rename the instance if the family is workfile, as the + # workfile instance is included in the AVALON_CONTAINER collection. if ( "subset" in changes.changed_keys or asset_name_key in changes.changed_keys - ): + ) and created_instance.family != "workfile": asset_name = data[asset_name_key] if AYON_SERVER_ENABLED: asset_name = asset_name.split("/")[-1] From 399bb404c4d0deae30731db123be76dca1de38d8 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 10 Jan 2024 17:10:52 +0100 Subject: [PATCH 101/198] Fusion: automatic installation of PySide2 (#6111) * OP-7450 - WIP of new hook to install PySide2 Currently not working yet as subprocess is invoking wrong `pip` which causes issue about missing `dataclasses`. * OP-7450 - updates querying of PySide2 presence Cannot use pip list as wrong pip from .venv is used and it was causing issue about missing dataclass (not in Python3.6). This implementation is simpler and just tries to import PySide2. * OP-7450 - typo * OP-7450 - removed forgotten raise for debugging * OP-7450 - double quotes Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * OP-7450 - return if error Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * OP-7450 - return False Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * OP-7450 - added optionality for InstallPySideToFusion New hook is controllable by Settings. * OP-7450 - updated querying of Qt This approach should be more generic, not tied to specific version of PySide2 * OP-7450 - fix unwanted change * OP-7450 - added settings for legacy OP * OP-7450 - use correct python executable name in Linux Because it is not "expected" python in blender but installed python, I would expect the executable is python3 on linux/macos rather than python. Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * OP-7450 - headless installation in Windows It checks first that it would need admin privileges for installation, if not it installs headlessly. If yes, it will create separate dialog that will ask for admin privileges. * OP-7450 - Hound * Update openpype/hosts/fusion/hooks/pre_pyside_install.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --------- Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- .../hosts/fusion/hooks/pre_fusion_setup.py | 3 + .../hosts/fusion/hooks/pre_pyside_install.py | 186 ++++++++++++++++++ .../defaults/project_settings/fusion.json | 5 + .../schema_project_fusion.json | 23 +++ server_addon/fusion/server/settings.py | 49 +++-- server_addon/fusion/server/version.py | 2 +- 6 files changed, 253 insertions(+), 15 deletions(-) create mode 100644 openpype/hosts/fusion/hooks/pre_pyside_install.py diff --git a/openpype/hosts/fusion/hooks/pre_fusion_setup.py b/openpype/hosts/fusion/hooks/pre_fusion_setup.py index 576628e876..3da8968727 100644 --- a/openpype/hosts/fusion/hooks/pre_fusion_setup.py +++ b/openpype/hosts/fusion/hooks/pre_fusion_setup.py @@ -64,5 +64,8 @@ class FusionPrelaunch(PreLaunchHook): self.launch_context.env[py3_var] = py3_dir + # for hook installing PySide2 + self.data["fusion_python3_home"] = py3_dir + self.log.info(f"Setting OPENPYPE_FUSION: {FUSION_HOST_DIR}") self.launch_context.env["OPENPYPE_FUSION"] = FUSION_HOST_DIR diff --git a/openpype/hosts/fusion/hooks/pre_pyside_install.py b/openpype/hosts/fusion/hooks/pre_pyside_install.py new file mode 100644 index 0000000000..f98aeda233 --- /dev/null +++ b/openpype/hosts/fusion/hooks/pre_pyside_install.py @@ -0,0 +1,186 @@ +import os +import subprocess +import platform +import uuid + +from openpype.lib.applications import PreLaunchHook, LaunchTypes + + +class InstallPySideToFusion(PreLaunchHook): + """Automatically installs Qt binding to fusion's python packages. + + Check if fusion has installed PySide2 and will try to install if not. + + For pipeline implementation is required to have Qt binding installed in + fusion's python packages. + """ + + app_groups = {"fusion"} + order = 2 + launch_types = {LaunchTypes.local} + + def execute(self): + # Prelaunch hook is not crucial + try: + settings = self.data["project_settings"][self.host_name] + if not settings["hooks"]["InstallPySideToFusion"]["enabled"]: + return + self.inner_execute() + except Exception: + self.log.warning( + "Processing of {} crashed.".format(self.__class__.__name__), + exc_info=True + ) + + def inner_execute(self): + self.log.debug("Check for PySide2 installation.") + + fusion_python3_home = self.data.get("fusion_python3_home") + if not fusion_python3_home: + self.log.warning("'fusion_python3_home' was not provided. " + "Installation of PySide2 not possible") + return + + if platform.system().lower() == "windows": + exe_filenames = ["python.exe"] + else: + exe_filenames = ["python3", "python"] + + for exe_filename in exe_filenames: + python_executable = os.path.join(fusion_python3_home, exe_filename) + if os.path.exists(python_executable): + break + + if not os.path.exists(python_executable): + self.log.warning( + "Couldn't find python executable for fusion. {}".format( + python_executable + ) + ) + return + + # Check if PySide2 is installed and skip if yes + if self._is_pyside_installed(python_executable): + self.log.debug("Fusion has already installed PySide2.") + return + + self.log.debug("Installing PySide2.") + # Install PySide2 in fusion's python + if self._windows_require_permissions( + os.path.dirname(python_executable)): + result = self._install_pyside_windows(python_executable) + else: + result = self._install_pyside(python_executable) + + if result: + self.log.info("Successfully installed PySide2 module to fusion.") + else: + self.log.warning("Failed to install PySide2 module to fusion.") + + def _install_pyside_windows(self, python_executable): + """Install PySide2 python module to fusion's python. + + Installation requires administration rights that's why it is required + to use "pywin32" module which can execute command's and ask for + administration rights. + """ + try: + import win32api + import win32con + import win32process + import win32event + import pywintypes + from win32comext.shell.shell import ShellExecuteEx + from win32comext.shell import shellcon + except Exception: + self.log.warning("Couldn't import \"pywin32\" modules") + return False + + try: + # Parameters + # - use "-m pip" as module pip to install PySide2 and argument + # "--ignore-installed" is to force install module to fusion's + # site-packages and make sure it is binary compatible + parameters = "-m pip install --ignore-installed PySide2" + + # Execute command and ask for administrator's rights + process_info = ShellExecuteEx( + nShow=win32con.SW_SHOWNORMAL, + fMask=shellcon.SEE_MASK_NOCLOSEPROCESS, + lpVerb="runas", + lpFile=python_executable, + lpParameters=parameters, + lpDirectory=os.path.dirname(python_executable) + ) + process_handle = process_info["hProcess"] + win32event.WaitForSingleObject(process_handle, + win32event.INFINITE) + returncode = win32process.GetExitCodeProcess(process_handle) + return returncode == 0 + except pywintypes.error: + return False + + def _install_pyside(self, python_executable): + """Install PySide2 python module to fusion's python.""" + try: + # Parameters + # - use "-m pip" as module pip to install PySide2 and argument + # "--ignore-installed" is to force install module to fusion's + # site-packages and make sure it is binary compatible + env = dict(os.environ) + del env['PYTHONPATH'] + args = [ + python_executable, + "-m", + "pip", + "install", + "--ignore-installed", + "PySide2", + ] + process = subprocess.Popen( + args, stdout=subprocess.PIPE, universal_newlines=True, + env=env + ) + process.communicate() + return process.returncode == 0 + except PermissionError: + self.log.warning( + "Permission denied with command:" + "\"{}\".".format(" ".join(args)) + ) + except OSError as error: + self.log.warning(f"OS error has occurred: \"{error}\".") + except subprocess.SubprocessError: + pass + + def _is_pyside_installed(self, python_executable): + """Check if PySide2 module is in fusion's pip list.""" + args = [python_executable, "-c", "from qtpy import QtWidgets"] + process = subprocess.Popen(args, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + _, stderr = process.communicate() + stderr = stderr.decode() + if stderr: + return False + return True + + def _windows_require_permissions(self, dirpath): + if platform.system().lower() != "windows": + return False + + try: + # Attempt to create a temporary file in the folder + temp_file_path = os.path.join(dirpath, uuid.uuid4().hex) + with open(temp_file_path, "w"): + pass + os.remove(temp_file_path) # Clean up temporary file + return False + + except PermissionError: + return True + + except BaseException as exc: + print(("Failed to determine if root requires permissions." + "Unexpected error: {}").format(exc)) + return False diff --git a/openpype/settings/defaults/project_settings/fusion.json b/openpype/settings/defaults/project_settings/fusion.json index 0edcae060a..8579442625 100644 --- a/openpype/settings/defaults/project_settings/fusion.json +++ b/openpype/settings/defaults/project_settings/fusion.json @@ -15,6 +15,11 @@ "copy_status": false, "force_sync": false }, + "hooks": { + "InstallPySideToFusion": { + "enabled": true + } + }, "create": { "CreateSaver": { "temp_rendering_path_template": "{workdir}/renders/fusion/{subset}/{subset}.{frame}.{ext}", diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json index 5177d8bc7c..fbd856b895 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json @@ -41,6 +41,29 @@ } ] }, + { + "type": "dict", + "collapsible": true, + "key": "hooks", + "label": "Hooks", + "children": [ + { + "type": "dict", + "collapsible": true, + "checkbox_key": "enabled", + "key": "InstallPySideToFusion", + "label": "Install PySide2", + "is_group": true, + "children": [ + { + "type": "boolean", + "key": "enabled", + "label": "Enabled" + } + ] + } + ] + }, { "type": "dict", "collapsible": true, diff --git a/server_addon/fusion/server/settings.py b/server_addon/fusion/server/settings.py index 1bc12773d2..21189b390e 100644 --- a/server_addon/fusion/server/settings.py +++ b/server_addon/fusion/server/settings.py @@ -25,16 +25,6 @@ def _create_saver_instance_attributes_enum(): ] -def _image_format_enum(): - return [ - {"value": "exr", "label": "exr"}, - {"value": "tga", "label": "tga"}, - {"value": "png", "label": "png"}, - {"value": "tif", "label": "tif"}, - {"value": "jpg", "label": "jpg"}, - ] - - class CreateSaverPluginModel(BaseSettingsModel): _isGroup = True temp_rendering_path_template: str = Field( @@ -49,9 +39,23 @@ class CreateSaverPluginModel(BaseSettingsModel): enum_resolver=_create_saver_instance_attributes_enum, title="Instance attributes" ) - image_format: str = Field( - enum_resolver=_image_format_enum, - title="Output Image Format" + output_formats: list[str] = Field( + default_factory=list, + title="Output formats" + ) + + +class HookOptionalModel(BaseSettingsModel): + enabled: bool = Field( + True, + title="Enabled" + ) + + +class HooksModel(BaseSettingsModel): + InstallPySideToFusion: HookOptionalModel = Field( + default_factory=HookOptionalModel, + title="Install PySide2" ) @@ -71,6 +75,10 @@ class FusionSettings(BaseSettingsModel): default_factory=CopyFusionSettingsModel, title="Local Fusion profile settings" ) + hooks: HooksModel = Field( + default_factory=HooksModel, + title="Hooks" + ) create: CreatPluginsModel = Field( default_factory=CreatPluginsModel, title="Creator plugins" @@ -93,6 +101,11 @@ DEFAULT_VALUES = { "copy_status": False, "force_sync": False }, + "hooks": { + "InstallPySideToFusion": { + "enabled": True + } + }, "create": { "CreateSaver": { "temp_rendering_path_template": "{workdir}/renders/fusion/{product[name]}/{product[name]}.{frame}.{ext}", @@ -104,7 +117,15 @@ DEFAULT_VALUES = { "reviewable", "farm_rendering" ], - "image_format": "exr" + "output_formats": [ + "exr", + "jpg", + "jpeg", + "jpg", + "tiff", + "png", + "tga" + ] } } } diff --git a/server_addon/fusion/server/version.py b/server_addon/fusion/server/version.py index 485f44ac21..b3f4756216 100644 --- a/server_addon/fusion/server/version.py +++ b/server_addon/fusion/server/version.py @@ -1 +1 @@ -__version__ = "0.1.1" +__version__ = "0.1.2" From aba61718b256ed9cafc7aedcd80ffe369570f0e6 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 11 Jan 2024 12:07:35 +0100 Subject: [PATCH 102/198] fix issue with parenting of widgets (#6106) --- openpype/hosts/nuke/api/pipeline.py | 8 ++------ openpype/tools/publisher/window.py | 2 +- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/openpype/hosts/nuke/api/pipeline.py b/openpype/hosts/nuke/api/pipeline.py index 12562a6b6f..c2fc684c21 100644 --- a/openpype/hosts/nuke/api/pipeline.py +++ b/openpype/hosts/nuke/api/pipeline.py @@ -259,9 +259,7 @@ def _install_menu(): menu.addCommand( "Create...", lambda: host_tools.show_publisher( - parent=( - main_window if nuke.NUKE_VERSION_MAJOR >= 14 else None - ), + parent=main_window, tab="create" ) ) @@ -270,9 +268,7 @@ def _install_menu(): menu.addCommand( "Publish...", lambda: host_tools.show_publisher( - parent=( - main_window if nuke.NUKE_VERSION_MAJOR >= 14 else None - ), + parent=main_window, tab="publish" ) ) diff --git a/openpype/tools/publisher/window.py b/openpype/tools/publisher/window.py index b3138c3f45..20d9884788 100644 --- a/openpype/tools/publisher/window.py +++ b/openpype/tools/publisher/window.py @@ -189,7 +189,7 @@ class PublisherWindow(QtWidgets.QDialog): controller, content_stacked_widget ) - report_widget = ReportPageWidget(controller, parent) + report_widget = ReportPageWidget(controller, content_stacked_widget) # Details - Publish details publish_details_widget = PublishReportViewerWidget( From 4e704b1b0728a158ef824acef1601ede9d4162ee Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:18:58 +0100 Subject: [PATCH 103/198] AYON: OpenPype addon dependencies (#6113) * click is required by openpype addon * removed Qt.py from dependencies * add six to openpype addon dependencies --- server_addon/openpype/client/pyproject.toml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/server_addon/openpype/client/pyproject.toml b/server_addon/openpype/client/pyproject.toml index d8de9d4d96..b5978f0498 100644 --- a/server_addon/openpype/client/pyproject.toml +++ b/server_addon/openpype/client/pyproject.toml @@ -7,15 +7,16 @@ python = ">=3.9.1,<3.10" aiohttp_json_rpc = "*" # TVPaint server aiohttp-middlewares = "^2.0.0" wsrpc_aiohttp = "^3.1.1" # websocket server +Click = "^8" clique = "1.6.*" jsonschema = "^2.6.0" pymongo = "^3.11.2" log4mongo = "^1.7" pyblish-base = "^1.8.11" pynput = "^1.7.2" # Timers manager - TODO remove -"Qt.py" = "^1.3.3" -qtawesome = "0.7.3" speedcopy = "^2.1" +six = "^1.15" +qtawesome = "0.7.3" [ayon.runtimeDependencies] OpenTimelineIO = "0.14.1" From adb7e19c232adad1e9fb122ba5cffdd55970916b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:21:41 +0100 Subject: [PATCH 104/198] Publisher: Window is not always on top (#6107) * make publisher a window without always on top * put publisher window to the top on process * make sure screenshot window is active * removed unnecessary variable --- .../publisher/widgets/screenshot_widget.py | 8 +++- openpype/tools/publisher/window.py | 38 ++++++++++++++----- 2 files changed, 35 insertions(+), 11 deletions(-) diff --git a/openpype/tools/publisher/widgets/screenshot_widget.py b/openpype/tools/publisher/widgets/screenshot_widget.py index 3504b419b4..37b958c1c7 100644 --- a/openpype/tools/publisher/widgets/screenshot_widget.py +++ b/openpype/tools/publisher/widgets/screenshot_widget.py @@ -18,10 +18,11 @@ class ScreenMarquee(QtWidgets.QDialog): super(ScreenMarquee, self).__init__(parent=parent) self.setWindowFlags( - QtCore.Qt.FramelessWindowHint + QtCore.Qt.Window + | QtCore.Qt.FramelessWindowHint | QtCore.Qt.WindowStaysOnTopHint | QtCore.Qt.CustomizeWindowHint - | QtCore.Qt.Tool) + ) self.setAttribute(QtCore.Qt.WA_TranslucentBackground) self.setCursor(QtCore.Qt.CrossCursor) self.setMouseTracking(True) @@ -210,6 +211,9 @@ class ScreenMarquee(QtWidgets.QDialog): """ tool = cls() + # Activate so Escape event is not ignored. + tool.setWindowState(QtCore.Qt.WindowActive) + # Exec dialog and return captured pixmap. tool.exec_() return tool.get_captured_pixmap() diff --git a/openpype/tools/publisher/window.py b/openpype/tools/publisher/window.py index 20d9884788..5dd6998b24 100644 --- a/openpype/tools/publisher/window.py +++ b/openpype/tools/publisher/window.py @@ -42,7 +42,7 @@ from .widgets import ( ) -class PublisherWindow(QtWidgets.QDialog): +class PublisherWindow(QtWidgets.QWidget): """Main window of publisher.""" default_width = 1300 default_height = 800 @@ -50,7 +50,7 @@ class PublisherWindow(QtWidgets.QDialog): publish_footer_spacer = 2 def __init__(self, parent=None, controller=None, reset_on_show=None): - super(PublisherWindow, self).__init__(parent) + super(PublisherWindow, self).__init__() self.setObjectName("PublishWindow") @@ -64,17 +64,12 @@ class PublisherWindow(QtWidgets.QDialog): if reset_on_show is None: reset_on_show = True - if parent is None: - on_top_flag = QtCore.Qt.WindowStaysOnTopHint - else: - on_top_flag = QtCore.Qt.Dialog - self.setWindowFlags( - QtCore.Qt.WindowTitleHint + QtCore.Qt.Window + | QtCore.Qt.WindowTitleHint | QtCore.Qt.WindowMaximizeButtonHint | QtCore.Qt.WindowMinimizeButtonHint | QtCore.Qt.WindowCloseButtonHint - | on_top_flag ) if controller is None: @@ -299,6 +294,12 @@ class PublisherWindow(QtWidgets.QDialog): controller.event_system.add_callback( "publish.process.stopped", self._on_publish_stop ) + controller.event_system.add_callback( + "publish.process.instance.changed", self._on_instance_change + ) + controller.event_system.add_callback( + "publish.process.plugin.changed", self._on_plugin_change + ) controller.event_system.add_callback( "show.card.message", self._on_overlay_message ) @@ -557,6 +558,18 @@ class PublisherWindow(QtWidgets.QDialog): self._reset_on_show = False self.reset() + def _make_sure_on_top(self): + """Raise window to top and activate it. + + This may not work for some DCCs without Qt. + """ + + if not self._window_is_visible: + self.show() + + self.setWindowState(QtCore.Qt.WindowActive) + self.raise_() + def _checks_before_save(self, explicit_save): """Save of changes may trigger some issues. @@ -869,6 +882,12 @@ class PublisherWindow(QtWidgets.QDialog): if self._is_on_create_tab(): self._go_to_publish_tab() + def _on_instance_change(self): + self._make_sure_on_top() + + def _on_plugin_change(self): + self._make_sure_on_top() + def _on_publish_validated_change(self, event): if event["value"]: self._validate_btn.setEnabled(False) @@ -879,6 +898,7 @@ class PublisherWindow(QtWidgets.QDialog): self._comment_input.setText("") def _on_publish_stop(self): + self._make_sure_on_top() self._set_publish_overlay_visibility(False) self._reset_btn.setEnabled(True) self._stop_btn.setEnabled(False) From dbf02e266f106c22e43c457705d0cb10acce5411 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 11 Jan 2024 21:10:13 +0800 Subject: [PATCH 105/198] create camera node with Camera4 instead of Camera2 in Nuke 14.0 --- openpype/hosts/nuke/api/lib.py | 17 +++++++++++++++++ .../hosts/nuke/plugins/create/create_camera.py | 5 ++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py index 88c587faf6..785727070d 100644 --- a/openpype/hosts/nuke/api/lib.py +++ b/openpype/hosts/nuke/api/lib.py @@ -3483,3 +3483,20 @@ def get_filenames_without_hash(filename, frame_start, frame_end): new_filename = filename_without_hashes.format(frame) filenames.append(new_filename) return filenames + + +def create_camera_node_by_version(): + """Function to create the camera with the latest node class + For Nuke version 14.0 or later, the Camera4 camera node class + would be used + For the version before, the Camera2 camera node class + would be used + Returns: + Node: camera node + """ + nuke_version = nuke.NUKE_VERSION_STRING + nuke_number_version = next(ver for ver in re.findall("\d+\.\d+", nuke_version)) + if float(nuke_number_version) >= 14.0: + return nuke.createNode("Camera4") + else: + return nuke.createNode("Camera2") diff --git a/openpype/hosts/nuke/plugins/create/create_camera.py b/openpype/hosts/nuke/plugins/create/create_camera.py index b84280b11b..be9c69213e 100644 --- a/openpype/hosts/nuke/plugins/create/create_camera.py +++ b/openpype/hosts/nuke/plugins/create/create_camera.py @@ -4,6 +4,9 @@ from openpype.hosts.nuke.api import ( NukeCreatorError, maintained_selection ) +from openpype.hosts.nuke.api.lib import ( + create_camera_node_by_version +) class CreateCamera(NukeCreator): @@ -32,7 +35,7 @@ class CreateCamera(NukeCreator): "Creator error: Select only camera node type") created_node = self.selected_nodes[0] else: - created_node = nuke.createNode("Camera2") + created_node = create_camera_node_by_version() created_node["tile_color"].setValue( int(self.node_color, 16)) From b51f61796d6cd40417575f14cf89be72bdbb2990 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 11 Jan 2024 21:17:22 +0800 Subject: [PATCH 106/198] hound shut --- openpype/hosts/nuke/api/lib.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py index 785727070d..f408ff1a9d 100644 --- a/openpype/hosts/nuke/api/lib.py +++ b/openpype/hosts/nuke/api/lib.py @@ -3495,7 +3495,8 @@ def create_camera_node_by_version(): Node: camera node """ nuke_version = nuke.NUKE_VERSION_STRING - nuke_number_version = next(ver for ver in re.findall("\d+\.\d+", nuke_version)) + nuke_number_version = next(ver for ver in + re.findall("\d+\.\d+", nuke_version)) if float(nuke_number_version) >= 14.0: return nuke.createNode("Camera4") else: From ee8294824e821c3e8bb45f2f305c8bd9b961b614 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 11 Jan 2024 21:19:21 +0800 Subject: [PATCH 107/198] hound shut --- openpype/hosts/nuke/api/lib.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py index f408ff1a9d..b879c96c9e 100644 --- a/openpype/hosts/nuke/api/lib.py +++ b/openpype/hosts/nuke/api/lib.py @@ -3495,8 +3495,9 @@ def create_camera_node_by_version(): Node: camera node """ nuke_version = nuke.NUKE_VERSION_STRING - nuke_number_version = next(ver for ver in - re.findall("\d+\.\d+", nuke_version)) + nuke_number_version = next( + ver for ver in re.findall( + r"\d+\.\d+", nuke_version)) if float(nuke_number_version) >= 14.0: return nuke.createNode("Camera4") else: From 199ff9944b3371105933bfaa4756e8f03833f11e Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 11 Jan 2024 22:50:29 +0800 Subject: [PATCH 108/198] Jakub's comment - using nuke.NUKE_VERSION_MAJOR for version check instead --- openpype/hosts/nuke/api/lib.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/nuke/api/lib.py b/openpype/hosts/nuke/api/lib.py index b879c96c9e..7ba53caead 100644 --- a/openpype/hosts/nuke/api/lib.py +++ b/openpype/hosts/nuke/api/lib.py @@ -3494,11 +3494,8 @@ def create_camera_node_by_version(): Returns: Node: camera node """ - nuke_version = nuke.NUKE_VERSION_STRING - nuke_number_version = next( - ver for ver in re.findall( - r"\d+\.\d+", nuke_version)) - if float(nuke_number_version) >= 14.0: + nuke_number_version = nuke.NUKE_VERSION_MAJOR + if nuke_number_version >= 14: return nuke.createNode("Camera4") else: return nuke.createNode("Camera2") From 629b49c18209652f1c3a931e1f06b791b0180d92 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 11 Jan 2024 16:15:45 +0100 Subject: [PATCH 109/198] Blender: Workfile instance update fix (#6048) * make sure workfile instance has always available 'instance_node' * create CONTAINERS node if does not exist yet --- .../blender/plugins/create/create_workfile.py | 34 +++++++++++-------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/openpype/hosts/blender/plugins/create/create_workfile.py b/openpype/hosts/blender/plugins/create/create_workfile.py index ceec3e0552..6b168f4c84 100644 --- a/openpype/hosts/blender/plugins/create/create_workfile.py +++ b/openpype/hosts/blender/plugins/create/create_workfile.py @@ -25,7 +25,7 @@ class CreateWorkfile(BaseCreator, AutoCreator): def create(self): """Create workfile instances.""" - existing_instance = next( + workfile_instance = next( ( instance for instance in self.create_context.instances if instance.creator_identifier == self.identifier @@ -39,14 +39,14 @@ class CreateWorkfile(BaseCreator, AutoCreator): host_name = self.create_context.host_name existing_asset_name = None - if existing_instance is not None: + if workfile_instance is not None: if AYON_SERVER_ENABLED: - existing_asset_name = existing_instance.get("folderPath") + existing_asset_name = workfile_instance.get("folderPath") if existing_asset_name is None: - existing_asset_name = existing_instance["asset"] + existing_asset_name = workfile_instance["asset"] - if not existing_instance: + if not workfile_instance: asset_doc = get_asset_by_name(project_name, asset_name) subset_name = self.get_subset_name( task_name, task_name, asset_doc, project_name, host_name @@ -66,19 +66,18 @@ class CreateWorkfile(BaseCreator, AutoCreator): asset_doc, project_name, host_name, - existing_instance, + workfile_instance, ) ) self.log.info("Auto-creating workfile instance...") - current_instance = CreatedInstance( + workfile_instance = CreatedInstance( self.family, subset_name, data, self ) - instance_node = bpy.data.collections.get(AVALON_CONTAINERS, {}) - current_instance.transient_data["instance_node"] = instance_node - self._add_instance_to_context(current_instance) + self._add_instance_to_context(workfile_instance) + elif ( existing_asset_name != asset_name - or existing_instance["task"] != task_name + or workfile_instance["task"] != task_name ): # Update instance context if it's different asset_doc = get_asset_by_name(project_name, asset_name) @@ -86,12 +85,17 @@ class CreateWorkfile(BaseCreator, AutoCreator): task_name, task_name, asset_doc, project_name, host_name ) if AYON_SERVER_ENABLED: - existing_instance["folderPath"] = asset_name + workfile_instance["folderPath"] = asset_name else: - existing_instance["asset"] = asset_name + workfile_instance["asset"] = asset_name - existing_instance["task"] = task_name - existing_instance["subset"] = subset_name + workfile_instance["task"] = task_name + workfile_instance["subset"] = subset_name + + instance_node = bpy.data.collections.get(AVALON_CONTAINERS) + if not instance_node: + instance_node = bpy.data.collections.new(name=AVALON_CONTAINERS) + workfile_instance.transient_data["instance_node"] = instance_node def collect_instances(self): From 47cf95ed69a4bb4ad4f5a9f2b5b09f145a94bc23 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:13:20 +0100 Subject: [PATCH 110/198] Chore: Template data for editorial publishing (#6120) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * start with anatomy data without anatomy updates * added ability to fill template data for editorial instances too * do not autofix editorial data in collect resources path * fix childs access --------- Co-authored-by: Jakub Ježek --- .../publish/collect_anatomy_instance_data.py | 211 ++++++++++++++---- .../plugins/publish/collect_resources_path.py | 13 -- 2 files changed, 168 insertions(+), 56 deletions(-) diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py index 1b4b44e40e..0a34848166 100644 --- a/openpype/plugins/publish/collect_anatomy_instance_data.py +++ b/openpype/plugins/publish/collect_anatomy_instance_data.py @@ -190,47 +190,18 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): project_task_types = project_doc["config"]["tasks"] for instance in context: - asset_doc = instance.data.get("assetEntity") - anatomy_updates = { + anatomy_data = copy.deepcopy(context.data["anatomyData"]) + anatomy_data.update({ "family": instance.data["family"], "subset": instance.data["subset"], - } - if asset_doc: - parents = asset_doc["data"].get("parents") or list() - parent_name = project_doc["name"] - if parents: - parent_name = parents[-1] + }) - hierarchy = "/".join(parents) - anatomy_updates.update({ - "asset": asset_doc["name"], - "hierarchy": hierarchy, - "parent": parent_name, - "folder": { - "name": asset_doc["name"], - }, - }) - - # Task - task_type = None - task_name = instance.data.get("task") - if task_name: - asset_tasks = asset_doc["data"]["tasks"] - task_type = asset_tasks.get(task_name, {}).get("type") - task_code = ( - project_task_types - .get(task_type, {}) - .get("short_name") - ) - anatomy_updates["task"] = { - "name": task_name, - "type": task_type, - "short": task_code - } + self._fill_asset_data(instance, project_doc, anatomy_data) + self._fill_task_data(instance, project_task_types, anatomy_data) # Define version if self.follow_workfile_version: - version_number = context.data('version') + version_number = context.data("version") else: version_number = instance.data.get("version") @@ -242,6 +213,9 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): # If version is not specified for instance or context if version_number is None: + task_data = anatomy_data.get("task") or {} + task_name = task_data.get("name") + task_type = task_data.get("type") version_number = get_versioning_start( context.data["projectName"], instance.context.data["hostName"], @@ -250,29 +224,26 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): family=instance.data["family"], subset=instance.data["subset"] ) - anatomy_updates["version"] = version_number + anatomy_data["version"] = version_number # Additional data resolution_width = instance.data.get("resolutionWidth") if resolution_width: - anatomy_updates["resolution_width"] = resolution_width + anatomy_data["resolution_width"] = resolution_width resolution_height = instance.data.get("resolutionHeight") if resolution_height: - anatomy_updates["resolution_height"] = resolution_height + anatomy_data["resolution_height"] = resolution_height pixel_aspect = instance.data.get("pixelAspect") if pixel_aspect: - anatomy_updates["pixel_aspect"] = float( + anatomy_data["pixel_aspect"] = float( "{:0.2f}".format(float(pixel_aspect)) ) fps = instance.data.get("fps") if fps: - anatomy_updates["fps"] = float("{:0.2f}".format(float(fps))) - - anatomy_data = copy.deepcopy(context.data["anatomyData"]) - anatomy_data.update(anatomy_updates) + anatomy_data["fps"] = float("{:0.2f}".format(float(fps))) # Store anatomy data instance.data["projectEntity"] = project_doc @@ -288,3 +259,157 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): instance_name, json.dumps(anatomy_data, indent=4) )) + + def _fill_asset_data(self, instance, project_doc, anatomy_data): + # QUESTION should we make sure that all asset data are poped if asset + # data cannot be found? + # - 'asset', 'hierarchy', 'parent', 'folder' + asset_doc = instance.data.get("assetEntity") + if asset_doc: + parents = asset_doc["data"].get("parents") or list() + parent_name = project_doc["name"] + if parents: + parent_name = parents[-1] + + hierarchy = "/".join(parents) + anatomy_data.update({ + "asset": asset_doc["name"], + "hierarchy": hierarchy, + "parent": parent_name, + "folder": { + "name": asset_doc["name"], + }, + }) + return + + if instance.data.get("newAssetPublishing"): + hierarchy = instance.data["hierarchy"] + anatomy_data["hierarchy"] = hierarchy + + parent_name = project_doc["name"] + if hierarchy: + parent_name = hierarchy.split("/")[-1] + + asset_name = instance.data["asset"].split("/")[-1] + anatomy_data.update({ + "asset": asset_name, + "hierarchy": hierarchy, + "parent": parent_name, + "folder": { + "name": asset_name, + }, + }) + + def _fill_task_data(self, instance, project_task_types, anatomy_data): + # QUESTION should we make sure that all task data are poped if task + # data cannot be resolved? + # - 'task' + + # Skip if there is no task + task_name = instance.data.get("task") + if not task_name: + return + + # Find task data based on asset entity + asset_doc = instance.data.get("assetEntity") + task_data = self._get_task_data_from_asset( + asset_doc, task_name, project_task_types + ) + if task_data: + # Fill task data + # - if we're in editorial, make sure the task type is filled + if ( + not instance.data.get("newAssetPublishing") + or task_data["type"] + ): + anatomy_data["task"] = task_data + return + + # New hierarchy is not created, so we can only skip rest of the logic + if not instance.data.get("newAssetPublishing"): + return + + # Try to find task data based on hierarchy context and asset name + hierarchy_context = instance.context.data.get("hierarchyContext") + asset_name = instance.data.get("asset") + if not hierarchy_context or not asset_name: + return + + project_name = instance.context.data["projectName"] + # OpenPype approach vs AYON approach + if "/" not in asset_name: + tasks_info = self._find_tasks_info_in_hierarchy( + hierarchy_context, asset_name + ) + else: + current_data = hierarchy_context.get(project_name, {}) + for key in asset_name.split("/"): + if key: + current_data = current_data.get("childs", {}).get(key, {}) + tasks_info = current_data.get("tasks", {}) + + task_info = tasks_info.get(task_name, {}) + task_type = task_info.get("type") + task_code = ( + project_task_types + .get(task_type, {}) + .get("short_name") + ) + anatomy_data["task"] = { + "name": task_name, + "type": task_type, + "short": task_code + } + + def _get_task_data_from_asset( + self, asset_doc, task_name, project_task_types + ): + """ + + Args: + asset_doc (Union[dict[str, Any], None]): Asset document. + task_name (Union[str, None]): Task name. + project_task_types (dict[str, dict[str, Any]]): Project task + types. + + Returns: + Union[dict[str, str], None]: Task data or None if not found. + """ + + if not asset_doc or not task_name: + return None + + asset_tasks = asset_doc["data"]["tasks"] + task_type = asset_tasks.get(task_name, {}).get("type") + task_code = ( + project_task_types + .get(task_type, {}) + .get("short_name") + ) + return { + "name": task_name, + "type": task_type, + "short": task_code + } + + def _find_tasks_info_in_hierarchy(self, hierarchy_context, asset_name): + """Find tasks info for an asset in editorial hierarchy. + + Args: + hierarchy_context (dict[str, Any]): Editorial hierarchy context. + asset_name (str): Asset name. + + Returns: + dict[str, dict[str, Any]]: Tasks info by name. + """ + + hierarchy_queue = collections.deque() + hierarchy_queue.append(hierarchy_context) + while hierarchy_queue: + item = hierarchy_context.popleft() + if asset_name in item: + return item[asset_name].get("tasks") or {} + + for subitem in item.values(): + hierarchy_queue.extend(subitem.get("childs") or []) + return {} diff --git a/openpype/plugins/publish/collect_resources_path.py b/openpype/plugins/publish/collect_resources_path.py index c8b67a3d05..6a871124f1 100644 --- a/openpype/plugins/publish/collect_resources_path.py +++ b/openpype/plugins/publish/collect_resources_path.py @@ -79,19 +79,6 @@ class CollectResourcesPath(pyblish.api.InstancePlugin): "representation": "TEMP" }) - # Add fill keys for editorial publishing creating new entity - # TODO handle in editorial plugin - if instance.data.get("newAssetPublishing"): - if "hierarchy" not in template_data: - template_data["hierarchy"] = instance.data["hierarchy"] - - if "asset" not in template_data: - asset_name = instance.data["asset"].split("/")[-1] - template_data["asset"] = asset_name - template_data["folder"] = { - "name": asset_name - } - publish_templates = anatomy.templates_obj["publish"] if "folder" in publish_templates: publish_folder = publish_templates["folder"].format_strict( From 046154037bc3514ef30d0448e2c7c1006d56970f Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Fri, 12 Jan 2024 10:44:01 +0100 Subject: [PATCH 111/198] Site Sync: small fixes in Loader (#6119) * Fix usage of correct values Returned item is dictionary of version_id: links, previous loop was looping through [[]]. * Fix usage of studio icon local and studio have both same provider, local_drive. Both of them should be differentiate by icon though. * Fix - pull only paths from icon_def Icon_def is dictionary with `type` and `path` keys, not directly 'path'. It must be massaged first. * Revert back, fixed in different PR Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * Fix looping Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --------- Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- openpype/client/server/entity_links.py | 23 ++++++++++--------- .../tools/ayon_loader/models/site_sync.py | 15 ++++++++---- .../ayon_sceneinventory/models/site_sync.py | 4 ++-- 3 files changed, 24 insertions(+), 18 deletions(-) diff --git a/openpype/client/server/entity_links.py b/openpype/client/server/entity_links.py index 368dcdcb9d..7fb9fbde6f 100644 --- a/openpype/client/server/entity_links.py +++ b/openpype/client/server/entity_links.py @@ -124,23 +124,24 @@ def get_linked_representation_id( if not versions_to_check: break - links = con.get_versions_links( + versions_links = con.get_versions_links( project_name, versions_to_check, link_types=link_types, link_direction="out") versions_to_check = set() - for link in links: - # Care only about version links - if link["entityType"] != "version": - continue - entity_id = link["entityId"] - # Skip already found linked version ids - if entity_id in linked_version_ids: - continue - linked_version_ids.add(entity_id) - versions_to_check.add(entity_id) + for links in versions_links.values(): + for link in links: + # Care only about version links + if link["entityType"] != "version": + continue + entity_id = link["entityId"] + # Skip already found linked version ids + if entity_id in linked_version_ids: + continue + linked_version_ids.add(entity_id) + versions_to_check.add(entity_id) linked_version_ids.remove(version_id) if not linked_version_ids: diff --git a/openpype/tools/ayon_loader/models/site_sync.py b/openpype/tools/ayon_loader/models/site_sync.py index 90852b6954..4b7ddee481 100644 --- a/openpype/tools/ayon_loader/models/site_sync.py +++ b/openpype/tools/ayon_loader/models/site_sync.py @@ -140,12 +140,10 @@ class SiteSyncModel: Union[dict[str, Any], None]: Site icon definition. """ - if not project_name: + if not project_name or not self.is_site_sync_enabled(project_name): return None - active_site = self.get_active_site(project_name) - provider = self._get_provider_for_site(project_name, active_site) - return self._get_provider_icon(provider) + return self._get_site_icon_def(project_name, active_site) def get_remote_site_icon_def(self, project_name): """Remote site icon definition. @@ -160,7 +158,14 @@ class SiteSyncModel: if not project_name or not self.is_site_sync_enabled(project_name): return None remote_site = self.get_remote_site(project_name) - provider = self._get_provider_for_site(project_name, remote_site) + return self._get_site_icon_def(project_name, remote_site) + + def _get_site_icon_def(self, project_name, site_name): + # use different icon for studio even if provider is 'local_drive' + if site_name == self._site_sync_addon.DEFAULT_SITE: + provider = "studio" + else: + provider = self._get_provider_for_site(project_name, site_name) return self._get_provider_icon(provider) def get_version_sync_availability(self, project_name, version_ids): diff --git a/openpype/tools/ayon_sceneinventory/models/site_sync.py b/openpype/tools/ayon_sceneinventory/models/site_sync.py index 1297137cb0..0101f6c88e 100644 --- a/openpype/tools/ayon_sceneinventory/models/site_sync.py +++ b/openpype/tools/ayon_sceneinventory/models/site_sync.py @@ -42,8 +42,8 @@ class SiteSyncModel: if not self.is_sync_server_enabled(): return {} - site_sync = self._get_sync_server_module() - return site_sync.get_site_icons() + site_sync_addon = self._get_sync_server_module() + return site_sync_addon.get_site_icons() def get_sites_information(self): return { From df7b8683716ff5bb2ab6b648ab22a62e2a555fd3 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 12 Jan 2024 18:32:42 +0800 Subject: [PATCH 112/198] bugfix the thumbnail error when publishing with emissive map & maps without RGB channel --- openpype/hosts/substancepainter/api/lib.py | 50 +++++++++++++++++++ .../publish/collect_textureset_images.py | 20 +++++--- 2 files changed, 62 insertions(+), 8 deletions(-) diff --git a/openpype/hosts/substancepainter/api/lib.py b/openpype/hosts/substancepainter/api/lib.py index 1cb480b552..f46426388b 100644 --- a/openpype/hosts/substancepainter/api/lib.py +++ b/openpype/hosts/substancepainter/api/lib.py @@ -643,3 +643,53 @@ def prompt_new_file_with_mesh(mesh_filepath): return return project_mesh + + +def has_rgb_channel_in_texture_set(texture_set_name, map_identifier): + """Function to check whether the texture has RGB channel. + + Args: + texture_set_name (str): Name of Texture Set + map_identifier (str): Map identifier + + Returns: + colorspace_dict: A dictionary which stores the boolean + value of textures having RGB channels + """ + texture_stack = substance_painter.textureset.Stack.from_name(texture_set_name) + # 2D_View is always True as it exports all texture maps + colorspace_dict = {"2D_View": True} + colorspace_dict["BaseColor"] = texture_stack.get_channel( + substance_painter.textureset.ChannelType.BaseColor).is_color() + colorspace_dict["Roughness"] = texture_stack.get_channel( + substance_painter.textureset.ChannelType.Roughness).is_color() + colorspace_dict["Metallic"] = texture_stack.get_channel( + substance_painter.textureset.ChannelType.Metallic).is_color() + colorspace_dict["Height"] = texture_stack.get_channel( + substance_painter.textureset.ChannelType.Height).is_color() + colorspace_dict["Normal"] = texture_stack.get_channel( + substance_painter.textureset.ChannelType.Normal).is_color() + return colorspace_dict.get(map_identifier, False) + + +def texture_set_filtering(texture_set_same, template): + """Function to check whether some specific textures(e.g. Emissive) + are parts of the texture stack in Substance Painter + + Args: + texture_set_same (str): Name of Texture Set + template (str): texture template name + + Returns: + texture_filter: A dictionary which stores the boolean + value of whether the texture exist in the channel. + """ + texture_filter = {} + channel_stack = substance_painter.textureset.Stack.from_name( + texture_set_same) + has_emissive = channel_stack.has_channel( + substance_painter.textureset.ChannelType.Emissive) + map_identifier = strip_template(template) + if map_identifier == "Emissive": + texture_filter[map_identifier] = has_emissive + return texture_filter.get(map_identifier, True) diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index 316f72509e..4c3398d5b4 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -7,7 +7,9 @@ from openpype.pipeline import publish import substance_painter.textureset from openpype.hosts.substancepainter.api.lib import ( get_parsed_export_maps, - strip_template + strip_template, + has_rgb_channel_in_texture_set, + texture_set_filtering ) from openpype.pipeline.create import get_subset_name from openpype.client import get_asset_by_name @@ -39,11 +41,12 @@ class CollectTextureSet(pyblish.api.InstancePlugin): for (texture_set_name, stack_name), template_maps in maps.items(): self.log.info(f"Processing {texture_set_name}/{stack_name}") for template, outputs in template_maps.items(): - self.log.info(f"Processing {template}") - self.create_image_instance(instance, template, outputs, - asset_doc=asset_doc, - texture_set_name=texture_set_name, - stack_name=stack_name) + if texture_set_filtering(texture_set_name, template): + self.log.info(f"Processing {template}") + self.create_image_instance(instance, template, outputs, + asset_doc=asset_doc, + texture_set_name=texture_set_name, + stack_name=stack_name) def create_image_instance(self, instance, template, outputs, asset_doc, texture_set_name, stack_name): @@ -78,7 +81,6 @@ class CollectTextureSet(pyblish.api.InstancePlugin): # Always include the map identifier map_identifier = strip_template(template) suffix += f".{map_identifier}" - image_subset = get_subset_name( # TODO: The family actually isn't 'texture' currently but for now # this is only done so the subset name starts with 'texture' @@ -132,7 +134,9 @@ class CollectTextureSet(pyblish.api.InstancePlugin): # Store color space with the instance # Note: The extractor will assign it to the representation colorspace = outputs[0].get("colorSpace") - if colorspace: + has_rgb_channel = has_rgb_channel_in_texture_set( + texture_set_name, map_identifier) + if colorspace and has_rgb_channel: self.log.debug(f"{image_subset} colorspace: {colorspace}") image_instance.data["colorspace"] = colorspace From 72848657af4e52aa6d037fbf1f35c2b4548efeee Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 12 Jan 2024 18:44:18 +0800 Subject: [PATCH 113/198] hound shut --- openpype/hosts/substancepainter/api/lib.py | 6 ++++-- .../plugins/publish/collect_textureset_images.py | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/substancepainter/api/lib.py b/openpype/hosts/substancepainter/api/lib.py index f46426388b..67229a75bf 100644 --- a/openpype/hosts/substancepainter/api/lib.py +++ b/openpype/hosts/substancepainter/api/lib.py @@ -656,7 +656,9 @@ def has_rgb_channel_in_texture_set(texture_set_name, map_identifier): colorspace_dict: A dictionary which stores the boolean value of textures having RGB channels """ - texture_stack = substance_painter.textureset.Stack.from_name(texture_set_name) + texture_stack = ( + substance_painter.textureset.Stack.from_name(texture_set_name) + ) # 2D_View is always True as it exports all texture maps colorspace_dict = {"2D_View": True} colorspace_dict["BaseColor"] = texture_stack.get_channel( @@ -686,7 +688,7 @@ def texture_set_filtering(texture_set_same, template): """ texture_filter = {} channel_stack = substance_painter.textureset.Stack.from_name( - texture_set_same) + texture_set_same) has_emissive = channel_stack.has_channel( substance_painter.textureset.ChannelType.Emissive) map_identifier = strip_template(template) diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index 4c3398d5b4..f535bfa2a6 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -44,9 +44,9 @@ class CollectTextureSet(pyblish.api.InstancePlugin): if texture_set_filtering(texture_set_name, template): self.log.info(f"Processing {template}") self.create_image_instance(instance, template, outputs, - asset_doc=asset_doc, - texture_set_name=texture_set_name, - stack_name=stack_name) + asset_doc=asset_doc, + texture_set_name=texture_set_name, + stack_name=stack_name) def create_image_instance(self, instance, template, outputs, asset_doc, texture_set_name, stack_name): From 6410f381f34625defa91250a8e529e47cb40a8a6 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Fri, 12 Jan 2024 18:45:40 +0800 Subject: [PATCH 114/198] hound shut --- .../plugins/publish/collect_textureset_images.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index f535bfa2a6..9d6aa06872 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -43,10 +43,11 @@ class CollectTextureSet(pyblish.api.InstancePlugin): for template, outputs in template_maps.items(): if texture_set_filtering(texture_set_name, template): self.log.info(f"Processing {template}") - self.create_image_instance(instance, template, outputs, - asset_doc=asset_doc, - texture_set_name=texture_set_name, - stack_name=stack_name) + self.create_image_instance( + instance, template, outputs, + asset_doc=asset_doc, + texture_set_name=texture_set_name, + stack_name=stack_name) def create_image_instance(self, instance, template, outputs, asset_doc, texture_set_name, stack_name): From 1eb7e59b931e146481253af9fab501120d1d6156 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 12 Jan 2024 12:25:00 +0100 Subject: [PATCH 115/198] Kitsu clear credentials are safe (#6116) --- openpype/modules/kitsu/utils/credentials.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/openpype/modules/kitsu/utils/credentials.py b/openpype/modules/kitsu/utils/credentials.py index 941343cc8d..c471b56907 100644 --- a/openpype/modules/kitsu/utils/credentials.py +++ b/openpype/modules/kitsu/utils/credentials.py @@ -64,8 +64,10 @@ def clear_credentials(): user_registry = OpenPypeSecureRegistry("kitsu_user") # Set local settings - user_registry.delete_item("login") - user_registry.delete_item("password") + if user_registry.get_item("login", None) is not None: + user_registry.delete_item("login") + if user_registry.get_item("password", None) is not None: + user_registry.delete_item("password") def save_credentials(login: str, password: str): @@ -92,8 +94,9 @@ def load_credentials() -> Tuple[str, str]: # Get user registry user_registry = OpenPypeSecureRegistry("kitsu_user") - return user_registry.get_item("login", None), user_registry.get_item( - "password", None + return ( + user_registry.get_item("login", None), + user_registry.get_item("password", None) ) From f88ab85cc1d586e71e6a4ccfb975ed7d5c75aef8 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 12 Jan 2024 13:50:34 +0100 Subject: [PATCH 116/198] SceneInventory: Fix site sync icon conversion (#6123) * use 'get_qt_icon' to convert icon definition * check if site sync is enabled before getting sites info * convert containers to list * Fix wrong method name --------- Co-authored-by: Petr Kalis --- openpype/tools/ayon_sceneinventory/control.py | 4 ++-- openpype/tools/ayon_sceneinventory/model.py | 5 +++-- openpype/tools/ayon_sceneinventory/models/site_sync.py | 8 ++++---- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/openpype/tools/ayon_sceneinventory/control.py b/openpype/tools/ayon_sceneinventory/control.py index 6111d7e43b..3b063ff72e 100644 --- a/openpype/tools/ayon_sceneinventory/control.py +++ b/openpype/tools/ayon_sceneinventory/control.py @@ -84,9 +84,9 @@ class SceneInventoryController: def get_containers(self): host = self._host if isinstance(host, ILoadHost): - return host.get_containers() + return list(host.get_containers()) elif hasattr(host, "ls"): - return host.ls() + return list(host.ls()) return [] # Site Sync methods diff --git a/openpype/tools/ayon_sceneinventory/model.py b/openpype/tools/ayon_sceneinventory/model.py index 16924b0a7e..f4450f0ac3 100644 --- a/openpype/tools/ayon_sceneinventory/model.py +++ b/openpype/tools/ayon_sceneinventory/model.py @@ -23,6 +23,7 @@ from openpype.pipeline import ( ) from openpype.style import get_default_entity_icon_color from openpype.tools.utils.models import TreeModel, Item +from openpype.tools.ayon_utils.widgets import get_qt_icon def walk_hierarchy(node): @@ -71,8 +72,8 @@ class InventoryModel(TreeModel): site_icons = self._controller.get_site_provider_icons() self._site_icons = { - provider: QtGui.QIcon(icon_path) - for provider, icon_path in site_icons.items() + provider: get_qt_icon(icon_def) + for provider, icon_def in site_icons.items() } def outdated(self, item): diff --git a/openpype/tools/ayon_sceneinventory/models/site_sync.py b/openpype/tools/ayon_sceneinventory/models/site_sync.py index 0101f6c88e..bd65ad1778 100644 --- a/openpype/tools/ayon_sceneinventory/models/site_sync.py +++ b/openpype/tools/ayon_sceneinventory/models/site_sync.py @@ -150,23 +150,23 @@ class SiteSyncModel: return self._remote_site_provider def _cache_sites(self): - site_sync = self._get_sync_server_module() active_site = None remote_site = None active_site_provider = None remote_site_provider = None - if site_sync is not None: + if self.is_sync_server_enabled(): + site_sync = self._get_sync_server_module() project_name = self._controller.get_current_project_name() active_site = site_sync.get_active_site(project_name) remote_site = site_sync.get_remote_site(project_name) active_site_provider = "studio" remote_site_provider = "studio" if active_site != "studio": - active_site_provider = site_sync.get_active_provider( + active_site_provider = site_sync.get_provider_for_site( project_name, active_site ) if remote_site != "studio": - remote_site_provider = site_sync.get_active_provider( + remote_site_provider = site_sync.get_provider_for_site( project_name, remote_site ) From 946b9318b66b96c1606e9d3805024a431e5be2a1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 12 Jan 2024 13:51:08 +0100 Subject: [PATCH 117/198] add 'outputName' to thumbnail representation (#6114) --- openpype/plugins/publish/extract_thumbnail_from_source.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/plugins/publish/extract_thumbnail_from_source.py b/openpype/plugins/publish/extract_thumbnail_from_source.py index 401a5d615d..33cbf6d9bf 100644 --- a/openpype/plugins/publish/extract_thumbnail_from_source.py +++ b/openpype/plugins/publish/extract_thumbnail_from_source.py @@ -65,7 +65,8 @@ class ExtractThumbnailFromSource(pyblish.api.InstancePlugin): "files": dst_filename, "stagingDir": dst_staging, "thumbnail": True, - "tags": ["thumbnail"] + "tags": ["thumbnail"], + "outputName": "thumbnail", } # adding representation From c506813c345429873e54e10c0cc42fa20517bdab Mon Sep 17 00:00:00 2001 From: Ynbot Date: Fri, 12 Jan 2024 12:59:28 +0000 Subject: [PATCH 118/198] [Automated] Release --- CHANGELOG.md | 256 ++++++++++++++++++++++++++++++++++++++++++++ openpype/version.py | 2 +- pyproject.toml | 2 +- 3 files changed, 258 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a21882008..7b51fade6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,262 @@ # Changelog +## [3.18.3](https://github.com/ynput/OpenPype/tree/3.18.3) + + +[Full Changelog](https://github.com/ynput/OpenPype/compare/3.18.2...3.18.3) + +### **🚀 Enhancements** + + +
+Maya: Apply initial viewport shader for Redshift Proxy after loading #6102 + +When the published redshift proxy is being loaded, the shader of the proxy is missing. This is different from the manual load through creating redshift proxy for files. This PR is to assign the default lambert to the redshift proxy, which replicates the same approach when the user manually loads the proxy with filepath. + + +___ + +
+ + +
+General: We should keep current subset version when we switch only the representation type #4629 + +When we switch only the representation type of subsets, we should not get the representation from the last version of the subset. + + +___ + +
+ + +
+Houdini: Add loader for redshift proxy family #5948 + +Loader for Redshift Proxy in Houdini (Thanks for @BigRoy contribution) + + +___ + +
+ + +
+AfterEffects: exposing Deadline pools fields in Publisher UI #6079 + +Deadline pools might be adhoc set by an artist during publishing. AfterEffects implementation wasn't providing this. + + +___ + +
+ + +
+Chore: Event callbacks can have order #6080 + +Event callbacks can have order in which are called, and fixed issue with getting function name and file when using `partial` function as callback. + + +___ + +
+ + +
+AYON: OpenPype addon defines runtime dependencies #6095 + +Moved runtime dependencies from ayon-launcher to openpype addon. + + +___ + +
+ + +
+Max: User's setting for scene unit scale #6097 + +Options for users to set the default scene unit scale for their scenes.AYONLegacy OP + + +___ + +
+ + +
+Chore: Remove deprecated templates profiles #6103 + +Remove deprecated usage of template profiles from settings. + + +___ + +
+ + +
+Publisher: Window is not always on top #6107 + +Goal of this PR is to avoid using `WindowStaysOnTopHint` which causes issues, especially in cases when DCC shows a popup dialog that is behind the window, in that case both Publisher and DCC are frozen and there is nothing to do. + + +___ + +
+ + +
+Houdini: add split job export support for Redshift ROP #6108 + +This is adding support for splitting of export and render jobs for Redshift as is already implemented for Vray, Mantra and Arnold. + + +___ + +
+ + +
+Fusion: automatic installation of PySide2 #6111 + +This PR adds hook which tries to check if PySide2 is installed in Python used by Fusion and if not, it tries to install it automatically. + + +___ + +
+ + +
+AYON: OpenPype addon dependencies #6113 + +Added `click` and `six` to requirements of openpype addon, and removed `Qt.py` requirement, which is not used anywhere. + + +___ + +
+ + +
+Chore: Thumbnail representation has 'outputName' #6114 + +Add thumbnail output name to thumbnail representation to prevent same output filename during integration. + + +___ + +
+ + +
+Kitsu: Clear credentials is safe #6116 + +Do not remove not existing keyring items. + + +___ + +
+ +### **🐛 Bug fixes** + + +
+Maya: bug fix the playblast without textures #5942 + +Bug fix the texture not being displayed when users enable texture placement in the OP/AYON setting + + +___ + +
+ + +
+Blender: Workfile instance update fix #6048 + +Make sure workfile instance has always available 'instance_node' in transient data. + + +___ + +
+ + +
+Publisher: Fix issue with parenting of widgets #6106 + +Don't use publisher window parent (usually main DCC window) as parent for report widget. + + +___ + +
+ + +
+:wrench: fix and update pydocstyle configuration #6109 + +Fix pydocstyle configuration and move it to `pyproject.toml` + + +___ + +
+ + +
+Nuke: Create camera node with the latest camera node class in Nuke 14 #6118 + +Creating instance fails for certain cameras, and it seems to only exist in Nuke 14. The reason of causing that contributes to the new camera node class `Camera4` while the camera creator is working with the `Camera2` class. + + +___ + +
+ + +
+Site Sync: small fixes in Loader #6119 + +Resolves issue: +- local and studio icons were same, they should be different +- `TypeError: string indices must be integers` error when downloading/uploading workfiles + + +___ + +
+ + +
+Chore: Template data for editorial publishing #6120 + +Template data for editorial publishing are filled during `CollectInstanceAnatomyData`. The structure for editorial is determined, as it's required for ExtractHierarchy AYON/OpenPype plugins. + + +___ + +
+ + +
+SceneInventory: Fix site sync icon conversion #6123 + +Use 'get_qt_icon' to convert icon definitions from site sync. + + +___ + +
+ + + + ## [3.18.2](https://github.com/ynput/OpenPype/tree/3.18.2) diff --git a/openpype/version.py b/openpype/version.py index 279575d110..c87c143ea3 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.3-nightly.2" +__version__ = "3.18.3" diff --git a/pyproject.toml b/pyproject.toml index ee8e8017e3..bad481c889 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "OpenPype" -version = "3.18.2" # OpenPype +version = "3.18.3" # OpenPype description = "Open VFX and Animation pipeline with support." authors = ["OpenPype Team "] license = "MIT License" From b5b85f7b7fe533e19c2a08ebb5d277ec819d6c2c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 12 Jan 2024 13:00:24 +0000 Subject: [PATCH 119/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7d6c5650d1..3f762bd2d8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.3 - 3.18.3-nightly.2 - 3.18.3-nightly.1 - 3.18.2 @@ -134,7 +135,6 @@ body: - 3.15.7-nightly.1 - 3.15.6 - 3.15.6-nightly.3 - - 3.15.6-nightly.2 validations: required: true - type: dropdown From e9d38f24f49784021bccd19f18b189fc47e91276 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Fri, 12 Jan 2024 15:03:47 +0000 Subject: [PATCH 120/198] Renamed variable --- openpype/hosts/blender/plugins/load/load_animation.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/blender/plugins/load/load_animation.py b/openpype/hosts/blender/plugins/load/load_animation.py index 0f968c75e5..fd087553f0 100644 --- a/openpype/hosts/blender/plugins/load/load_animation.py +++ b/openpype/hosts/blender/plugins/load/load_animation.py @@ -61,10 +61,10 @@ class BlendAnimationLoader(plugin.AssetLoader): bpy.data.objects.remove(container) - filepath = bpy.path.basename(libpath) + filename = bpy.path.basename(libpath) # Blender has a limit of 63 characters for any data name. - # If the filepath is longer, it will be truncated. - if len(filepath) > 63: - filepath = filepath[:63] - library = bpy.data.libraries.get(filepath) + # If the filename is longer, it will be truncated. + if len(filename) > 63: + filename = filename[:63] + library = bpy.data.libraries.get(filename) bpy.data.libraries.remove(library) From 00eb748b4b64339b00799b5fa4c41ad42426f73c Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Sat, 13 Jan 2024 00:15:46 +0800 Subject: [PATCH 121/198] code tweaks on has_rgb_channel_in_texture_set function & add publish data into the imageinstance --- openpype/hosts/substancepainter/api/lib.py | 48 +++++-------------- .../publish/collect_textureset_images.py | 12 ++--- .../plugins/publish/validate_ouput_maps.py | 1 + 3 files changed, 19 insertions(+), 42 deletions(-) diff --git a/openpype/hosts/substancepainter/api/lib.py b/openpype/hosts/substancepainter/api/lib.py index 67229a75bf..896cca79b0 100644 --- a/openpype/hosts/substancepainter/api/lib.py +++ b/openpype/hosts/substancepainter/api/lib.py @@ -653,45 +653,23 @@ def has_rgb_channel_in_texture_set(texture_set_name, map_identifier): map_identifier (str): Map identifier Returns: - colorspace_dict: A dictionary which stores the boolean - value of textures having RGB channels + bool: Whether the channel type identifier has RGB channel or not + in the texture stack. """ + + # 2D_View is always True as it exports all texture maps texture_stack = ( substance_painter.textureset.Stack.from_name(texture_set_name) ) # 2D_View is always True as it exports all texture maps - colorspace_dict = {"2D_View": True} - colorspace_dict["BaseColor"] = texture_stack.get_channel( - substance_painter.textureset.ChannelType.BaseColor).is_color() - colorspace_dict["Roughness"] = texture_stack.get_channel( - substance_painter.textureset.ChannelType.Roughness).is_color() - colorspace_dict["Metallic"] = texture_stack.get_channel( - substance_painter.textureset.ChannelType.Metallic).is_color() - colorspace_dict["Height"] = texture_stack.get_channel( - substance_painter.textureset.ChannelType.Height).is_color() - colorspace_dict["Normal"] = texture_stack.get_channel( - substance_painter.textureset.ChannelType.Normal).is_color() - return colorspace_dict.get(map_identifier, False) + if map_identifier == "2D_View": + return True + channel_type = getattr( + substance_painter.textureset.ChannelType, map_identifier, None) + if channel_type is None: + return False + if not texture_stack.has_channel(channel_type): + return False -def texture_set_filtering(texture_set_same, template): - """Function to check whether some specific textures(e.g. Emissive) - are parts of the texture stack in Substance Painter - - Args: - texture_set_same (str): Name of Texture Set - template (str): texture template name - - Returns: - texture_filter: A dictionary which stores the boolean - value of whether the texture exist in the channel. - """ - texture_filter = {} - channel_stack = substance_painter.textureset.Stack.from_name( - texture_set_same) - has_emissive = channel_stack.has_channel( - substance_painter.textureset.ChannelType.Emissive) - map_identifier = strip_template(template) - if map_identifier == "Emissive": - texture_filter[map_identifier] = has_emissive - return texture_filter.get(map_identifier, True) + return texture_stack.get_channel(channel_type).is_color() diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index 9d6aa06872..4468602392 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -41,13 +41,11 @@ class CollectTextureSet(pyblish.api.InstancePlugin): for (texture_set_name, stack_name), template_maps in maps.items(): self.log.info(f"Processing {texture_set_name}/{stack_name}") for template, outputs in template_maps.items(): - if texture_set_filtering(texture_set_name, template): - self.log.info(f"Processing {template}") - self.create_image_instance( - instance, template, outputs, - asset_doc=asset_doc, - texture_set_name=texture_set_name, - stack_name=stack_name) + self.log.info(f"Processing {template}") + self.create_image_instance(instance, template, outputs, + asset_doc=asset_doc, + texture_set_name=texture_set_name, + stack_name=stack_name) def create_image_instance(self, instance, template, outputs, asset_doc, texture_set_name, stack_name): diff --git a/openpype/hosts/substancepainter/plugins/publish/validate_ouput_maps.py b/openpype/hosts/substancepainter/plugins/publish/validate_ouput_maps.py index b57cf4c5a2..252683b6c8 100644 --- a/openpype/hosts/substancepainter/plugins/publish/validate_ouput_maps.py +++ b/openpype/hosts/substancepainter/plugins/publish/validate_ouput_maps.py @@ -80,6 +80,7 @@ class ValidateOutputMaps(pyblish.api.InstancePlugin): self.log.warning(f"Disabling texture instance: " f"{image_instance}") image_instance.data["active"] = False + image_instance.data["publish"] = False image_instance.data["integrate"] = False representation.setdefault("tags", []).append("delete") continue From 00ab2bc9f69916ab19ddd15d018dc38cba624991 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Sat, 13 Jan 2024 00:19:03 +0800 Subject: [PATCH 122/198] remove unused function --- .../plugins/publish/collect_textureset_images.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index 4468602392..370e72f34b 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -8,8 +8,7 @@ import substance_painter.textureset from openpype.hosts.substancepainter.api.lib import ( get_parsed_export_maps, strip_template, - has_rgb_channel_in_texture_set, - texture_set_filtering + has_rgb_channel_in_texture_set ) from openpype.pipeline.create import get_subset_name from openpype.client import get_asset_by_name From 95d2d45e0ffe10186714bf8136f6ac085ef6c202 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Fri, 12 Jan 2024 17:07:28 +0000 Subject: [PATCH 123/198] Fix reading image sequences through oiiotool --- openpype/lib/transcoding.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/openpype/lib/transcoding.py b/openpype/lib/transcoding.py index 316dedbd3d..79d24e737a 100644 --- a/openpype/lib/transcoding.py +++ b/openpype/lib/transcoding.py @@ -120,6 +120,10 @@ def get_oiio_info_for_input(filepath, logger=None, subimages=False): output = [] for subimage_lines in subimages_lines: + # First line of oiiotool for xml format is "Reading path/to/file.ext". + if not subimage_lines[0].startswith(" Date: Sat, 13 Jan 2024 03:25:27 +0000 Subject: [PATCH 124/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index c87c143ea3..5981cb657a 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.3" +__version__ = "3.18.4-nightly.1" From 8afd06233797bb0b949658a323bcbd0aeb3ffbd2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 13 Jan 2024 03:26:00 +0000 Subject: [PATCH 125/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3f762bd2d8..e9b68a54f1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.4-nightly.1 - 3.18.3 - 3.18.3-nightly.2 - 3.18.3-nightly.1 @@ -134,7 +135,6 @@ body: - 3.15.7-nightly.2 - 3.15.7-nightly.1 - 3.15.6 - - 3.15.6-nightly.3 validations: required: true - type: dropdown From 7d94fb92c23d7ef055329f71d0333ab490a0055c Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Mon, 15 Jan 2024 10:32:39 +0100 Subject: [PATCH 126/198] Fusion: new creator for image product type (#6057) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Introduced image product type 'image' product type should result in single frame output, 'render' should be more focused on multiple frames. * Updated logging * Refactor moved generic creaor class to better location * Update openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json Co-authored-by: Jakub Ježek * Change label It might be movie type not only image sequence. * OP-7470 - fix name * OP-7470 - update docstring There were objections for setting up this creator as it seems unnecessary. There is currently no other way how to implement customer requirement but this, but in the future 'alias' product types implementation might solve this. * Implementing changes from #6060 https://github.com/ynput/OpenPype/pull/6060 * Update openpype/settings/defaults/project_settings/fusion.json Co-authored-by: Jakub Ježek * Update server_addon/fusion/server/settings.py Co-authored-by: Jakub Ježek * Update openpype/hosts/fusion/api/plugin.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> * OP-7470 - added explicit frame field Artist can insert specific frame from which `image` instance should be created. * OP-7470 - fix name and logging Prints better message even in debug mode. * OP-7470 - update instance label It contained original frames which was confusing. * Update openpype/hosts/fusion/plugins/create/create_image_saver.py Co-authored-by: Roy Nieterau * OP-7470 - fix documentation * OP-7470 - moved frame range resolution earlier This approach is safer, as frame range is resolved sooner. * OP-7470 - added new validator for single frame * OP-7470 - Hound * OP-7470 - removed unnecessary as label * OP-7470 - use internal class anatomy * OP-7470 - add explicit settings_category to propagete values from Setting correctly apply_settings is replaced by correct value in `settings_category` * OP-7470 - typo * OP-7470 - update docstring * OP-7470 - update formatting data This probably fixes issue with missing product key in intermediate product name. * OP-7470 - moved around only proper fields Some fields (frame and frame_range) are making sense only in specific creator. * OP-7470 - added defaults to Settings * OP-7470 - fixed typo * OP-7470 - bumped up version Settings changed, so addon version should change too. 0.1.2 is in develop * Update openpype/hosts/fusion/plugins/publish/collect_instances.py Co-authored-by: Roy Nieterau * OP-7470 - removed unnecessary variables There was logic intended to use those, deemed not necessary. * OP-7470 - update to error message * OP-7470 - removed unneded method --------- Co-authored-by: Jakub Ježek Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Co-authored-by: Roy Nieterau --- openpype/hosts/fusion/api/plugin.py | 221 +++++++++++++++ .../plugins/create/create_image_saver.py | 64 +++++ .../fusion/plugins/create/create_saver.py | 257 ++---------------- .../fusion/plugins/publish/collect_inputs.py | 2 +- .../plugins/publish/collect_instances.py | 12 + .../fusion/plugins/publish/collect_render.py | 4 +- .../fusion/plugins/publish/save_scene.py | 2 +- .../publish/validate_background_depth.py | 2 +- .../plugins/publish/validate_comp_saved.py | 2 +- .../publish/validate_create_folder_checked.py | 2 +- .../validate_filename_has_extension.py | 2 +- .../plugins/publish/validate_image_frame.py | 27 ++ .../publish/validate_instance_frame_range.py | 4 +- .../publish/validate_saver_has_input.py | 2 +- .../publish/validate_saver_passthrough.py | 2 +- .../publish/validate_saver_resolution.py | 2 +- .../publish/validate_unique_subsets.py | 2 +- .../defaults/project_settings/fusion.json | 12 + .../schema_project_fusion.json | 51 +++- server_addon/fusion/server/settings.py | 67 ++++- server_addon/fusion/server/version.py | 2 +- 21 files changed, 482 insertions(+), 259 deletions(-) create mode 100644 openpype/hosts/fusion/api/plugin.py create mode 100644 openpype/hosts/fusion/plugins/create/create_image_saver.py create mode 100644 openpype/hosts/fusion/plugins/publish/validate_image_frame.py diff --git a/openpype/hosts/fusion/api/plugin.py b/openpype/hosts/fusion/api/plugin.py new file mode 100644 index 0000000000..63a74fbdb5 --- /dev/null +++ b/openpype/hosts/fusion/api/plugin.py @@ -0,0 +1,221 @@ +from copy import deepcopy +import os + +from openpype.hosts.fusion.api import ( + get_current_comp, + comp_lock_and_undo_chunk, +) + +from openpype.lib import ( + BoolDef, + EnumDef, +) +from openpype.pipeline import ( + legacy_io, + Creator, + CreatedInstance +) + + +class GenericCreateSaver(Creator): + default_variants = ["Main", "Mask"] + description = "Fusion Saver to generate image sequence" + icon = "fa5.eye" + + instance_attributes = [ + "reviewable" + ] + + settings_category = "fusion" + + image_format = "exr" + + # TODO: This should be renamed together with Nuke so it is aligned + temp_rendering_path_template = ( + "{workdir}/renders/fusion/{subset}/{subset}.{frame}.{ext}") + + def create(self, subset_name, instance_data, pre_create_data): + self.pass_pre_attributes_to_instance(instance_data, pre_create_data) + + instance = CreatedInstance( + family=self.family, + subset_name=subset_name, + data=instance_data, + creator=self, + ) + data = instance.data_to_store() + comp = get_current_comp() + with comp_lock_and_undo_chunk(comp): + args = (-32768, -32768) # Magical position numbers + saver = comp.AddTool("Saver", *args) + + self._update_tool_with_data(saver, data=data) + + # Register the CreatedInstance + self._imprint(saver, data) + + # Insert the transient data + instance.transient_data["tool"] = saver + + self._add_instance_to_context(instance) + + return instance + + def collect_instances(self): + comp = get_current_comp() + tools = comp.GetToolList(False, "Saver").values() + for tool in tools: + data = self.get_managed_tool_data(tool) + if not data: + continue + + # Add instance + created_instance = CreatedInstance.from_existing(data, self) + + # Collect transient data + created_instance.transient_data["tool"] = tool + + self._add_instance_to_context(created_instance) + + def update_instances(self, update_list): + for created_inst, _changes in update_list: + new_data = created_inst.data_to_store() + tool = created_inst.transient_data["tool"] + self._update_tool_with_data(tool, new_data) + self._imprint(tool, new_data) + + def remove_instances(self, instances): + for instance in instances: + # Remove the tool from the scene + + tool = instance.transient_data["tool"] + if tool: + tool.Delete() + + # Remove the collected CreatedInstance to remove from UI directly + self._remove_instance_from_context(instance) + + def _imprint(self, tool, data): + # Save all data in a "openpype.{key}" = value data + + # Instance id is the tool's name so we don't need to imprint as data + data.pop("instance_id", None) + + active = data.pop("active", None) + if active is not None: + # Use active value to set the passthrough state + tool.SetAttrs({"TOOLB_PassThrough": not active}) + + for key, value in data.items(): + tool.SetData(f"openpype.{key}", value) + + def _update_tool_with_data(self, tool, data): + """Update tool node name and output path based on subset data""" + if "subset" not in data: + return + + original_subset = tool.GetData("openpype.subset") + original_format = tool.GetData( + "openpype.creator_attributes.image_format" + ) + + subset = data["subset"] + if ( + original_subset != subset + or original_format != data["creator_attributes"]["image_format"] + ): + self._configure_saver_tool(data, tool, subset) + + def _configure_saver_tool(self, data, tool, subset): + formatting_data = deepcopy(data) + + # get frame padding from anatomy templates + frame_padding = self.project_anatomy.templates["frame_padding"] + + # get output format + ext = data["creator_attributes"]["image_format"] + + # Subset change detected + workdir = os.path.normpath(legacy_io.Session["AVALON_WORKDIR"]) + formatting_data.update({ + "workdir": workdir, + "frame": "0" * frame_padding, + "ext": ext, + "product": { + "name": formatting_data["subset"], + "type": formatting_data["family"], + }, + }) + + # build file path to render + filepath = self.temp_rendering_path_template.format(**formatting_data) + + comp = get_current_comp() + tool["Clip"] = comp.ReverseMapPath(os.path.normpath(filepath)) + + # Rename tool + if tool.Name != subset: + print(f"Renaming {tool.Name} -> {subset}") + tool.SetAttrs({"TOOLS_Name": subset}) + + def get_managed_tool_data(self, tool): + """Return data of the tool if it matches creator identifier""" + data = tool.GetData("openpype") + if not isinstance(data, dict): + return + + required = { + "id": "pyblish.avalon.instance", + "creator_identifier": self.identifier, + } + for key, value in required.items(): + if key not in data or data[key] != value: + return + + # Get active state from the actual tool state + attrs = tool.GetAttrs() + passthrough = attrs["TOOLB_PassThrough"] + data["active"] = not passthrough + + # Override publisher's UUID generation because tool names are + # already unique in Fusion in a comp + data["instance_id"] = tool.Name + + return data + + def get_instance_attr_defs(self): + """Settings for publish page""" + return self.get_pre_create_attr_defs() + + def pass_pre_attributes_to_instance(self, instance_data, pre_create_data): + creator_attrs = instance_data["creator_attributes"] = {} + for pass_key in pre_create_data.keys(): + creator_attrs[pass_key] = pre_create_data[pass_key] + + def _get_render_target_enum(self): + rendering_targets = { + "local": "Local machine rendering", + "frames": "Use existing frames", + } + if "farm_rendering" in self.instance_attributes: + rendering_targets["farm"] = "Farm rendering" + + return EnumDef( + "render_target", items=rendering_targets, label="Render target" + ) + + def _get_reviewable_bool(self): + return BoolDef( + "review", + default=("reviewable" in self.instance_attributes), + label="Review", + ) + + def _get_image_format_enum(self): + image_format_options = ["exr", "tga", "tif", "png", "jpg"] + return EnumDef( + "image_format", + items=image_format_options, + default=self.image_format, + label="Output Image Format", + ) diff --git a/openpype/hosts/fusion/plugins/create/create_image_saver.py b/openpype/hosts/fusion/plugins/create/create_image_saver.py new file mode 100644 index 0000000000..490228d488 --- /dev/null +++ b/openpype/hosts/fusion/plugins/create/create_image_saver.py @@ -0,0 +1,64 @@ +from openpype.lib import NumberDef + +from openpype.hosts.fusion.api.plugin import GenericCreateSaver +from openpype.hosts.fusion.api import get_current_comp + + +class CreateImageSaver(GenericCreateSaver): + """Fusion Saver to generate single image. + + Created to explicitly separate single ('image') or + multi frame('render) outputs. + + This might be temporary creator until 'alias' functionality will be + implemented to limit creation of additional product types with similar, but + not the same workflows. + """ + identifier = "io.openpype.creators.fusion.imagesaver" + label = "Image (saver)" + name = "image" + family = "image" + description = "Fusion Saver to generate image" + + default_frame = 0 + + def get_detail_description(self): + return """Fusion Saver to generate single image. + + This creator is expected for publishing of single frame `image` product + type. + + Artist should provide frame number (integer) to specify which frame + should be published. It must be inside of global timeline frame range. + + Supports local and deadline rendering. + + Supports selection from predefined set of output file extensions: + - exr + - tga + - png + - tif + - jpg + + Created to explicitly separate single frame ('image') or + multi frame ('render') outputs. + """ + + def get_pre_create_attr_defs(self): + """Settings for create page""" + attr_defs = [ + self._get_render_target_enum(), + self._get_reviewable_bool(), + self._get_frame_int(), + self._get_image_format_enum(), + ] + return attr_defs + + def _get_frame_int(self): + return NumberDef( + "frame", + default=self.default_frame, + label="Frame", + tooltip="Set frame to be rendered, must be inside of global " + "timeline range" + ) diff --git a/openpype/hosts/fusion/plugins/create/create_saver.py b/openpype/hosts/fusion/plugins/create/create_saver.py index 5870828b41..3a8ffe890b 100644 --- a/openpype/hosts/fusion/plugins/create/create_saver.py +++ b/openpype/hosts/fusion/plugins/create/create_saver.py @@ -1,187 +1,42 @@ -from copy import deepcopy -import os +from openpype.lib import EnumDef -from openpype.hosts.fusion.api import ( - get_current_comp, - comp_lock_and_undo_chunk, -) - -from openpype.lib import ( - BoolDef, - EnumDef, -) -from openpype.pipeline import ( - legacy_io, - Creator as NewCreator, - CreatedInstance, - Anatomy, -) +from openpype.hosts.fusion.api.plugin import GenericCreateSaver -class CreateSaver(NewCreator): +class CreateSaver(GenericCreateSaver): + """Fusion Saver to generate image sequence of 'render' product type. + + Original Saver creator targeted for 'render' product type. It uses + original not to descriptive name because of values in Settings. + """ identifier = "io.openpype.creators.fusion.saver" label = "Render (saver)" name = "render" family = "render" - default_variants = ["Main", "Mask"] description = "Fusion Saver to generate image sequence" - icon = "fa5.eye" - instance_attributes = ["reviewable"] - image_format = "exr" + default_frame_range_option = "asset_db" - # TODO: This should be renamed together with Nuke so it is aligned - temp_rendering_path_template = ( - "{workdir}/renders/fusion/{subset}/{subset}.{frame}.{ext}" - ) + def get_detail_description(self): + return """Fusion Saver to generate image sequence. - def create(self, subset_name, instance_data, pre_create_data): - self.pass_pre_attributes_to_instance(instance_data, pre_create_data) + This creator is expected for publishing of image sequences for 'render' + product type. (But can publish even single frame 'render'.) - instance_data.update( - {"id": "pyblish.avalon.instance", "subset": subset_name} - ) + Select what should be source of render range: + - "Current asset context" - values set on Asset in DB (Ftrack) + - "From render in/out" - from node itself + - "From composition timeline" - from timeline - comp = get_current_comp() - with comp_lock_and_undo_chunk(comp): - args = (-32768, -32768) # Magical position numbers - saver = comp.AddTool("Saver", *args) + Supports local and farm rendering. - self._update_tool_with_data(saver, data=instance_data) - - # Register the CreatedInstance - instance = CreatedInstance( - family=self.family, - subset_name=subset_name, - data=instance_data, - creator=self, - ) - data = instance.data_to_store() - self._imprint(saver, data) - - # Insert the transient data - instance.transient_data["tool"] = saver - - self._add_instance_to_context(instance) - - return instance - - def collect_instances(self): - comp = get_current_comp() - tools = comp.GetToolList(False, "Saver").values() - for tool in tools: - data = self.get_managed_tool_data(tool) - if not data: - continue - - # Add instance - created_instance = CreatedInstance.from_existing(data, self) - - # Collect transient data - created_instance.transient_data["tool"] = tool - - self._add_instance_to_context(created_instance) - - def update_instances(self, update_list): - for created_inst, _changes in update_list: - new_data = created_inst.data_to_store() - tool = created_inst.transient_data["tool"] - self._update_tool_with_data(tool, new_data) - self._imprint(tool, new_data) - - def remove_instances(self, instances): - for instance in instances: - # Remove the tool from the scene - - tool = instance.transient_data["tool"] - if tool: - tool.Delete() - - # Remove the collected CreatedInstance to remove from UI directly - self._remove_instance_from_context(instance) - - def _imprint(self, tool, data): - # Save all data in a "openpype.{key}" = value data - - # Instance id is the tool's name so we don't need to imprint as data - data.pop("instance_id", None) - - active = data.pop("active", None) - if active is not None: - # Use active value to set the passthrough state - tool.SetAttrs({"TOOLB_PassThrough": not active}) - - for key, value in data.items(): - tool.SetData(f"openpype.{key}", value) - - def _update_tool_with_data(self, tool, data): - """Update tool node name and output path based on subset data""" - if "subset" not in data: - return - - original_subset = tool.GetData("openpype.subset") - original_format = tool.GetData( - "openpype.creator_attributes.image_format" - ) - - subset = data["subset"] - if ( - original_subset != subset - or original_format != data["creator_attributes"]["image_format"] - ): - self._configure_saver_tool(data, tool, subset) - - def _configure_saver_tool(self, data, tool, subset): - formatting_data = deepcopy(data) - - # get frame padding from anatomy templates - anatomy = Anatomy() - frame_padding = anatomy.templates["frame_padding"] - - # get output format - ext = data["creator_attributes"]["image_format"] - - # Subset change detected - workdir = os.path.normpath(legacy_io.Session["AVALON_WORKDIR"]) - formatting_data.update( - {"workdir": workdir, "frame": "0" * frame_padding, "ext": ext} - ) - - # build file path to render - filepath = self.temp_rendering_path_template.format(**formatting_data) - - comp = get_current_comp() - tool["Clip"] = comp.ReverseMapPath(os.path.normpath(filepath)) - - # Rename tool - if tool.Name != subset: - print(f"Renaming {tool.Name} -> {subset}") - tool.SetAttrs({"TOOLS_Name": subset}) - - def get_managed_tool_data(self, tool): - """Return data of the tool if it matches creator identifier""" - data = tool.GetData("openpype") - if not isinstance(data, dict): - return - - required = { - "id": "pyblish.avalon.instance", - "creator_identifier": self.identifier, - } - for key, value in required.items(): - if key not in data or data[key] != value: - return - - # Get active state from the actual tool state - attrs = tool.GetAttrs() - passthrough = attrs["TOOLB_PassThrough"] - data["active"] = not passthrough - - # Override publisher's UUID generation because tool names are - # already unique in Fusion in a comp - data["instance_id"] = tool.Name - - return data + Supports selection from predefined set of output file extensions: + - exr + - tga + - png + - tif + - jpg + """ def get_pre_create_attr_defs(self): """Settings for create page""" @@ -193,29 +48,6 @@ class CreateSaver(NewCreator): ] return attr_defs - def get_instance_attr_defs(self): - """Settings for publish page""" - return self.get_pre_create_attr_defs() - - def pass_pre_attributes_to_instance(self, instance_data, pre_create_data): - creator_attrs = instance_data["creator_attributes"] = {} - for pass_key in pre_create_data.keys(): - creator_attrs[pass_key] = pre_create_data[pass_key] - - # These functions below should be moved to another file - # so it can be used by other plugins. plugin.py ? - def _get_render_target_enum(self): - rendering_targets = { - "local": "Local machine rendering", - "frames": "Use existing frames", - } - if "farm_rendering" in self.instance_attributes: - rendering_targets["farm"] = "Farm rendering" - - return EnumDef( - "render_target", items=rendering_targets, label="Render target" - ) - def _get_frame_range_enum(self): frame_range_options = { "asset_db": "Current asset context", @@ -227,42 +59,5 @@ class CreateSaver(NewCreator): "frame_range_source", items=frame_range_options, label="Frame range source", - ) - - def _get_reviewable_bool(self): - return BoolDef( - "review", - default=("reviewable" in self.instance_attributes), - label="Review", - ) - - def _get_image_format_enum(self): - image_format_options = ["exr", "tga", "tif", "png", "jpg"] - return EnumDef( - "image_format", - items=image_format_options, - default=self.image_format, - label="Output Image Format", - ) - - def apply_settings(self, project_settings): - """Method called on initialization of plugin to apply settings.""" - - # plugin settings - plugin_settings = project_settings["fusion"]["create"][ - self.__class__.__name__ - ] - - # individual attributes - self.instance_attributes = plugin_settings.get( - "instance_attributes", self.instance_attributes - ) - self.default_variants = plugin_settings.get( - "default_variants", self.default_variants - ) - self.temp_rendering_path_template = plugin_settings.get( - "temp_rendering_path_template", self.temp_rendering_path_template - ) - self.image_format = plugin_settings.get( - "image_format", self.image_format + default=self.default_frame_range_option ) diff --git a/openpype/hosts/fusion/plugins/publish/collect_inputs.py b/openpype/hosts/fusion/plugins/publish/collect_inputs.py index a6628300db..f23e4d0268 100644 --- a/openpype/hosts/fusion/plugins/publish/collect_inputs.py +++ b/openpype/hosts/fusion/plugins/publish/collect_inputs.py @@ -95,7 +95,7 @@ class CollectUpstreamInputs(pyblish.api.InstancePlugin): label = "Collect Inputs" order = pyblish.api.CollectorOrder + 0.2 hosts = ["fusion"] - families = ["render"] + families = ["render", "image"] def process(self, instance): diff --git a/openpype/hosts/fusion/plugins/publish/collect_instances.py b/openpype/hosts/fusion/plugins/publish/collect_instances.py index 4d6da79b77..a0131248e8 100644 --- a/openpype/hosts/fusion/plugins/publish/collect_instances.py +++ b/openpype/hosts/fusion/plugins/publish/collect_instances.py @@ -57,6 +57,18 @@ class CollectInstanceData(pyblish.api.InstancePlugin): start_with_handle = comp_start end_with_handle = comp_end + frame = instance.data["creator_attributes"].get("frame") + # explicitly publishing only single frame + if frame is not None: + frame = int(frame) + + start = frame + end = frame + handle_start = 0 + handle_end = 0 + start_with_handle = frame + end_with_handle = frame + # Include start and end render frame in label subset = instance.data["subset"] label = ( diff --git a/openpype/hosts/fusion/plugins/publish/collect_render.py b/openpype/hosts/fusion/plugins/publish/collect_render.py index a7daa0b64c..366eaa905c 100644 --- a/openpype/hosts/fusion/plugins/publish/collect_render.py +++ b/openpype/hosts/fusion/plugins/publish/collect_render.py @@ -50,7 +50,7 @@ class CollectFusionRender( continue family = inst.data["family"] - if family != "render": + if family not in ["render", "image"]: continue task_name = context.data["task"] @@ -59,7 +59,7 @@ class CollectFusionRender( instance_families = inst.data.get("families", []) subset_name = inst.data["subset"] instance = FusionRenderInstance( - family="render", + family=family, tool=tool, workfileComp=comp, families=instance_families, diff --git a/openpype/hosts/fusion/plugins/publish/save_scene.py b/openpype/hosts/fusion/plugins/publish/save_scene.py index 0798e7c8b7..da9b6ce41f 100644 --- a/openpype/hosts/fusion/plugins/publish/save_scene.py +++ b/openpype/hosts/fusion/plugins/publish/save_scene.py @@ -7,7 +7,7 @@ class FusionSaveComp(pyblish.api.ContextPlugin): label = "Save current file" order = pyblish.api.ExtractorOrder - 0.49 hosts = ["fusion"] - families = ["render", "workfile"] + families = ["render", "image", "workfile"] def process(self, context): diff --git a/openpype/hosts/fusion/plugins/publish/validate_background_depth.py b/openpype/hosts/fusion/plugins/publish/validate_background_depth.py index 6908889eb4..e268f8adec 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_background_depth.py +++ b/openpype/hosts/fusion/plugins/publish/validate_background_depth.py @@ -17,7 +17,7 @@ class ValidateBackgroundDepth( order = pyblish.api.ValidatorOrder label = "Validate Background Depth 32 bit" hosts = ["fusion"] - families = ["render"] + families = ["render", "image"] optional = True actions = [SelectInvalidAction, publish.RepairAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_comp_saved.py b/openpype/hosts/fusion/plugins/publish/validate_comp_saved.py index 748047e8cf..6e6d10e09a 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_comp_saved.py +++ b/openpype/hosts/fusion/plugins/publish/validate_comp_saved.py @@ -9,7 +9,7 @@ class ValidateFusionCompSaved(pyblish.api.ContextPlugin): order = pyblish.api.ValidatorOrder label = "Validate Comp Saved" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] def process(self, context): diff --git a/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py b/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py index 35c92163eb..d5c618af58 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py +++ b/openpype/hosts/fusion/plugins/publish/validate_create_folder_checked.py @@ -15,7 +15,7 @@ class ValidateCreateFolderChecked(pyblish.api.InstancePlugin): order = pyblish.api.ValidatorOrder label = "Validate Create Folder Checked" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] actions = [RepairAction, SelectInvalidAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_filename_has_extension.py b/openpype/hosts/fusion/plugins/publish/validate_filename_has_extension.py index 537e43c875..38cd578ff2 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_filename_has_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_filename_has_extension.py @@ -17,7 +17,7 @@ class ValidateFilenameHasExtension(pyblish.api.InstancePlugin): order = pyblish.api.ValidatorOrder label = "Validate Filename Has Extension" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] actions = [SelectInvalidAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_image_frame.py b/openpype/hosts/fusion/plugins/publish/validate_image_frame.py new file mode 100644 index 0000000000..734203f31c --- /dev/null +++ b/openpype/hosts/fusion/plugins/publish/validate_image_frame.py @@ -0,0 +1,27 @@ +import pyblish.api + +from openpype.pipeline import PublishValidationError + + +class ValidateImageFrame(pyblish.api.InstancePlugin): + """Validates that `image` product type contains only single frame.""" + + order = pyblish.api.ValidatorOrder + label = "Validate Image Frame" + families = ["image"] + hosts = ["fusion"] + + def process(self, instance): + render_start = instance.data["frameStartHandle"] + render_end = instance.data["frameEndHandle"] + too_many_frames = (isinstance(instance.data["expectedFiles"], list) + and len(instance.data["expectedFiles"]) > 1) + + if render_end - render_start > 0 or too_many_frames: + desc = ("Trying to render multiple frames. 'image' product type " + "is meant for single frame. Please use 'render' creator.") + raise PublishValidationError( + title="Frame range outside of comp range", + message=desc, + description=desc + ) diff --git a/openpype/hosts/fusion/plugins/publish/validate_instance_frame_range.py b/openpype/hosts/fusion/plugins/publish/validate_instance_frame_range.py index 06cd0ca186..edf219e752 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_instance_frame_range.py +++ b/openpype/hosts/fusion/plugins/publish/validate_instance_frame_range.py @@ -7,8 +7,8 @@ class ValidateInstanceFrameRange(pyblish.api.InstancePlugin): """Validate instance frame range is within comp's global render range.""" order = pyblish.api.ValidatorOrder - label = "Validate Filename Has Extension" - families = ["render"] + label = "Validate Frame Range" + families = ["render", "image"] hosts = ["fusion"] def process(self, instance): diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_has_input.py b/openpype/hosts/fusion/plugins/publish/validate_saver_has_input.py index faf2102a8b..0103e990fb 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_has_input.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_has_input.py @@ -13,7 +13,7 @@ class ValidateSaverHasInput(pyblish.api.InstancePlugin): order = pyblish.api.ValidatorOrder label = "Validate Saver Has Input" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] actions = [SelectInvalidAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_passthrough.py b/openpype/hosts/fusion/plugins/publish/validate_saver_passthrough.py index 9004976dc5..6019bee93a 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_passthrough.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_passthrough.py @@ -9,7 +9,7 @@ class ValidateSaverPassthrough(pyblish.api.ContextPlugin): order = pyblish.api.ValidatorOrder label = "Validate Saver Passthrough" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] actions = [SelectInvalidAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py b/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py index efa7295d11..f6aba170c0 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py @@ -64,7 +64,7 @@ class ValidateSaverResolution( order = pyblish.api.ValidatorOrder label = "Validate Asset Resolution" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] optional = True actions = [SelectInvalidAction] diff --git a/openpype/hosts/fusion/plugins/publish/validate_unique_subsets.py b/openpype/hosts/fusion/plugins/publish/validate_unique_subsets.py index 5b6ceb2fdb..d1693ef3dc 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_unique_subsets.py +++ b/openpype/hosts/fusion/plugins/publish/validate_unique_subsets.py @@ -11,7 +11,7 @@ class ValidateUniqueSubsets(pyblish.api.ContextPlugin): order = pyblish.api.ValidatorOrder label = "Validate Unique Subsets" - families = ["render"] + families = ["render", "image"] hosts = ["fusion"] actions = [SelectInvalidAction] diff --git a/openpype/settings/defaults/project_settings/fusion.json b/openpype/settings/defaults/project_settings/fusion.json index 8579442625..15b6bfc09b 100644 --- a/openpype/settings/defaults/project_settings/fusion.json +++ b/openpype/settings/defaults/project_settings/fusion.json @@ -32,6 +32,18 @@ "farm_rendering" ], "image_format": "exr" + }, + "CreateImageSaver": { + "temp_rendering_path_template": "{workdir}/renders/fusion/{subset}/{subset}.{ext}", + "default_variants": [ + "Main", + "Mask" + ], + "instance_attributes": [ + "reviewable", + "farm_rendering" + ], + "image_format": "exr" } }, "publish": { diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json index fbd856b895..8669842087 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json @@ -74,7 +74,56 @@ "type": "dict", "collapsible": true, "key": "CreateSaver", - "label": "Create Saver", + "label": "Create Render Saver", + "is_group": true, + "children": [ + { + "type": "text", + "key": "temp_rendering_path_template", + "label": "Temporary rendering path template" + }, + { + "type": "list", + "key": "default_variants", + "label": "Default variants", + "object_type": { + "type": "text" + } + }, + { + "key": "instance_attributes", + "label": "Instance attributes", + "type": "enum", + "multiselection": true, + "enum_items": [ + { + "reviewable": "Reviewable" + }, + { + "farm_rendering": "Farm rendering" + } + ] + }, + { + "key": "image_format", + "label": "Output Image Format", + "type": "enum", + "multiselect": false, + "enum_items": [ + {"exr": "exr"}, + {"tga": "tga"}, + {"png": "png"}, + {"tif": "tif"}, + {"jpg": "jpg"} + ] + } + ] + }, + { + "type": "dict", + "collapsible": true, + "key": "CreateImageSaver", + "label": "Create Image Saver", "is_group": true, "children": [ { diff --git a/server_addon/fusion/server/settings.py b/server_addon/fusion/server/settings.py index 21189b390e..bf295f3064 100644 --- a/server_addon/fusion/server/settings.py +++ b/server_addon/fusion/server/settings.py @@ -25,6 +25,24 @@ def _create_saver_instance_attributes_enum(): ] +def _image_format_enum(): + return [ + {"value": "exr", "label": "exr"}, + {"value": "tga", "label": "tga"}, + {"value": "png", "label": "png"}, + {"value": "tif", "label": "tif"}, + {"value": "jpg", "label": "jpg"}, + ] + + +def _frame_range_options_enum(): + return [ + {"value": "asset_db", "label": "Current asset context"}, + {"value": "render_range", "label": "From render in/out"}, + {"value": "comp_range", "label": "From composition timeline"}, + ] + + class CreateSaverPluginModel(BaseSettingsModel): _isGroup = True temp_rendering_path_template: str = Field( @@ -59,10 +77,29 @@ class HooksModel(BaseSettingsModel): ) +class CreateSaverModel(CreateSaverPluginModel): + default_frame_range_option: str = Field( + default="asset_db", + enum_resolver=_frame_range_options_enum, + title="Default frame range source" + ) + + +class CreateImageSaverModel(CreateSaverPluginModel): + default_frame: int = Field( + 0, + title="Default rendered frame" + ) class CreatPluginsModel(BaseSettingsModel): - CreateSaver: CreateSaverPluginModel = Field( - default_factory=CreateSaverPluginModel, - title="Create Saver" + CreateSaver: CreateSaverModel = Field( + default_factory=CreateSaverModel, + title="Create Saver", + description="Creator for render product type (eg. sequence)" + ) + CreateImageSaver: CreateImageSaverModel = Field( + default_factory=CreateImageSaverModel, + title="Create Image Saver", + description="Creator for image product type (eg. single)" ) @@ -117,15 +154,21 @@ DEFAULT_VALUES = { "reviewable", "farm_rendering" ], - "output_formats": [ - "exr", - "jpg", - "jpeg", - "jpg", - "tiff", - "png", - "tga" - ] + "image_format": "exr", + "default_frame_range_option": "asset_db" + }, + "CreateImageSaver": { + "temp_rendering_path_template": "{workdir}/renders/fusion/{product[name]}/{product[name]}.{ext}", + "default_variants": [ + "Main", + "Mask" + ], + "instance_attributes": [ + "reviewable", + "farm_rendering" + ], + "image_format": "exr", + "default_frame": 0 } } } diff --git a/server_addon/fusion/server/version.py b/server_addon/fusion/server/version.py index b3f4756216..ae7362549b 100644 --- a/server_addon/fusion/server/version.py +++ b/server_addon/fusion/server/version.py @@ -1 +1 @@ -__version__ = "0.1.2" +__version__ = "0.1.3" From 1ac89d2efa55792e11023419e3ac5914e7b57480 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Mon, 15 Jan 2024 19:17:12 +0800 Subject: [PATCH 127/198] restore some of the codes on lib and collect images --- openpype/hosts/substancepainter/api/lib.py | 30 ------------------- .../publish/collect_textureset_images.py | 8 ++--- 2 files changed, 3 insertions(+), 35 deletions(-) diff --git a/openpype/hosts/substancepainter/api/lib.py b/openpype/hosts/substancepainter/api/lib.py index 896cca79b0..1cb480b552 100644 --- a/openpype/hosts/substancepainter/api/lib.py +++ b/openpype/hosts/substancepainter/api/lib.py @@ -643,33 +643,3 @@ def prompt_new_file_with_mesh(mesh_filepath): return return project_mesh - - -def has_rgb_channel_in_texture_set(texture_set_name, map_identifier): - """Function to check whether the texture has RGB channel. - - Args: - texture_set_name (str): Name of Texture Set - map_identifier (str): Map identifier - - Returns: - bool: Whether the channel type identifier has RGB channel or not - in the texture stack. - """ - - # 2D_View is always True as it exports all texture maps - texture_stack = ( - substance_painter.textureset.Stack.from_name(texture_set_name) - ) - # 2D_View is always True as it exports all texture maps - if map_identifier == "2D_View": - return True - - channel_type = getattr( - substance_painter.textureset.ChannelType, map_identifier, None) - if channel_type is None: - return False - if not texture_stack.has_channel(channel_type): - return False - - return texture_stack.get_channel(channel_type).is_color() diff --git a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py index 370e72f34b..316f72509e 100644 --- a/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py +++ b/openpype/hosts/substancepainter/plugins/publish/collect_textureset_images.py @@ -7,8 +7,7 @@ from openpype.pipeline import publish import substance_painter.textureset from openpype.hosts.substancepainter.api.lib import ( get_parsed_export_maps, - strip_template, - has_rgb_channel_in_texture_set + strip_template ) from openpype.pipeline.create import get_subset_name from openpype.client import get_asset_by_name @@ -79,6 +78,7 @@ class CollectTextureSet(pyblish.api.InstancePlugin): # Always include the map identifier map_identifier = strip_template(template) suffix += f".{map_identifier}" + image_subset = get_subset_name( # TODO: The family actually isn't 'texture' currently but for now # this is only done so the subset name starts with 'texture' @@ -132,9 +132,7 @@ class CollectTextureSet(pyblish.api.InstancePlugin): # Store color space with the instance # Note: The extractor will assign it to the representation colorspace = outputs[0].get("colorSpace") - has_rgb_channel = has_rgb_channel_in_texture_set( - texture_set_name, map_identifier) - if colorspace and has_rgb_channel: + if colorspace: self.log.debug(f"{image_subset} colorspace: {colorspace}") image_instance.data["colorspace"] = colorspace From 190840fe052d0ee35ad9585d18ebc06eec916808 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Mon, 15 Jan 2024 12:16:50 +0000 Subject: [PATCH 128/198] Missing nuke family Windows arguments --- .../applications/server/applications.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/server_addon/applications/server/applications.json b/server_addon/applications/server/applications.json index 35f1b4cfbb..d2e2d942c6 100644 --- a/server_addon/applications/server/applications.json +++ b/server_addon/applications/server/applications.json @@ -307,7 +307,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukeassist"], "darwin": [], "linux": [] }, @@ -329,7 +329,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukeassist"], "darwin": [], "linux": [] }, @@ -351,7 +351,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukeassist"], "darwin": [], "linux": [] }, @@ -382,7 +382,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukex"], "darwin": [], "linux": [] }, @@ -404,7 +404,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukex"], "darwin": [], "linux": [] }, @@ -426,7 +426,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--nukex"], "darwin": [], "linux": [] }, @@ -457,7 +457,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--studio"], "darwin": [], "linux": [] }, @@ -479,7 +479,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--studio"], "darwin": [], "linux": [] }, @@ -501,7 +501,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--studio"], "darwin": [], "linux": [] }, @@ -532,7 +532,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--hiero"], "darwin": [], "linux": [] }, @@ -554,7 +554,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--hiero"], "darwin": [], "linux": [] }, @@ -576,7 +576,7 @@ ] }, "arguments": { - "windows": [], + "windows": ["--hiero"], "darwin": [], "linux": [] }, From e9be330393cb5a50fcbc257ecf4ed0c8eb335804 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Mon, 15 Jan 2024 14:56:29 +0000 Subject: [PATCH 129/198] Add Linux arguments. --- .../applications/server/applications.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/server_addon/applications/server/applications.json b/server_addon/applications/server/applications.json index d2e2d942c6..b0b12b2003 100644 --- a/server_addon/applications/server/applications.json +++ b/server_addon/applications/server/applications.json @@ -309,7 +309,7 @@ "arguments": { "windows": ["--nukeassist"], "darwin": [], - "linux": [] + "linux": ["--nukeassist"] }, "environment": "{}", "use_python_2": false @@ -331,7 +331,7 @@ "arguments": { "windows": ["--nukeassist"], "darwin": [], - "linux": [] + "linux": ["--nukeassist"] }, "environment": "{}", "use_python_2": false @@ -353,7 +353,7 @@ "arguments": { "windows": ["--nukeassist"], "darwin": [], - "linux": [] + "linux": ["--nukeassist"] }, "environment": "{}", "use_python_2": false @@ -384,7 +384,7 @@ "arguments": { "windows": ["--nukex"], "darwin": [], - "linux": [] + "linux": ["--nukex"] }, "environment": "{}", "use_python_2": false @@ -406,7 +406,7 @@ "arguments": { "windows": ["--nukex"], "darwin": [], - "linux": [] + "linux": ["--nukex"] }, "environment": "{}", "use_python_2": false @@ -428,7 +428,7 @@ "arguments": { "windows": ["--nukex"], "darwin": [], - "linux": [] + "linux": ["--nukex"] }, "environment": "{}", "use_python_2": false @@ -459,7 +459,7 @@ "arguments": { "windows": ["--studio"], "darwin": [], - "linux": [] + "linux": ["--studio"] }, "environment": "{}", "use_python_2": false @@ -481,7 +481,7 @@ "arguments": { "windows": ["--studio"], "darwin": [], - "linux": [] + "linux": ["--studio"] }, "environment": "{}", "use_python_2": false @@ -503,7 +503,7 @@ "arguments": { "windows": ["--studio"], "darwin": [], - "linux": [] + "linux": ["--studio"] }, "environment": "{}", "use_python_2": false @@ -534,7 +534,7 @@ "arguments": { "windows": ["--hiero"], "darwin": [], - "linux": [] + "linux": ["--hiero"] }, "environment": "{}", "use_python_2": false @@ -556,7 +556,7 @@ "arguments": { "windows": ["--hiero"], "darwin": [], - "linux": [] + "linux": ["--hiero"] }, "environment": "{}", "use_python_2": false @@ -578,7 +578,7 @@ "arguments": { "windows": ["--hiero"], "darwin": [], - "linux": [] + "linux": ["--hiero"] }, "environment": "{}", "use_python_2": false From 7dcdd1b3b0d1799d786054da896af57f13244657 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 15 Jan 2024 17:21:40 +0100 Subject: [PATCH 130/198] remove 'template_name_profiles' for 'IntegrateHeroVersion' (#6130) --- openpype/settings/ayon_settings.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/openpype/settings/ayon_settings.py b/openpype/settings/ayon_settings.py index a6d90d1cf0..36f96c9dc7 100644 --- a/openpype/settings/ayon_settings.py +++ b/openpype/settings/ayon_settings.py @@ -1291,12 +1291,6 @@ def _convert_global_project_settings(ayon_settings, output, default_settings): for extract_burnin_def in extract_burnin_defs } - ayon_integrate_hero = ayon_publish["IntegrateHeroVersion"] - for profile in ayon_integrate_hero["template_name_profiles"]: - if "product_types" not in profile: - break - profile["families"] = profile.pop("product_types") - if "IntegrateProductGroup" in ayon_publish: subset_group = ayon_publish.pop("IntegrateProductGroup") subset_group_profiles = subset_group.pop("product_grouping_profiles") From 10167c86a7c25044280df8012ec3193677749677 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 15 Jan 2024 17:33:26 +0100 Subject: [PATCH 131/198] use instance version if context version is not set (#6117) --- openpype/plugins/publish/collect_anatomy_instance_data.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py index 0a34848166..34df49ea5b 100644 --- a/openpype/plugins/publish/collect_anatomy_instance_data.py +++ b/openpype/plugins/publish/collect_anatomy_instance_data.py @@ -200,9 +200,15 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): self._fill_task_data(instance, project_task_types, anatomy_data) # Define version + version_number = None if self.follow_workfile_version: version_number = context.data("version") - else: + + # Even if 'follow_workfile_version' is enabled, it may not be set + # because workfile version was not collected to 'context.data' + # - that can happen e.g. in 'traypublisher' or other hosts without + # a workfile + if version_number is None: version_number = instance.data.get("version") # use latest version (+1) if already any exist From 17e861f532bbdd6b3e4e9f16f2c69639483c16b2 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Mon, 15 Jan 2024 17:42:47 +0000 Subject: [PATCH 132/198] Illicit suggestion --- openpype/lib/transcoding.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/openpype/lib/transcoding.py b/openpype/lib/transcoding.py index 79d24e737a..03fd91bec2 100644 --- a/openpype/lib/transcoding.py +++ b/openpype/lib/transcoding.py @@ -110,8 +110,9 @@ def get_oiio_info_for_input(filepath, logger=None, subimages=False): if line == "": subimages_lines.append(lines) lines = [] + xml_started = False - if not xml_started: + if not subimages_lines: raise ValueError( "Failed to read input file \"{}\".\nOutput:\n{}".format( filepath, output @@ -120,10 +121,6 @@ def get_oiio_info_for_input(filepath, logger=None, subimages=False): output = [] for subimage_lines in subimages_lines: - # First line of oiiotool for xml format is "Reading path/to/file.ext". - if not subimage_lines[0].startswith(" Date: Tue, 16 Jan 2024 07:46:47 +0000 Subject: [PATCH 133/198] change label to be more reable. --- server_addon/maya/server/settings/render_settings.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/server_addon/maya/server/settings/render_settings.py b/server_addon/maya/server/settings/render_settings.py index b6163a04ce..75d0994759 100644 --- a/server_addon/maya/server/settings/render_settings.py +++ b/server_addon/maya/server/settings/render_settings.py @@ -298,6 +298,7 @@ class ArnoldSettingsModel(BaseSettingsModel): title="Additional Arnold Options", description=( "Add additional options - put attribute and value, like AASamples" + " and 4" ) ) @@ -325,8 +326,8 @@ class VraySettingsModel(BaseSettingsModel): default_factory=list, title="Additional Vray Options", description=( - "Add additional options - put attribute and value," - " like aaFilterSize" + "Add additional options - put attribute and value, like " + "aaFilterSize and 1.5" ) ) @@ -358,8 +359,8 @@ class RedshiftSettingsModel(BaseSettingsModel): default_factory=list, title="Additional Vray Options", description=( - "Add additional options - put attribute and value," - " like reflectionMaxTraceDepth" + "Add additional options - put attribute and value, like " + "reflectionMaxTraceDepth and 3" ) ) From b0a2c9689b3e3aec26e061663255c9c397380551 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Tue, 16 Jan 2024 10:53:40 +0100 Subject: [PATCH 134/198] make sure style object is not garbage collected --- openpype/tools/utils/lib.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/tools/utils/lib.py b/openpype/tools/utils/lib.py index 723e71e7aa..365caaafd9 100644 --- a/openpype/tools/utils/lib.py +++ b/openpype/tools/utils/lib.py @@ -91,7 +91,8 @@ def set_style_property(widget, property_name, property_value): if cur_value == property_value: return widget.setProperty(property_name, property_value) - widget.style().polish(widget) + style = widget.style() + style.polish(widget) def paint_image_with_color(image, color): From a6cc0b511e4468be960e14f47aa2300a865e9035 Mon Sep 17 00:00:00 2001 From: Toke Jepsen Date: Tue, 16 Jan 2024 10:15:48 +0000 Subject: [PATCH 135/198] Maya: Account and ignore free image planes. (#5993) * Account and ignore for free image planes. * Incorporating BigRoy changes --------- Co-authored-by: Petr Kalis --- .../maya/plugins/publish/extract_camera_mayaScene.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py b/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py index 38cf00bbdd..f67e9db14f 100644 --- a/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py +++ b/openpype/hosts/maya/plugins/publish/extract_camera_mayaScene.py @@ -265,13 +265,16 @@ def transfer_image_planes(source_cameras, target_cameras, try: for source_camera, target_camera in zip(source_cameras, target_cameras): - image_planes = cmds.listConnections(source_camera, + image_plane_plug = "{}.imagePlane".format(source_camera) + image_planes = cmds.listConnections(image_plane_plug, + source=True, + destination=False, type="imagePlane") or [] # Split of the parent path they are attached - we want - # the image plane node name. + # the image plane node name if attached to a camera. # TODO: Does this still mean the image plane name is unique? - image_planes = [x.split("->", 1)[1] for x in image_planes] + image_planes = [x.split("->", 1)[-1] for x in image_planes] if not image_planes: continue @@ -282,7 +285,7 @@ def transfer_image_planes(source_cameras, target_cameras, if source_camera == target_camera: continue _attach_image_plane(target_camera, image_plane) - else: # explicitly dettaching image planes + else: # explicitly detach image planes cmds.imagePlane(image_plane, edit=True, detach=True) originals[source_camera].append(image_plane) yield From 9d5736aca78dcf9ca449f0bc5b9c73aedf96089c Mon Sep 17 00:00:00 2001 From: Ynbot Date: Tue, 16 Jan 2024 13:07:31 +0000 Subject: [PATCH 136/198] [Automated] Release --- CHANGELOG.md | 145 ++++++++++++++++++++++++++++++++++++++++++++ openpype/version.py | 2 +- pyproject.toml | 2 +- 3 files changed, 147 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b51fade6f..546b2c12ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,151 @@ # Changelog +## [3.18.4](https://github.com/ynput/OpenPype/tree/3.18.4) + + +[Full Changelog](https://github.com/ynput/OpenPype/compare/3.18.3...3.18.4) + +### **🚀 Enhancements** + + +
+multiple render camera supports for 3dsmax #5124 + +Supports for rendering with multiple cameras in 3dsmax +- [x] Add Batch Render Layers functions +- [x] Rewrite lib.rendersetting and lib.renderproduct +- [x] Add multi-camera options in creator. +- [x] Collector with batch render-layer when multi-camera enabled. +- [x] Add instance plugin for saving scene files with different cameras respectively by using subprocess +- [x] Refactor submit_max_deadline +- [x] Check with metadata.json in submit publish job + + +___ + +
+ + +
+Fusion: new creator for image product type #6057 + +In many DCC `render` product type is expected to be sequence of files. This PR adds new explicit creator for `image` product type which is focused on single frame image. Workflows for both product types might be a bit different, this gives artists more granularity to choose better workflow. + + +___ + +
+ +### **🐛 Bug fixes** + + +
+Maya: Account and ignore free image planes. #5993 + +Free image planes do not have the `->` path separator, so we need to account for that. + + +___ + +
+ + +
+Blender: Fix long names for instances #6070 + +Changed naming for instances to use only final part of the `folderPath`. + + +___ + +
+ + +
+Traypublisher & Chore: Instance version on follow workfile version #6117 + +If `follow_workfile_version` is enabled but context does not have filled workfile version, a version on instance is used instead. + + +___ + +
+ + +
+Substance Painter: Thumbnail errors with PBR Texture Set #6127 + +When publishing with PBR Metallic Roughness as Output Template, Emissive Map errors out because of the missing channel in the material and the map can't be generated in Substance Painter. This PR is to make sure `imagestance.data["publish"] = False` so that the related "empty" texture instance would be skipped to generate the output. + + +___ + +
+ + +
+Transcoding: Fix reading image sequences through oiiotool #6129 + +When transcoding image sequences, the second image onwards includes the invalid xml line of `Reading path/to/file.exr` of the oiiotool output.This is most likely not the best solution, but it fixes the issue and illustrates the problem.Error: +``` +ERROR:pyblish.plugin:Traceback (most recent call last): + File "C:\Users\tokejepsen\AppData\Local\Ynput\AYON\dependency_packages\ayon_2310271602_windows.zip\dependencies\pyblish\plugin.py", line 527, in __explicit_process + runner(*args) + File "C:\Users\tokejepsen\OpenPype\openpype\plugins\publish\extract_color_transcode.py", line 152, in process + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 1136, in convert_colorspace + input_info = get_oiio_info_for_input(input_path, logger=logger) + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 124, in get_oiio_info_for_input + output.append(parse_oiio_xml_output(xml_text, logger=logger)) + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 276, in parse_oiio_xml_output + tree = xml.etree.ElementTree.fromstring(xml_string) + File "xml\etree\ElementTree.py", line 1347, in XML +xml.etree.ElementTree.ParseError: syntax error: line 1, column 0 +Traceback (most recent call last): + File "C:\Users\tokejepsen\AppData\Local\Ynput\AYON\dependency_packages\ayon_2310271602_windows.zip\dependencies\pyblish\plugin.py", line 527, in __explicit_process + runner(*args) + File "", line 152, in process + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 1136, in convert_colorspace + input_info = get_oiio_info_for_input(input_path, logger=logger) + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 124, in get_oiio_info_for_input + output.append(parse_oiio_xml_output(xml_text, logger=logger)) + File "C:\Users\tokejepsen\OpenPype\openpype\lib\transcoding.py", line 276, in parse_oiio_xml_output + tree = xml.etree.ElementTree.fromstring(xml_string) + File "xml\etree\ElementTree.py", line 1347, in XML +xml.etree.ElementTree.ParseError: syntax error: line 1, column 0 +``` + + + +___ + +
+ + +
+AYON: Remove 'IntegrateHeroVersion' conversion #6130 + +Remove settings conversion for `IntegrateHeroVersion`. + + +___ + +
+ + +
+Chore tools: Make sure style object is not garbage collected #6136 + +Minor fix in tool utils to make sure style C++ object is not garbage collected when not stored into variable. + + +___ + +
+ + + + ## [3.18.3](https://github.com/ynput/OpenPype/tree/3.18.3) diff --git a/openpype/version.py b/openpype/version.py index 5981cb657a..0b6584dbff 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.4-nightly.1" +__version__ = "3.18.4" diff --git a/pyproject.toml b/pyproject.toml index bad481c889..f9d5381a15 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "OpenPype" -version = "3.18.3" # OpenPype +version = "3.18.4" # OpenPype description = "Open VFX and Animation pipeline with support." authors = ["OpenPype Team "] license = "MIT License" From 4c9b19ed9974559bd63f6eeb593570f010983b85 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 16 Jan 2024 13:08:30 +0000 Subject: [PATCH 137/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e9b68a54f1..8df948a7c1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.4 - 3.18.4-nightly.1 - 3.18.3 - 3.18.3-nightly.2 @@ -134,7 +135,6 @@ body: - 3.15.7-nightly.3 - 3.15.7-nightly.2 - 3.15.7-nightly.1 - - 3.15.6 validations: required: true - type: dropdown From 5bdad2b37c89272ff29885bc03eabadce907c0be Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Tue, 16 Jan 2024 21:36:04 +0800 Subject: [PATCH 138/198] bug fix the limit groups from maya deadline settings unabled to be set by the username and error out --- server_addon/deadline/server/settings/publish_plugins.py | 2 +- server_addon/deadline/server/version.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/server_addon/deadline/server/settings/publish_plugins.py b/server_addon/deadline/server/settings/publish_plugins.py index a989f3ad9d..dfb30f9b41 100644 --- a/server_addon/deadline/server/settings/publish_plugins.py +++ b/server_addon/deadline/server/settings/publish_plugins.py @@ -87,7 +87,7 @@ class MayaSubmitDeadlineModel(BaseSettingsModel): title="Disable Strict Error Check profiles" ) - @validator("limit", "scene_patches") + @validator("scene_patches") def validate_unique_names(cls, value): ensure_unique_names(value) return value diff --git a/server_addon/deadline/server/version.py b/server_addon/deadline/server/version.py index 0a8da88258..f1380eede2 100644 --- a/server_addon/deadline/server/version.py +++ b/server_addon/deadline/server/version.py @@ -1 +1 @@ -__version__ = "0.1.6" +__version__ = "0.1.7" From b29dee59fadbaa59876d0684eb0c30df5bba0681 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Tue, 16 Jan 2024 16:48:35 +0100 Subject: [PATCH 139/198] add addons dir only if exists --- openpype/modules/base.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/modules/base.py b/openpype/modules/base.py index 1a2513b4b4..41be2998f9 100644 --- a/openpype/modules/base.py +++ b/openpype/modules/base.py @@ -542,7 +542,8 @@ def _load_modules(): module_dirs.insert(0, current_dir) addons_dir = os.path.join(os.path.dirname(current_dir), "addons") - module_dirs.append(addons_dir) + if os.path.exists(addons_dir): + module_dirs.append(addons_dir) ignored_host_names = set(IGNORED_HOSTS_IN_AYON) ignored_current_dir_filenames = set(IGNORED_DEFAULT_FILENAMES) From 25b33c60f0e86f7b3303bfdff92b563bc13180b6 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Tue, 16 Jan 2024 16:49:31 +0100 Subject: [PATCH 140/198] add missing '.tif' extension --- openpype/lib/transcoding.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/openpype/lib/transcoding.py b/openpype/lib/transcoding.py index 03fd91bec2..c8ddbde061 100644 --- a/openpype/lib/transcoding.py +++ b/openpype/lib/transcoding.py @@ -44,17 +44,17 @@ XML_CHAR_REF_REGEX_HEX = re.compile(r"&#x?[0-9a-fA-F]+;") ARRAY_TYPE_REGEX = re.compile(r"^(int|float|string)\[\d+\]$") IMAGE_EXTENSIONS = { - ".ani", ".anim", ".apng", ".art", ".bmp", ".bpg", ".bsave", ".cal", - ".cin", ".cpc", ".cpt", ".dds", ".dpx", ".ecw", ".exr", ".fits", - ".flic", ".flif", ".fpx", ".gif", ".hdri", ".hevc", ".icer", - ".icns", ".ico", ".cur", ".ics", ".ilbm", ".jbig", ".jbig2", - ".jng", ".jpeg", ".jpeg-ls", ".jpeg", ".2000", ".jpg", ".xr", - ".jpeg", ".xt", ".jpeg-hdr", ".kra", ".mng", ".miff", ".nrrd", - ".ora", ".pam", ".pbm", ".pgm", ".ppm", ".pnm", ".pcx", ".pgf", - ".pictor", ".png", ".psd", ".psb", ".psp", ".qtvr", ".ras", - ".rgbe", ".logluv", ".tiff", ".sgi", ".tga", ".tiff", ".tiff/ep", - ".tiff/it", ".ufo", ".ufp", ".wbmp", ".webp", ".xbm", ".xcf", - ".xpm", ".xwd" + ".ani", ".anim", ".apng", ".art", ".bmp", ".bpg", ".bsave", + ".cal", ".cin", ".cpc", ".cpt", ".dds", ".dpx", ".ecw", ".exr", + ".fits", ".flic", ".flif", ".fpx", ".gif", ".hdri", ".hevc", + ".icer", ".icns", ".ico", ".cur", ".ics", ".ilbm", ".jbig", ".jbig2", + ".jng", ".jpeg", ".jpeg-ls", ".jpeg-hdr", ".2000", ".jpg", + ".kra", ".logluv", ".mng", ".miff", ".nrrd", ".ora", + ".pam", ".pbm", ".pgm", ".ppm", ".pnm", ".pcx", ".pgf", + ".pictor", ".png", ".psd", ".psb", ".psp", ".qtvr", + ".ras", ".rgbe", ".sgi", ".tga", + ".tif", ".tiff", ".tiff/ep", ".tiff/it", ".ufo", ".ufp", + ".wbmp", ".webp", ".xr", ".xt", ".xbm", ".xcf", ".xpm", ".xwd" } VIDEO_EXTENSIONS = { From b468baa80677aac036472ae484894f4f8330f17b Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Tue, 16 Jan 2024 16:51:23 +0100 Subject: [PATCH 141/198] use correct variable for error items --- openpype/pipeline/workfile/workfile_template_builder.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/pipeline/workfile/workfile_template_builder.py b/openpype/pipeline/workfile/workfile_template_builder.py index 9dc833061a..3096d22518 100644 --- a/openpype/pipeline/workfile/workfile_template_builder.py +++ b/openpype/pipeline/workfile/workfile_template_builder.py @@ -1971,7 +1971,6 @@ class PlaceholderCreateMixin(object): if not placeholder.data.get("keep_placeholder", True): self.delete_placeholder(placeholder) - def create_failed(self, placeholder, creator_data): if hasattr(placeholder, "create_failed"): placeholder.create_failed(creator_data) @@ -2036,7 +2035,7 @@ class CreatePlaceholderItem(PlaceholderItem): self._failed_created_publish_instances = [] def get_errors(self): - if not self._failed_representations: + if not self._failed_created_publish_instances: return [] message = ( "Failed to create {} instance using Creator {}" From dcf8805cfe2aca6f2615de1a7c18988d0efedae6 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 16 Jan 2024 16:53:26 +0000 Subject: [PATCH 142/198] Add settings for effect categories --- .../hiero/server/settings/publish_plugins.py | 34 +++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/server_addon/hiero/server/settings/publish_plugins.py b/server_addon/hiero/server/settings/publish_plugins.py index a85e62724b..07778b8ebe 100644 --- a/server_addon/hiero/server/settings/publish_plugins.py +++ b/server_addon/hiero/server/settings/publish_plugins.py @@ -1,5 +1,7 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from pydantic import Field, validator +from ayon_server.settings import ( + BaseSettingsModel, ensure_unique_names, normalize_name +) class CollectInstanceVersionModel(BaseSettingsModel): @@ -9,6 +11,30 @@ class CollectInstanceVersionModel(BaseSettingsModel): ) +class CollectClipEffectsDefModel(BaseSettingsModel): + _layout = "expanded" + name: str = Field("", title="Name") + effect_classes: list[str] = Field( + default_factory=list, title="Effect Classes" + ) + + @validator("name") + def validate_name(cls, value): + """Ensure name does not contain weird characters""" + return normalize_name(value) + + +class CollectClipEffectsModel(BaseSettingsModel): + effect_categories: list[CollectClipEffectsDefModel] = Field( + default_factory=list, title="Effect Categories" + ) + + @validator("effect_categories") + def validate_unique_outputs(cls, value): + ensure_unique_names(value) + return value + + class ExtractReviewCutUpVideoModel(BaseSettingsModel): enabled: bool = Field( True, @@ -25,6 +51,10 @@ class PublishPuginsModel(BaseSettingsModel): default_factory=CollectInstanceVersionModel, title="Collect Instance Version" ) + CollectClipEffects: CollectClipEffectsModel = Field( + default_factory=CollectClipEffectsModel, + title="Collect Clip Effects" + ) """# TODO: enhance settings with host api: Rename class name and plugin name to match title (it makes more sense) From 9c8a4a7b6cccc2fd112b6c41f1e4c10d7f94f6e4 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 16 Jan 2024 16:53:51 +0000 Subject: [PATCH 143/198] Categorize effects from settings. --- .../plugins/publish/collect_clip_effects.py | 71 ++++++++++++++----- 1 file changed, 52 insertions(+), 19 deletions(-) diff --git a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py index fcb1ab27a0..89dc66d73c 100644 --- a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py +++ b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py @@ -70,29 +70,62 @@ class CollectClipEffects(pyblish.api.InstancePlugin): subset_split.insert(0, "effect") - name = "".join(subset_split) + effect_categories = { + x["name"]: x["effect_classes"] for x in self.effect_categories + } - # create new instance and inherit data - data = {} - for key, value in instance.data.items(): - if "clipEffectItems" in key: + category_by_effect = {} + for key, values in effect_categories.items(): + for cls in values: + category_by_effect[cls] = key + + effects_categorized = {k: {} for k in effect_categories.keys()} + for key, value in effects.items(): + if key == "assignTo": continue - data[key] = value - # change names - data["subset"] = name - data["family"] = family - data["families"] = [family] - data["name"] = data["subset"] + "_" + data["asset"] - data["label"] = "{} - {}".format( - data['asset'], data["subset"] - ) - data["effects"] = effects + # Some classes can have a number in them. Like Text2. + found_cls = None + for cls in category_by_effect.keys(): + if value["class"].startswith(cls): + found_cls = cls - # create new instance - _instance = instance.context.create_instance(**data) - self.log.info("Created instance `{}`".format(_instance)) - self.log.debug("instance.data `{}`".format(_instance.data)) + if found_cls is None: + continue + + effects_categorized[category_by_effect[found_cls]][key] = value + + if effects_categorized: + for key in effects_categorized.keys(): + effects_categorized[key]["assignTo"] = effects["assignTo"] + else: + effects_categorized[""] = effects + + for category, effects in effects_categorized.items(): + name = "".join(subset_split) + name += category.capitalize() + + # create new instance and inherit data + data = {} + for key, value in instance.data.items(): + if "clipEffectItems" in key: + continue + data[key] = value + + # change names + data["subset"] = name + data["family"] = family + data["families"] = [family] + data["name"] = data["subset"] + "_" + data["asset"] + data["label"] = "{} - {}".format( + data['asset'], data["subset"] + ) + data["effects"] = effects + + # create new instance + _instance = instance.context.create_instance(**data) + self.log.info("Created instance `{}`".format(_instance)) + self.log.debug("instance.data `{}`".format(_instance.data)) def test_overlap(self, effect_t_in, effect_t_out): covering_exp = bool( From 6857082f1e0e9cab399ccb85fe1ec5a41cfc010f Mon Sep 17 00:00:00 2001 From: Ynbot Date: Wed, 17 Jan 2024 03:26:10 +0000 Subject: [PATCH 144/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index 0b6584dbff..043b6fbebb 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.4" +__version__ = "3.18.5-nightly.1" From 4cf6ddfea215c5d747fef01ba00ffe18da2b2fb2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 17 Jan 2024 03:26:46 +0000 Subject: [PATCH 145/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8df948a7c1..1177b9e4fe 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.5-nightly.1 - 3.18.4 - 3.18.4-nightly.1 - 3.18.3 @@ -134,7 +135,6 @@ body: - 3.15.7 - 3.15.7-nightly.3 - 3.15.7-nightly.2 - - 3.15.7-nightly.1 validations: required: true - type: dropdown From b7557c754385a8a966c1b7fcce804cbcfa9e8dcf Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 17 Jan 2024 09:12:14 +0000 Subject: [PATCH 146/198] Increment version --- server_addon/applications/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/applications/server/version.py b/server_addon/applications/server/version.py index ae7362549b..bbab0242f6 100644 --- a/server_addon/applications/server/version.py +++ b/server_addon/applications/server/version.py @@ -1 +1 @@ -__version__ = "0.1.3" +__version__ = "0.1.4" From 883eb9f4f86c49bf6e387d38fac1dcc9042c93f3 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 17 Jan 2024 09:13:03 +0000 Subject: [PATCH 147/198] Increment version --- server_addon/hiero/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/hiero/server/version.py b/server_addon/hiero/server/version.py index 485f44ac21..3ced3581bb 100644 --- a/server_addon/hiero/server/version.py +++ b/server_addon/hiero/server/version.py @@ -1 +1 @@ -__version__ = "0.1.1" +__version__ = "0.2.1" From 58978f55d8d54c79c25bbb7841e3692cb037692b Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 17 Jan 2024 09:14:55 +0000 Subject: [PATCH 148/198] Increment version --- server_addon/maya/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/maya/server/version.py b/server_addon/maya/server/version.py index b87834cc35..684d830189 100644 --- a/server_addon/maya/server/version.py +++ b/server_addon/maya/server/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring addon version.""" -__version__ = "0.1.7" +__version__ = "0.1.8" From 7e3e567f002974436badeea5ff25bfa8db9461cf Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Wed, 17 Jan 2024 10:46:50 +0000 Subject: [PATCH 149/198] Use the new API for override context --- openpype/hosts/blender/api/capture.py | 11 +++--- .../hosts/blender/plugins/load/load_audio.py | 35 ++++++++++--------- .../plugins/publish/extract_abc_animation.py | 14 ++++---- .../plugins/publish/extract_camera_fbx.py | 26 +++++++------- .../blender/plugins/publish/extract_fbx.py | 18 +++++----- .../plugins/publish/extract_fbx_animation.py | 25 +++++++------ .../blender/plugins/publish/extract_layout.py | 23 ++++++------ 7 files changed, 81 insertions(+), 71 deletions(-) diff --git a/openpype/hosts/blender/api/capture.py b/openpype/hosts/blender/api/capture.py index bad6831143..9922140cea 100644 --- a/openpype/hosts/blender/api/capture.py +++ b/openpype/hosts/blender/api/capture.py @@ -127,8 +127,9 @@ def isolate_objects(window, objects): context = create_blender_context(selected=objects, window=window) - bpy.ops.view3d.view_axis(context, type="FRONT") - bpy.ops.view3d.localview(context) + with bpy.context.temp_override(**context): + bpy.ops.view3d.view_axis(type="FRONT") + bpy.ops.view3d.localview() deselect_all() @@ -270,10 +271,12 @@ def _independent_window(): """Create capture-window context.""" context = create_blender_context() current_windows = set(bpy.context.window_manager.windows) - bpy.ops.wm.window_new(context) + with bpy.context.temp_override(**context): + bpy.ops.wm.window_new() window = list(set(bpy.context.window_manager.windows) - current_windows)[0] context["window"] = window try: yield window finally: - bpy.ops.wm.window_close(context) + with bpy.context.temp_override(**context): + bpy.ops.wm.window_close() diff --git a/openpype/hosts/blender/plugins/load/load_audio.py b/openpype/hosts/blender/plugins/load/load_audio.py index 1e5bd39a32..367fff03f0 100644 --- a/openpype/hosts/blender/plugins/load/load_audio.py +++ b/openpype/hosts/blender/plugins/load/load_audio.py @@ -67,7 +67,8 @@ class AudioLoader(plugin.AssetLoader): oc = bpy.context.copy() oc["area"] = window_manager.windows[-1].screen.areas[0] - bpy.ops.sequencer.sound_strip_add(oc, filepath=libpath, frame_start=1) + with bpy.context.temp_override(**oc): + bpy.ops.sequencer.sound_strip_add(filepath=libpath, frame_start=1) window_manager.windows[-1].screen.areas[0].type = old_type @@ -156,17 +157,18 @@ class AudioLoader(plugin.AssetLoader): oc = bpy.context.copy() oc["area"] = window_manager.windows[-1].screen.areas[0] - # We deselect all sequencer strips, and then select the one we - # need to remove. - bpy.ops.sequencer.select_all(oc, action='DESELECT') - scene = bpy.context.scene - scene.sequence_editor.sequences_all[old_audio].select = True + with bpy.context.temp_override(**oc): + # We deselect all sequencer strips, and then select the one we + # need to remove. + bpy.ops.sequencer.select_all(action='DESELECT') + scene = bpy.context.scene + scene.sequence_editor.sequences_all[old_audio].select = True - bpy.ops.sequencer.delete(oc) - bpy.data.sounds.remove(bpy.data.sounds[old_audio]) + bpy.ops.sequencer.delete() + bpy.data.sounds.remove(bpy.data.sounds[old_audio]) - bpy.ops.sequencer.sound_strip_add( - oc, filepath=str(libpath), frame_start=1) + bpy.ops.sequencer.sound_strip_add( + filepath=str(libpath), frame_start=1) window_manager.windows[-1].screen.areas[0].type = old_type @@ -205,12 +207,13 @@ class AudioLoader(plugin.AssetLoader): oc = bpy.context.copy() oc["area"] = window_manager.windows[-1].screen.areas[0] - # We deselect all sequencer strips, and then select the one we - # need to remove. - bpy.ops.sequencer.select_all(oc, action='DESELECT') - bpy.context.scene.sequence_editor.sequences_all[audio].select = True - - bpy.ops.sequencer.delete(oc) + with bpy.context.temp_override(**oc): + # We deselect all sequencer strips, and then select the one we + # need to remove. + bpy.ops.sequencer.select_all(action='DESELECT') + scene = bpy.context.scene + scene.sequence_editor.sequences_all[audio].select = True + bpy.ops.sequencer.delete() window_manager.windows[-1].screen.areas[0].type = old_type diff --git a/openpype/hosts/blender/plugins/publish/extract_abc_animation.py b/openpype/hosts/blender/plugins/publish/extract_abc_animation.py index 6ef9b29693..2bf75aa05e 100644 --- a/openpype/hosts/blender/plugins/publish/extract_abc_animation.py +++ b/openpype/hosts/blender/plugins/publish/extract_abc_animation.py @@ -55,13 +55,13 @@ class ExtractAnimationABC( context = plugin.create_blender_context( active=asset_group, selected=selected) - # We export the abc - bpy.ops.wm.alembic_export( - context, - filepath=filepath, - selected=True, - flatten=False - ) + with bpy.context.temp_override(**context): + # We export the abc + bpy.ops.wm.alembic_export( + filepath=filepath, + selected=True, + flatten=False + ) plugin.deselect_all() diff --git a/openpype/hosts/blender/plugins/publish/extract_camera_fbx.py b/openpype/hosts/blender/plugins/publish/extract_camera_fbx.py index ee046b7d11..f904b79ddb 100644 --- a/openpype/hosts/blender/plugins/publish/extract_camera_fbx.py +++ b/openpype/hosts/blender/plugins/publish/extract_camera_fbx.py @@ -50,19 +50,19 @@ class ExtractCamera(publish.Extractor, publish.OptionalPyblishPluginMixin): scale_length = bpy.context.scene.unit_settings.scale_length bpy.context.scene.unit_settings.scale_length = 0.01 - # We export the fbx - bpy.ops.export_scene.fbx( - context, - filepath=filepath, - use_active_collection=False, - use_selection=True, - bake_anim_use_nla_strips=False, - bake_anim_use_all_actions=False, - add_leaf_bones=False, - armature_nodetype='ROOT', - object_types={'CAMERA'}, - bake_anim_simplify_factor=0.0 - ) + with bpy.context.temp_override(**context): + # We export the fbx + bpy.ops.export_scene.fbx( + filepath=filepath, + use_active_collection=False, + use_selection=True, + bake_anim_use_nla_strips=False, + bake_anim_use_all_actions=False, + add_leaf_bones=False, + armature_nodetype='ROOT', + object_types={'CAMERA'}, + bake_anim_simplify_factor=0.0 + ) bpy.context.scene.unit_settings.scale_length = scale_length diff --git a/openpype/hosts/blender/plugins/publish/extract_fbx.py b/openpype/hosts/blender/plugins/publish/extract_fbx.py index 4ae6501f7d..aed6df1d3d 100644 --- a/openpype/hosts/blender/plugins/publish/extract_fbx.py +++ b/openpype/hosts/blender/plugins/publish/extract_fbx.py @@ -57,15 +57,15 @@ class ExtractFBX(publish.Extractor, publish.OptionalPyblishPluginMixin): scale_length = bpy.context.scene.unit_settings.scale_length bpy.context.scene.unit_settings.scale_length = 0.01 - # We export the fbx - bpy.ops.export_scene.fbx( - context, - filepath=filepath, - use_active_collection=False, - use_selection=True, - mesh_smooth_type='FACE', - add_leaf_bones=False - ) + with bpy.context.temp_override(**context): + # We export the fbx + bpy.ops.export_scene.fbx( + filepath=filepath, + use_active_collection=False, + use_selection=True, + mesh_smooth_type='FACE', + add_leaf_bones=False + ) bpy.context.scene.unit_settings.scale_length = scale_length diff --git a/openpype/hosts/blender/plugins/publish/extract_fbx_animation.py b/openpype/hosts/blender/plugins/publish/extract_fbx_animation.py index 4fc8230a1b..1cb8dac0cf 100644 --- a/openpype/hosts/blender/plugins/publish/extract_fbx_animation.py +++ b/openpype/hosts/blender/plugins/publish/extract_fbx_animation.py @@ -153,17 +153,20 @@ class ExtractAnimationFBX( override = plugin.create_blender_context( active=root, selected=[root, armature]) - bpy.ops.export_scene.fbx( - override, - filepath=filepath, - use_active_collection=False, - use_selection=True, - bake_anim_use_nla_strips=False, - bake_anim_use_all_actions=False, - add_leaf_bones=False, - armature_nodetype='ROOT', - object_types={'EMPTY', 'ARMATURE'} - ) + + with bpy.context.temp_override(**override): + # We export the fbx + bpy.ops.export_scene.fbx( + filepath=filepath, + use_active_collection=False, + use_selection=True, + bake_anim_use_nla_strips=False, + bake_anim_use_all_actions=False, + add_leaf_bones=False, + armature_nodetype='ROOT', + object_types={'EMPTY', 'ARMATURE'} + ) + armature.name = armature_name asset_group.name = asset_group_name root.select_set(True) diff --git a/openpype/hosts/blender/plugins/publish/extract_layout.py b/openpype/hosts/blender/plugins/publish/extract_layout.py index 3e8978c8d3..383c3bdcc5 100644 --- a/openpype/hosts/blender/plugins/publish/extract_layout.py +++ b/openpype/hosts/blender/plugins/publish/extract_layout.py @@ -80,17 +80,18 @@ class ExtractLayout(publish.Extractor, publish.OptionalPyblishPluginMixin): override = plugin.create_blender_context( active=asset, selected=[asset, obj]) - bpy.ops.export_scene.fbx( - override, - filepath=filepath, - use_active_collection=False, - use_selection=True, - bake_anim_use_nla_strips=False, - bake_anim_use_all_actions=False, - add_leaf_bones=False, - armature_nodetype='ROOT', - object_types={'EMPTY', 'ARMATURE'} - ) + with bpy.context.temp_override(**override): + # We export the fbx + bpy.ops.export_scene.fbx( + filepath=filepath, + use_active_collection=False, + use_selection=True, + bake_anim_use_nla_strips=False, + bake_anim_use_all_actions=False, + add_leaf_bones=False, + armature_nodetype='ROOT', + object_types={'EMPTY', 'ARMATURE'} + ) obj.name = armature_name asset.name = asset_group_name asset.select_set(False) From 38eb8e0ae38169137316b57e90271c640b96420a Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 17 Jan 2024 11:31:29 +0000 Subject: [PATCH 150/198] initial working version --- .../plugins/publish/submit_nuke_deadline.py | 43 ++++++++++++------- .../defaults/project_settings/deadline.json | 2 + .../schema_project_deadline.json | 10 +++++ .../server/settings/publish_plugins.py | 3 ++ 4 files changed, 43 insertions(+), 15 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py index d03416ca00..ead22fe302 100644 --- a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py @@ -47,6 +47,7 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin, env_allowed_keys = [] env_search_replace_values = {} workfile_dependency = True + use_published_workfile = True @classmethod def get_attribute_defs(cls): @@ -85,8 +86,13 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin, ), BoolDef( "workfile_dependency", - default=True, + default=cls.workfile_dependency, label="Workfile Dependency" + ), + BoolDef( + "use_published_workfile", + default=cls.use_published_workfile, + label="Use Published Workfile" ) ] @@ -125,20 +131,27 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin, render_path = instance.data['path'] script_path = context.data["currentFile"] - for item_ in context: - if "workfile" in item_.data["family"]: - template_data = item_.data.get("anatomyData") - rep = item_.data.get("representations")[0].get("name") - template_data["representation"] = rep - template_data["ext"] = rep - template_data["comment"] = None - anatomy_filled = context.data["anatomy"].format(template_data) - template_filled = anatomy_filled["publish"]["path"] - script_path = os.path.normpath(template_filled) - - self.log.info( - "Using published scene for render {}".format(script_path) - ) + use_published_workfile = instance.data["attributeValues"].get( + "use_published_workfile", self.use_published_workfile + ) + if use_published_workfile: + for item_ in context: + if "workfile" in item_.data["family"]: + template_data = item_.data.get("anatomyData") + rep = item_.data.get("representations")[0].get("name") + template_data["representation"] = rep + template_data["ext"] = rep + template_data["comment"] = None + anatomy_filled = context.data["anatomy"].format( + template_data + ) + template_filled = anatomy_filled["publish"]["path"] + script_path = os.path.normpath(template_filled) + self.log.info( + "Using published scene for render {}".format( + script_path + ) + ) # only add main rendering job if target is not frames_farm r_job_response_json = None diff --git a/openpype/settings/defaults/project_settings/deadline.json b/openpype/settings/defaults/project_settings/deadline.json index a19464a5c1..b02cfa8207 100644 --- a/openpype/settings/defaults/project_settings/deadline.json +++ b/openpype/settings/defaults/project_settings/deadline.json @@ -65,6 +65,8 @@ "group": "", "department": "", "use_gpu": true, + "workfile_dependency": true, + "use_published_workfile": true, "env_allowed_keys": [], "env_search_replace_values": {}, "limit_groups": {} diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json b/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json index 1aea778e32..42dea33ef9 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_deadline.json @@ -362,6 +362,16 @@ "key": "use_gpu", "label": "Use GPU" }, + { + "type": "boolean", + "key": "workfile_dependency", + "label": "Workfile Dependency" + }, + { + "type": "boolean", + "key": "use_published_workfile", + "label": "Use Published Workfile" + }, { "type": "list", "key": "env_allowed_keys", diff --git a/server_addon/deadline/server/settings/publish_plugins.py b/server_addon/deadline/server/settings/publish_plugins.py index a989f3ad9d..8e44d8d47f 100644 --- a/server_addon/deadline/server/settings/publish_plugins.py +++ b/server_addon/deadline/server/settings/publish_plugins.py @@ -161,6 +161,8 @@ class NukeSubmitDeadlineModel(BaseSettingsModel): group: str = Field(title="Group") department: str = Field(title="Department") use_gpu: bool = Field(title="Use GPU") + workfile_dependency: bool = Field(title="Workfile Dependency") + use_published_workfile: bool = Field(title="Use Published Workfile") env_allowed_keys: list[str] = Field( default_factory=list, @@ -382,6 +384,7 @@ DEFAULT_DEADLINE_PLUGINS_SETTINGS = { "group": "", "department": "", "use_gpu": True, + "workfile_dependency": True, "env_allowed_keys": [], "env_search_replace_values": [], "limit_groups": [] From acd61bef12f9580f3b1b1ed189b7864ed7623316 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Thu, 18 Jan 2024 12:15:10 +0000 Subject: [PATCH 151/198] Increment version --- server_addon/nuke/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/nuke/server/version.py b/server_addon/nuke/server/version.py index 9cb17e7976..c49a95c357 100644 --- a/server_addon/nuke/server/version.py +++ b/server_addon/nuke/server/version.py @@ -1 +1 @@ -__version__ = "0.1.8" +__version__ = "0.2.8" From 6591d883e495c7d5b6ac80da1085f556227d1859 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Thu, 18 Jan 2024 14:43:20 +0000 Subject: [PATCH 152/198] Correct version increment --- server_addon/deadline/server/version.py | 2 +- server_addon/nuke/server/version.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/server_addon/deadline/server/version.py b/server_addon/deadline/server/version.py index 0a8da88258..01ef12070d 100644 --- a/server_addon/deadline/server/version.py +++ b/server_addon/deadline/server/version.py @@ -1 +1 @@ -__version__ = "0.1.6" +__version__ = "0.2.6" diff --git a/server_addon/nuke/server/version.py b/server_addon/nuke/server/version.py index c49a95c357..9cb17e7976 100644 --- a/server_addon/nuke/server/version.py +++ b/server_addon/nuke/server/version.py @@ -1 +1 @@ -__version__ = "0.2.8" +__version__ = "0.1.8" From 423df8d1fdaaf5742b8aad0a7002e98cdbe1daa9 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Thu, 18 Jan 2024 14:44:42 +0000 Subject: [PATCH 153/198] Fix settings defaults. --- server_addon/deadline/server/settings/publish_plugins.py | 1 + 1 file changed, 1 insertion(+) diff --git a/server_addon/deadline/server/settings/publish_plugins.py b/server_addon/deadline/server/settings/publish_plugins.py index 8e44d8d47f..9fc8d4a6b7 100644 --- a/server_addon/deadline/server/settings/publish_plugins.py +++ b/server_addon/deadline/server/settings/publish_plugins.py @@ -385,6 +385,7 @@ DEFAULT_DEADLINE_PLUGINS_SETTINGS = { "department": "", "use_gpu": True, "workfile_dependency": True, + "use_published_workfile": True, "env_allowed_keys": [], "env_search_replace_values": [], "limit_groups": [] From 5761c4e5d00147eacf77bd275be12c007684912f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Je=C5=BEek?= Date: Thu, 18 Jan 2024 16:15:31 +0100 Subject: [PATCH 154/198] Update server_addon/deadline/server/version.py --- server_addon/deadline/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/deadline/server/version.py b/server_addon/deadline/server/version.py index 6cd38b7465..9cb17e7976 100644 --- a/server_addon/deadline/server/version.py +++ b/server_addon/deadline/server/version.py @@ -1 +1 @@ -__version__ = "0.2.7" +__version__ = "0.1.8" From 1d7f23ab72b83b94fd951426c392035a877fbbce Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Fri, 19 Jan 2024 09:47:17 +0200 Subject: [PATCH 155/198] include model product type --- openpype/hosts/houdini/plugins/load/load_fbx.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/houdini/plugins/load/load_fbx.py b/openpype/hosts/houdini/plugins/load/load_fbx.py index cac22d62d4..649c2e9995 100644 --- a/openpype/hosts/houdini/plugins/load/load_fbx.py +++ b/openpype/hosts/houdini/plugins/load/load_fbx.py @@ -16,7 +16,7 @@ class FbxLoader(load.LoaderPlugin): order = -10 - families = ["staticMesh", "fbx"] + families = ["model", "staticMesh", "fbx"] representations = ["fbx"] def load(self, context, name=None, namespace=None, data=None): From 04c072947c7c7e5f93dc21ad2afd9434c44f2b95 Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Fri, 19 Jan 2024 10:47:37 +0200 Subject: [PATCH 156/198] BigRoy's Comment - Make it able to load any FBX file --- openpype/hosts/houdini/plugins/load/load_fbx.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/houdini/plugins/load/load_fbx.py b/openpype/hosts/houdini/plugins/load/load_fbx.py index 649c2e9995..894ac62b3e 100644 --- a/openpype/hosts/houdini/plugins/load/load_fbx.py +++ b/openpype/hosts/houdini/plugins/load/load_fbx.py @@ -16,8 +16,9 @@ class FbxLoader(load.LoaderPlugin): order = -10 - families = ["model", "staticMesh", "fbx"] - representations = ["fbx"] + families = ["*"] + representations = ["*"] + extensions = {"fbx"} def load(self, context, name=None, namespace=None, data=None): From 5a524b7fd99a7226e450eac2d7a12c2e239cf900 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Fri, 19 Jan 2024 16:27:33 +0000 Subject: [PATCH 157/198] Restore actions to objects after update --- .../hosts/blender/plugins/load/load_blend.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/blender/plugins/load/load_blend.py b/openpype/hosts/blender/plugins/load/load_blend.py index 2d5ac18149..4abe4a6afb 100644 --- a/openpype/hosts/blender/plugins/load/load_blend.py +++ b/openpype/hosts/blender/plugins/load/load_blend.py @@ -102,7 +102,6 @@ class BlendLoader(plugin.AssetLoader): # Link all the container children to the collection for obj in container.children_recursive: - print(obj) bpy.context.scene.collection.objects.link(obj) # Remove the library from the blend file @@ -194,8 +193,20 @@ class BlendLoader(plugin.AssetLoader): transform = asset_group.matrix_basis.copy() old_data = dict(asset_group.get(AVALON_PROPERTY)) + old_members = old_data.get("members", []) parent = asset_group.parent + actions = {} + objects_with_anim = [ + obj for obj in asset_group.children_recursive + if obj.animation_data] + for obj in objects_with_anim: + # Check if the object has an action and, if so, add it to a dict + # so we can restore it later. Save and restore the action only + # if it wasn't originally loaded from the current asset. + if obj.animation_data.action not in old_members: + actions[obj.name] = obj.animation_data.action + self.exec_remove(container) asset_group, members = self._process_data(libpath, group_name) @@ -206,6 +217,11 @@ class BlendLoader(plugin.AssetLoader): asset_group.matrix_basis = transform asset_group.parent = parent + # Restore the actions + for obj in asset_group.children_recursive: + if obj.name in actions: + obj.animation_data.action = actions[obj.name] + # Restore the old data, but reset memebers, as they don't exist anymore # This avoids a crash, because the memory addresses of those members # are not valid anymore From 372c74b40674ad254f5665e2b9c0e62234101746 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 19 Jan 2024 18:00:44 +0100 Subject: [PATCH 158/198] use correct variable in queue loop --- openpype/plugins/publish/collect_anatomy_instance_data.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py index 34df49ea5b..8cc1d2b5e3 100644 --- a/openpype/plugins/publish/collect_anatomy_instance_data.py +++ b/openpype/plugins/publish/collect_anatomy_instance_data.py @@ -412,7 +412,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): hierarchy_queue = collections.deque() hierarchy_queue.append(hierarchy_context) while hierarchy_queue: - item = hierarchy_context.popleft() + item = hierarchy_queue.popleft() if asset_name in item: return item[asset_name].get("tasks") or {} From 4d1907b94bcd01b916a7ddb70834232ff70af778 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 19 Jan 2024 18:00:59 +0100 Subject: [PATCH 159/198] create copy of hierarchy context before any manipulation --- openpype/plugins/publish/collect_anatomy_instance_data.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/plugins/publish/collect_anatomy_instance_data.py b/openpype/plugins/publish/collect_anatomy_instance_data.py index 8cc1d2b5e3..b1b7ecd138 100644 --- a/openpype/plugins/publish/collect_anatomy_instance_data.py +++ b/openpype/plugins/publish/collect_anatomy_instance_data.py @@ -410,7 +410,7 @@ class CollectAnatomyInstanceData(pyblish.api.ContextPlugin): """ hierarchy_queue = collections.deque() - hierarchy_queue.append(hierarchy_context) + hierarchy_queue.append(copy.deepcopy(hierarchy_context)) while hierarchy_queue: item = hierarchy_queue.popleft() if asset_name in item: From 9a6f518a51bd34ca99c747eb3795b858235a6ce5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 19 Jan 2024 18:01:15 +0100 Subject: [PATCH 160/198] do not store 'hierarchyContext' to variable --- openpype/plugins/publish/extract_hierarchy_to_ayon.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/plugins/publish/extract_hierarchy_to_ayon.py b/openpype/plugins/publish/extract_hierarchy_to_ayon.py index b601a3fc29..9e84daca30 100644 --- a/openpype/plugins/publish/extract_hierarchy_to_ayon.py +++ b/openpype/plugins/publish/extract_hierarchy_to_ayon.py @@ -30,8 +30,7 @@ class ExtractHierarchyToAYON(pyblish.api.ContextPlugin): if not AYON_SERVER_ENABLED: return - hierarchy_context = context.data.get("hierarchyContext") - if not hierarchy_context: + if not context.data.get("hierarchyContext"): self.log.debug("Skipping ExtractHierarchyToAYON") return From e0f6497f95006f1190c4a619b566f54386dabf54 Mon Sep 17 00:00:00 2001 From: Ynbot Date: Sat, 20 Jan 2024 03:25:30 +0000 Subject: [PATCH 161/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index 043b6fbebb..5bb4b4fb0a 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.5-nightly.1" +__version__ = "3.18.5-nightly.2" From c3af397348029bf3337262d1fb9f5a469292eb35 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 20 Jan 2024 03:26:05 +0000 Subject: [PATCH 162/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 1177b9e4fe..e831bf3dc1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.5-nightly.2 - 3.18.5-nightly.1 - 3.18.4 - 3.18.4-nightly.1 @@ -134,7 +135,6 @@ body: - 3.15.8-nightly.1 - 3.15.7 - 3.15.7-nightly.3 - - 3.15.7-nightly.2 validations: required: true - type: dropdown From c2ea9303a3a30f491d1984b06f7b91b388f786c1 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Mon, 22 Jan 2024 11:03:02 +0000 Subject: [PATCH 163/198] Collect non-categorized effects as well --- .../plugins/publish/collect_clip_effects.py | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py index 89dc66d73c..9c147e88d6 100644 --- a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py +++ b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py @@ -74,32 +74,32 @@ class CollectClipEffects(pyblish.api.InstancePlugin): x["name"]: x["effect_classes"] for x in self.effect_categories } - category_by_effect = {} + category_by_effect = {"": ""} for key, values in effect_categories.items(): for cls in values: category_by_effect[cls] = key effects_categorized = {k: {} for k in effect_categories.keys()} + effects_categorized[""] = {} for key, value in effects.items(): if key == "assignTo": continue # Some classes can have a number in them. Like Text2. - found_cls = None + found_cls = "" for cls in category_by_effect.keys(): if value["class"].startswith(cls): found_cls = cls - if found_cls is None: - continue - effects_categorized[category_by_effect[found_cls]][key] = value - if effects_categorized: - for key in effects_categorized.keys(): - effects_categorized[key]["assignTo"] = effects["assignTo"] - else: - effects_categorized[""] = effects + categories = list(effects_categorized.keys()) + for category in categories: + if not effects_categorized[category]: + effects_categorized.pop(category) + continue + + effects_categorized[category]["assignTo"] = effects["assignTo"] for category, effects in effects_categorized.items(): name = "".join(subset_split) From bfdfa78e57e8c4f3f551569c109ffa5f4c5ed474 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Tue, 23 Jan 2024 10:48:20 +0000 Subject: [PATCH 164/198] Fix problem with independent window --- openpype/hosts/blender/api/capture.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/openpype/hosts/blender/api/capture.py b/openpype/hosts/blender/api/capture.py index 9922140cea..e16a865607 100644 --- a/openpype/hosts/blender/api/capture.py +++ b/openpype/hosts/blender/api/capture.py @@ -273,10 +273,9 @@ def _independent_window(): current_windows = set(bpy.context.window_manager.windows) with bpy.context.temp_override(**context): bpy.ops.wm.window_new() - window = list(set(bpy.context.window_manager.windows) - current_windows)[0] - context["window"] = window - try: - yield window - finally: - with bpy.context.temp_override(**context): + window = list(set(bpy.context.window_manager.windows) - current_windows)[0] + context["window"] = window + try: + yield window + finally: bpy.ops.wm.window_close() From a6556b4c2cb2c901b1df54460413e77ab278f888 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Tue, 23 Jan 2024 10:51:36 +0000 Subject: [PATCH 165/198] Hound fix --- openpype/hosts/blender/api/capture.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/blender/api/capture.py b/openpype/hosts/blender/api/capture.py index e16a865607..e5e6041563 100644 --- a/openpype/hosts/blender/api/capture.py +++ b/openpype/hosts/blender/api/capture.py @@ -273,7 +273,8 @@ def _independent_window(): current_windows = set(bpy.context.window_manager.windows) with bpy.context.temp_override(**context): bpy.ops.wm.window_new() - window = list(set(bpy.context.window_manager.windows) - current_windows)[0] + window = list( + set(bpy.context.window_manager.windows) - current_windows)[0] context["window"] = window try: yield window From 8b9def5b9a281d6f3522af0fb5fe30fad346611c Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 11:41:26 +0000 Subject: [PATCH 166/198] Add default settings. --- server_addon/hiero/server/settings/publish_plugins.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/server_addon/hiero/server/settings/publish_plugins.py b/server_addon/hiero/server/settings/publish_plugins.py index 07778b8ebe..f3d1e21fe4 100644 --- a/server_addon/hiero/server/settings/publish_plugins.py +++ b/server_addon/hiero/server/settings/publish_plugins.py @@ -74,5 +74,8 @@ DEFAULT_PUBLISH_PLUGIN_SETTINGS = { "tags_addition": [ "review" ] + }, + "CollectClipEffectsModel": { + "effect_categories": [] } } From b0484e6dab9767cc1ea8ffa044ba53a9127bf037 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 12:02:31 +0000 Subject: [PATCH 167/198] Refactor getting published workfile path --- .../plugins/publish/submit_nuke_deadline.py | 56 +++++++++++++------ 1 file changed, 39 insertions(+), 17 deletions(-) diff --git a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py index ead22fe302..746b009255 100644 --- a/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py +++ b/openpype/modules/deadline/plugins/publish/submit_nuke_deadline.py @@ -135,23 +135,7 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin, "use_published_workfile", self.use_published_workfile ) if use_published_workfile: - for item_ in context: - if "workfile" in item_.data["family"]: - template_data = item_.data.get("anatomyData") - rep = item_.data.get("representations")[0].get("name") - template_data["representation"] = rep - template_data["ext"] = rep - template_data["comment"] = None - anatomy_filled = context.data["anatomy"].format( - template_data - ) - template_filled = anatomy_filled["publish"]["path"] - script_path = os.path.normpath(template_filled) - self.log.info( - "Using published scene for render {}".format( - script_path - ) - ) + script_path = self._get_published_workfile_path(context) # only add main rendering job if target is not frames_farm r_job_response_json = None @@ -210,6 +194,44 @@ class NukeSubmitDeadline(pyblish.api.InstancePlugin, families.insert(0, "prerender") instance.data["families"] = families + def _get_published_workfile_path(self, context): + """This method is temporary while the class is not inherited from + AbstractSubmitDeadline""" + for instance in context: + if ( + instance.data["family"] != "workfile" + # Disabled instances won't be integrated + or instance.data("publish") is False + ): + continue + template_data = instance.data["anatomyData"] + # Expect workfile instance has only one representation + representation = instance.data["representations"][0] + # Get workfile extension + repre_file = representation["files"] + self.log.info(repre_file) + ext = os.path.splitext(repre_file)[1].lstrip(".") + + # Fill template data + template_data["representation"] = representation["name"] + template_data["ext"] = ext + template_data["comment"] = None + + anatomy = context.data["anatomy"] + # WARNING Hardcoded template name 'publish' > may not be used + template_obj = anatomy.templates_obj["publish"]["path"] + + template_filled = template_obj.format(template_data) + script_path = os.path.normpath(template_filled) + self.log.info( + "Using published scene for render {}".format( + script_path + ) + ) + return script_path + + return None + def payload_submit( self, instance, From 1d2f97052a527fb379c57518ecae22c6bfe12ca0 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 12:04:59 +0000 Subject: [PATCH 168/198] Add class attribute --- openpype/hosts/hiero/plugins/publish/collect_clip_effects.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py index 9c147e88d6..6647459e8e 100644 --- a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py +++ b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py @@ -9,6 +9,8 @@ class CollectClipEffects(pyblish.api.InstancePlugin): label = "Collect Clip Effects Instances" families = ["clip"] + effect_categories = [] + def process(self, instance): family = "effect" effects = {} From d3276c70dfa8a59a2487e7a6d2feb16c58164652 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 12:05:05 +0000 Subject: [PATCH 169/198] Fix version --- server_addon/hiero/server/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/hiero/server/version.py b/server_addon/hiero/server/version.py index 3ced3581bb..b3f4756216 100644 --- a/server_addon/hiero/server/version.py +++ b/server_addon/hiero/server/version.py @@ -1 +1 @@ -__version__ = "0.2.1" +__version__ = "0.1.2" From f69c63042f73bfaae4898fbd4ada583f648de5da Mon Sep 17 00:00:00 2001 From: Toke Jepsen Date: Tue, 23 Jan 2024 14:34:44 +0000 Subject: [PATCH 170/198] Update openpype/hosts/hiero/plugins/publish/collect_clip_effects.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jakub Ježek --- openpype/hosts/hiero/plugins/publish/collect_clip_effects.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py index 6647459e8e..d7f646ebc9 100644 --- a/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py +++ b/openpype/hosts/hiero/plugins/publish/collect_clip_effects.py @@ -90,7 +90,7 @@ class CollectClipEffects(pyblish.api.InstancePlugin): # Some classes can have a number in them. Like Text2. found_cls = "" for cls in category_by_effect.keys(): - if value["class"].startswith(cls): + if cls in value["class"]: found_cls = cls effects_categorized[category_by_effect[found_cls]][key] = value From 26409d4fecee3d1dc2b3d94ee545751111aee169 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 17:36:53 +0000 Subject: [PATCH 171/198] Fix simple instances for Tray Publisher. --- .../plugins/publish/collect_simple_instances.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/openpype/hosts/traypublisher/plugins/publish/collect_simple_instances.py b/openpype/hosts/traypublisher/plugins/publish/collect_simple_instances.py index 3fa3c3b8c8..d6e35f4d75 100644 --- a/openpype/hosts/traypublisher/plugins/publish/collect_simple_instances.py +++ b/openpype/hosts/traypublisher/plugins/publish/collect_simple_instances.py @@ -216,6 +216,11 @@ class CollectSettingsSimpleInstances(pyblish.api.InstancePlugin): instance.data["thumbnailSource"] = first_filepath review_representation["tags"].append("review") + + # Adding "review" to representation name since it can clash with main + # representation if they share the same extension. + review_representation["outputName"] = "review" + self.log.debug("Representation {} was marked for review. {}".format( review_representation["name"], review_path )) From f59e403a3dbfac41eaa8b6debacc0c8f9a746484 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 17:37:39 +0000 Subject: [PATCH 172/198] Fix edge case for ExtractOIIOTranscode --- openpype/plugins/publish/extract_color_transcode.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/openpype/plugins/publish/extract_color_transcode.py b/openpype/plugins/publish/extract_color_transcode.py index faacb7af2e..052759c10b 100644 --- a/openpype/plugins/publish/extract_color_transcode.py +++ b/openpype/plugins/publish/extract_color_transcode.py @@ -189,6 +189,13 @@ class ExtractOIIOTranscode(publish.Extractor): if len(new_repre["files"]) == 1: new_repre["files"] = new_repre["files"][0] + # If the source representation has "review" tag, but its not + # part of the output defintion tags, then both the + # representations will be transcoded in ExtractReview and + # their outputs will clash in integration. + if not added_review and "review" in repre.get("tags", []): + added_review = True + new_representations.append(new_repre) added_representations = True From 741eab7140c627b19d71719e4b03424d5481209f Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Tue, 23 Jan 2024 17:37:53 +0000 Subject: [PATCH 173/198] Fix thumbnail extraction --- openpype/plugins/publish/extract_thumbnail.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/openpype/plugins/publish/extract_thumbnail.py b/openpype/plugins/publish/extract_thumbnail.py index 2b4ea0529a..10eb261482 100644 --- a/openpype/plugins/publish/extract_thumbnail.py +++ b/openpype/plugins/publish/extract_thumbnail.py @@ -231,7 +231,10 @@ class ExtractThumbnail(pyblish.api.InstancePlugin): "files": jpeg_file, "stagingDir": dst_staging, "thumbnail": True, - "tags": new_repre_tags + "tags": new_repre_tags, + # If source image is jpg then there can be clash when + # integrating to making the output name explicit. + "outputName": "thumbnail" } # adding representation From 97c465c20f57aff7a87e3604ed30849a6feec09d Mon Sep 17 00:00:00 2001 From: Ynbot Date: Wed, 24 Jan 2024 03:25:59 +0000 Subject: [PATCH 174/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index 5bb4b4fb0a..674ea2cb8a 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.5-nightly.2" +__version__ = "3.18.5-nightly.3" From c8e00d4aa4cfc81d967c8d607bd409af9659b068 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 24 Jan 2024 03:26:36 +0000 Subject: [PATCH 175/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e831bf3dc1..1816ffe515 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.5-nightly.3 - 3.18.5-nightly.2 - 3.18.5-nightly.1 - 3.18.4 @@ -134,7 +135,6 @@ body: - 3.15.8-nightly.2 - 3.15.8-nightly.1 - 3.15.7 - - 3.15.7-nightly.3 validations: required: true - type: dropdown From 24cf858a29f742bf552df7d353052e288e13fee3 Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 24 Jan 2024 07:50:38 +0000 Subject: [PATCH 176/198] Remove duplicate plugin --- .../publish/validate_look_members_unique.py | 77 ------------------- 1 file changed, 77 deletions(-) delete mode 100644 openpype/hosts/maya/plugins/publish/validate_look_members_unique.py diff --git a/openpype/hosts/maya/plugins/publish/validate_look_members_unique.py b/openpype/hosts/maya/plugins/publish/validate_look_members_unique.py deleted file mode 100644 index 4e01b55249..0000000000 --- a/openpype/hosts/maya/plugins/publish/validate_look_members_unique.py +++ /dev/null @@ -1,77 +0,0 @@ -from collections import defaultdict - -import pyblish.api - -import openpype.hosts.maya.api.action -from openpype.pipeline.publish import ( - PublishValidationError, ValidatePipelineOrder) - - -class ValidateUniqueRelationshipMembers(pyblish.api.InstancePlugin): - """Validate the relational nodes of the look data to ensure every node is - unique. - - This ensures the all member ids are unique. Every node id must be from - a single node in the scene. - - That means there's only ever one of a specific node inside the look to be - published. For example if you'd have a loaded 3x the same tree and by - accident you're trying to publish them all together in a single look that - would be invalid, because they are the same tree. It should be included - inside the look instance only once. - - """ - - order = ValidatePipelineOrder - label = 'Look members unique' - hosts = ['maya'] - families = ['look'] - - actions = [openpype.hosts.maya.api.action.SelectInvalidAction, - openpype.hosts.maya.api.action.GenerateUUIDsOnInvalidAction] - - def process(self, instance): - """Process all meshes""" - - invalid = self.get_invalid(instance) - if invalid: - raise PublishValidationError( - ("Members found without non-unique IDs: " - "{0}").format(invalid)) - - @staticmethod - def get_invalid(instance): - """ - Check all the relationship members of the objectSets - - Example of the lookData relationships: - {"uuid": 59b2bb27bda2cb2776206dd8:79ab0a63ffdf, - "members":[{"uuid": 59b2bb27bda2cb2776206dd8:1b158cc7496e, - "name": |model_GRP|body_GES|body_GESShape} - ..., - ...]} - - Args: - instance: - - Returns: - - """ - - # Get all members from the sets - id_nodes = defaultdict(set) - relationships = instance.data["lookData"]["relationships"] - - for relationship in relationships.values(): - for member in relationship['members']: - node_id = member["uuid"] - node = member["name"] - id_nodes[node_id].add(node) - - # Check if any id has more than 1 node - invalid = [] - for nodes in id_nodes.values(): - if len(nodes) > 1: - invalid.extend(nodes) - - return invalid From 560698bcd8e600b5ab28ce0d7a2fd6e2fabae15b Mon Sep 17 00:00:00 2001 From: Toke Stuart Jepsen Date: Wed, 24 Jan 2024 12:19:02 +0000 Subject: [PATCH 177/198] Missing product_names to subsets conversion. --- openpype/settings/ayon_settings.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openpype/settings/ayon_settings.py b/openpype/settings/ayon_settings.py index 36f96c9dc7..8c6524f423 100644 --- a/openpype/settings/ayon_settings.py +++ b/openpype/settings/ayon_settings.py @@ -1236,6 +1236,8 @@ def _convert_global_project_settings(ayon_settings, output, default_settings): for profile in extract_oiio_transcode_profiles: new_outputs = {} name_counter = {} + if "product_names" in profile: + profile["subsets"] = profile.pop("product_names") for profile_output in profile["outputs"]: if "name" in profile_output: name = profile_output.pop("name") From 277fcd82fb474437d14c8147f4e628b145899b6e Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 24 Jan 2024 15:52:35 +0100 Subject: [PATCH 178/198] Extended error message --- .../maya/plugins/publish/validate_scene_set_workspace.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py index b48d67e416..ad89b7c791 100644 --- a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py +++ b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py @@ -44,4 +44,7 @@ class ValidateSceneSetWorkspace(pyblish.api.ContextPlugin): if not is_subdir(scene_name, root_dir): raise PublishValidationError( - "Maya workspace is not set correctly.") + "Maya workspace is not set correctly.\n\n" + f"`{os.path.dirname(scene_name)}` is not in `{root_dir}`.\n\n" + "Please use Workfile app to re-save." + ) From 8ca681109874760d04edc11b3c314b8b736430a0 Mon Sep 17 00:00:00 2001 From: Kayla Man Date: Thu, 25 Jan 2024 16:13:42 +0800 Subject: [PATCH 179/198] bugfix the save scene for camera error out when multi camera option turned off --- .../hosts/max/plugins/publish/save_scenes_for_cameras.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py index c39109417b..f089bf663c 100644 --- a/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py +++ b/openpype/hosts/max/plugins/publish/save_scenes_for_cameras.py @@ -21,6 +21,11 @@ class SaveScenesForCamera(pyblish.api.InstancePlugin): families = ["maxrender"] def process(self, instance): + if not instance.data.get("multiCamera"): + self.log.debug( + "Multi Camera disabled. " + "Skipping to save scene files for cameras") + return current_folder = rt.maxFilePath current_filename = rt.maxFileName current_filepath = os.path.join(current_folder, current_filename) From cb9802e3fe63fa7542b463b0c613bf8480260492 Mon Sep 17 00:00:00 2001 From: Toke Jepsen Date: Thu, 25 Jan 2024 11:04:56 +0000 Subject: [PATCH 180/198] Update openpype/plugins/publish/extract_color_transcode.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- openpype/plugins/publish/extract_color_transcode.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/plugins/publish/extract_color_transcode.py b/openpype/plugins/publish/extract_color_transcode.py index 052759c10b..922df469fe 100644 --- a/openpype/plugins/publish/extract_color_transcode.py +++ b/openpype/plugins/publish/extract_color_transcode.py @@ -193,7 +193,7 @@ class ExtractOIIOTranscode(publish.Extractor): # part of the output defintion tags, then both the # representations will be transcoded in ExtractReview and # their outputs will clash in integration. - if not added_review and "review" in repre.get("tags", []): + if "review" in repre.get("tags", []): added_review = True new_representations.append(new_repre) From ac383a5de66e79aec84fb19a2a71ecd55b2ef224 Mon Sep 17 00:00:00 2001 From: Simone Barbieri Date: Thu, 25 Jan 2024 11:33:29 +0000 Subject: [PATCH 181/198] Fix missing animation data when updating blend assets --- openpype/hosts/blender/plugins/load/load_blend.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openpype/hosts/blender/plugins/load/load_blend.py b/openpype/hosts/blender/plugins/load/load_blend.py index 4abe4a6afb..1a84f5afbb 100644 --- a/openpype/hosts/blender/plugins/load/load_blend.py +++ b/openpype/hosts/blender/plugins/load/load_blend.py @@ -220,6 +220,8 @@ class BlendLoader(plugin.AssetLoader): # Restore the actions for obj in asset_group.children_recursive: if obj.name in actions: + if not obj.animation_data: + obj.animation_data_create() obj.animation_data.action = actions[obj.name] # Restore the old data, but reset memebers, as they don't exist anymore From 77a12f49f8ad91b2771908b1dcfb9f7f4721fafd Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Thu, 25 Jan 2024 12:34:35 +0100 Subject: [PATCH 182/198] fix project name duplication in project folders --- openpype/pipeline/project_folders.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/openpype/pipeline/project_folders.py b/openpype/pipeline/project_folders.py index 1bcba5c320..ecdb5cf6d3 100644 --- a/openpype/pipeline/project_folders.py +++ b/openpype/pipeline/project_folders.py @@ -28,13 +28,14 @@ def concatenate_splitted_paths(split_paths, anatomy): # backward compatibility if "__project_root__" in path_items: for root, root_path in anatomy.roots.items(): - if not os.path.exists(str(root_path)): - log.debug("Root {} path path {} not exist on \ - computer!".format(root, root_path)) + if not root_path: continue - clean_items = ["{{root[{}]}}".format(root), - r"{project[name]}"] + clean_items[1:] - output.append(os.path.normpath(os.path.sep.join(clean_items))) + root_items = [ + "{{root[{}]}}".format(root), + "{project[name]}" + ] + root_items.extend(clean_items[1:]) + output.append(os.path.normpath(os.path.sep.join(root_items))) continue output.append(os.path.normpath(os.path.sep.join(clean_items))) From 8f6d78e4eb9985efa689a7c7a1548bcde5231a14 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Thu, 25 Jan 2024 12:41:15 +0100 Subject: [PATCH 183/198] skip path exists --- openpype/pipeline/project_folders.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/openpype/pipeline/project_folders.py b/openpype/pipeline/project_folders.py index ecdb5cf6d3..608344ce03 100644 --- a/openpype/pipeline/project_folders.py +++ b/openpype/pipeline/project_folders.py @@ -28,8 +28,14 @@ def concatenate_splitted_paths(split_paths, anatomy): # backward compatibility if "__project_root__" in path_items: for root, root_path in anatomy.roots.items(): - if not root_path: + if not root_path or not os.path.exists(str(root_path)): + log.debug( + "Root {} path path {} not exist on computer!".format( + root, root_path + ) + ) continue + root_items = [ "{{root[{}]}}".format(root), "{project[name]}" From de2d70a8a34e03c27c05a085fdfee408e19a0d79 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Thu, 25 Jan 2024 13:30:16 +0100 Subject: [PATCH 184/198] Added settings for Fusion creators to legacy OP (#6162) --- .../defaults/project_settings/fusion.json | 6 ++++-- .../projects_schema/schema_project_fusion.json | 16 ++++++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/openpype/settings/defaults/project_settings/fusion.json b/openpype/settings/defaults/project_settings/fusion.json index 15b6bfc09b..f890f94b6f 100644 --- a/openpype/settings/defaults/project_settings/fusion.json +++ b/openpype/settings/defaults/project_settings/fusion.json @@ -31,7 +31,8 @@ "reviewable", "farm_rendering" ], - "image_format": "exr" + "image_format": "exr", + "default_frame_range_option": "asset_db" }, "CreateImageSaver": { "temp_rendering_path_template": "{workdir}/renders/fusion/{subset}/{subset}.{ext}", @@ -43,7 +44,8 @@ "reviewable", "farm_rendering" ], - "image_format": "exr" + "image_format": "exr", + "default_frame": 0 } }, "publish": { diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json index 8669842087..84d1efae78 100644 --- a/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json +++ b/openpype/settings/entities/schemas/projects_schema/schema_project_fusion.json @@ -116,6 +116,17 @@ {"tif": "tif"}, {"jpg": "jpg"} ] + }, + { + "key": "default_frame_range_option", + "label": "Default frame range source", + "type": "enum", + "multiselect": false, + "enum_items": [ + {"asset_db": "Current asset context"}, + {"render_range": "From render in/out"}, + {"comp_range": "From composition timeline"} + ] } ] }, @@ -165,6 +176,11 @@ {"tif": "tif"}, {"jpg": "jpg"} ] + }, + { + "type": "number", + "key": "default_frame", + "label": "Default rendered frame" } ] } From b783fae8e0262a9c0edc689ad84162d180b8e574 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Thu, 25 Jan 2024 13:31:12 +0100 Subject: [PATCH 185/198] Update openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py Co-authored-by: Toke Jepsen --- .../hosts/maya/plugins/publish/validate_scene_set_workspace.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py index ad89b7c791..0c780d3a69 100644 --- a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py +++ b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py @@ -45,6 +45,6 @@ class ValidateSceneSetWorkspace(pyblish.api.ContextPlugin): if not is_subdir(scene_name, root_dir): raise PublishValidationError( "Maya workspace is not set correctly.\n\n" - f"`{os.path.dirname(scene_name)}` is not in `{root_dir}`.\n\n" + f"Current workfile `{scene_name}` is not inside the current Maya project root directory `{root_dir}`.\n\n" "Please use Workfile app to re-save." ) From a0faa3f130c7a806cec1d045dceceb7ee09ea3e2 Mon Sep 17 00:00:00 2001 From: Toke Jepsen Date: Thu, 25 Jan 2024 12:34:53 +0000 Subject: [PATCH 186/198] Update openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py --- .../hosts/maya/plugins/publish/validate_scene_set_workspace.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py index 0c780d3a69..ddcbab8931 100644 --- a/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py +++ b/openpype/hosts/maya/plugins/publish/validate_scene_set_workspace.py @@ -45,6 +45,7 @@ class ValidateSceneSetWorkspace(pyblish.api.ContextPlugin): if not is_subdir(scene_name, root_dir): raise PublishValidationError( "Maya workspace is not set correctly.\n\n" - f"Current workfile `{scene_name}` is not inside the current Maya project root directory `{root_dir}`.\n\n" + f"Current workfile `{scene_name}` is not inside the " + "current Maya project root directory `{root_dir}`.\n\n" "Please use Workfile app to re-save." ) From 20e089c30ea8834553c8d7888542ca0101787ba7 Mon Sep 17 00:00:00 2001 From: Ynbot Date: Thu, 25 Jan 2024 14:04:28 +0000 Subject: [PATCH 187/198] [Automated] Release --- CHANGELOG.md | 215 ++++++++++++++++++++++++++++++++++++++++++++ openpype/version.py | 2 +- pyproject.toml | 2 +- 3 files changed, 217 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 546b2c12ea..14f0bc469f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,221 @@ # Changelog +## [3.18.5](https://github.com/ynput/OpenPype/tree/3.18.5) + + +[Full Changelog](https://github.com/ynput/OpenPype/compare/3.18.4...3.18.5) + +### **🚀 Enhancements** + + +
+Chore: Add addons dir only if exists #6140 + +Do not add addons directory path for addons discovery if does not exists. + + +___ + +
+ + +
+Hiero: Effect Categories - OP-7397 #6143 + +This PR introduces `Effect Categories` for the Hiero settings. This allows studios to split effect stacks into meaningful subsets. + + +___ + +
+ + +
+Nuke: Render Workfile Attributes #6146 + +`Workfile Dependency` default value can now be controlled from project settings.`Use Published Workfile` makes using published workfiles for rendering optional. + + +___ + +
+ +### **🐛 Bug fixes** + + +
+Maya: Attributes are locked after publishing if they are locked in Camera Family #6073 + +This PR is to make sure unlock attributes only during the bake context, make sure attributes are relocked after to preserve the lock state of the original node being baked. + + +___ + +
+ + +
+Missing nuke family Windows arguments #6131 + +Default Windows arguments for launching the Nuke family was missing. + + +___ + +
+ + +
+AYON: Fix the bug on the limit group not being set correctly in Maya Deadline Setting #6139 + +This PR is to bug-fix the limit groups from maya deadline settings errored out when the user tries to edit the setting. + + +___ + +
+ + +
+Chore: Transcoding extensions add missing '.tif' extension #6142 + +Image extensions in transcoding helper was missing `.tif` extension and had `.tiff` twice. + + +___ + +
+ + +
+Blender: Use the new API for override context #6145 + +Blender 4.0 disabled the old API to override context. This API updates the code to use the new API. + + +___ + +
+ + +
+BugFix: Include Model in FBX Loader in Houdini #6150 + +A quick bugfig where we can't load fbx exported from blender. The bug was reported here. + + +___ + +
+ + +
+Blender: Restore actions to objects after update #6153 + +Restore the actions assigned to objects after updating assets from blend files. + + +___ + +
+ + +
+Chore: Collect template data with hierarchy context #6154 + +Fixed queue loop where is used wrong variable to pop items from queue. + + +___ + +
+ + +
+OP-6382 - Thumbnail Integration Problem #6156 + +This ticket alerted to 3 different cases of integration issues; +- [x] Using the Tray Publisher with the same image format (extension) for representation and review representation. +- [x] Clash on publish file path from output definitions in `ExtractOIIOTranscode`. +- [x] Clash on publish file from thumbnail in `ExtractThumbnail`There might be an issue with this fix, if a studio does not use the `{output}` token in their `render` anatomy template. But thinking if they have customized it, they will be responsible to maintain these edge cases. + + +___ + +
+ + +
+Max: Bugfix saving camera scene errored out when creating render instance with multi-camera option turned off #6163 + +This PR is to make sure the integrator of saving camera scene turned off and the render submitted successfully when multi-camera options being turned off in 3dsmax + + +___ + +
+ + +
+Chore: Fix duplicated project name on create project structure #6166 + +Small fix in project folders. It is not used same variable name to change values which breaks values on any next loop. + + +___ + +
+ +### **Merged pull requests** + + +
+Maya: Remove duplicate plugin #6157 + +The two plugins below are doing the same work, so we can remove the one focused solely on lookdev.https://github.com/ynput/OpenPype/blob/develop/openpype/hosts/maya/plugins/publish/validate_look_members_unique.pyhttps://github.com/ynput/OpenPype/blob/develop/openpype/hosts/maya/plugins/publish/validate_node_ids_unique.py + + +___ + +
+ + +
+Publish report viewer: Report items sorting #6092 + +Proposal of items sorting in Publish report viewer tool. Items are sorted by report creation time. Creation time is also added to publish report data when saved from publisher tool. + + +___ + +
+ + +
+Maya: Extended error message #6161 + +Added more details to message + + +___ + +
+ + +
+Fusion: Added settings for Fusion creators to legacy OP #6162 + +Added missing OP variant of setting for new Fusion creator. + + +___ + +
+ + + + ## [3.18.4](https://github.com/ynput/OpenPype/tree/3.18.4) diff --git a/openpype/version.py b/openpype/version.py index 674ea2cb8a..ddfb3ebeeb 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.5-nightly.3" +__version__ = "3.18.5" diff --git a/pyproject.toml b/pyproject.toml index f9d5381a15..24172aa77f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "OpenPype" -version = "3.18.4" # OpenPype +version = "3.18.5" # OpenPype description = "Open VFX and Animation pipeline with support." authors = ["OpenPype Team "] license = "MIT License" From 6c83642af6bf7238ae686a1fa22aa95187b42192 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 25 Jan 2024 14:05:21 +0000 Subject: [PATCH 188/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 1816ffe515..fd6999604a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.5 - 3.18.5-nightly.3 - 3.18.5-nightly.2 - 3.18.5-nightly.1 @@ -134,7 +135,6 @@ body: - 3.15.8-nightly.3 - 3.15.8-nightly.2 - 3.15.8-nightly.1 - - 3.15.7 validations: required: true - type: dropdown From d53d8410e74e69007a91c1a1d9cda657b4b0ad72 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 26 Jan 2024 12:55:14 +0100 Subject: [PATCH 189/198] removed kitsu ayon settings --- server_addon/kitsu/server/__init__.py | 19 ----- server_addon/kitsu/server/settings.py | 112 -------------------------- server_addon/kitsu/server/version.py | 1 - 3 files changed, 132 deletions(-) delete mode 100644 server_addon/kitsu/server/__init__.py delete mode 100644 server_addon/kitsu/server/settings.py delete mode 100644 server_addon/kitsu/server/version.py diff --git a/server_addon/kitsu/server/__init__.py b/server_addon/kitsu/server/__init__.py deleted file mode 100644 index 69cf812dea..0000000000 --- a/server_addon/kitsu/server/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -from typing import Type - -from ayon_server.addons import BaseServerAddon - -from .version import __version__ -from .settings import KitsuSettings, DEFAULT_VALUES - - -class KitsuAddon(BaseServerAddon): - name = "kitsu" - title = "Kitsu" - version = __version__ - settings_model: Type[KitsuSettings] = KitsuSettings - frontend_scopes = {} - services = {} - - async def get_default_settings(self): - settings_model_cls = self.get_settings_model() - return settings_model_cls(**DEFAULT_VALUES) diff --git a/server_addon/kitsu/server/settings.py b/server_addon/kitsu/server/settings.py deleted file mode 100644 index a4d10d889d..0000000000 --- a/server_addon/kitsu/server/settings.py +++ /dev/null @@ -1,112 +0,0 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel - - -class EntityPattern(BaseSettingsModel): - episode: str = Field(title="Episode") - sequence: str = Field(title="Sequence") - shot: str = Field(title="Shot") - - -def _status_change_cond_enum(): - return [ - {"value": "equal", "label": "Equal"}, - {"value": "not_equal", "label": "Not equal"} - ] - - -class StatusChangeCondition(BaseSettingsModel): - condition: str = Field( - "equal", - enum_resolver=_status_change_cond_enum, - title="Condition" - ) - short_name: str = Field("", title="Short name") - - -class StatusChangeProductTypeRequirementModel(BaseSettingsModel): - condition: str = Field( - "equal", - enum_resolver=_status_change_cond_enum, - title="Condition" - ) - product_type: str = Field("", title="Product type") - - -class StatusChangeConditionsModel(BaseSettingsModel): - status_conditions: list[StatusChangeCondition] = Field( - default_factory=list, - title="Status conditions" - ) - product_type_requirements: list[StatusChangeProductTypeRequirementModel] = Field( - default_factory=list, - title="Product type requirements") - - -class CustomCommentTemplateModel(BaseSettingsModel): - enabled: bool = Field(True) - comment_template: str = Field("", title="Custom comment") - - -class IntegrateKitsuNotes(BaseSettingsModel): - """Kitsu supports markdown and here you can create a custom comment template. - - You can use data from your publishing instance's data. - """ - - set_status_note: bool = Field(title="Set status on note") - note_status_shortname: str = Field(title="Note shortname") - status_change_conditions: StatusChangeConditionsModel = Field( - default_factory=StatusChangeConditionsModel, - title="Status change conditions" - ) - custom_comment_template: CustomCommentTemplateModel = Field( - default_factory=CustomCommentTemplateModel, - title="Custom Comment Template", - ) - - -class PublishPlugins(BaseSettingsModel): - IntegrateKitsuNote: IntegrateKitsuNotes = Field( - default_factory=IntegrateKitsuNotes, - title="Integrate Kitsu Note" - ) - - -class KitsuSettings(BaseSettingsModel): - server: str = Field( - "", - title="Kitsu Server", - scope=["studio"], - ) - entities_naming_pattern: EntityPattern = Field( - default_factory=EntityPattern, - title="Entities naming pattern", - ) - publish: PublishPlugins = Field( - default_factory=PublishPlugins, - title="Publish plugins", - ) - - -DEFAULT_VALUES = { - "entities_naming_pattern": { - "episode": "E##", - "sequence": "SQ##", - "shot": "SH##" - }, - "publish": { - "IntegrateKitsuNote": { - "set_status_note": False, - "note_status_shortname": "wfa", - "status_change_conditions": { - "status_conditions": [], - "product_type_requirements": [] - }, - "custom_comment_template": { - "enabled": False, - "comment_template": "{comment}\n\n| | |\n|--|--|\n| version| `{version}` |\n| product type | `{product[type]}` |\n| name | `{name}` |" - } - } - } -} diff --git a/server_addon/kitsu/server/version.py b/server_addon/kitsu/server/version.py deleted file mode 100644 index 485f44ac21..0000000000 --- a/server_addon/kitsu/server/version.py +++ /dev/null @@ -1 +0,0 @@ -__version__ = "0.1.1" From 3ea4c29d0fa17b6a08c1f057e65c0c0df60cfd9e Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 26 Jan 2024 12:59:18 +0100 Subject: [PATCH 190/198] use 'SettingsField' from ayon server instead of 'Field' from pydantic This is preparation for new version of pydantic which will require to customize the field for AYON purposes and raw pydantic Field could not be used. --- .../server/settings/creator_plugins.py | 10 +- .../aftereffects/server/settings/imageio.py | 26 +- .../aftereffects/server/settings/main.py | 13 +- .../server/settings/publish_plugins.py | 28 +- .../settings/templated_workfile_build.py | 14 +- .../server/settings/workfile_builder.py | 16 +- server_addon/applications/server/settings.py | 120 ++--- .../blender/server/settings/imageio.py | 26 +- server_addon/blender/server/settings/main.py | 22 +- .../server/settings/publish_plugins.py | 72 +-- .../server/settings/render_settings.py | 20 +- server_addon/celaction/server/imageio.py | 26 +- server_addon/celaction/server/settings.py | 19 +- server_addon/clockify/server/settings.py | 5 +- server_addon/core/server/settings/main.py | 69 +-- .../core/server/settings/publish_plugins.py | 331 ++++++------- server_addon/core/server/settings/tools.py | 156 ++++--- server_addon/deadline/server/settings/main.py | 18 +- .../server/settings/publish_plugins.py | 270 ++++++----- .../flame/server/settings/create_plugins.py | 43 +- server_addon/flame/server/settings/imageio.py | 54 ++- .../flame/server/settings/loader_plugins.py | 36 +- server_addon/flame/server/settings/main.py | 10 +- .../flame/server/settings/publish_plugins.py | 58 +-- server_addon/fusion/server/imageio.py | 26 +- server_addon/fusion/server/settings.py | 36 +- .../harmony/server/settings/imageio.py | 30 +- server_addon/harmony/server/settings/main.py | 7 +- .../server/settings/publish_plugins.py | 32 +- server_addon/hiero/server/settings/common.py | 39 +- .../hiero/server/settings/create_plugins.py | 33 +- server_addon/hiero/server/settings/filters.py | 16 +- server_addon/hiero/server/settings/imageio.py | 53 +-- .../hiero/server/settings/loader_plugins.py | 11 +- server_addon/hiero/server/settings/main.py | 16 +- .../hiero/server/settings/publish_plugins.py | 25 +- .../hiero/server/settings/scriptsmenu.py | 17 +- .../houdini/server/settings/create.py | 57 ++- .../houdini/server/settings/general.py | 17 +- .../houdini/server/settings/imageio.py | 26 +- server_addon/houdini/server/settings/main.py | 13 +- .../houdini/server/settings/publish.py | 41 +- .../houdini/server/settings/shelves.py | 26 +- .../server/settings/create_review_settings.py | 22 +- server_addon/max/server/settings/imageio.py | 26 +- server_addon/max/server/settings/main.py | 25 +- .../max/server/settings/publishers.py | 40 +- .../max/server/settings/render_settings.py | 12 +- server_addon/maya/server/settings/creators.py | 169 +++---- .../settings/explicit_plugins_loading.py | 12 +- server_addon/maya/server/settings/imageio.py | 56 +-- .../maya/server/settings/include_handles.py | 16 +- server_addon/maya/server/settings/loaders.py | 52 +-- server_addon/maya/server/settings/main.py | 40 +- .../maya/server/settings/maya_dirmap.py | 14 +- .../maya/server/settings/publish_playblast.py | 235 +++++----- .../maya/server/settings/publishers.py | 436 ++++++++++-------- .../maya/server/settings/render_settings.py | 82 ++-- .../maya/server/settings/scriptsmenu.py | 20 +- .../settings/templated_workfile_settings.py | 15 +- .../settings/workfile_build_settings.py | 25 +- server_addon/muster/server/settings.py | 11 +- server_addon/nuke/server/settings/common.py | 51 +- .../nuke/server/settings/create_plugins.py | 41 +- server_addon/nuke/server/settings/dirmap.py | 11 +- server_addon/nuke/server/settings/general.py | 15 +- server_addon/nuke/server/settings/gizmo.py | 24 +- server_addon/nuke/server/settings/imageio.py | 65 +-- .../nuke/server/settings/loader_plugins.py | 25 +- server_addon/nuke/server/settings/main.py | 23 +- .../nuke/server/settings/publish_plugins.py | 127 ++--- .../nuke/server/settings/scriptsmenu.py | 17 +- .../settings/templated_workfile_build.py | 14 +- .../nuke/server/settings/workfile_builder.py | 30 +- .../server/settings/creator_plugins.py | 40 +- .../photoshop/server/settings/imageio.py | 34 +- .../photoshop/server/settings/main.py | 11 +- .../server/settings/publish_plugins.py | 58 ++- .../server/settings/workfile_builder.py | 16 +- server_addon/resolve/server/imageio.py | 34 +- server_addon/resolve/server/settings.py | 39 +- server_addon/royal_render/server/settings.py | 23 +- .../server/settings/imageio.py | 26 +- .../substancepainter/server/settings/main.py | 11 +- .../timers_manager/server/settings.py | 11 +- .../server/settings/creator_plugins.py | 12 +- .../server/settings/editorial_creators.py | 50 +- .../traypublisher/server/settings/imageio.py | 26 +- .../traypublisher/server/settings/main.py | 13 +- .../server/settings/publish_plugins.py | 14 +- .../server/settings/simple_creators.py | 26 +- .../tvpaint/server/settings/create_plugins.py | 65 ++- .../tvpaint/server/settings/filters.py | 10 +- .../tvpaint/server/settings/imageio.py | 26 +- server_addon/tvpaint/server/settings/main.py | 14 +- .../server/settings/publish_plugins.py | 40 +- .../server/settings/workfile_builder.py | 11 +- server_addon/unreal/server/imageio.py | 26 +- server_addon/unreal/server/settings.py | 19 +- 99 files changed, 2235 insertions(+), 2154 deletions(-) diff --git a/server_addon/aftereffects/server/settings/creator_plugins.py b/server_addon/aftereffects/server/settings/creator_plugins.py index 9cb03b0b26..988a036589 100644 --- a/server_addon/aftereffects/server/settings/creator_plugins.py +++ b/server_addon/aftereffects/server/settings/creator_plugins.py @@ -1,18 +1,16 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CreateRenderPlugin(BaseSettingsModel): - mark_for_review: bool = Field(True, title="Review") - default_variants: list[str] = Field( + mark_for_review: bool = SettingsField(True, title="Review") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Variants" ) class AfterEffectsCreatorPlugins(BaseSettingsModel): - RenderCreator: CreateRenderPlugin = Field( + RenderCreator: CreateRenderPlugin = SettingsField( title="Create Render", default_factory=CreateRenderPlugin, ) diff --git a/server_addon/aftereffects/server/settings/imageio.py b/server_addon/aftereffects/server/settings/imageio.py index 55160ffd11..4657425c81 100644 --- a/server_addon/aftereffects/server/settings/imageio.py +++ b/server_addon/aftereffects/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class AfterEffectsImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/aftereffects/server/settings/main.py b/server_addon/aftereffects/server/settings/main.py index 4edc46d259..f30f4dc258 100644 --- a/server_addon/aftereffects/server/settings/main.py +++ b/server_addon/aftereffects/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import AfterEffectsImageIOModel from .creator_plugins import AfterEffectsCreatorPlugins @@ -14,23 +13,23 @@ from .templated_workfile_build import TemplatedWorkfileBuildModel class AfterEffectsSettings(BaseSettingsModel): """AfterEffects Project Settings.""" - imageio: AfterEffectsImageIOModel = Field( + imageio: AfterEffectsImageIOModel = SettingsField( default_factory=AfterEffectsImageIOModel, title="OCIO config" ) - create: AfterEffectsCreatorPlugins = Field( + create: AfterEffectsCreatorPlugins = SettingsField( default_factory=AfterEffectsCreatorPlugins, title="Creator plugins" ) - publish: AfterEffectsPublishPlugins = Field( + publish: AfterEffectsPublishPlugins = SettingsField( default_factory=AfterEffectsPublishPlugins, title="Publish plugins" ) - workfile_builder: WorkfileBuilderPlugin = Field( + workfile_builder: WorkfileBuilderPlugin = SettingsField( default_factory=WorkfileBuilderPlugin, title="Workfile Builder" ) - templated_workfile_build: TemplatedWorkfileBuildModel = Field( + templated_workfile_build: TemplatedWorkfileBuildModel = SettingsField( default_factory=TemplatedWorkfileBuildModel, title="Templated Workfile Build Settings" ) diff --git a/server_addon/aftereffects/server/settings/publish_plugins.py b/server_addon/aftereffects/server/settings/publish_plugins.py index 78445d3223..61d67f26d3 100644 --- a/server_addon/aftereffects/server/settings/publish_plugins.py +++ b/server_addon/aftereffects/server/settings/publish_plugins.py @@ -1,45 +1,43 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CollectReviewPluginModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") + enabled: bool = SettingsField(True, title="Enabled") class ValidateSceneSettingsModel(BaseSettingsModel): """Validate naming of products and layers""" # _isGroup = True - enabled: bool = Field(True, title="Enabled") - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") - skip_resolution_check: list[str] = Field( + enabled: bool = SettingsField(True, title="Enabled") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") + skip_resolution_check: list[str] = SettingsField( default_factory=list, title="Skip Resolution Check for Tasks", ) - skip_timelines_check: list[str] = Field( + skip_timelines_check: list[str] = SettingsField( default_factory=list, title="Skip Timeline Check for Tasks", ) class ValidateContainersModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - optional: bool = Field(True, title="Optional") - active: bool = Field(True, title="Active") + enabled: bool = SettingsField(True, title="Enabled") + optional: bool = SettingsField(True, title="Optional") + active: bool = SettingsField(True, title="Active") class AfterEffectsPublishPlugins(BaseSettingsModel): - CollectReview: CollectReviewPluginModel = Field( + CollectReview: CollectReviewPluginModel = SettingsField( default_factory=CollectReviewPluginModel, title="Collect Review", ) - ValidateSceneSettings: ValidateSceneSettingsModel = Field( + ValidateSceneSettings: ValidateSceneSettingsModel = SettingsField( default_factory=ValidateSceneSettingsModel, title="Validate Scene Settings", ) - ValidateContainers: ValidateContainersModel = Field( + ValidateContainers: ValidateContainersModel = SettingsField( default_factory=ValidateContainersModel, title="Validate Containers", ) diff --git a/server_addon/aftereffects/server/settings/templated_workfile_build.py b/server_addon/aftereffects/server/settings/templated_workfile_build.py index e0245c8d06..5b71c2addc 100644 --- a/server_addon/aftereffects/server/settings/templated_workfile_build.py +++ b/server_addon/aftereffects/server/settings/templated_workfile_build.py @@ -1,33 +1,33 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, task_types_enum, + SettingsField, ) class TemplatedWorkfileProfileModel(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - path: str = Field( + path: str = SettingsField( title="Path to template" ) - keep_placeholder: bool = Field( + keep_placeholder: bool = SettingsField( False, title="Keep placeholders") - create_first_version: bool = Field( + create_first_version: bool = SettingsField( True, title="Create first version" ) class TemplatedWorkfileBuildModel(BaseSettingsModel): - profiles: list[TemplatedWorkfileProfileModel] = Field( + profiles: list[TemplatedWorkfileProfileModel] = SettingsField( default_factory=list ) diff --git a/server_addon/aftereffects/server/settings/workfile_builder.py b/server_addon/aftereffects/server/settings/workfile_builder.py index d45d3f7f24..65f5ddd893 100644 --- a/server_addon/aftereffects/server/settings/workfile_builder.py +++ b/server_addon/aftereffects/server/settings/workfile_builder.py @@ -1,25 +1,27 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel, MultiplatformPathModel +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + MultiplatformPathModel, +) class CustomBuilderTemplate(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", ) - template_path: MultiplatformPathModel = Field( + template_path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel ) class WorkfileBuilderPlugin(BaseSettingsModel): _title = "Workfile Builder" - create_first_version: bool = Field( + create_first_version: bool = SettingsField( False, title="Create first workfile" ) - custom_templates: list[CustomBuilderTemplate] = Field( + custom_templates: list[CustomBuilderTemplate] = SettingsField( default_factory=list ) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 70c8b57c6a..710bbbf9ee 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -1,7 +1,11 @@ import json -from pydantic import Field, validator +from pydantic import validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) from ayon_server.exceptions import BadRequestException @@ -23,21 +27,21 @@ def validate_json_dict(value): class MultiplatformStrList(BaseSettingsModel): - windows: list[str] = Field(default_factory=list, title="Windows") - linux: list[str] = Field(default_factory=list, title="Linux") - darwin: list[str] = Field(default_factory=list, title="MacOS") + windows: list[str] = SettingsField(default_factory=list, title="Windows") + linux: list[str] = SettingsField(default_factory=list, title="Linux") + darwin: list[str] = SettingsField(default_factory=list, title="MacOS") class AppVariant(BaseSettingsModel): - name: str = Field("", title="Name") - label: str = Field("", title="Label") - executables: MultiplatformStrList = Field( + name: str = SettingsField("", title="Name") + label: str = SettingsField("", title="Label") + executables: MultiplatformStrList = SettingsField( default_factory=MultiplatformStrList, title="Executables" ) - arguments: MultiplatformStrList = Field( + arguments: MultiplatformStrList = SettingsField( default_factory=MultiplatformStrList, title="Arguments" ) - environment: str = Field("{}", title="Environment", widget="textarea") + environment: str = SettingsField("{}", title="Environment", widget="textarea") @validator("environment") def validate_json(cls, value): @@ -45,17 +49,17 @@ class AppVariant(BaseSettingsModel): class AppVariantWithPython(AppVariant): - use_python_2: bool = Field(False, title="Use Python 2") + use_python_2: bool = SettingsField(False, title="Use Python 2") class AppGroup(BaseSettingsModel): - enabled: bool = Field(True) - label: str = Field("", title="Label") - host_name: str = Field("", title="Host name") - icon: str = Field("", title="Icon") - environment: str = Field("{}", title="Environment", widget="textarea") + enabled: bool = SettingsField(True) + label: str = SettingsField("", title="Label") + host_name: str = SettingsField("", title="Host name") + icon: str = SettingsField("", title="Icon") + environment: str = SettingsField("{}", title="Environment", widget="textarea") - variants: list[AppVariant] = Field( + variants: list[AppVariant] = SettingsField( default_factory=list, title="Variants", description="Different variants of the applications", @@ -69,7 +73,7 @@ class AppGroup(BaseSettingsModel): class AppGroupWithPython(AppGroup): - variants: list[AppVariantWithPython] = Field( + variants: list[AppVariantWithPython] = SettingsField( default_factory=list, title="Variants", description="Different variants of the applications", @@ -78,14 +82,14 @@ class AppGroupWithPython(AppGroup): class AdditionalAppGroup(BaseSettingsModel): - enabled: bool = Field(True) - name: str = Field("", title="Name") - label: str = Field("", title="Label") - host_name: str = Field("", title="Host name") - icon: str = Field("", title="Icon") - environment: str = Field("{}", title="Environment", widget="textarea") + enabled: bool = SettingsField(True) + name: str = SettingsField("", title="Name") + label: str = SettingsField("", title="Label") + host_name: str = SettingsField("", title="Host name") + icon: str = SettingsField("", title="Icon") + environment: str = SettingsField("{}", title="Environment", widget="textarea") - variants: list[AppVariantWithPython] = Field( + variants: list[AppVariantWithPython] = SettingsField( default_factory=list, title="Variants", description="Different variants of the applications", @@ -99,12 +103,12 @@ class AdditionalAppGroup(BaseSettingsModel): class ToolVariantModel(BaseSettingsModel): - name: str = Field("", title="Name") - label: str = Field("", title="Label") - host_names: list[str] = Field(default_factory=list, title="Hosts") + name: str = SettingsField("", title="Name") + label: str = SettingsField("", title="Label") + host_names: list[str] = SettingsField(default_factory=list, title="Hosts") # TODO use applications enum if possible - app_variants: list[str] = Field(default_factory=list, title="Applications") - environment: str = Field("{}", title="Environments", widget="textarea") + app_variants: list[str] = SettingsField(default_factory=list, title="Applications") + environment: str = SettingsField("{}", title="Environments", widget="textarea") @validator("environment") def validate_json(cls, value): @@ -112,10 +116,10 @@ class ToolVariantModel(BaseSettingsModel): class ToolGroupModel(BaseSettingsModel): - name: str = Field("", title="Name") - label: str = Field("", title="Label") - environment: str = Field("{}", title="Environments", widget="textarea") - variants: list[ToolVariantModel] = Field(default_factory=list) + name: str = SettingsField("", title="Name") + label: str = SettingsField("", title="Label") + environment: str = SettingsField("{}", title="Environments", widget="textarea") + variants: list[ToolVariantModel] = SettingsField(default_factory=list) @validator("environment") def validate_json(cls, value): @@ -130,47 +134,47 @@ class ToolGroupModel(BaseSettingsModel): class ApplicationsSettings(BaseSettingsModel): """Applications settings""" - maya: AppGroupWithPython = Field( + maya: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Autodesk Maya") - adsk_3dsmax: AppGroupWithPython = Field( + adsk_3dsmax: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Autodesk 3ds Max") - flame: AppGroupWithPython = Field( + flame: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Autodesk Flame") - nuke: AppGroupWithPython = Field( + nuke: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Nuke") - nukeassist: AppGroupWithPython = Field( + nukeassist: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Nuke Assist") - nukex: AppGroupWithPython = Field( + nukex: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Nuke X") - nukestudio: AppGroupWithPython = Field( + nukestudio: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Nuke Studio") - hiero: AppGroupWithPython = Field( + hiero: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Hiero") - fusion: AppGroup = Field( + fusion: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Fusion") - resolve: AppGroupWithPython = Field( + resolve: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Resolve") - houdini: AppGroupWithPython = Field( + houdini: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Houdini") - blender: AppGroup = Field( + blender: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Blender") - harmony: AppGroup = Field( + harmony: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Harmony") - tvpaint: AppGroup = Field( + tvpaint: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="TVPaint") - photoshop: AppGroup = Field( + photoshop: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Adobe Photoshop") - aftereffects: AppGroup = Field( + aftereffects: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Adobe After Effects") - celaction: AppGroup = Field( + celaction: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Celaction 2D") - substancepainter: AppGroup = Field( + substancepainter: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Substance Painter") - unreal: AppGroup = Field( + unreal: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Unreal Editor") - wrap: AppGroup = Field( + wrap: AppGroup = SettingsField( default_factory=AppGroupWithPython, title="Wrap") - additional_apps: list[AdditionalAppGroup] = Field( + additional_apps: list[AdditionalAppGroup] = SettingsField( default_factory=list, title="Additional Applications") @validator("additional_apps") @@ -180,16 +184,16 @@ class ApplicationsSettings(BaseSettingsModel): class ApplicationsAddonSettings(BaseSettingsModel): - applications: ApplicationsSettings = Field( + applications: ApplicationsSettings = SettingsField( default_factory=ApplicationsSettings, title="Applications", scope=["studio"] ) - tool_groups: list[ToolGroupModel] = Field( + tool_groups: list[ToolGroupModel] = SettingsField( default_factory=list, scope=["studio"] ) - only_available: bool = Field( + only_available: bool = SettingsField( True, title="Show only available applications") @validator("tool_groups") diff --git a/server_addon/blender/server/settings/imageio.py b/server_addon/blender/server/settings/imageio.py index a6d3c5ff64..412d01638f 100644 --- a/server_addon/blender/server/settings/imageio.py +++ b/server_addon/blender/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class BlenderImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/blender/server/settings/main.py b/server_addon/blender/server/settings/main.py index 3d53162e45..aed9b5632d 100644 --- a/server_addon/blender/server/settings/main.py +++ b/server_addon/blender/server/settings/main.py @@ -1,6 +1,6 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, TemplateWorkfileBaseOptions, ) @@ -16,38 +16,38 @@ from .render_settings import ( class UnitScaleSettingsModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - apply_on_opening: bool = Field( + enabled: bool = SettingsField(True, title="Enabled") + apply_on_opening: bool = SettingsField( False, title="Apply on Opening Existing Files") - base_file_unit_scale: float = Field( + base_file_unit_scale: float = SettingsField( 1.0, title="Base File Unit Scale" ) class BlenderSettings(BaseSettingsModel): - unit_scale_settings: UnitScaleSettingsModel = Field( + unit_scale_settings: UnitScaleSettingsModel = SettingsField( default_factory=UnitScaleSettingsModel, title="Set Unit Scale" ) - set_resolution_startup: bool = Field( + set_resolution_startup: bool = SettingsField( True, title="Set Resolution on Startup" ) - set_frames_startup: bool = Field( + set_frames_startup: bool = SettingsField( True, title="Set Start/End Frames and FPS on Startup" ) - imageio: BlenderImageIOModel = Field( + imageio: BlenderImageIOModel = SettingsField( default_factory=BlenderImageIOModel, title="Color Management (ImageIO)" ) - RenderSettings: RenderSettingsModel = Field( + RenderSettings: RenderSettingsModel = SettingsField( default_factory=RenderSettingsModel, title="Render Settings") - workfile_builder: TemplateWorkfileBaseOptions = Field( + workfile_builder: TemplateWorkfileBaseOptions = SettingsField( default_factory=TemplateWorkfileBaseOptions, title="Workfile Builder" ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish Plugins" ) diff --git a/server_addon/blender/server/settings/publish_plugins.py b/server_addon/blender/server/settings/publish_plugins.py index 9a1e0c681e..c2a989dd55 100644 --- a/server_addon/blender/server/settings/publish_plugins.py +++ b/server_addon/blender/server/settings/publish_plugins.py @@ -1,7 +1,7 @@ import json -from pydantic import Field, validator +from pydantic import validator from ayon_server.exceptions import BadRequestException -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField def validate_json_dict(value): @@ -21,36 +21,36 @@ def validate_json_dict(value): class ValidatePluginModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class ValidateFileSavedModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateFileSaved") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - exclude_families: list[str] = Field( + enabled: bool = SettingsField(title="ValidateFileSaved") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + exclude_families: list[str] = SettingsField( default_factory=list, title="Exclude product types" ) class ExtractBlendModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - families: list[str] = Field( + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + families: list[str] = SettingsField( default_factory=list, title="Families" ) class ExtractPlayblastModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - presets: str = Field("", title="Presets", widget="textarea") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + presets: str = SettingsField("", title="Presets", widget="textarea") @validator("presets") def validate_json(cls, value): @@ -58,83 +58,83 @@ class ExtractPlayblastModel(BaseSettingsModel): class PublishPuginsModel(BaseSettingsModel): - ValidateCameraZeroKeyframe: ValidatePluginModel = Field( + ValidateCameraZeroKeyframe: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Camera Zero Keyframe", section="General Validators" ) - ValidateFileSaved: ValidateFileSavedModel = Field( + ValidateFileSaved: ValidateFileSavedModel = SettingsField( default_factory=ValidateFileSavedModel, title="Validate File Saved", ) - ValidateInstanceEmpty: ValidatePluginModel = Field( + ValidateInstanceEmpty: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Instance is not Empty" ) - ValidateMeshHasUvs: ValidatePluginModel = Field( + ValidateMeshHasUvs: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Mesh Has Uvs", section="Model Validators" ) - ValidateMeshNoNegativeScale: ValidatePluginModel = Field( + ValidateMeshNoNegativeScale: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Mesh No Negative Scale" ) - ValidateTransformZero: ValidatePluginModel = Field( + ValidateTransformZero: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Transform Zero" ) - ValidateNoColonsInName: ValidatePluginModel = Field( + ValidateNoColonsInName: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate No Colons In Name" ) - ValidateRenderCameraIsSet: ValidatePluginModel = Field( + ValidateRenderCameraIsSet: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Render Camera Is Set", section="Render Validators" ) - ValidateDeadlinePublish: ValidatePluginModel = Field( + ValidateDeadlinePublish: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Render Output for Deadline", ) - ExtractBlend: ExtractBlendModel = Field( + ExtractBlend: ExtractBlendModel = SettingsField( default_factory=ExtractBlendModel, title="Extract Blend", section="Extractors" ) - ExtractFBX: ValidatePluginModel = Field( + ExtractFBX: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract FBX" ) - ExtractModelABC: ValidatePluginModel = Field( + ExtractModelABC: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract ABC" ) - ExtractBlendAnimation: ValidatePluginModel = Field( + ExtractBlendAnimation: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract Blend Animation" ) - ExtractAnimationFBX: ValidatePluginModel = Field( + ExtractAnimationFBX: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract Animation FBX" ) - ExtractCamera: ValidatePluginModel = Field( + ExtractCamera: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract Camera" ) - ExtractCameraABC: ValidatePluginModel = Field( + ExtractCameraABC: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract Camera as ABC" ) - ExtractLayout: ValidatePluginModel = Field( + ExtractLayout: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Extract Layout (JSON)" ) - ExtractThumbnail: ExtractPlayblastModel = Field( + ExtractThumbnail: ExtractPlayblastModel = SettingsField( default_factory=ExtractPlayblastModel, title="Extract Thumbnail" ) - ExtractPlayblast: ExtractPlayblastModel = Field( + ExtractPlayblast: ExtractPlayblastModel = SettingsField( default_factory=ExtractPlayblastModel, title="Extract Playblast" ) diff --git a/server_addon/blender/server/settings/render_settings.py b/server_addon/blender/server/settings/render_settings.py index f62013982e..f91ba1627a 100644 --- a/server_addon/blender/server/settings/render_settings.py +++ b/server_addon/blender/server/settings/render_settings.py @@ -1,7 +1,5 @@ """Providing models and values for Blender Render Settings.""" -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField def aov_separators_enum(): @@ -58,8 +56,8 @@ class CustomPassesModel(BaseSettingsModel): """Custom Passes""" _layout = "compact" - attribute: str = Field("", title="Attribute name") - value: str = Field( + attribute: str = SettingsField("", title="Attribute name") + value: str = SettingsField( "COLOR", title="Type", enum_resolver=custom_passes_types_enum @@ -67,28 +65,28 @@ class CustomPassesModel(BaseSettingsModel): class RenderSettingsModel(BaseSettingsModel): - default_render_image_folder: str = Field( + default_render_image_folder: str = SettingsField( title="Default Render Image Folder" ) - aov_separator: str = Field( + aov_separator: str = SettingsField( "underscore", title="AOV Separator Character", enum_resolver=aov_separators_enum ) - image_format: str = Field( + image_format: str = SettingsField( "exr", title="Image Format", enum_resolver=image_format_enum ) - multilayer_exr: bool = Field( + multilayer_exr: bool = SettingsField( title="Multilayer (EXR)" ) - aov_list: list[str] = Field( + aov_list: list[str] = SettingsField( default_factory=list, enum_resolver=aov_list_enum, title="AOVs to create" ) - custom_passes: list[CustomPassesModel] = Field( + custom_passes: list[CustomPassesModel] = SettingsField( default_factory=list, title="Custom Passes", description=( diff --git a/server_addon/celaction/server/imageio.py b/server_addon/celaction/server/imageio.py index 72da441528..1e1ac6ff52 100644 --- a/server_addon/celaction/server/imageio.py +++ b/server_addon/celaction/server/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class CelActionImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/celaction/server/settings.py b/server_addon/celaction/server/settings.py index 68d1d2dc31..9208948a07 100644 --- a/server_addon/celaction/server/settings.py +++ b/server_addon/celaction/server/settings.py @@ -1,18 +1,17 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import CelActionImageIOModel class CollectRenderPathModel(BaseSettingsModel): - output_extension: str = Field( + output_extension: str = SettingsField( "", title="Output render file extension" ) - anatomy_template_key_render_files: str = Field( + anatomy_template_key_render_files: str = SettingsField( "", title="Anatomy template key: render files" ) - anatomy_template_key_metadata: str = Field( + anatomy_template_key_metadata: str = SettingsField( "", title="Anatomy template key: metadata job file" ) @@ -36,7 +35,7 @@ def _workfile_submit_overrides(): class WorkfileModel(BaseSettingsModel): - submission_overrides: list[str] = Field( + submission_overrides: list[str] = SettingsField( default_factory=list, title="Submission workfile overrides", enum_resolver=_workfile_submit_overrides @@ -44,21 +43,21 @@ class WorkfileModel(BaseSettingsModel): class PublishPuginsModel(BaseSettingsModel): - CollectRenderPath: CollectRenderPathModel = Field( + CollectRenderPath: CollectRenderPathModel = SettingsField( default_factory=CollectRenderPathModel, title="Collect Render Path" ) class CelActionSettings(BaseSettingsModel): - imageio: CelActionImageIOModel = Field( + imageio: CelActionImageIOModel = SettingsField( default_factory=CelActionImageIOModel, title="Color Management (ImageIO)" ) - workfile: WorkfileModel = Field( + workfile: WorkfileModel = SettingsField( title="Workfile" ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish plugins", ) diff --git a/server_addon/clockify/server/settings.py b/server_addon/clockify/server/settings.py index 9067cd4243..c01d4c1545 100644 --- a/server_addon/clockify/server/settings.py +++ b/server_addon/clockify/server/settings.py @@ -1,9 +1,8 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class ClockifySettings(BaseSettingsModel): - workspace_name: str = Field( + workspace_name: str = SettingsField( "", title="Workspace name", scope=["studio"] diff --git a/server_addon/core/server/settings/main.py b/server_addon/core/server/settings/main.py index f9e572cbf9..1ebfc5a4ca 100644 --- a/server_addon/core/server/settings/main.py +++ b/server_addon/core/server/settings/main.py @@ -1,7 +1,8 @@ import json -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathListModel, ensure_unique_names, task_types_enum, @@ -14,35 +15,35 @@ from .tools import GlobalToolsModel, DEFAULT_TOOLS_VALUES class DiskMappingItemModel(BaseSettingsModel): _layout = "expanded" - source: str = Field("", title="Source") - destination: str = Field("", title="Destination") + source: str = SettingsField("", title="Source") + destination: str = SettingsField("", title="Destination") class DiskMappingModel(BaseSettingsModel): - windows: list[DiskMappingItemModel] = Field( + windows: list[DiskMappingItemModel] = SettingsField( title="Windows", default_factory=list, ) - linux: list[DiskMappingItemModel] = Field( + linux: list[DiskMappingItemModel] = SettingsField( title="Linux", default_factory=list, ) - darwin: list[DiskMappingItemModel] = Field( + darwin: list[DiskMappingItemModel] = SettingsField( title="MacOS", default_factory=list, ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class CoreImageIOFileRulesModel(BaseSettingsModel): - activate_global_file_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_global_file_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -54,19 +55,19 @@ class CoreImageIOFileRulesModel(BaseSettingsModel): class CoreImageIOConfigModel(BaseSettingsModel): - filepath: list[str] = Field(default_factory=list, title="Config path") + filepath: list[str] = SettingsField(default_factory=list, title="Config path") class CoreImageIOBaseModel(BaseSettingsModel): - activate_global_color_management: bool = Field( + activate_global_color_management: bool = SettingsField( False, title="Enable Color Management" ) - ocio_config: CoreImageIOConfigModel = Field( + ocio_config: CoreImageIOConfigModel = SettingsField( default_factory=CoreImageIOConfigModel, title="OCIO config" ) - file_rules: CoreImageIOFileRulesModel = Field( + file_rules: CoreImageIOFileRulesModel = SettingsField( default_factory=CoreImageIOFileRulesModel, title="File Rules" ) @@ -74,28 +75,28 @@ class CoreImageIOBaseModel(BaseSettingsModel): class VersionStartCategoryProfileModel(BaseSettingsModel): _layout = "expanded" - host_names: list[str] = Field( + host_names: list[str] = SettingsField( default_factory=list, title="Host names" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names" ) - version_start: int = Field( + version_start: int = SettingsField( 1, title="Version Start", ge=0 @@ -103,52 +104,52 @@ class VersionStartCategoryProfileModel(BaseSettingsModel): class VersionStartCategoryModel(BaseSettingsModel): - profiles: list[VersionStartCategoryProfileModel] = Field( + profiles: list[VersionStartCategoryProfileModel] = SettingsField( default_factory=list, title="Profiles" ) class CoreSettings(BaseSettingsModel): - studio_name: str = Field("", title="Studio name", scope=["studio"]) - studio_code: str = Field("", title="Studio code", scope=["studio"]) - environments: str = Field( + studio_name: str = SettingsField("", title="Studio name", scope=["studio"]) + studio_code: str = SettingsField("", title="Studio code", scope=["studio"]) + environments: str = SettingsField( "{}", title="Global environment variables", widget="textarea", scope=["studio"], ) - disk_mapping: DiskMappingModel = Field( + disk_mapping: DiskMappingModel = SettingsField( default_factory=DiskMappingModel, title="Disk mapping", ) - tools: GlobalToolsModel = Field( + tools: GlobalToolsModel = SettingsField( default_factory=GlobalToolsModel, title="Tools" ) - version_start_category: VersionStartCategoryModel = Field( + version_start_category: VersionStartCategoryModel = SettingsField( default_factory=VersionStartCategoryModel, title="Version start" ) - imageio: CoreImageIOBaseModel = Field( + imageio: CoreImageIOBaseModel = SettingsField( default_factory=CoreImageIOBaseModel, title="Color Management (ImageIO)" ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish plugins" ) - project_plugins: MultiplatformPathListModel = Field( + project_plugins: MultiplatformPathListModel = SettingsField( default_factory=MultiplatformPathListModel, title="Additional Project Plugin Paths", ) - project_folder_structure: str = Field( + project_folder_structure: str = SettingsField( "{}", widget="textarea", title="Project folder structure", section="---" ) - project_environments: str = Field( + project_environments: str = SettingsField( "{}", widget="textarea", title="Project environments", diff --git a/server_addon/core/server/settings/publish_plugins.py b/server_addon/core/server/settings/publish_plugins.py index 0c9b9c96ef..61e35e02d4 100644 --- a/server_addon/core/server/settings/publish_plugins.py +++ b/server_addon/core/server/settings/publish_plugins.py @@ -1,7 +1,8 @@ -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathModel, normalize_name, ensure_unique_names, @@ -13,46 +14,46 @@ from ayon_server.types import ColorRGBA_uint8 class ValidateBaseModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - optional: bool = Field(True, title="Optional") - active: bool = Field(True, title="Active") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(True, title="Optional") + active: bool = SettingsField(True, title="Active") class CollectAnatomyInstanceDataModel(BaseSettingsModel): _isGroup = True - follow_workfile_version: bool = Field( + follow_workfile_version: bool = SettingsField( True, title="Follow workfile version" ) class CollectAudioModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - audio_product_name: str = Field( + enabled: bool = SettingsField(True) + audio_product_name: str = SettingsField( "", title="Name of audio variant" ) class CollectSceneVersionModel(BaseSettingsModel): _isGroup = True - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Host names" ) - skip_hosts_headless_publish: list[str] = Field( + skip_hosts_headless_publish: list[str] = SettingsField( default_factory=list, title="Skip for host if headless publish" ) class CollectCommentPIModel(BaseSettingsModel): - enabled: bool = Field(True) - families: list[str] = Field(default_factory=list, title="Families") + enabled: bool = SettingsField(True) + families: list[str] = SettingsField(default_factory=list, title="Families") class CollectFramesFixDefModel(BaseSettingsModel): - enabled: bool = Field(True) - rewrite_version_enable: bool = Field( + enabled: bool = SettingsField(True) + rewrite_version_enable: bool = SettingsField( True, title="Show 'Rewrite latest version' toggle" ) @@ -60,15 +61,15 @@ class CollectFramesFixDefModel(BaseSettingsModel): class ValidateIntentProfile(BaseSettingsModel): _layout = "expanded" - hosts: list[str] = Field(default_factory=list, title="Host names") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Host names") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field(default_factory=list, title="Task names") + tasks: list[str] = SettingsField(default_factory=list, title="Task names") # TODO This was 'validate' in v3 - validate_intent: bool = Field(True, title="Validate") + validate_intent: bool = SettingsField(True, title="Validate") class ValidateIntentModel(BaseSettingsModel): @@ -79,16 +80,16 @@ class ValidateIntentModel(BaseSettingsModel): """ _isGroup = True - enabled: bool = Field(False) - profiles: list[ValidateIntentProfile] = Field(default_factory=list) + enabled: bool = SettingsField(False) + profiles: list[ValidateIntentProfile] = SettingsField(default_factory=list) class ExtractThumbnailFFmpegModel(BaseSettingsModel): - input: list[str] = Field( + input: list[str] = SettingsField( default_factory=list, title="FFmpeg input arguments" ) - output: list[str] = Field( + output: list[str] = SettingsField( default_factory=list, title="FFmpeg input arguments" ) @@ -96,7 +97,7 @@ class ExtractThumbnailFFmpegModel(BaseSettingsModel): class ResizeItemModel(BaseSettingsModel): _layout = "expanded" - width: int = Field( + width: int = SettingsField( 1920, ge=0, le=100000, @@ -104,7 +105,7 @@ class ResizeItemModel(BaseSettingsModel): description="Width and Height must be both set to higher value than 0" " else source resolution is used." ) - height: int = Field( + height: int = SettingsField( 1080, title="Height", ge=0, @@ -121,7 +122,7 @@ _resize_types_enum = [ class ResizeModel(BaseSettingsModel): _layout = "expanded" - type: str = Field( + type: str = SettingsField( title="Type", description="Type of resizing", enum_resolver=lambda: _resize_types_enum, @@ -129,7 +130,7 @@ class ResizeModel(BaseSettingsModel): default="source" ) - resize: ResizeItemModel = Field( + resize: ResizeItemModel = SettingsField( default_factory=ResizeItemModel, title="Resize" ) @@ -143,18 +144,18 @@ _thumbnail_oiio_transcoding_type = [ class DisplayAndViewModel(BaseSettingsModel): _layout = "expanded" - display: str = Field( + display: str = SettingsField( "default", title="Display" ) - view: str = Field( + view: str = SettingsField( "sRGB", title="View" ) class ExtractThumbnailOIIODefaultsModel(BaseSettingsModel): - type: str = Field( + type: str = SettingsField( title="Type", description="Transcoding type", enum_resolver=lambda: _thumbnail_oiio_transcoding_type, @@ -162,11 +163,11 @@ class ExtractThumbnailOIIODefaultsModel(BaseSettingsModel): default="colorspace" ) - colorspace: str = Field( + colorspace: str = SettingsField( "", title="Colorspace" ) - display_and_view: DisplayAndViewModel = Field( + display_and_view: DisplayAndViewModel = SettingsField( default_factory=DisplayAndViewModel, title="Display&View" ) @@ -174,30 +175,30 @@ class ExtractThumbnailOIIODefaultsModel(BaseSettingsModel): class ExtractThumbnailModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - integrate_thumbnail: bool = Field( + enabled: bool = SettingsField(True) + integrate_thumbnail: bool = SettingsField( True, title="Integrate Thumbnail Representation" ) - target_size: ResizeModel = Field( + target_size: ResizeModel = SettingsField( default_factory=ResizeModel, title="Target size" ) - background_color: ColorRGBA_uint8 = Field( + background_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 0.0), title="Background color" ) - duration_split: float = Field( + duration_split: float = SettingsField( 0.5, title="Duration split", ge=0.0, le=1.0 ) - oiiotool_defaults: ExtractThumbnailOIIODefaultsModel = Field( + oiiotool_defaults: ExtractThumbnailOIIODefaultsModel = SettingsField( default_factory=ExtractThumbnailOIIODefaultsModel, title="OIIOtool defaults" ) - ffmpeg_args: ExtractThumbnailFFmpegModel = Field( + ffmpeg_args: ExtractThumbnailFFmpegModel = SettingsField( default_factory=ExtractThumbnailFFmpegModel ) @@ -210,57 +211,57 @@ def _extract_oiio_transcoding_type(): class OIIOToolArgumentsModel(BaseSettingsModel): - additional_command_args: list[str] = Field( + additional_command_args: list[str] = SettingsField( default_factory=list, title="Arguments") class ExtractOIIOTranscodeOutputModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Name") - extension: str = Field("", title="Extension") - transcoding_type: str = Field( + name: str = SettingsField("", title="Name") + extension: str = SettingsField("", title="Extension") + transcoding_type: str = SettingsField( "colorspace", title="Transcoding type", enum_resolver=_extract_oiio_transcoding_type ) - colorspace: str = Field("", title="Colorspace") - display: str = Field("", title="Display") - view: str = Field("", title="View") - oiiotool_args: OIIOToolArgumentsModel = Field( + colorspace: str = SettingsField("", title="Colorspace") + display: str = SettingsField("", title="Display") + view: str = SettingsField("", title="View") + oiiotool_args: OIIOToolArgumentsModel = SettingsField( default_factory=OIIOToolArgumentsModel, title="OIIOtool arguments") - tags: list[str] = Field(default_factory=list, title="Tags") - custom_tags: list[str] = Field(default_factory=list, title="Custom Tags") + tags: list[str] = SettingsField(default_factory=list, title="Tags") + custom_tags: list[str] = SettingsField(default_factory=list, title="Custom Tags") class ExtractOIIOTranscodeProfileModel(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Host names" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names" ) - delete_original: bool = Field( + delete_original: bool = SettingsField( True, title="Delete Original Representation" ) - outputs: list[ExtractOIIOTranscodeOutputModel] = Field( + outputs: list[ExtractOIIOTranscodeOutputModel] = SettingsField( default_factory=list, title="Output Definitions", ) @@ -272,27 +273,27 @@ class ExtractOIIOTranscodeProfileModel(BaseSettingsModel): class ExtractOIIOTranscodeModel(BaseSettingsModel): - enabled: bool = Field(True) - profiles: list[ExtractOIIOTranscodeProfileModel] = Field( + enabled: bool = SettingsField(True) + profiles: list[ExtractOIIOTranscodeProfileModel] = SettingsField( default_factory=list, title="Profiles" ) # --- [START] Extract Review --- class ExtractReviewFFmpegModel(BaseSettingsModel): - video_filters: list[str] = Field( + video_filters: list[str] = SettingsField( default_factory=list, title="Video filters" ) - audio_filters: list[str] = Field( + audio_filters: list[str] = SettingsField( default_factory=list, title="Audio filters" ) - input: list[str] = Field( + input: list[str] = SettingsField( default_factory=list, title="Input arguments" ) - output: list[str] = Field( + output: list[str] = SettingsField( default_factory=list, title="Output arguments" ) @@ -316,11 +317,11 @@ def extract_review_filter_enum(): class ExtractReviewFilterModel(BaseSettingsModel): - families: list[str] = Field(default_factory=list, title="Families") - product_names: list[str] = Field( + families: list[str] = SettingsField(default_factory=list, title="Families") + product_names: list[str] = SettingsField( default_factory=list, title="Product names") - custom_tags: list[str] = Field(default_factory=list, title="Custom Tags") - single_frame_filter: str = Field( + custom_tags: list[str] = SettingsField(default_factory=list, title="Custom Tags") + single_frame_filter: str = SettingsField( "everytime", description=( "Use output always / only if input is 1 frame" @@ -331,24 +332,24 @@ class ExtractReviewFilterModel(BaseSettingsModel): class ExtractReviewLetterBox(BaseSettingsModel): - enabled: bool = Field(True) - ratio: float = Field( + enabled: bool = SettingsField(True) + ratio: float = SettingsField( 0.0, title="Ratio", ge=0.0, le=10000.0 ) - fill_color: ColorRGBA_uint8 = Field( + fill_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 0.0), title="Fill Color" ) - line_thickness: int = Field( + line_thickness: int = SettingsField( 0, title="Line Thickness", ge=0, le=1000 ) - line_color: ColorRGBA_uint8 = Field( + line_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 0.0), title="Line Color" ) @@ -356,29 +357,29 @@ class ExtractReviewLetterBox(BaseSettingsModel): class ExtractReviewOutputDefModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Name") - ext: str = Field("", title="Output extension") + name: str = SettingsField("", title="Name") + ext: str = SettingsField("", title="Output extension") # TODO use some different source of tags - tags: list[str] = Field(default_factory=list, title="Tags") - burnins: list[str] = Field( + tags: list[str] = SettingsField(default_factory=list, title="Tags") + burnins: list[str] = SettingsField( default_factory=list, title="Link to a burnin by name" ) - ffmpeg_args: ExtractReviewFFmpegModel = Field( + ffmpeg_args: ExtractReviewFFmpegModel = SettingsField( default_factory=ExtractReviewFFmpegModel, title="FFmpeg arguments" ) - filter: ExtractReviewFilterModel = Field( + filter: ExtractReviewFilterModel = SettingsField( default_factory=ExtractReviewFilterModel, title="Additional output filtering" ) - overscan_crop: str = Field( + overscan_crop: str = SettingsField( "", title="Overscan crop", description=( "Crop input overscan. See the documentation for more information." ) ) - overscan_color: ColorRGBA_uint8 = Field( + overscan_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 0.0), title="Overscan color", description=( @@ -386,7 +387,7 @@ class ExtractReviewOutputDefModel(BaseSettingsModel): " same as output aspect ratio." ) ) - width: int = Field( + width: int = SettingsField( 0, ge=0, le=100000, @@ -396,13 +397,13 @@ class ExtractReviewOutputDefModel(BaseSettingsModel): " value than 0 else source resolution is used." ) ) - height: int = Field( + height: int = SettingsField( 0, title="Output height", ge=0, le=100000, ) - scale_pixel_aspect: bool = Field( + scale_pixel_aspect: bool = SettingsField( True, title="Scale pixel aspect", description=( @@ -410,7 +411,7 @@ class ExtractReviewOutputDefModel(BaseSettingsModel): " Usefull for anamorph reviews." ) ) - bg_color: ColorRGBA_uint8 = Field( + bg_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 0.0), description=( "Background color is used only when input have transparency" @@ -418,7 +419,7 @@ class ExtractReviewOutputDefModel(BaseSettingsModel): ), title="Background color", ) - letter_box: ExtractReviewLetterBox = Field( + letter_box: ExtractReviewLetterBox = SettingsField( default_factory=ExtractReviewLetterBox, title="Letter Box" ) @@ -431,14 +432,14 @@ class ExtractReviewOutputDefModel(BaseSettingsModel): class ExtractReviewProfileModel(BaseSettingsModel): _layout = "expanded" - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) # TODO use hosts enum - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Host names" ) - outputs: list[ExtractReviewOutputDefModel] = Field( + outputs: list[ExtractReviewOutputDefModel] = SettingsField( default_factory=list, title="Output Definitions" ) @@ -450,8 +451,8 @@ class ExtractReviewProfileModel(BaseSettingsModel): class ExtractReviewModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - profiles: list[ExtractReviewProfileModel] = Field( + enabled: bool = SettingsField(True) + profiles: list[ExtractReviewProfileModel] = SettingsField( default_factory=list, title="Profiles" ) @@ -460,30 +461,30 @@ class ExtractReviewModel(BaseSettingsModel): # --- [Start] Extract Burnin --- class ExtractBurninOptionsModel(BaseSettingsModel): - font_size: int = Field(0, ge=0, title="Font size") - font_color: ColorRGBA_uint8 = Field( + font_size: int = SettingsField(0, ge=0, title="Font size") + font_color: ColorRGBA_uint8 = SettingsField( (255, 255, 255, 1.0), title="Font color" ) - bg_color: ColorRGBA_uint8 = Field( + bg_color: ColorRGBA_uint8 = SettingsField( (0, 0, 0, 1.0), title="Background color" ) - x_offset: int = Field(0, title="X Offset") - y_offset: int = Field(0, title="Y Offset") - bg_padding: int = Field(0, title="Padding around text") - font_filepath: MultiplatformPathModel = Field( + x_offset: int = SettingsField(0, title="X Offset") + y_offset: int = SettingsField(0, title="Y Offset") + bg_padding: int = SettingsField(0, title="Padding around text") + font_filepath: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Font file path" ) class ExtractBurninDefFilter(BaseSettingsModel): - families: list[str] = Field( + families: list[str] = SettingsField( default_factory=list, title="Families" ) - tags: list[str] = Field( + tags: list[str] = SettingsField( default_factory=list, title="Tags" ) @@ -492,14 +493,14 @@ class ExtractBurninDefFilter(BaseSettingsModel): class ExtractBurninDef(BaseSettingsModel): _isGroup = True _layout = "expanded" - name: str = Field("") - TOP_LEFT: str = Field("", topic="Top Left") - TOP_CENTERED: str = Field("", topic="Top Centered") - TOP_RIGHT: str = Field("", topic="Top Right") - BOTTOM_LEFT: str = Field("", topic="Bottom Left") - BOTTOM_CENTERED: str = Field("", topic="Bottom Centered") - BOTTOM_RIGHT: str = Field("", topic="Bottom Right") - filter: ExtractBurninDefFilter = Field( + name: str = SettingsField("") + TOP_LEFT: str = SettingsField("", topic="Top Left") + TOP_CENTERED: str = SettingsField("", topic="Top Centered") + TOP_RIGHT: str = SettingsField("", topic="Top Right") + BOTTOM_LEFT: str = SettingsField("", topic="Bottom Left") + BOTTOM_CENTERED: str = SettingsField("", topic="Bottom Centered") + BOTTOM_RIGHT: str = SettingsField("", topic="Bottom Right") + filter: ExtractBurninDefFilter = SettingsField( default_factory=ExtractBurninDefFilter, title="Additional filtering" ) @@ -512,28 +513,28 @@ class ExtractBurninDef(BaseSettingsModel): class ExtractBurninProfile(BaseSettingsModel): _layout = "expanded" - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Produt types" ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Host names" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names" ) - burnins: list[ExtractBurninDef] = Field( + burnins: list[ExtractBurninDef] = SettingsField( default_factory=list, title="Burnins" ) @@ -547,12 +548,12 @@ class ExtractBurninProfile(BaseSettingsModel): class ExtractBurninModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - options: ExtractBurninOptionsModel = Field( + enabled: bool = SettingsField(True) + options: ExtractBurninOptionsModel = SettingsField( default_factory=ExtractBurninOptionsModel, title="Burnin formatting options" ) - profiles: list[ExtractBurninProfile] = Field( + profiles: list[ExtractBurninProfile] = SettingsField( default_factory=list, title="Profiles" ) @@ -561,24 +562,24 @@ class ExtractBurninModel(BaseSettingsModel): class PreIntegrateThumbnailsProfile(BaseSettingsModel): _isGroup = True - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types", ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Hosts", ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names", ) - integrate_thumbnail: bool = Field(True) + integrate_thumbnail: bool = SettingsField(True) class PreIntegrateThumbnailsModel(BaseSettingsModel): @@ -589,26 +590,26 @@ class PreIntegrateThumbnailsModel(BaseSettingsModel): """ _isGroup = True - enabled: bool = Field(True) - integrate_profiles: list[PreIntegrateThumbnailsProfile] = Field( + enabled: bool = SettingsField(True) + integrate_profiles: list[PreIntegrateThumbnailsProfile] = SettingsField( default_factory=list, title="Integrate profiles" ) class IntegrateProductGroupProfile(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field(default_factory=list, title="Task names") - template: str = Field("", title="Template") + tasks: list[str] = SettingsField(default_factory=list, title="Task names") + template: str = SettingsField("", title="Template") class IntegrateProductGroupModel(BaseSettingsModel): @@ -622,163 +623,163 @@ class IntegrateProductGroupModel(BaseSettingsModel): """ _isGroup = True - product_grouping_profiles: list[IntegrateProductGroupProfile] = Field( + product_grouping_profiles: list[IntegrateProductGroupProfile] = SettingsField( default_factory=list, title="Product group profiles" ) class IntegrateANProductGroupProfileModel(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Hosts" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field( + tasks: list[str] = SettingsField( default_factory=list, title="Task names" ) - template: str = Field("", title="Template") + template: str = SettingsField("", title="Template") class IntegrateANTemplateNameProfileModel(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Hosts" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field( + tasks: list[str] = SettingsField( default_factory=list, title="Task names" ) - template_name: str = Field("", title="Template name") + template_name: str = SettingsField("", title="Template name") class IntegrateHeroTemplateNameProfileModel(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field( + hosts: list[str] = SettingsField( default_factory=list, title="Hosts" ) - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - template_name: str = Field("", title="Template name") + template_name: str = SettingsField("", title="Template name") class IntegrateHeroVersionModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") - families: list[str] = Field(default_factory=list, title="Families") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") + families: list[str] = SettingsField(default_factory=list, title="Families") class CleanUpModel(BaseSettingsModel): _isGroup = True - paterns: list[str] = Field( + paterns: list[str] = SettingsField( default_factory=list, title="Patterns (regex)" ) - remove_temp_renders: bool = Field(False, title="Remove Temp renders") + remove_temp_renders: bool = SettingsField(False, title="Remove Temp renders") class CleanUpFarmModel(BaseSettingsModel): _isGroup = True - enabled: bool = Field(True) + enabled: bool = SettingsField(True) class PublishPuginsModel(BaseSettingsModel): - CollectAnatomyInstanceData: CollectAnatomyInstanceDataModel = Field( + CollectAnatomyInstanceData: CollectAnatomyInstanceDataModel = SettingsField( default_factory=CollectAnatomyInstanceDataModel, title="Collect Anatomy Instance Data" ) - CollectAudio: CollectAudioModel = Field( + CollectAudio: CollectAudioModel = SettingsField( default_factory=CollectAudioModel, title="Collect Audio" ) - CollectSceneVersion: CollectSceneVersionModel = Field( + CollectSceneVersion: CollectSceneVersionModel = SettingsField( default_factory=CollectSceneVersionModel, title="Collect Version from Workfile" ) - collect_comment_per_instance: CollectCommentPIModel = Field( + collect_comment_per_instance: CollectCommentPIModel = SettingsField( default_factory=CollectCommentPIModel, title="Collect comment per instance", ) - CollectFramesFixDef: CollectFramesFixDefModel = Field( + CollectFramesFixDef: CollectFramesFixDefModel = SettingsField( default_factory=CollectFramesFixDefModel, title="Collect Frames to Fix", ) - ValidateEditorialAssetName: ValidateBaseModel = Field( + ValidateEditorialAssetName: ValidateBaseModel = SettingsField( default_factory=ValidateBaseModel, title="Validate Editorial Asset Name" ) - ValidateVersion: ValidateBaseModel = Field( + ValidateVersion: ValidateBaseModel = SettingsField( default_factory=ValidateBaseModel, title="Validate Version" ) - ValidateIntent: ValidateIntentModel = Field( + ValidateIntent: ValidateIntentModel = SettingsField( default_factory=ValidateIntentModel, title="Validate Intent" ) - ExtractThumbnail: ExtractThumbnailModel = Field( + ExtractThumbnail: ExtractThumbnailModel = SettingsField( default_factory=ExtractThumbnailModel, title="Extract Thumbnail" ) - ExtractOIIOTranscode: ExtractOIIOTranscodeModel = Field( + ExtractOIIOTranscode: ExtractOIIOTranscodeModel = SettingsField( default_factory=ExtractOIIOTranscodeModel, title="Extract OIIO Transcode" ) - ExtractReview: ExtractReviewModel = Field( + ExtractReview: ExtractReviewModel = SettingsField( default_factory=ExtractReviewModel, title="Extract Review" ) - ExtractBurnin: ExtractBurninModel = Field( + ExtractBurnin: ExtractBurninModel = SettingsField( default_factory=ExtractBurninModel, title="Extract Burnin" ) - PreIntegrateThumbnails: PreIntegrateThumbnailsModel = Field( + PreIntegrateThumbnails: PreIntegrateThumbnailsModel = SettingsField( default_factory=PreIntegrateThumbnailsModel, title="Override Integrate Thumbnail Representations" ) - IntegrateProductGroup: IntegrateProductGroupModel = Field( + IntegrateProductGroup: IntegrateProductGroupModel = SettingsField( default_factory=IntegrateProductGroupModel, title="Integrate Product Group" ) - IntegrateHeroVersion: IntegrateHeroVersionModel = Field( + IntegrateHeroVersion: IntegrateHeroVersionModel = SettingsField( default_factory=IntegrateHeroVersionModel, title="Integrate Hero Version" ) - CleanUp: CleanUpModel = Field( + CleanUp: CleanUpModel = SettingsField( default_factory=CleanUpModel, title="Clean Up" ) - CleanUpFarm: CleanUpFarmModel = Field( + CleanUpFarm: CleanUpFarmModel = SettingsField( default_factory=CleanUpFarmModel, title="Clean Up Farm" ) diff --git a/server_addon/core/server/settings/tools.py b/server_addon/core/server/settings/tools.py index 0dd9d396ae..b45f9b49d4 100644 --- a/server_addon/core/server/settings/tools.py +++ b/server_addon/core/server/settings/tools.py @@ -1,6 +1,7 @@ -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, normalize_name, ensure_unique_names, task_types_enum, @@ -9,8 +10,10 @@ from ayon_server.settings import ( class ProductTypeSmartSelectModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Product type") - task_names: list[str] = Field(default_factory=list, title="Task names") + name: str = SettingsField("", title="Product type") + task_names: list[str] = SettingsField( + default_factory=list, title="Task names" + ) @validator("name") def normalize_value(cls, value): @@ -19,26 +22,28 @@ class ProductTypeSmartSelectModel(BaseSettingsModel): class ProductNameProfile(BaseSettingsModel): _layout = "expanded" - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field(default_factory=list, title="Task names") - template: str = Field("", title="Template") + tasks: list[str] = SettingsField(default_factory=list, title="Task names") + template: str = SettingsField("", title="Template") class CreatorToolModel(BaseSettingsModel): # TODO this was dynamic dictionary '{name: task_names}' - product_types_smart_select: list[ProductTypeSmartSelectModel] = Field( - default_factory=list, - title="Create Smart Select" + product_types_smart_select: list[ProductTypeSmartSelectModel] = ( + SettingsField( + default_factory=list, + title="Create Smart Select" + ) ) - product_name_profiles: list[ProductNameProfile] = Field( + product_name_profiles: list[ProductNameProfile] = SettingsField( default_factory=list, title="Product name profiles" ) @@ -51,29 +56,29 @@ class CreatorToolModel(BaseSettingsModel): class WorkfileTemplateProfile(BaseSettingsModel): _layout = "expanded" - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") # TODO this was using project anatomy template name - workfile_template: str = Field("", title="Workfile template") + workfile_template: str = SettingsField("", title="Workfile template") class LastWorkfileOnStartupProfile(BaseSettingsModel): _layout = "expanded" # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field(default_factory=list, title="Task names") - enabled: bool = Field(True, title="Enabled") - use_last_published_workfile: bool = Field( + tasks: list[str] = SettingsField(default_factory=list, title="Task names") + enabled: bool = SettingsField(True, title="Enabled") + use_last_published_workfile: bool = SettingsField( True, title="Use last published workfile" ) @@ -81,54 +86,60 @@ class LastWorkfileOnStartupProfile(BaseSettingsModel): class WorkfilesToolOnStartupProfile(BaseSettingsModel): _layout = "expanded" # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field(default_factory=list, title="Task names") - enabled: bool = Field(True, title="Enabled") + tasks: list[str] = SettingsField(default_factory=list, title="Task names") + enabled: bool = SettingsField(True, title="Enabled") class ExtraWorkFoldersProfile(BaseSettingsModel): _layout = "expanded" # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field(default_factory=list, title="Task names") - folders: list[str] = Field(default_factory=list, title="Folders") + task_names: list[str] = SettingsField( + default_factory=list, title="Task names" + ) + folders: list[str] = SettingsField(default_factory=list, title="Folders") class WorkfilesLockProfile(BaseSettingsModel): _layout = "expanded" # TODO this should use hosts enum - host_names: list[str] = Field(default_factory=list, title="Hosts") - enabled: bool = Field(True, title="Enabled") + host_names: list[str] = SettingsField(default_factory=list, title="Hosts") + enabled: bool = SettingsField(True, title="Enabled") class WorkfilesToolModel(BaseSettingsModel): - workfile_template_profiles: list[WorkfileTemplateProfile] = Field( + workfile_template_profiles: list[WorkfileTemplateProfile] = SettingsField( default_factory=list, title="Workfile template profiles" ) - last_workfile_on_startup: list[LastWorkfileOnStartupProfile] = Field( - default_factory=list, - title="Open last workfile on launch" + last_workfile_on_startup: list[LastWorkfileOnStartupProfile] = ( + SettingsField( + default_factory=list, + title="Open last workfile on launch" + ) ) - open_workfile_tool_on_startup: list[WorkfilesToolOnStartupProfile] = Field( - default_factory=list, - title="Open workfile tool on launch" + open_workfile_tool_on_startup: list[WorkfilesToolOnStartupProfile] = ( + SettingsField( + default_factory=list, + title="Open workfile tool on launch" + ) ) - extra_folders: list[ExtraWorkFoldersProfile] = Field( + extra_folders: list[ExtraWorkFoldersProfile] = SettingsField( default_factory=list, title="Extra work folders" ) - workfile_lock_profiles: list[WorkfilesLockProfile] = Field( + workfile_lock_profiles: list[WorkfilesLockProfile] = SettingsField( default_factory=list, title="Workfile lock profiles" ) @@ -175,95 +186,100 @@ def _product_types_enum(): class LoaderProductTypeFilterProfile(BaseSettingsModel): _layout = "expanded" # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - is_include: bool = Field(True, title="Exclude / Include") - filter_product_types: list[str] = Field( + is_include: bool = SettingsField(True, title="Exclude / Include") + filter_product_types: list[str] = SettingsField( default_factory=list, enum_resolver=_product_types_enum ) class LoaderToolModel(BaseSettingsModel): - product_type_filter_profiles: list[LoaderProductTypeFilterProfile] = Field( - default_factory=list, - title="Product type filtering" + product_type_filter_profiles: list[LoaderProductTypeFilterProfile] = ( + SettingsField(default_factory=list, title="Product type filtering") ) class PublishTemplateNameProfile(BaseSettingsModel): _layout = "expanded" - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) # TODO this should use hosts enum - hosts: list[str] = Field(default_factory=list, title="Hosts") - task_types: list[str] = Field( + hosts: list[str] = SettingsField(default_factory=list, title="Hosts") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field(default_factory=list, title="Task names") - template_name: str = Field("", title="Template name") + task_names: list[str] = SettingsField( + default_factory=list, title="Task names" + ) + template_name: str = SettingsField("", title="Template name") class CustomStagingDirProfileModel(BaseSettingsModel): - active: bool = Field(True, title="Is active") - hosts: list[str] = Field(default_factory=list, title="Host names") - task_types: list[str] = Field( + active: bool = SettingsField(True, title="Is active") + hosts: list[str] = SettingsField(default_factory=list, title="Host names") + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names" ) - custom_staging_dir_persistent: bool = Field( + custom_staging_dir_persistent: bool = SettingsField( False, title="Custom Staging Folder Persistent" ) - template_name: str = Field("", title="Template Name") + template_name: str = SettingsField("", title="Template Name") class PublishToolModel(BaseSettingsModel): - template_name_profiles: list[PublishTemplateNameProfile] = Field( + template_name_profiles: list[PublishTemplateNameProfile] = SettingsField( default_factory=list, title="Template name profiles" ) - hero_template_name_profiles: list[PublishTemplateNameProfile] = Field( - default_factory=list, - title="Hero template name profiles" + hero_template_name_profiles: list[PublishTemplateNameProfile] = ( + SettingsField( + default_factory=list, + title="Hero template name profiles" + ) ) - custom_staging_dir_profiles: list[CustomStagingDirProfileModel] = Field( - default_factory=list, - title="Custom Staging Dir Profiles" + custom_staging_dir_profiles: list[CustomStagingDirProfileModel] = ( + SettingsField( + default_factory=list, + title="Custom Staging Dir Profiles" + ) ) class GlobalToolsModel(BaseSettingsModel): - creator: CreatorToolModel = Field( + creator: CreatorToolModel = SettingsField( default_factory=CreatorToolModel, title="Creator" ) - Workfiles: WorkfilesToolModel = Field( + Workfiles: WorkfilesToolModel = SettingsField( default_factory=WorkfilesToolModel, title="Workfiles" ) - loader: LoaderToolModel = Field( + loader: LoaderToolModel = SettingsField( default_factory=LoaderToolModel, title="Loader" ) - publish: PublishToolModel = Field( + publish: PublishToolModel = SettingsField( default_factory=PublishToolModel, title="Publish" ) diff --git a/server_addon/deadline/server/settings/main.py b/server_addon/deadline/server/settings/main.py index f766ef9db8..9537d6d550 100644 --- a/server_addon/deadline/server/settings/main.py +++ b/server_addon/deadline/server/settings/main.py @@ -1,6 +1,10 @@ -from pydantic import Field, validator +from pydantic import validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) from .publish_plugins import ( PublishPluginsModel, @@ -10,8 +14,8 @@ from .publish_plugins import ( class ServerListSubmodel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: str = Field(title="Value") + name: str = SettingsField(title="Name") + value: str = SettingsField(title="Value") async def defined_deadline_ws_name_enum_resolver( @@ -33,18 +37,18 @@ async def defined_deadline_ws_name_enum_resolver( class DeadlineSettings(BaseSettingsModel): - deadline_urls: list[ServerListSubmodel] = Field( + deadline_urls: list[ServerListSubmodel] = SettingsField( default_factory=list, title="System Deadline Webservice URLs", scope=["studio"], ) - deadline_server: str = Field( + deadline_server: str = SettingsField( title="Project deadline server", section="---", scope=["project"], enum_resolver=defined_deadline_ws_name_enum_resolver ) - publish: PublishPluginsModel = Field( + publish: PublishPluginsModel = SettingsField( default_factory=PublishPluginsModel, title="Publish Plugins", ) diff --git a/server_addon/deadline/server/settings/publish_plugins.py b/server_addon/deadline/server/settings/publish_plugins.py index dc2cd7591f..8abe59674b 100644 --- a/server_addon/deadline/server/settings/publish_plugins.py +++ b/server_addon/deadline/server/settings/publish_plugins.py @@ -1,26 +1,30 @@ -from pydantic import Field, validator +from pydantic import validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) class CollectDeadlinePoolsModel(BaseSettingsModel): """Settings Deadline default pools.""" - primary_pool: str = Field(title="Primary Pool") + primary_pool: str = SettingsField(title="Primary Pool") - secondary_pool: str = Field(title="Secondary Pool") + secondary_pool: str = SettingsField(title="Secondary Pool") class ValidateExpectedFilesModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - active: bool = Field(True, title="Active") - allow_user_override: bool = Field( + enabled: bool = SettingsField(True, title="Enabled") + active: bool = SettingsField(True, title="Active") + allow_user_override: bool = SettingsField( True, title="Allow user change frame range" ) - families: list[str] = Field( + families: list[str] = SettingsField( default_factory=list, title="Trigger on families" ) - targets: list[str] = Field( + targets: list[str] = SettingsField( default_factory=list, title="Trigger for plugins" ) @@ -45,45 +49,47 @@ def tile_assembler_enum(): class ScenePatchesSubmodel(BaseSettingsModel): _layout = "expanded" - name: str = Field(title="Patch name") - regex: str = Field(title="Patch regex") - line: str = Field(title="Patch line") + name: str = SettingsField(title="Patch name") + regex: str = SettingsField(title="Patch regex") + line: str = SettingsField(title="Patch line") class MayaSubmitDeadlineModel(BaseSettingsModel): """Maya deadline submitter settings.""" - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - use_published: bool = Field(title="Use Published scene") - import_reference: bool = Field(title="Use Scene with Imported Reference") - asset_dependencies: bool = Field(title="Use Asset dependencies") - priority: int = Field(title="Priority") - tile_priority: int = Field(title="Tile Priority") - group: str = Field(title="Group") - limit: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + use_published: bool = SettingsField(title="Use Published scene") + import_reference: bool = SettingsField( + title="Use Scene with Imported Reference" + ) + asset_dependencies: bool = SettingsField(title="Use Asset dependencies") + priority: int = SettingsField(title="Priority") + tile_priority: int = SettingsField(title="Tile Priority") + group: str = SettingsField(title="Group") + limit: list[str] = SettingsField( default_factory=list, title="Limit Groups" ) - tile_assembler_plugin: str = Field( + tile_assembler_plugin: str = SettingsField( title="Tile Assembler Plugin", enum_resolver=tile_assembler_enum, ) - jobInfo: str = Field( + jobInfo: str = SettingsField( title="Additional JobInfo data", widget="textarea", ) - pluginInfo: str = Field( + pluginInfo: str = SettingsField( title="Additional PluginInfo data", widget="textarea", ) - scene_patches: list[ScenePatchesSubmodel] = Field( + scene_patches: list[ScenePatchesSubmodel] = SettingsField( default_factory=list, title="Scene patches", ) - strict_error_checking: bool = Field( + strict_error_checking: bool = SettingsField( title="Disable Strict Error Check profiles" ) @@ -94,25 +100,25 @@ class MayaSubmitDeadlineModel(BaseSettingsModel): class MaxSubmitDeadlineModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - use_published: bool = Field(title="Use Published scene") - priority: int = Field(title="Priority") - chunk_size: int = Field(title="Frame per Task") - group: str = Field("", title="Group Name") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + use_published: bool = SettingsField(title="Use Published scene") + priority: int = SettingsField(title="Priority") + chunk_size: int = SettingsField(title="Frame per Task") + group: str = SettingsField("", title="Group Name") class EnvSearchReplaceSubmodel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: str = Field(title="Value") + name: str = SettingsField(title="Name") + value: str = SettingsField(title="Value") class LimitGroupsSubmodel(BaseSettingsModel): _layout = "expanded" - name: str = Field(title="Name") - value: list[str] = Field( + name: str = SettingsField(title="Name") + value: list[str] = SettingsField( default_factory=list, title="Limit Groups" ) @@ -137,14 +143,16 @@ def fusion_deadline_plugin_enum(): class FusionSubmitDeadlineModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") - priority: int = Field(50, title="Priority") - chunk_size: int = Field(10, title="Frame per Task") - concurrent_tasks: int = Field(1, title="Number of concurrent tasks") - group: str = Field("", title="Group Name") - plugin: str = Field("Fusion", + enabled: bool = SettingsField(True, title="Enabled") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") + priority: int = SettingsField(50, title="Priority") + chunk_size: int = SettingsField(10, title="Frame per Task") + concurrent_tasks: int = SettingsField( + 1, title="Number of concurrent tasks" + ) + group: str = SettingsField("", title="Group Name") + plugin: str = SettingsField("Fusion", enum_resolver=fusion_deadline_plugin_enum, title="Deadline Plugin") @@ -152,34 +160,39 @@ class FusionSubmitDeadlineModel(BaseSettingsModel): class NukeSubmitDeadlineModel(BaseSettingsModel): """Nuke deadline submitter settings.""" - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - priority: int = Field(title="Priority") - chunk_size: int = Field(title="Chunk Size") - concurrent_tasks: int = Field(title="Number of concurrent tasks") - group: str = Field(title="Group") - department: str = Field(title="Department") - use_gpu: bool = Field(title="Use GPU") - workfile_dependency: bool = Field(title="Workfile Dependency") - use_published_workfile: bool = Field(title="Use Published Workfile") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + priority: int = SettingsField(title="Priority") + chunk_size: int = SettingsField(title="Chunk Size") + concurrent_tasks: int = SettingsField(title="Number of concurrent tasks") + group: str = SettingsField(title="Group") + department: str = SettingsField(title="Department") + use_gpu: bool = SettingsField(title="Use GPU") + workfile_dependency: bool = SettingsField(title="Workfile Dependency") + use_published_workfile: bool = SettingsField( + title="Use Published Workfile" + ) - env_allowed_keys: list[str] = Field( + env_allowed_keys: list[str] = SettingsField( default_factory=list, title="Allowed environment keys" ) - env_search_replace_values: list[EnvSearchReplaceSubmodel] = Field( + env_search_replace_values: list[EnvSearchReplaceSubmodel] = SettingsField( default_factory=list, title="Search & replace in environment values", ) - limit_groups: list[LimitGroupsSubmodel] = Field( + limit_groups: list[LimitGroupsSubmodel] = SettingsField( default_factory=list, title="Limit Groups", ) - @validator("limit_groups", "env_allowed_keys", "env_search_replace_values") + @validator( + "limit_groups", + "env_allowed_keys", + "env_search_replace_values") def validate_unique_names(cls, value): ensure_unique_names(value) return value @@ -188,58 +201,62 @@ class NukeSubmitDeadlineModel(BaseSettingsModel): class HarmonySubmitDeadlineModel(BaseSettingsModel): """Harmony deadline submitter settings.""" - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - use_published: bool = Field(title="Use Published scene") - priority: int = Field(title="Priority") - chunk_size: int = Field(title="Chunk Size") - group: str = Field(title="Group") - department: str = Field(title="Department") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + use_published: bool = SettingsField(title="Use Published scene") + priority: int = SettingsField(title="Priority") + chunk_size: int = SettingsField(title="Chunk Size") + group: str = SettingsField(title="Group") + department: str = SettingsField(title="Department") class AfterEffectsSubmitDeadlineModel(BaseSettingsModel): """After Effects deadline submitter settings.""" - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - use_published: bool = Field(title="Use Published scene") - priority: int = Field(title="Priority") - chunk_size: int = Field(title="Chunk Size") - group: str = Field(title="Group") - department: str = Field(title="Department") - multiprocess: bool = Field(title="Optional") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + use_published: bool = SettingsField(title="Use Published scene") + priority: int = SettingsField(title="Priority") + chunk_size: int = SettingsField(title="Chunk Size") + group: str = SettingsField(title="Group") + department: str = SettingsField(title="Department") + multiprocess: bool = SettingsField(title="Optional") class CelactionSubmitDeadlineModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - deadline_department: str = Field("", title="Deadline apartment") - deadline_priority: int = Field(50, title="Deadline priority") - deadline_pool: str = Field("", title="Deadline pool") - deadline_pool_secondary: str = Field("", title="Deadline pool (secondary)") - deadline_group: str = Field("", title="Deadline Group") - deadline_chunk_size: int = Field(10, title="Deadline Chunk size") - deadline_job_delay: str = Field( + enabled: bool = SettingsField(True, title="Enabled") + deadline_department: str = SettingsField("", title="Deadline apartment") + deadline_priority: int = SettingsField(50, title="Deadline priority") + deadline_pool: str = SettingsField("", title="Deadline pool") + deadline_pool_secondary: str = SettingsField( + "", title="Deadline pool (secondary)" + ) + deadline_group: str = SettingsField("", title="Deadline Group") + deadline_chunk_size: int = SettingsField(10, title="Deadline Chunk size") + deadline_job_delay: str = SettingsField( "", title="Delay job (timecode dd:hh:mm:ss)" ) class BlenderSubmitDeadlineModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - use_published: bool = Field(title="Use Published scene") - priority: int = Field(title="Priority") - chunk_size: int = Field(title="Frame per Task") - group: str = Field("", title="Group Name") - job_delay: str = Field("", title="Delay job (timecode dd:hh:mm:ss)") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + use_published: bool = SettingsField(title="Use Published scene") + priority: int = SettingsField(title="Priority") + chunk_size: int = SettingsField(title="Frame per Task") + group: str = SettingsField("", title="Group Name") + job_delay: str = SettingsField( + "", title="Delay job (timecode dd:hh:mm:ss)" + ) class AOVFilterSubmodel(BaseSettingsModel): _layout = "expanded" - name: str = Field(title="Host") - value: list[str] = Field( + name: str = SettingsField(title="Host") + value: list[str] = SettingsField( default_factory=list, title="AOV regex" ) @@ -248,29 +265,29 @@ class AOVFilterSubmodel(BaseSettingsModel): class ProcessCacheJobFarmModel(BaseSettingsModel): """Process submitted job on farm.""" - enabled: bool = Field(title="Enabled") - deadline_department: str = Field(title="Department") - deadline_pool: str = Field(title="Pool") - deadline_group: str = Field(title="Group") - deadline_chunk_size: int = Field(title="Chunk Size") - deadline_priority: int = Field(title="Priority") + enabled: bool = SettingsField(title="Enabled") + deadline_department: str = SettingsField(title="Department") + deadline_pool: str = SettingsField(title="Pool") + deadline_group: str = SettingsField(title="Group") + deadline_chunk_size: int = SettingsField(title="Chunk Size") + deadline_priority: int = SettingsField(title="Priority") class ProcessSubmittedJobOnFarmModel(BaseSettingsModel): """Process submitted job on farm.""" - enabled: bool = Field(title="Enabled") - deadline_department: str = Field(title="Department") - deadline_pool: str = Field(title="Pool") - deadline_group: str = Field(title="Group") - deadline_chunk_size: int = Field(title="Chunk Size") - deadline_priority: int = Field(title="Priority") - publishing_script: str = Field(title="Publishing script path") - skip_integration_repre_list: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + deadline_department: str = SettingsField(title="Department") + deadline_pool: str = SettingsField(title="Pool") + deadline_group: str = SettingsField(title="Group") + deadline_chunk_size: int = SettingsField(title="Chunk Size") + deadline_priority: int = SettingsField(title="Priority") + publishing_script: str = SettingsField(title="Publishing script path") + skip_integration_repre_list: list[str] = SettingsField( default_factory=list, title="Skip integration of representation with ext" ) - aov_filter: list[AOVFilterSubmodel] = Field( + aov_filter: list[AOVFilterSubmodel] = SettingsField( default_factory=list, title="Reviewable products filter", ) @@ -282,41 +299,44 @@ class ProcessSubmittedJobOnFarmModel(BaseSettingsModel): class PublishPluginsModel(BaseSettingsModel): - CollectDeadlinePools: CollectDeadlinePoolsModel = Field( + CollectDeadlinePools: CollectDeadlinePoolsModel = SettingsField( default_factory=CollectDeadlinePoolsModel, title="Default Pools") - ValidateExpectedFiles: ValidateExpectedFilesModel = Field( + ValidateExpectedFiles: ValidateExpectedFilesModel = SettingsField( default_factory=ValidateExpectedFilesModel, title="Validate Expected Files" ) - MayaSubmitDeadline: MayaSubmitDeadlineModel = Field( + MayaSubmitDeadline: MayaSubmitDeadlineModel = SettingsField( default_factory=MayaSubmitDeadlineModel, title="Maya Submit to deadline") - MaxSubmitDeadline: MaxSubmitDeadlineModel = Field( + MaxSubmitDeadline: MaxSubmitDeadlineModel = SettingsField( default_factory=MaxSubmitDeadlineModel, title="Max Submit to deadline") - FusionSubmitDeadline: FusionSubmitDeadlineModel = Field( + FusionSubmitDeadline: FusionSubmitDeadlineModel = SettingsField( default_factory=FusionSubmitDeadlineModel, title="Fusion submit to Deadline") - NukeSubmitDeadline: NukeSubmitDeadlineModel = Field( + NukeSubmitDeadline: NukeSubmitDeadlineModel = SettingsField( default_factory=NukeSubmitDeadlineModel, title="Nuke Submit to deadline") - HarmonySubmitDeadline: HarmonySubmitDeadlineModel = Field( + HarmonySubmitDeadline: HarmonySubmitDeadlineModel = SettingsField( default_factory=HarmonySubmitDeadlineModel, title="Harmony Submit to deadline") - AfterEffectsSubmitDeadline: AfterEffectsSubmitDeadlineModel = Field( - default_factory=AfterEffectsSubmitDeadlineModel, - title="After Effects to deadline") - CelactionSubmitDeadline: CelactionSubmitDeadlineModel = Field( + AfterEffectsSubmitDeadline: AfterEffectsSubmitDeadlineModel = ( + SettingsField( + default_factory=AfterEffectsSubmitDeadlineModel, + title="After Effects to deadline" + ) + ) + CelactionSubmitDeadline: CelactionSubmitDeadlineModel = SettingsField( default_factory=CelactionSubmitDeadlineModel, title="Celaction Submit Deadline") - BlenderSubmitDeadline: BlenderSubmitDeadlineModel = Field( + BlenderSubmitDeadline: BlenderSubmitDeadlineModel = SettingsField( default_factory=BlenderSubmitDeadlineModel, title="Blender Submit Deadline") - ProcessSubmittedCacheJobOnFarm: ProcessCacheJobFarmModel = Field( + ProcessSubmittedCacheJobOnFarm: ProcessCacheJobFarmModel = SettingsField( default_factory=ProcessCacheJobFarmModel, title="Process submitted cache Job on farm.") - ProcessSubmittedJobOnFarm: ProcessSubmittedJobOnFarmModel = Field( + ProcessSubmittedJobOnFarm: ProcessSubmittedJobOnFarmModel = SettingsField( default_factory=ProcessSubmittedJobOnFarmModel, title="Process submitted job on farm.") diff --git a/server_addon/flame/server/settings/create_plugins.py b/server_addon/flame/server/settings/create_plugins.py index 374a7368d2..44fb8a2e91 100644 --- a/server_addon/flame/server/settings/create_plugins.py +++ b/server_addon/flame/server/settings/create_plugins.py @@ -1,95 +1,94 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CreateShotClipModel(BaseSettingsModel): - hierarchy: str = Field( + hierarchy: str = SettingsField( "shot", title="Shot parent hierarchy", section="Shot Hierarchy And Rename Settings" ) - useShotName: bool = Field( + useShotName: bool = SettingsField( True, title="Use Shot Name", ) - clipRename: bool = Field( + clipRename: bool = SettingsField( False, title="Rename clips", ) - clipName: str = Field( + clipName: str = SettingsField( "{sequence}{shot}", title="Clip name template" ) - segmentIndex: bool = Field( + segmentIndex: bool = SettingsField( True, title="Accept segment order" ) - countFrom: int = Field( + countFrom: int = SettingsField( 10, title="Count sequence from" ) - countSteps: int = Field( + countSteps: int = SettingsField( 10, title="Stepping number" ) - folder: str = Field( + folder: str = SettingsField( "shots", title="{folder}", section="Shot Template Keywords" ) - episode: str = Field( + episode: str = SettingsField( "ep01", title="{episode}" ) - sequence: str = Field( + sequence: str = SettingsField( "a", title="{sequence}" ) - track: str = Field( + track: str = SettingsField( "{_track_}", title="{track}" ) - shot: str = Field( + shot: str = SettingsField( "####", title="{shot}" ) - vSyncOn: bool = Field( + vSyncOn: bool = SettingsField( False, title="Enable Vertical Sync", section="Vertical Synchronization Of Attributes" ) - workfileFrameStart: int = Field( + workfileFrameStart: int = SettingsField( 1001, title="Workfiles Start Frame", section="Shot Attributes" ) - handleStart: int = Field( + handleStart: int = SettingsField( 10, title="Handle start (head)" ) - handleEnd: int = Field( + handleEnd: int = SettingsField( 10, title="Handle end (tail)" ) - includeHandles: bool = Field( + includeHandles: bool = SettingsField( False, title="Enable handles including" ) - retimedHandles: bool = Field( + retimedHandles: bool = SettingsField( True, title="Enable retimed handles" ) - retimedFramerange: bool = Field( + retimedFramerange: bool = SettingsField( True, title="Enable retimed shot frameranges" ) class CreatePuginsModel(BaseSettingsModel): - CreateShotClip: CreateShotClipModel = Field( + CreateShotClip: CreateShotClipModel = SettingsField( default_factory=CreateShotClipModel, title="Create Shot Clip" ) diff --git a/server_addon/flame/server/settings/imageio.py b/server_addon/flame/server/settings/imageio.py index ef1e4721d1..3f6ec31ef4 100644 --- a/server_addon/flame/server/settings/imageio.py +++ b/server_addon/flame/server/settings/imageio.py @@ -1,17 +1,21 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from pydantic import validator +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -23,24 +27,24 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIORemappingRulesModel(BaseSettingsModel): - host_native_name: str = Field( + host_native_name: str = SettingsField( title="Application native colorspace name" ) - ocio_name: str = Field(title="OCIO colorspace name") + ocio_name: str = SettingsField(title="OCIO colorspace name") class ImageIORemappingModel(BaseSettingsModel): - rules: list[ImageIORemappingRulesModel] = Field( + rules: list[ImageIORemappingRulesModel] = SettingsField( default_factory=list ) class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) @@ -49,30 +53,30 @@ class ImageIOConfigModel(BaseSettingsModel): class ProfileNamesMappingInputsModel(BaseSettingsModel): _layout = "expanded" - flameName: str = Field("", title="Flame name") - ocioName: str = Field("", title="OCIO name") + flameName: str = SettingsField("", title="Flame name") + ocioName: str = SettingsField("", title="OCIO name") class ProfileNamesMappingModel(BaseSettingsModel): _layout = "expanded" - inputs: list[ProfileNamesMappingInputsModel] = Field( + inputs: list[ProfileNamesMappingInputsModel] = SettingsField( default_factory=list, title="Profile names mapping" ) class ImageIOProjectModel(BaseSettingsModel): - colourPolicy: str = Field( + colourPolicy: str = SettingsField( "ACES 1.1", title="Colour Policy (name or path)", section="Project" ) - frameDepth: str = Field( + frameDepth: str = SettingsField( "16-bit fp", title="Image Depth" ) - fieldDominance: str = Field( + fieldDominance: str = SettingsField( "PROGRESSIVE", title="Field Dominance" ) @@ -80,18 +84,18 @@ class ImageIOProjectModel(BaseSettingsModel): class FlameImageIOModel(BaseSettingsModel): _isGroup = True - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - remapping: ImageIORemappingModel = Field( + remapping: ImageIORemappingModel = SettingsField( title="Remapping colorspace names", default_factory=ImageIORemappingModel ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) @@ -99,11 +103,11 @@ class FlameImageIOModel(BaseSettingsModel): # inconsistency with v3 settings and harder conversion handling # - it can be moved back but keep in mind that it must be handled in v3 # conversion script too - project: ImageIOProjectModel = Field( + project: ImageIOProjectModel = SettingsField( default_factory=ImageIOProjectModel, title="Project" ) - profilesMapping: ProfileNamesMappingModel = Field( + profilesMapping: ProfileNamesMappingModel = SettingsField( default_factory=ProfileNamesMappingModel, title="Profile names mapping" ) diff --git a/server_addon/flame/server/settings/loader_plugins.py b/server_addon/flame/server/settings/loader_plugins.py index 6c27b926c2..e616f442b5 100644 --- a/server_addon/flame/server/settings/loader_plugins.py +++ b/server_addon/flame/server/settings/loader_plugins.py @@ -1,60 +1,64 @@ -from ayon_server.settings import Field, BaseSettingsModel +from ayon_server.settings import SettingsField, BaseSettingsModel class LoadClipModel(BaseSettingsModel): - enabled: bool = Field(True) + enabled: bool = SettingsField(True) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - reel_group_name: str = Field( + reel_group_name: str = SettingsField( "OpenPype_Reels", title="Reel group name" ) - reel_name: str = Field( + reel_name: str = SettingsField( "Loaded", title="Reel name" ) - clip_name_template: str = Field( + clip_name_template: str = SettingsField( "{folder[name]}_{product[name]}<_{output}>", title="Clip name template" ) - layer_rename_template: str = Field("", title="Layer name template") - layer_rename_patterns: list[str] = Field( + layer_rename_template: str = SettingsField( + "", title="Layer name template" + ) + layer_rename_patterns: list[str] = SettingsField( default_factory=list, title="Layer rename patters", ) class LoadClipBatchModel(BaseSettingsModel): - enabled: bool = Field(True) - product_types: list[str] = Field( + enabled: bool = SettingsField(True) + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - reel_name: str = Field( + reel_name: str = SettingsField( "OP_LoadedReel", title="Reel name" ) - clip_name_template: str = Field( + clip_name_template: str = SettingsField( "{batch}_{folder[name]}_{product[name]}<_{output}>", title="Clip name template" ) - layer_rename_template: str = Field("", title="Layer name template") - layer_rename_patterns: list[str] = Field( + layer_rename_template: str = SettingsField( + "", title="Layer name template" + ) + layer_rename_patterns: list[str] = SettingsField( default_factory=list, title="Layer rename patters", ) class LoaderPluginsModel(BaseSettingsModel): - LoadClip: LoadClipModel = Field( + LoadClip: LoadClipModel = SettingsField( default_factory=LoadClipModel, title="Load Clip" ) - LoadClipBatch: LoadClipBatchModel = Field( + LoadClipBatch: LoadClipBatchModel = SettingsField( default_factory=LoadClipBatchModel, title="Load as clip to current batch" ) diff --git a/server_addon/flame/server/settings/main.py b/server_addon/flame/server/settings/main.py index f28de6641b..047f5af287 100644 --- a/server_addon/flame/server/settings/main.py +++ b/server_addon/flame/server/settings/main.py @@ -1,4 +1,4 @@ -from ayon_server.settings import Field, BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import FlameImageIOModel, DEFAULT_IMAGEIO_SETTINGS from .create_plugins import CreatePuginsModel, DEFAULT_CREATE_SETTINGS @@ -7,19 +7,19 @@ from .loader_plugins import LoaderPluginsModel, DEFAULT_LOADER_SETTINGS class FlameSettings(BaseSettingsModel): - imageio: FlameImageIOModel = Field( + imageio: FlameImageIOModel = SettingsField( default_factory=FlameImageIOModel, title="Color Management (ImageIO)" ) - create: CreatePuginsModel = Field( + create: CreatePuginsModel = SettingsField( default_factory=CreatePuginsModel, title="Create plugins" ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish plugins" ) - load: LoaderPluginsModel = Field( + load: LoaderPluginsModel = SettingsField( default_factory=LoaderPluginsModel, title="Loader plugins" ) diff --git a/server_addon/flame/server/settings/publish_plugins.py b/server_addon/flame/server/settings/publish_plugins.py index ea7f109f73..2c21034c44 100644 --- a/server_addon/flame/server/settings/publish_plugins.py +++ b/server_addon/flame/server/settings/publish_plugins.py @@ -1,10 +1,14 @@ -from ayon_server.settings import Field, BaseSettingsModel, task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class XMLPresetAttrsFromCommentsModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Attribute name") - type: str = Field( + name: str = SettingsField("", title="Attribute name") + type: str = SettingsField( default_factory=str, title="Attribute type", enum_resolver=lambda: ["number", "float", "string"] @@ -13,13 +17,13 @@ class XMLPresetAttrsFromCommentsModel(BaseSettingsModel): class AddTasksModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Task name") - type: str = Field( + name: str = SettingsField("", title="Task name") + type: str = SettingsField( default_factory=str, title="Task type", enum_resolver=task_types_enum ) - create_batch_group: bool = Field( + create_batch_group: bool = SettingsField( True, title="Create batch group" ) @@ -28,11 +32,11 @@ class AddTasksModel(BaseSettingsModel): class CollectTimelineInstancesModel(BaseSettingsModel): _isGroup = True - xml_preset_attrs_from_comments: list[XMLPresetAttrsFromCommentsModel] = Field( + xml_preset_attrs_from_comments: list[XMLPresetAttrsFromCommentsModel] = SettingsField( default_factory=list, title="XML presets attributes parsable from segment comments" ) - add_tasks: list[AddTasksModel] = Field( + add_tasks: list[AddTasksModel] = SettingsField( default_factory=list, title="Add tasks" ) @@ -41,22 +45,22 @@ class CollectTimelineInstancesModel(BaseSettingsModel): class ExportPresetsMappingModel(BaseSettingsModel): _layout = "expanded" - name: str = Field( + name: str = SettingsField( ..., title="Name" ) - active: bool = Field(True, title="Is active") - export_type: str = Field( + active: bool = SettingsField(True, title="Is active") + export_type: str = SettingsField( "File Sequence", title="Eport clip type", enum_resolver=lambda: ["Movie", "File Sequence", "Sequence Publish"] ) - ext: str = Field("exr", title="Output extension") - xml_preset_file: str = Field( + ext: str = SettingsField("exr", title="Output extension") + xml_preset_file: str = SettingsField( "OpenEXR (16-bit fp DWAA).xml", title="XML preset file (with ext)" ) - colorspace_out: str = Field( + colorspace_out: str = SettingsField( "ACES - ACEScg", title="Output color (imageio)" ) @@ -65,31 +69,31 @@ class ExportPresetsMappingModel(BaseSettingsModel): # created inconsistency with v3 settings and harder conversion handling # - it can be moved back but keep in mind that it must be handled in v3 # conversion script too - xml_preset_dir: str = Field( + xml_preset_dir: str = SettingsField( "", title="XML preset directory" ) - parsed_comment_attrs: bool = Field( + parsed_comment_attrs: bool = SettingsField( True, title="Parsed comment attributes" ) - representation_add_range: bool = Field( + representation_add_range: bool = SettingsField( True, title="Add range to representation name" ) - representation_tags: list[str] = Field( + representation_tags: list[str] = SettingsField( default_factory=list, title="Representation tags" ) - load_to_batch_group: bool = Field( + load_to_batch_group: bool = SettingsField( True, title="Load to batch group reel" ) - batch_group_loader_name: str = Field( + batch_group_loader_name: str = SettingsField( "LoadClipBatch", title="Use loader name" ) - filter_path_regex: str = Field( + filter_path_regex: str = SettingsField( ".*", title="Regex in clip path" ) @@ -98,35 +102,35 @@ class ExportPresetsMappingModel(BaseSettingsModel): class ExtractProductResourcesModel(BaseSettingsModel): _isGroup = True - keep_original_representation: bool = Field( + keep_original_representation: bool = SettingsField( False, title="Publish clip's original media" ) - export_presets_mapping: list[ExportPresetsMappingModel] = Field( + export_presets_mapping: list[ExportPresetsMappingModel] = SettingsField( default_factory=list, title="Export presets mapping" ) class IntegrateBatchGroupModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( False, title="Enabled" ) class PublishPuginsModel(BaseSettingsModel): - CollectTimelineInstances: CollectTimelineInstancesModel = Field( + CollectTimelineInstances: CollectTimelineInstancesModel = SettingsField( default_factory=CollectTimelineInstancesModel, title="Collect Timeline Instances" ) - ExtractProductResources: ExtractProductResourcesModel = Field( + ExtractProductResources: ExtractProductResourcesModel = SettingsField( default_factory=ExtractProductResourcesModel, title="Extract Product Resources" ) - IntegrateBatchGroup: IntegrateBatchGroupModel = Field( + IntegrateBatchGroup: IntegrateBatchGroupModel = SettingsField( default_factory=IntegrateBatchGroupModel, title="IntegrateBatchGroup" ) diff --git a/server_addon/fusion/server/imageio.py b/server_addon/fusion/server/imageio.py index fe867af424..e93dc2ae00 100644 --- a/server_addon/fusion/server/imageio.py +++ b/server_addon/fusion/server/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class FusionImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/fusion/server/settings.py b/server_addon/fusion/server/settings.py index bf295f3064..b157ce9e40 100644 --- a/server_addon/fusion/server/settings.py +++ b/server_addon/fusion/server/settings.py @@ -1,15 +1,15 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ) from .imageio import FusionImageIOModel class CopyFusionSettingsModel(BaseSettingsModel): - copy_path: str = Field("", title="Local Fusion profile directory") - copy_status: bool = Field(title="Copy profile on first launch") - force_sync: bool = Field(title="Resync profile on each launch") + copy_path: str = SettingsField("", title="Local Fusion profile directory") + copy_status: bool = SettingsField(title="Copy profile on first launch") + force_sync: bool = SettingsField(title="Resync profile on each launch") def _create_saver_instance_attributes_enum(): @@ -45,40 +45,40 @@ def _frame_range_options_enum(): class CreateSaverPluginModel(BaseSettingsModel): _isGroup = True - temp_rendering_path_template: str = Field( + temp_rendering_path_template: str = SettingsField( "", title="Temporary rendering path template" ) - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants" ) - instance_attributes: list[str] = Field( + instance_attributes: list[str] = SettingsField( default_factory=list, enum_resolver=_create_saver_instance_attributes_enum, title="Instance attributes" ) - output_formats: list[str] = Field( + output_formats: list[str] = SettingsField( default_factory=list, title="Output formats" ) class HookOptionalModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( True, title="Enabled" ) class HooksModel(BaseSettingsModel): - InstallPySideToFusion: HookOptionalModel = Field( + InstallPySideToFusion: HookOptionalModel = SettingsField( default_factory=HookOptionalModel, title="Install PySide2" ) class CreateSaverModel(CreateSaverPluginModel): - default_frame_range_option: str = Field( + default_frame_range_option: str = SettingsField( default="asset_db", enum_resolver=_frame_range_options_enum, title="Default frame range source" @@ -86,17 +86,17 @@ class CreateSaverModel(CreateSaverPluginModel): class CreateImageSaverModel(CreateSaverPluginModel): - default_frame: int = Field( + default_frame: int = SettingsField( 0, title="Default rendered frame" ) class CreatPluginsModel(BaseSettingsModel): - CreateSaver: CreateSaverModel = Field( + CreateSaver: CreateSaverModel = SettingsField( default_factory=CreateSaverModel, title="Create Saver", description="Creator for render product type (eg. sequence)" ) - CreateImageSaver: CreateImageSaverModel = Field( + CreateImageSaver: CreateImageSaverModel = SettingsField( default_factory=CreateImageSaverModel, title="Create Image Saver", description="Creator for image product type (eg. single)" @@ -104,19 +104,19 @@ class CreatPluginsModel(BaseSettingsModel): class FusionSettings(BaseSettingsModel): - imageio: FusionImageIOModel = Field( + imageio: FusionImageIOModel = SettingsField( default_factory=FusionImageIOModel, title="Color Management (ImageIO)" ) - copy_fusion_settings: CopyFusionSettingsModel = Field( + copy_fusion_settings: CopyFusionSettingsModel = SettingsField( default_factory=CopyFusionSettingsModel, title="Local Fusion profile settings" ) - hooks: HooksModel = Field( + hooks: HooksModel = SettingsField( default_factory=HooksModel, title="Hooks" ) - create: CreatPluginsModel = Field( + create: CreatPluginsModel = SettingsField( default_factory=CreatPluginsModel, title="Creator plugins" ) diff --git a/server_addon/harmony/server/settings/imageio.py b/server_addon/harmony/server/settings/imageio.py index 4e01fae3d4..a4b481f91f 100644 --- a/server_addon/harmony/server/settings/imageio.py +++ b/server_addon/harmony/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,21 +35,21 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIORemappingRulesModel(BaseSettingsModel): - host_native_name: str = Field( + host_native_name: str = SettingsField( title="Application native colorspace name" ) - ocio_name: str = Field(title="OCIO colorspace name") + ocio_name: str = SettingsField(title="OCIO colorspace name") class HarmonyImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/harmony/server/settings/main.py b/server_addon/harmony/server/settings/main.py index 0936bc1fc7..9c780b63c2 100644 --- a/server_addon/harmony/server/settings/main.py +++ b/server_addon/harmony/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import HarmonyImageIOModel from .publish_plugins import HarmonyPublishPlugins @@ -8,11 +7,11 @@ from .publish_plugins import HarmonyPublishPlugins class HarmonySettings(BaseSettingsModel): """Harmony Project Settings.""" - imageio: HarmonyImageIOModel = Field( + imageio: HarmonyImageIOModel = SettingsField( default_factory=HarmonyImageIOModel, title="OCIO config" ) - publish: HarmonyPublishPlugins = Field( + publish: HarmonyPublishPlugins = SettingsField( default_factory=HarmonyPublishPlugins, title="Publish plugins" ) diff --git a/server_addon/harmony/server/settings/publish_plugins.py b/server_addon/harmony/server/settings/publish_plugins.py index bdaec2bbd4..c9e7c515e4 100644 --- a/server_addon/harmony/server/settings/publish_plugins.py +++ b/server_addon/harmony/server/settings/publish_plugins.py @@ -1,12 +1,10 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CollectPalettesPlugin(BaseSettingsModel): """Set regular expressions to filter triggering on specific task names. '.*' means on all.""" # noqa - allowed_tasks: list[str] = Field( + allowed_tasks: list[str] = SettingsField( default_factory=list, title="Allowed tasks" ) @@ -16,16 +14,16 @@ class ValidateAudioPlugin(BaseSettingsModel): """Check if scene contains audio track.""" # _isGroup = True enabled: bool = True - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") class ValidateContainersPlugin(BaseSettingsModel): """Check if loaded container is scene are latest versions.""" _isGroup = True enabled: bool = True - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") class ValidateSceneSettingsPlugin(BaseSettingsModel): @@ -34,20 +32,20 @@ class ValidateSceneSettingsPlugin(BaseSettingsModel): or task names.""" _isGroup = True enabled: bool = True - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") - frame_check_filter: list[str] = Field( + frame_check_filter: list[str] = SettingsField( default_factory=list, title="Skip Frame check for Assets with name containing" ) - skip_resolution_check: list[str] = Field( + skip_resolution_check: list[str] = SettingsField( default_factory=list, title="Skip Resolution Check for Tasks" ) - skip_timelines_check: list[str] = Field( + skip_timelines_check: list[str] = SettingsField( default_factory=list, title="Skip Timeline Check for Tasks" ) @@ -55,22 +53,22 @@ class ValidateSceneSettingsPlugin(BaseSettingsModel): class HarmonyPublishPlugins(BaseSettingsModel): - CollectPalettes: CollectPalettesPlugin = Field( + CollectPalettes: CollectPalettesPlugin = SettingsField( title="Collect Palettes", default_factory=CollectPalettesPlugin, ) - ValidateAudio: ValidateAudioPlugin = Field( + ValidateAudio: ValidateAudioPlugin = SettingsField( title="Validate Audio", default_factory=ValidateAudioPlugin, ) - ValidateContainers: ValidateContainersPlugin = Field( + ValidateContainers: ValidateContainersPlugin = SettingsField( title="Validate Containers", default_factory=ValidateContainersPlugin, ) - ValidateSceneSettings: ValidateSceneSettingsPlugin = Field( + ValidateSceneSettings: ValidateSceneSettingsPlugin = SettingsField( title="Validate Scene Settings", default_factory=ValidateSceneSettingsPlugin, ) diff --git a/server_addon/hiero/server/settings/common.py b/server_addon/hiero/server/settings/common.py index eb4791f93e..7b5e4390c5 100644 --- a/server_addon/hiero/server/settings/common.py +++ b/server_addon/hiero/server/settings/common.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.types import ( ColorRGBA_float, ColorRGB_uint8 @@ -9,16 +8,16 @@ from ayon_server.types import ( class Vector2d(BaseSettingsModel): _layout = "compact" - x: float = Field(1.0, title="X") - y: float = Field(1.0, title="Y") + x: float = SettingsField(1.0, title="X") + y: float = SettingsField(1.0, title="Y") class Vector3d(BaseSettingsModel): _layout = "compact" - x: float = Field(1.0, title="X") - y: float = Field(1.0, title="Y") - z: float = Field(1.0, title="Z") + x: float = SettingsField(1.0, title="X") + y: float = SettingsField(1.0, title="Y") + z: float = SettingsField(1.0, title="Z") def formatable_knob_type_enum(): @@ -34,12 +33,12 @@ def formatable_knob_type_enum(): class Formatable(BaseSettingsModel): _layout = "compact" - template: str = Field( + template: str = SettingsField( "", placeholder="""{{key}} or {{key}};{{key}}""", title="Template" ) - to_type: str = Field( + to_type: str = SettingsField( "Text", title="To Knob type", enum_resolver=formatable_knob_type_enum, @@ -62,37 +61,37 @@ knob_types_enum = [ class KnobModel(BaseSettingsModel): _layout = "expanded" - type: str = Field( + type: str = SettingsField( title="Type", description="Switch between different knob types", enum_resolver=lambda: knob_types_enum, conditionalEnum=True ) - name: str = Field( + name: str = SettingsField( title="Name", placeholder="Name" ) - text: str = Field("", title="Value") - color_gui: ColorRGB_uint8 = Field( + text: str = SettingsField("", title="Value") + color_gui: ColorRGB_uint8 = SettingsField( (0, 0, 255), title="RGB Uint8", ) - boolean: bool = Field(False, title="Value") - number: int = Field(0, title="Value") - decimal_number: float = Field(0.0, title="Value") - vector_2d: Vector2d = Field( + boolean: bool = SettingsField(False, title="Value") + number: int = SettingsField(0, title="Value") + decimal_number: float = SettingsField(0.0, title="Value") + vector_2d: Vector2d = SettingsField( default_factory=Vector2d, title="Value" ) - vector_3d: Vector3d = Field( + vector_3d: Vector3d = SettingsField( default_factory=Vector3d, title="Value" ) - color: ColorRGBA_float = Field( + color: ColorRGBA_float = SettingsField( (0.0, 0.0, 1.0, 1.0), title="RGBA Float" ) - formatable: Formatable = Field( + formatable: Formatable = SettingsField( default_factory=Formatable, title="Value" ) diff --git a/server_addon/hiero/server/settings/create_plugins.py b/server_addon/hiero/server/settings/create_plugins.py index daec4a7cea..80e0b67182 100644 --- a/server_addon/hiero/server/settings/create_plugins.py +++ b/server_addon/hiero/server/settings/create_plugins.py @@ -1,75 +1,74 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CreateShotClipModels(BaseSettingsModel): - hierarchy: str = Field( + hierarchy: str = SettingsField( "{folder}/{sequence}", title="Shot parent hierarchy", section="Shot Hierarchy And Rename Settings" ) - clipRename: bool = Field( + clipRename: bool = SettingsField( True, title="Rename clips" ) - clipName: str = Field( + clipName: str = SettingsField( "{track}{sequence}{shot}", title="Clip name template" ) - countFrom: int = Field( + countFrom: int = SettingsField( 10, title="Count sequence from" ) - countSteps: int = Field( + countSteps: int = SettingsField( 10, title="Stepping number" ) - folder: str = Field( + folder: str = SettingsField( "shots", title="{folder}", section="Shot Template Keywords" ) - episode: str = Field( + episode: str = SettingsField( "ep01", title="{episode}" ) - sequence: str = Field( + sequence: str = SettingsField( "sq01", title="{sequence}" ) - track: str = Field( + track: str = SettingsField( "{_track_}", title="{track}" ) - shot: str = Field( + shot: str = SettingsField( "sh###", title="{shot}" ) - vSyncOn: bool = Field( + vSyncOn: bool = SettingsField( False, title="Enable Vertical Sync", section="Vertical Synchronization Of Attributes" ) - workfileFrameStart: int = Field( + workfileFrameStart: int = SettingsField( 1001, title="Workfiles Start Frame", section="Shot Attributes" ) - handleStart: int = Field( + handleStart: int = SettingsField( 10, title="Handle start (head)" ) - handleEnd: int = Field( + handleEnd: int = SettingsField( 10, title="Handle end (tail)" ) class CreatorPluginsSettings(BaseSettingsModel): - CreateShotClip: CreateShotClipModels = Field( + CreateShotClip: CreateShotClipModels = SettingsField( default_factory=CreateShotClipModels, title="Create Shot Clip" ) diff --git a/server_addon/hiero/server/settings/filters.py b/server_addon/hiero/server/settings/filters.py index 7e2702b3b7..9642f93f7e 100644 --- a/server_addon/hiero/server/settings/filters.py +++ b/server_addon/hiero/server/settings/filters.py @@ -1,17 +1,21 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from pydantic import validator +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) class PublishGUIFilterItemModel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: bool = Field(True, title="Active") + name: str = SettingsField(title="Name") + value: bool = SettingsField(True, title="Active") class PublishGUIFiltersModel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: list[PublishGUIFilterItemModel] = Field(default_factory=list) + name: str = SettingsField(title="Name") + value: list[PublishGUIFilterItemModel] = SettingsField(default_factory=list) @validator("value") def validate_unique_outputs(cls, value): diff --git a/server_addon/hiero/server/settings/imageio.py b/server_addon/hiero/server/settings/imageio.py index f2c2728057..f2bc71ac33 100644 --- a/server_addon/hiero/server/settings/imageio.py +++ b/server_addon/hiero/server/settings/imageio.py @@ -1,7 +1,8 @@ -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names, ) @@ -39,34 +40,34 @@ class WorkfileColorspaceSettings(BaseSettingsModel): thumbnail_name = thumbnailLut """ - ocioConfigName: str = Field( + ocioConfigName: str = SettingsField( title="OpenColorIO Config", description="Switch between OCIO configs", enum_resolver=ocio_configs_switcher_enum, conditionalEnum=True ) - workingSpace: str = Field( + workingSpace: str = SettingsField( title="Working Space" ) - viewerLut: str = Field( + viewerLut: str = SettingsField( title="Viewer" ) - eightBitLut: str = Field( + eightBitLut: str = SettingsField( title="8-bit files" ) - sixteenBitLut: str = Field( + sixteenBitLut: str = SettingsField( title="16-bit files" ) - logLut: str = Field( + logLut: str = SettingsField( title="Log files" ) - floatLut: str = Field( + floatLut: str = SettingsField( title="Float files" ) - thumbnailLut: str = Field( + thumbnailLut: str = SettingsField( title="Thumnails" ) - monitorOutLut: str = Field( + monitorOutLut: str = SettingsField( title="Monitor" ) @@ -74,38 +75,38 @@ class WorkfileColorspaceSettings(BaseSettingsModel): class ClipColorspaceRulesItems(BaseSettingsModel): _layout = "expanded" - regex: str = Field("", title="Regex expression") - colorspace: str = Field("", title="Colorspace") + regex: str = SettingsField("", title="Regex expression") + colorspace: str = SettingsField("", title="Colorspace") class RegexInputsModel(BaseSettingsModel): - inputs: list[ClipColorspaceRulesItems] = Field( + inputs: list[ClipColorspaceRulesItems] = SettingsField( default_factory=list, title="Inputs" ) class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -119,18 +120,18 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIOSettings(BaseSettingsModel): """Hiero color management project settings. """ _isGroup: bool = True - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) - workfile: WorkfileColorspaceSettings = Field( + workfile: WorkfileColorspaceSettings = SettingsField( default_factory=WorkfileColorspaceSettings, title="Workfile" ) @@ -140,7 +141,7 @@ class ImageIOSettings(BaseSettingsModel): - no need for `inputs` middle part. It can stay directly on `regex_inputs` """ - regexInputs: RegexInputsModel = Field( + regexInputs: RegexInputsModel = SettingsField( default_factory=RegexInputsModel, title="Assign colorspace to clips via rules" ) diff --git a/server_addon/hiero/server/settings/loader_plugins.py b/server_addon/hiero/server/settings/loader_plugins.py index 83b3564c2a..b5a81d1ae2 100644 --- a/server_addon/hiero/server/settings/loader_plugins.py +++ b/server_addon/hiero/server/settings/loader_plugins.py @@ -1,23 +1,22 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class LoadClipModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( True, title="Enabled" ) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - clip_name_template: str = Field( + clip_name_template: str = SettingsField( title="Clip name template" ) class LoaderPuginsModel(BaseSettingsModel): - LoadClip: LoadClipModel = Field( + LoadClip: LoadClipModel = SettingsField( default_factory=LoadClipModel, title="Load Clip" ) diff --git a/server_addon/hiero/server/settings/main.py b/server_addon/hiero/server/settings/main.py index 47f8110c22..b170ecafb8 100644 --- a/server_addon/hiero/server/settings/main.py +++ b/server_addon/hiero/server/settings/main.py @@ -1,6 +1,4 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import ( ImageIOSettings, @@ -28,28 +26,28 @@ from .filters import PublishGUIFilterItemModel class HieroSettings(BaseSettingsModel): """Nuke addon settings.""" - imageio: ImageIOSettings = Field( + imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (imageio)", ) - create: CreatorPluginsSettings = Field( + create: CreatorPluginsSettings = SettingsField( default_factory=CreatorPluginsSettings, title="Creator Plugins", ) - load: LoaderPuginsModel = Field( + load: LoaderPuginsModel = SettingsField( default_factory=LoaderPuginsModel, title="Loader plugins" ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish plugins" ) - scriptsmenu: ScriptsmenuSettings = Field( + scriptsmenu: ScriptsmenuSettings = SettingsField( default_factory=ScriptsmenuSettings, title="Scripts Menu Definition", ) - filters: list[PublishGUIFilterItemModel] = Field( + filters: list[PublishGUIFilterItemModel] = SettingsField( default_factory=list ) diff --git a/server_addon/hiero/server/settings/publish_plugins.py b/server_addon/hiero/server/settings/publish_plugins.py index f3d1e21fe4..c35c61c332 100644 --- a/server_addon/hiero/server/settings/publish_plugins.py +++ b/server_addon/hiero/server/settings/publish_plugins.py @@ -1,11 +1,14 @@ -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( - BaseSettingsModel, ensure_unique_names, normalize_name + BaseSettingsModel, + SettingsField, + ensure_unique_names, + normalize_name, ) class CollectInstanceVersionModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( True, title="Enabled" ) @@ -13,8 +16,8 @@ class CollectInstanceVersionModel(BaseSettingsModel): class CollectClipEffectsDefModel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Name") - effect_classes: list[str] = Field( + name: str = SettingsField("", title="Name") + effect_classes: list[str] = SettingsField( default_factory=list, title="Effect Classes" ) @@ -25,7 +28,7 @@ class CollectClipEffectsDefModel(BaseSettingsModel): class CollectClipEffectsModel(BaseSettingsModel): - effect_categories: list[CollectClipEffectsDefModel] = Field( + effect_categories: list[CollectClipEffectsDefModel] = SettingsField( default_factory=list, title="Effect Categories" ) @@ -36,22 +39,22 @@ class CollectClipEffectsModel(BaseSettingsModel): class ExtractReviewCutUpVideoModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( True, title="Enabled" ) - tags_addition: list[str] = Field( + tags_addition: list[str] = SettingsField( default_factory=list, title="Additional tags" ) class PublishPuginsModel(BaseSettingsModel): - CollectInstanceVersion: CollectInstanceVersionModel = Field( + CollectInstanceVersion: CollectInstanceVersionModel = SettingsField( default_factory=CollectInstanceVersionModel, title="Collect Instance Version" ) - CollectClipEffects: CollectClipEffectsModel = Field( + CollectClipEffects: CollectClipEffectsModel = SettingsField( default_factory=CollectClipEffectsModel, title="Collect Clip Effects" ) @@ -59,7 +62,7 @@ class PublishPuginsModel(BaseSettingsModel): Rename class name and plugin name to match title (it makes more sense) """ - ExtractReviewCutUpVideo: ExtractReviewCutUpVideoModel = Field( + ExtractReviewCutUpVideo: ExtractReviewCutUpVideoModel = SettingsField( default_factory=ExtractReviewCutUpVideoModel, title="Exctract Review Trim" ) diff --git a/server_addon/hiero/server/settings/scriptsmenu.py b/server_addon/hiero/server/settings/scriptsmenu.py index ea898dd7ff..a627da9643 100644 --- a/server_addon/hiero/server/settings/scriptsmenu.py +++ b/server_addon/hiero/server/settings/scriptsmenu.py @@ -1,16 +1,15 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class ScriptsmenuSubmodel(BaseSettingsModel): """Item Definition""" _isGroup = True - type: str = Field(title="Type") - command: str = Field(title="Command") - sourcetype: str = Field(title="Source Type") - title: str = Field(title="Title") - tooltip: str = Field(title="Tooltip") + type: str = SettingsField(title="Type") + command: str = SettingsField(title="Command") + sourcetype: str = SettingsField(title="Source Type") + title: str = SettingsField(title="Title") + tooltip: str = SettingsField(title="Tooltip") class ScriptsmenuSettings(BaseSettingsModel): @@ -20,8 +19,8 @@ class ScriptsmenuSettings(BaseSettingsModel): """# TODO: enhance settings with host api: - in api rename key `name` to `menu_name` """ - name: str = Field(title="Menu name") - definition: list[ScriptsmenuSubmodel] = Field( + name: str = SettingsField(title="Menu name") + definition: list[ScriptsmenuSubmodel] = SettingsField( default_factory=list, title="Definition", description="Scriptmenu Items Definition") diff --git a/server_addon/houdini/server/settings/create.py b/server_addon/houdini/server/settings/create.py index a5ca4d477b..203ca4f9d6 100644 --- a/server_addon/houdini/server/settings/create.py +++ b/server_addon/houdini/server/settings/create.py @@ -1,92 +1,91 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField # Creator Plugins class CreatorModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( title="Default Products", default_factory=list, ) class CreateArnoldAssModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( title="Default Products", default_factory=list, ) - ext: str = Field(Title="Extension") + ext: str = SettingsField(Title="Extension") class CreateStaticMeshModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) - static_mesh_prefix: str = Field("S", title="Static Mesh Prefix") - collision_prefixes: list[str] = Field( + static_mesh_prefix: str = SettingsField("S", title="Static Mesh Prefix") + collision_prefixes: list[str] = SettingsField( default_factory=list, title="Collision Prefixes" ) class CreatePluginsModel(BaseSettingsModel): - CreateAlembicCamera: CreatorModel = Field( + CreateAlembicCamera: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Alembic Camera") - CreateArnoldAss: CreateArnoldAssModel = Field( + CreateArnoldAss: CreateArnoldAssModel = SettingsField( default_factory=CreateArnoldAssModel, title="Create Arnold Ass") - CreateArnoldRop: CreatorModel = Field( + CreateArnoldRop: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Arnold ROP") - CreateCompositeSequence: CreatorModel = Field( + CreateCompositeSequence: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Composite (Image Sequence)") - CreateHDA: CreatorModel = Field( + CreateHDA: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Houdini Digital Asset") - CreateKarmaROP: CreatorModel = Field( + CreateKarmaROP: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Karma ROP") - CreateMantraIFD: CreatorModel = Field( + CreateMantraIFD: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Mantra IFD") - CreateMantraROP: CreatorModel = Field( + CreateMantraROP: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Mantra ROP") - CreatePointCache: CreatorModel = Field( + CreatePointCache: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create PointCache (Abc)") - CreateBGEO: CreatorModel = Field( + CreateBGEO: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create PointCache (Bgeo)") - CreateRedshiftProxy: CreatorModel = Field( + CreateRedshiftProxy: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Redshift Proxy") - CreateRedshiftROP: CreatorModel = Field( + CreateRedshiftROP: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Redshift ROP") - CreateReview: CreatorModel = Field( + CreateReview: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create Review") # "-" is not compatible in the new model - CreateStaticMesh: CreateStaticMeshModel = Field( + CreateStaticMesh: CreateStaticMeshModel = SettingsField( default_factory=CreateStaticMeshModel, title="Create Static Mesh") - CreateUSD: CreatorModel = Field( + CreateUSD: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create USD (experimental)") - CreateUSDRender: CreatorModel = Field( + CreateUSDRender: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create USD render (experimental)") - CreateVDBCache: CreatorModel = Field( + CreateVDBCache: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create VDB Cache") - CreateVrayROP: CreatorModel = Field( + CreateVrayROP: CreatorModel = SettingsField( default_factory=CreatorModel, title="Create VRay ROP") diff --git a/server_addon/houdini/server/settings/general.py b/server_addon/houdini/server/settings/general.py index aee44f1648..b71feae554 100644 --- a/server_addon/houdini/server/settings/general.py +++ b/server_addon/houdini/server/settings/general.py @@ -1,12 +1,11 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class HoudiniVarModel(BaseSettingsModel): _layout = "expanded" - var: str = Field("", title="Var") - value: str = Field("", title="Value") - is_directory: bool = Field(False, title="Treat as directory") + var: str = SettingsField("", title="Var") + value: str = SettingsField("", title="Value") + is_directory: bool = SettingsField(False, title="Treat as directory") class UpdateHoudiniVarcontextModel(BaseSettingsModel): @@ -16,20 +15,20 @@ class UpdateHoudiniVarcontextModel(BaseSettingsModel): it will be ensured the folder exists. """ - enabled: bool = Field(title="Enabled") + enabled: bool = SettingsField(title="Enabled") # TODO this was dynamic dictionary '{var: path}' - houdini_vars: list[HoudiniVarModel] = Field( + houdini_vars: list[HoudiniVarModel] = SettingsField( default_factory=list, title="Houdini Vars" ) class GeneralSettingsModel(BaseSettingsModel): - add_self_publish_button: bool = Field( + add_self_publish_button: bool = SettingsField( False, title="Add Self Publish Button" ) - update_houdini_var_context: UpdateHoudiniVarcontextModel = Field( + update_houdini_var_context: UpdateHoudiniVarcontextModel = SettingsField( default_factory=UpdateHoudiniVarcontextModel, title="Update Houdini Vars on context change" ) diff --git a/server_addon/houdini/server/settings/imageio.py b/server_addon/houdini/server/settings/imageio.py index 88aa40ecd6..f4850c5df7 100644 --- a/server_addon/houdini/server/settings/imageio.py +++ b/server_addon/houdini/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class HoudiniImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/houdini/server/settings/main.py b/server_addon/houdini/server/settings/main.py index 9cfec54f22..cbb19d15b7 100644 --- a/server_addon/houdini/server/settings/main.py +++ b/server_addon/houdini/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .general import ( GeneralSettingsModel, DEFAULT_GENERAL_SETTINGS @@ -17,23 +16,23 @@ from .publish import ( class HoudiniSettings(BaseSettingsModel): - general: GeneralSettingsModel = Field( + general: GeneralSettingsModel = SettingsField( default_factory=GeneralSettingsModel, title="General" ) - imageio: HoudiniImageIOModel = Field( + imageio: HoudiniImageIOModel = SettingsField( default_factory=HoudiniImageIOModel, title="Color Management (ImageIO)" ) - shelves: list[ShelvesModel] = Field( + shelves: list[ShelvesModel] = SettingsField( default_factory=list, title="Shelves Manager", ) - create: CreatePluginsModel = Field( + create: CreatePluginsModel = SettingsField( default_factory=CreatePluginsModel, title="Creator Plugins", ) - publish: PublishPluginsModel = Field( + publish: PublishPluginsModel = SettingsField( default_factory=PublishPluginsModel, title="Publish Plugins", ) diff --git a/server_addon/houdini/server/settings/publish.py b/server_addon/houdini/server/settings/publish.py index f551b3a209..1741568d63 100644 --- a/server_addon/houdini/server/settings/publish.py +++ b/server_addon/houdini/server/settings/publish.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField # Publish Plugins @@ -9,64 +8,64 @@ class CollectAssetHandlesModel(BaseSettingsModel): ignore start and end handles specified in the asset data for publish instances """ - use_asset_handles: bool = Field( + use_asset_handles: bool = SettingsField( title="Use asset handles") class CollectChunkSizeModel(BaseSettingsModel): """Collect Chunk Size.""" - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - chunk_size: int = Field( + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + chunk_size: int = SettingsField( title="Frames Per Task") class ValidateWorkfilePathsModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - node_types: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + node_types: list[str] = SettingsField( default_factory=list, title="Node Types" ) - prohibited_vars: list[str] = Field( + prohibited_vars: list[str] = SettingsField( default_factory=list, title="Prohibited Variables" ) class BasicValidateModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class PublishPluginsModel(BaseSettingsModel): - CollectAssetHandles: CollectAssetHandlesModel = Field( + CollectAssetHandles: CollectAssetHandlesModel = SettingsField( default_factory=CollectAssetHandlesModel, title="Collect Asset Handles.", section="Collectors" ) - CollectChunkSize: CollectChunkSizeModel = Field( + CollectChunkSize: CollectChunkSizeModel = SettingsField( default_factory=CollectChunkSizeModel, title="Collect Chunk Size." ) - ValidateContainers: BasicValidateModel = Field( + ValidateContainers: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Latest Containers.", section="Validators") - ValidateMeshIsStatic: BasicValidateModel = Field( + ValidateMeshIsStatic: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh is Static.") - ValidateReviewColorspace: BasicValidateModel = Field( + ValidateReviewColorspace: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Review Colorspace.") - ValidateSubsetName: BasicValidateModel = Field( + ValidateSubsetName: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Subset Name.") - ValidateUnrealStaticMeshName: BasicValidateModel = Field( + ValidateUnrealStaticMeshName: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Unreal Static Mesh Name.") - ValidateWorkfilePaths: ValidateWorkfilePathsModel = Field( + ValidateWorkfilePaths: ValidateWorkfilePathsModel = SettingsField( default_factory=ValidateWorkfilePathsModel, title="Validate workfile paths settings.") diff --git a/server_addon/houdini/server/settings/shelves.py b/server_addon/houdini/server/settings/shelves.py index 133c18f77c..f6d7f1d06c 100644 --- a/server_addon/houdini/server/settings/shelves.py +++ b/server_addon/houdini/server/settings/shelves.py @@ -1,37 +1,37 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathModel ) class ShelfToolsModel(BaseSettingsModel): """Name and Script Path are mandatory.""" - label: str = Field(title="Name") - script: str = Field(title="Script Path") - icon: str = Field("", title="Icon Path") - help: str = Field("", title="Help text") + label: str = SettingsField(title="Name") + script: str = SettingsField(title="Script Path") + icon: str = SettingsField("", title="Icon Path") + help: str = SettingsField("", title="Help text") class ShelfDefinitionModel(BaseSettingsModel): _layout = "expanded" - shelf_name: str = Field(title="Shelf name") - tools_list: list[ShelfToolsModel] = Field( + shelf_name: str = SettingsField(title="Shelf name") + tools_list: list[ShelfToolsModel] = SettingsField( default_factory=list, title="Shelf Tools" ) class AddShelfFileModel(BaseSettingsModel): - shelf_set_source_path: MultiplatformPathModel = Field( + shelf_set_source_path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Shelf Set Path" ) class AddSetAndDefinitionsModel(BaseSettingsModel): - shelf_set_name: str = Field("", title="Shelf Set Name") - shelf_definition: list[ShelfDefinitionModel] = Field( + shelf_set_name: str = SettingsField("", title="Shelf Set Name") + shelf_definition: list[ShelfDefinitionModel] = SettingsField( default_factory=list, title="Shelves Definitions" ) @@ -51,17 +51,17 @@ def shelves_enum_options(): class ShelvesModel(BaseSettingsModel): - options: str = Field( + options: str = SettingsField( title="Options", description="Switch between shelves manager options", enum_resolver=shelves_enum_options, conditionalEnum=True ) - add_shelf_file: AddShelfFileModel = Field( + add_shelf_file: AddShelfFileModel = SettingsField( title="Add a .shelf file", default_factory=AddShelfFileModel ) - add_set_and_definitions: AddSetAndDefinitionsModel = Field( + add_set_and_definitions: AddSetAndDefinitionsModel = SettingsField( title="Add Shelf Set Name and Shelves Definitions", default_factory=AddSetAndDefinitionsModel ) diff --git a/server_addon/max/server/settings/create_review_settings.py b/server_addon/max/server/settings/create_review_settings.py index 43dac0730a..807976a391 100644 --- a/server_addon/max/server/settings/create_review_settings.py +++ b/server_addon/max/server/settings/create_review_settings.py @@ -1,6 +1,4 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField def image_format_enum(): @@ -57,27 +55,27 @@ def anti_aliasing_enum(): class CreateReviewModel(BaseSettingsModel): - review_width: int = Field(1920, title="Review Width") - review_height: int = Field(1080, title="Review Height") - percentSize: float = Field(100.0, title="Percent of Output") - keep_images: bool = Field(False, title="Keep Image Sequences") - image_format: str = Field( + review_width: int = SettingsField(1920, title="Review Width") + review_height: int = SettingsField(1080, title="Review Height") + percentSize: float = SettingsField(100.0, title="Percent of Output") + keep_images: bool = SettingsField(False, title="Keep Image Sequences") + image_format: str = SettingsField( enum_resolver=image_format_enum, title="Image Format Options" ) - visual_style: str = Field( + visual_style: str = SettingsField( enum_resolver=visual_style_enum, title="Preference" ) - viewport_preset: str = Field( + viewport_preset: str = SettingsField( enum_resolver=preview_preset_enum, title="Preview Preset" ) - anti_aliasing: str = Field( + anti_aliasing: str = SettingsField( enum_resolver=anti_aliasing_enum, title="Anti-aliasing Quality" ) - vp_texture: bool = Field(True, title="Viewport Texture") + vp_texture: bool = SettingsField(True, title="Viewport Texture") DEFAULT_CREATE_REVIEW_SETTINGS = { diff --git a/server_addon/max/server/settings/imageio.py b/server_addon/max/server/settings/imageio.py index 5e46104fa7..221f85a41f 100644 --- a/server_addon/max/server/settings/imageio.py +++ b/server_addon/max/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIOSettings(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/max/server/settings/main.py b/server_addon/max/server/settings/main.py index cad6024cf7..7b0bfc6421 100644 --- a/server_addon/max/server/settings/main.py +++ b/server_addon/max/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import ImageIOSettings from .render_settings import ( RenderSettingsModel, DEFAULT_RENDER_SETTINGS @@ -23,8 +22,8 @@ def unit_scale_enum(): class UnitScaleSettings(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - scene_unit_scale: str = Field( + enabled: bool = SettingsField(True, title="Enabled") + scene_unit_scale: str = SettingsField( "Centimeters", title="Scene Unit Scale", enum_resolver=unit_scale_enum @@ -33,37 +32,37 @@ class UnitScaleSettings(BaseSettingsModel): class PRTAttributesModel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: str = Field(title="Attribute") + name: str = SettingsField(title="Name") + value: str = SettingsField(title="Attribute") class PointCloudSettings(BaseSettingsModel): - attribute: list[PRTAttributesModel] = Field( + attribute: list[PRTAttributesModel] = SettingsField( default_factory=list, title="Channel Attribute") class MaxSettings(BaseSettingsModel): - unit_scale_settings: UnitScaleSettings = Field( + unit_scale_settings: UnitScaleSettings = SettingsField( default_factory=UnitScaleSettings, title="Set Unit Scale" ) - imageio: ImageIOSettings = Field( + imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (ImageIO)" ) - RenderSettings: RenderSettingsModel = Field( + RenderSettings: RenderSettingsModel = SettingsField( default_factory=RenderSettingsModel, title="Render Settings" ) - CreateReview: CreateReviewModel = Field( + CreateReview: CreateReviewModel = SettingsField( default_factory=CreateReviewModel, title="Create Review" ) - PointCloud: PointCloudSettings = Field( + PointCloud: PointCloudSettings = SettingsField( default_factory=PointCloudSettings, title="Point Cloud" ) - publish: PublishersModel = Field( + publish: PublishersModel = SettingsField( default_factory=PublishersModel, title="Publish Plugins") diff --git a/server_addon/max/server/settings/publishers.py b/server_addon/max/server/settings/publishers.py index d40d85a99b..da782cb494 100644 --- a/server_addon/max/server/settings/publishers.py +++ b/server_addon/max/server/settings/publishers.py @@ -1,13 +1,13 @@ import json -from pydantic import Field, validator +from pydantic import validator -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.exceptions import BadRequestException class ValidateAttributesModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateAttributes") - attributes: str = Field( + enabled: bool = SettingsField(title="ValidateAttributes") + attributes: str = SettingsField( "{}", title="Attributes", widget="textarea") @validator("attributes") @@ -28,64 +28,64 @@ class ValidateAttributesModel(BaseSettingsModel): class FamilyMappingItemModel(BaseSettingsModel): - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product Types" ) - plugins: list[str] = Field( + plugins: list[str] = SettingsField( default_factory=list, title="Plugins" ) class ValidateLoadedPluginModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - family_plugins_mapping: list[FamilyMappingItemModel] = Field( + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + family_plugins_mapping: list[FamilyMappingItemModel] = SettingsField( default_factory=list, title="Family Plugins Mapping" ) class BasicValidateModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class PublishersModel(BaseSettingsModel): - ValidateFrameRange: BasicValidateModel = Field( + ValidateFrameRange: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Frame Range", section="Validators" ) - ValidateAttributes: ValidateAttributesModel = Field( + ValidateAttributes: ValidateAttributesModel = SettingsField( default_factory=ValidateAttributesModel, title="Validate Attributes" ) - ValidateLoadedPlugin: ValidateLoadedPluginModel = Field( + ValidateLoadedPlugin: ValidateLoadedPluginModel = SettingsField( default_factory=ValidateLoadedPluginModel, title="Validate Loaded Plugin" ) - ExtractModelObj: BasicValidateModel = Field( + ExtractModelObj: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Extract OBJ", section="Extractors" ) - ExtractModelFbx: BasicValidateModel = Field( + ExtractModelFbx: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Extract FBX" ) - ExtractModelUSD: BasicValidateModel = Field( + ExtractModelUSD: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Extract Geometry (USD)" ) - ExtractModel: BasicValidateModel = Field( + ExtractModel: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Extract Geometry (Alembic)" ) - ExtractMaxSceneRaw: BasicValidateModel = Field( + ExtractMaxSceneRaw: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Extract Max Scene (Raw)" ) diff --git a/server_addon/max/server/settings/render_settings.py b/server_addon/max/server/settings/render_settings.py index c00cb5e436..19d36dd0f8 100644 --- a/server_addon/max/server/settings/render_settings.py +++ b/server_addon/max/server/settings/render_settings.py @@ -1,6 +1,4 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField def aov_separators_enum(): @@ -26,19 +24,19 @@ def image_format_enum(): class RenderSettingsModel(BaseSettingsModel): - default_render_image_folder: str = Field( + default_render_image_folder: str = SettingsField( title="Default render image folder" ) - aov_separator: str = Field( + aov_separator: str = SettingsField( "underscore", title="AOV Separator character", enum_resolver=aov_separators_enum ) - image_format: str = Field( + image_format: str = SettingsField( enum_resolver=image_format_enum, title="Output Image Format" ) - multipass: bool = Field(title="multipass") + multipass: bool = SettingsField(title="multipass") DEFAULT_RENDER_SETTINGS = { diff --git a/server_addon/maya/server/settings/creators.py b/server_addon/maya/server/settings/creators.py index 34a54832af..6b5583e726 100644 --- a/server_addon/maya/server/settings/creators.py +++ b/server_addon/maya/server/settings/creators.py @@ -1,232 +1,233 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel -from ayon_server.settings import task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class CreateLookModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - make_tx: bool = Field(title="Make tx files") - rs_tex: bool = Field(title="Make Redshift texture files") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + make_tx: bool = SettingsField(title="Make tx files") + rs_tex: bool = SettingsField(title="Make Redshift texture files") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class BasicCreatorModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class CreateUnrealStaticMeshModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) - static_mesh_prefix: str = Field("S", title="Static Mesh Prefix") - collision_prefixes: list[str] = Field( + static_mesh_prefix: str = SettingsField("S", title="Static Mesh Prefix") + collision_prefixes: list[str] = SettingsField( default_factory=list, title="Collision Prefixes" ) class CreateUnrealSkeletalMeshModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products") - joint_hints: str = Field("jnt_org", title="Joint root hint") + joint_hints: str = SettingsField("jnt_org", title="Joint root hint") class CreateMultiverseLookModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - publish_mip_map: bool = Field(title="publish_mip_map") + enabled: bool = SettingsField(title="Enabled") + publish_mip_map: bool = SettingsField(title="publish_mip_map") class BasicExportMeshModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - write_color_sets: bool = Field(title="Write Color Sets") - write_face_sets: bool = Field(title="Write Face Sets") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + write_color_sets: bool = SettingsField(title="Write Color Sets") + write_face_sets: bool = SettingsField(title="Write Face Sets") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class CreateAnimationModel(BaseSettingsModel): - write_color_sets: bool = Field(title="Write Color Sets") - write_face_sets: bool = Field(title="Write Face Sets") - include_parent_hierarchy: bool = Field( + write_color_sets: bool = SettingsField(title="Write Color Sets") + write_face_sets: bool = SettingsField(title="Write Face Sets") + include_parent_hierarchy: bool = SettingsField( title="Include Parent Hierarchy") - include_user_defined_attributes: bool = Field( + include_user_defined_attributes: bool = SettingsField( title="Include User Defined Attributes") - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class CreatePointCacheModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - write_color_sets: bool = Field(title="Write Color Sets") - write_face_sets: bool = Field(title="Write Face Sets") - include_user_defined_attributes: bool = Field( + enabled: bool = SettingsField(title="Enabled") + write_color_sets: bool = SettingsField(title="Write Color Sets") + write_face_sets: bool = SettingsField(title="Write Face Sets") + include_user_defined_attributes: bool = SettingsField( title="Include User Defined Attributes" ) - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class CreateProxyAlembicModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - write_color_sets: bool = Field(title="Write Color Sets") - write_face_sets: bool = Field(title="Write Face Sets") - default_variants: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + write_color_sets: bool = SettingsField(title="Write Color Sets") + write_face_sets: bool = SettingsField(title="Write Face Sets") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products" ) class CreateAssModel(BasicCreatorModel): - expandProcedurals: bool = Field(title="Expand Procedurals") - motionBlur: bool = Field(title="Motion Blur") - motionBlurKeys: int = Field(2, title="Motion Blur Keys") - motionBlurLength: float = Field(0.5, title="Motion Blur Length") - maskOptions: bool = Field(title="Mask Options") - maskCamera: bool = Field(title="Mask Camera") - maskLight: bool = Field(title="Mask Light") - maskShape: bool = Field(title="Mask Shape") - maskShader: bool = Field(title="Mask Shader") - maskOverride: bool = Field(title="Mask Override") - maskDriver: bool = Field(title="Mask Driver") - maskFilter: bool = Field(title="Mask Filter") - maskColor_manager: bool = Field(title="Mask Color Manager") - maskOperator: bool = Field(title="Mask Operator") + expandProcedurals: bool = SettingsField(title="Expand Procedurals") + motionBlur: bool = SettingsField(title="Motion Blur") + motionBlurKeys: int = SettingsField(2, title="Motion Blur Keys") + motionBlurLength: float = SettingsField(0.5, title="Motion Blur Length") + maskOptions: bool = SettingsField(title="Mask Options") + maskCamera: bool = SettingsField(title="Mask Camera") + maskLight: bool = SettingsField(title="Mask Light") + maskShape: bool = SettingsField(title="Mask Shape") + maskShader: bool = SettingsField(title="Mask Shader") + maskOverride: bool = SettingsField(title="Mask Override") + maskDriver: bool = SettingsField(title="Mask Driver") + maskFilter: bool = SettingsField(title="Mask Filter") + maskColor_manager: bool = SettingsField(title="Mask Color Manager") + maskOperator: bool = SettingsField(title="Mask Operator") class CreateReviewModel(BasicCreatorModel): - useMayaTimeline: bool = Field(title="Use Maya Timeline for Frame Range.") + useMayaTimeline: bool = SettingsField(title="Use Maya Timeline for Frame Range.") class CreateVrayProxyModel(BaseSettingsModel): - enabled: bool = Field(True) - vrmesh: bool = Field(title="VrMesh") - alembic: bool = Field(title="Alembic") - default_variants: list[str] = Field( + enabled: bool = SettingsField(True) + vrmesh: bool = SettingsField(title="VrMesh") + alembic: bool = SettingsField(title="Alembic") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Products") class CreateMultishotLayout(BasicCreatorModel): - shotParent: str = Field(title="Shot Parent Folder") - groupLoadedAssets: bool = Field(title="Group Loaded Assets") - task_type: list[str] = Field( + shotParent: str = SettingsField(title="Shot Parent Folder") + groupLoadedAssets: bool = SettingsField(title="Group Loaded Assets") + task_type: list[str] = SettingsField( title="Task types", enum_resolver=task_types_enum ) - task_name: str = Field(title="Task name (regex)") + task_name: str = SettingsField(title="Task name (regex)") class CreatorsModel(BaseSettingsModel): - CreateLook: CreateLookModel = Field( + CreateLook: CreateLookModel = SettingsField( default_factory=CreateLookModel, title="Create Look" ) - CreateRender: BasicCreatorModel = Field( + CreateRender: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Render" ) # "-" is not compatible in the new model - CreateUnrealStaticMesh: CreateUnrealStaticMeshModel = Field( + CreateUnrealStaticMesh: CreateUnrealStaticMeshModel = SettingsField( default_factory=CreateUnrealStaticMeshModel, title="Create Unreal_Static Mesh" ) # "-" is not compatible in the new model - CreateUnrealSkeletalMesh: CreateUnrealSkeletalMeshModel = Field( + CreateUnrealSkeletalMesh: CreateUnrealSkeletalMeshModel = SettingsField( default_factory=CreateUnrealSkeletalMeshModel, title="Create Unreal_Skeletal Mesh" ) - CreateMultiverseLook: CreateMultiverseLookModel = Field( + CreateMultiverseLook: CreateMultiverseLookModel = SettingsField( default_factory=CreateMultiverseLookModel, title="Create Multiverse Look" ) - CreateAnimation: CreateAnimationModel = Field( + CreateAnimation: CreateAnimationModel = SettingsField( default_factory=CreateAnimationModel, title="Create Animation" ) - CreateModel: BasicExportMeshModel = Field( + CreateModel: BasicExportMeshModel = SettingsField( default_factory=BasicExportMeshModel, title="Create Model" ) - CreatePointCache: CreatePointCacheModel = Field( + CreatePointCache: CreatePointCacheModel = SettingsField( default_factory=CreatePointCacheModel, title="Create Point Cache" ) - CreateProxyAlembic: CreateProxyAlembicModel = Field( + CreateProxyAlembic: CreateProxyAlembicModel = SettingsField( default_factory=CreateProxyAlembicModel, title="Create Proxy Alembic" ) - CreateMultiverseUsd: BasicCreatorModel = Field( + CreateMultiverseUsd: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Multiverse USD" ) - CreateMultiverseUsdComp: BasicCreatorModel = Field( + CreateMultiverseUsdComp: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Multiverse USD Composition" ) - CreateMultiverseUsdOver: BasicCreatorModel = Field( + CreateMultiverseUsdOver: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Multiverse USD Override" ) - CreateAss: CreateAssModel = Field( + CreateAss: CreateAssModel = SettingsField( default_factory=CreateAssModel, title="Create Ass" ) - CreateAssembly: BasicCreatorModel = Field( + CreateAssembly: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Assembly" ) - CreateCamera: BasicCreatorModel = Field( + CreateCamera: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Camera" ) - CreateLayout: BasicCreatorModel = Field( + CreateLayout: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Layout" ) - CreateMayaScene: BasicCreatorModel = Field( + CreateMayaScene: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Maya Scene" ) - CreateRenderSetup: BasicCreatorModel = Field( + CreateRenderSetup: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Render Setup" ) - CreateReview: CreateReviewModel = Field( + CreateReview: CreateReviewModel = SettingsField( default_factory=CreateReviewModel, title="Create Review" ) - CreateRig: BasicCreatorModel = Field( + CreateRig: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Rig" ) - CreateSetDress: BasicCreatorModel = Field( + CreateSetDress: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Set Dress" ) - CreateVrayProxy: CreateVrayProxyModel = Field( + CreateVrayProxy: CreateVrayProxyModel = SettingsField( default_factory=CreateVrayProxyModel, title="Create VRay Proxy" ) - CreateVRayScene: BasicCreatorModel = Field( + CreateVRayScene: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create VRay Scene" ) - CreateYetiRig: BasicCreatorModel = Field( + CreateYetiRig: BasicCreatorModel = SettingsField( default_factory=BasicCreatorModel, title="Create Yeti Rig" ) diff --git a/server_addon/maya/server/settings/explicit_plugins_loading.py b/server_addon/maya/server/settings/explicit_plugins_loading.py index 394adb728f..cda5154b90 100644 --- a/server_addon/maya/server/settings/explicit_plugins_loading.py +++ b/server_addon/maya/server/settings/explicit_plugins_loading.py @@ -1,19 +1,17 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class PluginsModel(BaseSettingsModel): _layout = "expanded" - enabled: bool = Field(title="Enabled") - name: str = Field("", title="Name") + enabled: bool = SettingsField(title="Enabled") + name: str = SettingsField("", title="Name") class ExplicitPluginsLoadingModel(BaseSettingsModel): """Maya Explicit Plugins Loading.""" _isGroup: bool = True - enabled: bool = Field(title="enabled") - plugins_to_load: list[PluginsModel] = Field( + enabled: bool = SettingsField(title="enabled") + plugins_to_load: list[PluginsModel] = SettingsField( default_factory=list, title="Plugins To Load" ) diff --git a/server_addon/maya/server/settings/imageio.py b/server_addon/maya/server/settings/imageio.py index 946a14c866..34338b24e4 100644 --- a/server_addon/maya/server/settings/imageio.py +++ b/server_addon/maya/server/settings/imageio.py @@ -2,32 +2,36 @@ Note: Names were changed to get rid of the versions in class names. """ -from pydantic import Field, validator +from pydantic import validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -44,25 +48,25 @@ class ColorManagementPreferenceV2Model(BaseSettingsModel): Please migrate all to 'imageio/workfile' and enable it. """ - enabled: bool = Field(True, title="Use Color Management Preference v2") + enabled: bool = SettingsField(True, title="Use Color Management Preference v2") - renderSpace: str = Field(title="Rendering Space") - displayName: str = Field(title="Display") - viewName: str = Field(title="View") + renderSpace: str = SettingsField(title="Rendering Space") + displayName: str = SettingsField(title="Display") + viewName: str = SettingsField(title="View") class ColorManagementPreferenceModel(BaseSettingsModel): """Color Management Preference (legacy).""" - renderSpace: str = Field(title="Rendering Space") - viewTransform: str = Field(title="Viewer Transform ") + renderSpace: str = SettingsField(title="Rendering Space") + viewTransform: str = SettingsField(title="Viewer Transform ") class WorkfileImageIOModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - renderSpace: str = Field(title="Rendering Space") - displayName: str = Field(title="Display") - viewName: str = Field(title="View") + enabled: bool = SettingsField(True, title="Enabled") + renderSpace: str = SettingsField(title="Rendering Space") + displayName: str = SettingsField(title="Display") + viewName: str = SettingsField(title="View") class ImageIOSettings(BaseSettingsModel): @@ -72,27 +76,27 @@ class ImageIOSettings(BaseSettingsModel): """ _isGroup: bool = True - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) - workfile: WorkfileImageIOModel = Field( + workfile: WorkfileImageIOModel = SettingsField( default_factory=WorkfileImageIOModel, title="Workfile" ) # Deprecated - colorManagementPreference_v2: ColorManagementPreferenceV2Model = Field( + colorManagementPreference_v2: ColorManagementPreferenceV2Model = SettingsField( default_factory=ColorManagementPreferenceV2Model, title="DEPRECATED: Color Management Preference v2 (Maya 2022+)" ) - colorManagementPreference: ColorManagementPreferenceModel = Field( + colorManagementPreference: ColorManagementPreferenceModel = SettingsField( default_factory=ColorManagementPreferenceModel, title="DEPRECATED: Color Management Preference (legacy)" ) diff --git a/server_addon/maya/server/settings/include_handles.py b/server_addon/maya/server/settings/include_handles.py index 3ba6aca66b..931222ad2d 100644 --- a/server_addon/maya/server/settings/include_handles.py +++ b/server_addon/maya/server/settings/include_handles.py @@ -1,24 +1,26 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel, task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class IncludeByTaskTypeModel(BaseSettingsModel): - task_type: list[str] = Field( + task_type: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - include_handles: bool = Field(True, title="Include handles") + include_handles: bool = SettingsField(True, title="Include handles") class IncludeHandlesModel(BaseSettingsModel): """Maya dirmap settings.""" # _layout = "expanded" - include_handles_default: bool = Field( + include_handles_default: bool = SettingsField( True, title="Include handles by default" ) - per_task_type: list[IncludeByTaskTypeModel] = Field( + per_task_type: list[IncludeByTaskTypeModel] = SettingsField( default_factory=list, title="Include/exclude handles by task type" ) diff --git a/server_addon/maya/server/settings/loaders.py b/server_addon/maya/server/settings/loaders.py index ed6b6fd2ac..1d5b972056 100644 --- a/server_addon/maya/server/settings/loaders.py +++ b/server_addon/maya/server/settings/loaders.py @@ -1,66 +1,64 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.types import ColorRGBA_uint8 class ColorsSetting(BaseSettingsModel): - model: ColorRGBA_uint8 = Field( + model: ColorRGBA_uint8 = SettingsField( (209, 132, 30, 1.0), title="Model:") - rig: ColorRGBA_uint8 = Field( + rig: ColorRGBA_uint8 = SettingsField( (59, 226, 235, 1.0), title="Rig:") - pointcache: ColorRGBA_uint8 = Field( + pointcache: ColorRGBA_uint8 = SettingsField( (94, 209, 30, 1.0), title="Pointcache:") - animation: ColorRGBA_uint8 = Field( + animation: ColorRGBA_uint8 = SettingsField( (94, 209, 30, 1.0), title="Animation:") - ass: ColorRGBA_uint8 = Field( + ass: ColorRGBA_uint8 = SettingsField( (249, 135, 53, 1.0), title="Arnold StandIn:") - camera: ColorRGBA_uint8 = Field( + camera: ColorRGBA_uint8 = SettingsField( (136, 114, 244, 1.0), title="Camera:") - fbx: ColorRGBA_uint8 = Field( + fbx: ColorRGBA_uint8 = SettingsField( (215, 166, 255, 1.0), title="FBX:") - mayaAscii: ColorRGBA_uint8 = Field( + mayaAscii: ColorRGBA_uint8 = SettingsField( (67, 174, 255, 1.0), title="Maya Ascii:") - mayaScene: ColorRGBA_uint8 = Field( + mayaScene: ColorRGBA_uint8 = SettingsField( (67, 174, 255, 1.0), title="Maya Scene:") - setdress: ColorRGBA_uint8 = Field( + setdress: ColorRGBA_uint8 = SettingsField( (255, 250, 90, 1.0), title="Set Dress:") - layout: ColorRGBA_uint8 = Field(( + layout: ColorRGBA_uint8 = SettingsField(( 255, 250, 90, 1.0), title="Layout:") - vdbcache: ColorRGBA_uint8 = Field( + vdbcache: ColorRGBA_uint8 = SettingsField( (249, 54, 0, 1.0), title="VDB Cache:") - vrayproxy: ColorRGBA_uint8 = Field( + vrayproxy: ColorRGBA_uint8 = SettingsField( (255, 150, 12, 1.0), title="VRay Proxy:") - vrayscene_layer: ColorRGBA_uint8 = Field( + vrayscene_layer: ColorRGBA_uint8 = SettingsField( (255, 150, 12, 1.0), title="VRay Scene:") - yeticache: ColorRGBA_uint8 = Field( + yeticache: ColorRGBA_uint8 = SettingsField( (99, 206, 220, 1.0), title="Yeti Cache:") - yetiRig: ColorRGBA_uint8 = Field( + yetiRig: ColorRGBA_uint8 = SettingsField( (0, 205, 125, 1.0), title="Yeti Rig:") class ReferenceLoaderModel(BaseSettingsModel): - namespace: str = Field(title="Namespace") - group_name: str = Field(title="Group name") - display_handle: bool = Field(title="Display Handle On Load References") + namespace: str = SettingsField(title="Namespace") + group_name: str = SettingsField(title="Group name") + display_handle: bool = SettingsField(title="Display Handle On Load References") class ImportLoaderModel(BaseSettingsModel): - namespace: str = Field(title="Namespace") - group_name: str = Field(title="Group name") + namespace: str = SettingsField(title="Namespace") + group_name: str = SettingsField(title="Group name") class LoadersModel(BaseSettingsModel): - colors: ColorsSetting = Field( + colors: ColorsSetting = SettingsField( default_factory=ColorsSetting, title="Loaded Products Outliner Colors") - reference_loader: ReferenceLoaderModel = Field( + reference_loader: ReferenceLoaderModel = SettingsField( default_factory=ReferenceLoaderModel, title="Reference Loader" ) - import_loader: ImportLoaderModel = Field( + import_loader: ImportLoaderModel = SettingsField( default_factory=ImportLoaderModel, title="Import Loader" ) diff --git a/server_addon/maya/server/settings/main.py b/server_addon/maya/server/settings/main.py index 3d084312e9..ddfb797f8a 100644 --- a/server_addon/maya/server/settings/main.py +++ b/server_addon/maya/server/settings/main.py @@ -1,5 +1,9 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel, ensure_unique_names +from pydantic import validator +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + ensure_unique_names, +) from .imageio import ImageIOSettings, DEFAULT_IMAGEIO_SETTINGS from .maya_dirmap import MayaDirmapModel, DEFAULT_MAYA_DIRMAP_SETTINGS from .include_handles import IncludeHandlesModel, DEFAULT_INCLUDE_HANDLES @@ -19,44 +23,44 @@ from .templated_workfile_settings import ( class ExtMappingItemModel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Product type") - value: str = Field(title="Extension") + name: str = SettingsField(title="Product type") + value: str = SettingsField(title="Extension") class MayaSettings(BaseSettingsModel): """Maya Project Settings.""" - open_workfile_post_initialization: bool = Field( + open_workfile_post_initialization: bool = SettingsField( True, title="Open Workfile Post Initialization") - explicit_plugins_loading: ExplicitPluginsLoadingModel = Field( + explicit_plugins_loading: ExplicitPluginsLoadingModel = SettingsField( default_factory=ExplicitPluginsLoadingModel, title="Explicit Plugins Loading") - imageio: ImageIOSettings = Field( + imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (imageio)") - mel_workspace: str = Field(title="Maya MEL Workspace", widget="textarea") - ext_mapping: list[ExtMappingItemModel] = Field( + mel_workspace: str = SettingsField(title="Maya MEL Workspace", widget="textarea") + ext_mapping: list[ExtMappingItemModel] = SettingsField( default_factory=list, title="Extension Mapping") - maya_dirmap: MayaDirmapModel = Field( + maya_dirmap: MayaDirmapModel = SettingsField( default_factory=MayaDirmapModel, title="Maya dirmap Settings") - include_handles: IncludeHandlesModel = Field( + include_handles: IncludeHandlesModel = SettingsField( default_factory=IncludeHandlesModel, title="Include/Exclude Handles in default playback & render range" ) - scriptsmenu: ScriptsmenuModel = Field( + scriptsmenu: ScriptsmenuModel = SettingsField( default_factory=ScriptsmenuModel, title="Scriptsmenu Settings" ) - render_settings: RenderSettingsModel = Field( + render_settings: RenderSettingsModel = SettingsField( default_factory=RenderSettingsModel, title="Render Settings") - create: CreatorsModel = Field( + create: CreatorsModel = SettingsField( default_factory=CreatorsModel, title="Creators") - publish: PublishersModel = Field( + publish: PublishersModel = SettingsField( default_factory=PublishersModel, title="Publishers") - load: LoadersModel = Field( + load: LoadersModel = SettingsField( default_factory=LoadersModel, title="Loaders") - workfile_build: ProfilesModel = Field( + workfile_build: ProfilesModel = SettingsField( default_factory=ProfilesModel, title="Workfile Build Settings") - templated_workfile_build: TemplatedProfilesModel = Field( + templated_workfile_build: TemplatedProfilesModel = SettingsField( default_factory=TemplatedProfilesModel, title="Templated Workfile Build Settings") diff --git a/server_addon/maya/server/settings/maya_dirmap.py b/server_addon/maya/server/settings/maya_dirmap.py index 243261dc87..f68028cd79 100644 --- a/server_addon/maya/server/settings/maya_dirmap.py +++ b/server_addon/maya/server/settings/maya_dirmap.py @@ -1,14 +1,12 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class MayaDirmapPathsSubmodel(BaseSettingsModel): _layout = "compact" - source_path: list[str] = Field( + source_path: list[str] = SettingsField( default_factory=list, title="Source Paths" ) - destination_path: list[str] = Field( + destination_path: list[str] = SettingsField( default_factory=list, title="Destination Paths" ) @@ -18,13 +16,13 @@ class MayaDirmapModel(BaseSettingsModel): # _layout = "expanded" _isGroup: bool = True - enabled: bool = Field(title="enabled") + enabled: bool = SettingsField(title="enabled") # Use ${} placeholder instead of absolute value of a root in # referenced filepaths. - use_env_var_as_root: bool = Field( + use_env_var_as_root: bool = SettingsField( title="Use env var placeholder in referenced paths" ) - paths: MayaDirmapPathsSubmodel = Field( + paths: MayaDirmapPathsSubmodel = SettingsField( default_factory=MayaDirmapPathsSubmodel, title="Dirmap Paths" ) diff --git a/server_addon/maya/server/settings/publish_playblast.py b/server_addon/maya/server/settings/publish_playblast.py index 0abc9f7110..0461a18cc8 100644 --- a/server_addon/maya/server/settings/publish_playblast.py +++ b/server_addon/maya/server/settings/publish_playblast.py @@ -1,7 +1,8 @@ -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names, task_types_enum, ) @@ -43,36 +44,40 @@ def plugin_objects_default(): class CodecSetting(BaseSettingsModel): _layout = "expanded" - compression: str = Field("png", title="Encoding") - format: str = Field("image", title="Format") - quality: int = Field(95, title="Quality", ge=0, le=100) + compression: str = SettingsField("png", title="Encoding") + format: str = SettingsField("image", title="Format") + quality: int = SettingsField(95, title="Quality", ge=0, le=100) class DisplayOptionsSetting(BaseSettingsModel): _layout = "expanded" - override_display: bool = Field(True, title="Override display options") - background: ColorRGBA_uint8 = Field( + override_display: bool = SettingsField( + True, title="Override display options" + ) + background: ColorRGBA_uint8 = SettingsField( (125, 125, 125, 1.0), title="Background Color" ) - displayGradient: bool = Field(True, title="Display background gradient") - backgroundTop: ColorRGBA_uint8 = Field( + displayGradient: bool = SettingsField( + True, title="Display background gradient" + ) + backgroundTop: ColorRGBA_uint8 = SettingsField( (125, 125, 125, 1.0), title="Background Top" ) - backgroundBottom: ColorRGBA_uint8 = Field( + backgroundBottom: ColorRGBA_uint8 = SettingsField( (125, 125, 125, 1.0), title="Background Bottom" ) class GenericSetting(BaseSettingsModel): _layout = "expanded" - isolate_view: bool = Field(True, title="Isolate View") - off_screen: bool = Field(True, title="Off Screen") - pan_zoom: bool = Field(False, title="2D Pan/Zoom") + isolate_view: bool = SettingsField(True, title="Isolate View") + off_screen: bool = SettingsField(True, title="Off Screen") + pan_zoom: bool = SettingsField(False, title="2D Pan/Zoom") class RendererSetting(BaseSettingsModel): _layout = "expanded" - rendererName: str = Field( + rendererName: str = SettingsField( "vp2Renderer", enum_resolver=renderer_enum, title="Renderer name" @@ -81,100 +86,112 @@ class RendererSetting(BaseSettingsModel): class ResolutionSetting(BaseSettingsModel): _layout = "expanded" - width: int = Field(0, title="Width") - height: int = Field(0, title="Height") + width: int = SettingsField(0, title="Width") + height: int = SettingsField(0, title="Height") class PluginObjectsModel(BaseSettingsModel): - name: str = Field("", title="Name") - value: bool = Field(True, title="Enabled") + name: str = SettingsField("", title="Name") + value: bool = SettingsField(True, title="Enabled") class ViewportOptionsSetting(BaseSettingsModel): - override_viewport_options: bool = Field( + override_viewport_options: bool = SettingsField( True, title="Override viewport options" ) - displayLights: str = Field( + displayLights: str = SettingsField( "default", enum_resolver=displayLights_enum, title="Display Lights" ) - displayTextures: bool = Field(True, title="Display Textures") - textureMaxResolution: int = Field(1024, title="Texture Clamp Resolution") - renderDepthOfField: bool = Field( + displayTextures: bool = SettingsField(True, title="Display Textures") + textureMaxResolution: int = SettingsField( + 1024, title="Texture Clamp Resolution" + ) + renderDepthOfField: bool = SettingsField( True, title="Depth of Field", section="Depth of Field" ) - shadows: bool = Field(True, title="Display Shadows") - twoSidedLighting: bool = Field(True, title="Two Sided Lighting") - lineAAEnable: bool = Field( + shadows: bool = SettingsField(True, title="Display Shadows") + twoSidedLighting: bool = SettingsField(True, title="Two Sided Lighting") + lineAAEnable: bool = SettingsField( True, title="Enable Anti-Aliasing", section="Anti-Aliasing" ) - multiSample: int = Field(8, title="Anti Aliasing Samples") - loadTextures: bool = Field(False, title="Load Textures") - useDefaultMaterial: bool = Field(False, title="Use Default Material") - wireframeOnShaded: bool = Field(False, title="Wireframe On Shaded") - xray: bool = Field(False, title="X-Ray") - jointXray: bool = Field(False, title="X-Ray Joints") - backfaceCulling: bool = Field(False, title="Backface Culling") - ssaoEnable: bool = Field( + multiSample: int = SettingsField(8, title="Anti Aliasing Samples") + loadTextures: bool = SettingsField(False, title="Load Textures") + useDefaultMaterial: bool = SettingsField( + False, title="Use Default Material" + ) + wireframeOnShaded: bool = SettingsField(False, title="Wireframe On Shaded") + xray: bool = SettingsField(False, title="X-Ray") + jointXray: bool = SettingsField(False, title="X-Ray Joints") + backfaceCulling: bool = SettingsField(False, title="Backface Culling") + ssaoEnable: bool = SettingsField( False, title="Screen Space Ambient Occlusion", section="SSAO" ) - ssaoAmount: int = Field(1, title="SSAO Amount") - ssaoRadius: int = Field(16, title="SSAO Radius") - ssaoFilterRadius: int = Field(16, title="SSAO Filter Radius") - ssaoSamples: int = Field(16, title="SSAO Samples") - fogging: bool = Field(False, title="Enable Hardware Fog", section="Fog") - hwFogFalloff: str = Field( + ssaoAmount: int = SettingsField(1, title="SSAO Amount") + ssaoRadius: int = SettingsField(16, title="SSAO Radius") + ssaoFilterRadius: int = SettingsField(16, title="SSAO Filter Radius") + ssaoSamples: int = SettingsField(16, title="SSAO Samples") + fogging: bool = SettingsField( + False, title="Enable Hardware Fog", section="Fog" + ) + hwFogFalloff: str = SettingsField( "0", enum_resolver=hardware_falloff_enum, title="Hardware Falloff" ) - hwFogDensity: float = Field(0.0, title="Fog Density") - hwFogStart: int = Field(0, title="Fog Start") - hwFogEnd: int = Field(100, title="Fog End") - hwFogAlpha: int = Field(0, title="Fog Alpha") - hwFogColorR: float = Field(1.0, title="Fog Color R") - hwFogColorG: float = Field(1.0, title="Fog Color G") - hwFogColorB: float = Field(1.0, title="Fog Color B") - motionBlurEnable: bool = Field( + hwFogDensity: float = SettingsField(0.0, title="Fog Density") + hwFogStart: int = SettingsField(0, title="Fog Start") + hwFogEnd: int = SettingsField(100, title="Fog End") + hwFogAlpha: int = SettingsField(0, title="Fog Alpha") + hwFogColorR: float = SettingsField(1.0, title="Fog Color R") + hwFogColorG: float = SettingsField(1.0, title="Fog Color G") + hwFogColorB: float = SettingsField(1.0, title="Fog Color B") + motionBlurEnable: bool = SettingsField( False, title="Enable Motion Blur", section="Motion Blur" ) - motionBlurSampleCount: int = Field(8, title="Motion Blur Sample Count") - motionBlurShutterOpenFraction: float = Field( + motionBlurSampleCount: int = SettingsField( + 8, title="Motion Blur Sample Count" + ) + motionBlurShutterOpenFraction: float = SettingsField( 0.2, title="Shutter Open Fraction" ) - cameras: bool = Field(False, title="Cameras", section="Show") - clipGhosts: bool = Field(False, title="Clip Ghosts") - deformers: bool = Field(False, title="Deformers") - dimensions: bool = Field(False, title="Dimensions") - dynamicConstraints: bool = Field(False, title="Dynamic Constraints") - dynamics: bool = Field(False, title="Dynamics") - fluids: bool = Field(False, title="Fluids") - follicles: bool = Field(False, title="Follicles") - greasePencils: bool = Field(False, title="Grease Pencils") - grid: bool = Field(False, title="Grid") - hairSystems: bool = Field(True, title="Hair Systems") - handles: bool = Field(False, title="Handles") - headsUpDisplay: bool = Field(False, title="HUD") - ikHandles: bool = Field(False, title="IK Handles") - imagePlane: bool = Field(True, title="Image Plane") - joints: bool = Field(False, title="Joints") - lights: bool = Field(False, title="Lights") - locators: bool = Field(False, title="Locators") - manipulators: bool = Field(False, title="Manipulators") - motionTrails: bool = Field(False, title="Motion Trails") - nCloths: bool = Field(False, title="nCloths") - nParticles: bool = Field(False, title="nParticles") - nRigids: bool = Field(False, title="nRigids") - controlVertices: bool = Field(False, title="NURBS CVs") - nurbsCurves: bool = Field(False, title="NURBS Curves") - hulls: bool = Field(False, title="NURBS Hulls") - nurbsSurfaces: bool = Field(False, title="NURBS Surfaces") - particleInstancers: bool = Field(False, title="Particle Instancers") - pivots: bool = Field(False, title="Pivots") - planes: bool = Field(False, title="Planes") - pluginShapes: bool = Field(False, title="Plugin Shapes") - polymeshes: bool = Field(True, title="Polygons") - strokes: bool = Field(False, title="Strokes") - subdivSurfaces: bool = Field(False, title="Subdiv Surfaces") - textures: bool = Field(False, title="Texture Placements") - pluginObjects: list[PluginObjectsModel] = Field( + cameras: bool = SettingsField(False, title="Cameras", section="Show") + clipGhosts: bool = SettingsField(False, title="Clip Ghosts") + deformers: bool = SettingsField(False, title="Deformers") + dimensions: bool = SettingsField(False, title="Dimensions") + dynamicConstraints: bool = SettingsField( + False, title="Dynamic Constraints" + ) + dynamics: bool = SettingsField(False, title="Dynamics") + fluids: bool = SettingsField(False, title="Fluids") + follicles: bool = SettingsField(False, title="Follicles") + greasePencils: bool = SettingsField(False, title="Grease Pencils") + grid: bool = SettingsField(False, title="Grid") + hairSystems: bool = SettingsField(True, title="Hair Systems") + handles: bool = SettingsField(False, title="Handles") + headsUpDisplay: bool = SettingsField(False, title="HUD") + ikHandles: bool = SettingsField(False, title="IK Handles") + imagePlane: bool = SettingsField(True, title="Image Plane") + joints: bool = SettingsField(False, title="Joints") + lights: bool = SettingsField(False, title="Lights") + locators: bool = SettingsField(False, title="Locators") + manipulators: bool = SettingsField(False, title="Manipulators") + motionTrails: bool = SettingsField(False, title="Motion Trails") + nCloths: bool = SettingsField(False, title="nCloths") + nParticles: bool = SettingsField(False, title="nParticles") + nRigids: bool = SettingsField(False, title="nRigids") + controlVertices: bool = SettingsField(False, title="NURBS CVs") + nurbsCurves: bool = SettingsField(False, title="NURBS Curves") + hulls: bool = SettingsField(False, title="NURBS Hulls") + nurbsSurfaces: bool = SettingsField(False, title="NURBS Surfaces") + particleInstancers: bool = SettingsField( + False, title="Particle Instancers" + ) + pivots: bool = SettingsField(False, title="Pivots") + planes: bool = SettingsField(False, title="Planes") + pluginShapes: bool = SettingsField(False, title="Plugin Shapes") + polymeshes: bool = SettingsField(True, title="Polygons") + strokes: bool = SettingsField(False, title="Strokes") + subdivSurfaces: bool = SettingsField(False, title="Subdiv Surfaces") + textures: bool = SettingsField(False, title="Texture Placements") + pluginObjects: list[PluginObjectsModel] = SettingsField( default_factory=plugin_objects_default, title="Plugin Objects" ) @@ -186,67 +203,71 @@ class ViewportOptionsSetting(BaseSettingsModel): class CameraOptionsSetting(BaseSettingsModel): - displayGateMask: bool = Field(False, title="Display Gate Mask") - displayResolution: bool = Field(False, title="Display Resolution") - displayFilmGate: bool = Field(False, title="Display Film Gate") - displayFieldChart: bool = Field(False, title="Display Field Chart") - displaySafeAction: bool = Field(False, title="Display Safe Action") - displaySafeTitle: bool = Field(False, title="Display Safe Title") - displayFilmPivot: bool = Field(False, title="Display Film Pivot") - displayFilmOrigin: bool = Field(False, title="Display Film Origin") - overscan: int = Field(1.0, title="Overscan") + displayGateMask: bool = SettingsField(False, title="Display Gate Mask") + displayResolution: bool = SettingsField(False, title="Display Resolution") + displayFilmGate: bool = SettingsField(False, title="Display Film Gate") + displayFieldChart: bool = SettingsField(False, title="Display Field Chart") + displaySafeAction: bool = SettingsField(False, title="Display Safe Action") + displaySafeTitle: bool = SettingsField(False, title="Display Safe Title") + displayFilmPivot: bool = SettingsField(False, title="Display Film Pivot") + displayFilmOrigin: bool = SettingsField(False, title="Display Film Origin") + overscan: int = SettingsField(1.0, title="Overscan") class CapturePresetSetting(BaseSettingsModel): - Codec: CodecSetting = Field( + Codec: CodecSetting = SettingsField( default_factory=CodecSetting, title="Codec", section="Codec") - DisplayOptions: DisplayOptionsSetting = Field( + DisplayOptions: DisplayOptionsSetting = SettingsField( default_factory=DisplayOptionsSetting, title="Display Options", section="Display Options") - Generic: GenericSetting = Field( + Generic: GenericSetting = SettingsField( default_factory=GenericSetting, title="Generic", section="Generic") - Renderer: RendererSetting = Field( + Renderer: RendererSetting = SettingsField( default_factory=RendererSetting, title="Renderer", section="Renderer") - Resolution: ResolutionSetting = Field( + Resolution: ResolutionSetting = SettingsField( default_factory=ResolutionSetting, title="Resolution", section="Resolution") - ViewportOptions: ViewportOptionsSetting = Field( + ViewportOptions: ViewportOptionsSetting = SettingsField( default_factory=ViewportOptionsSetting, title="Viewport Options") - CameraOptions: CameraOptionsSetting = Field( + CameraOptions: CameraOptionsSetting = SettingsField( default_factory=CameraOptionsSetting, title="Camera Options") class ProfilesModel(BaseSettingsModel): _layout = "expanded" - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field(default_factory=list, title="Task names") - product_names: list[str] = Field(default_factory=list, title="Products names") - capture_preset: CapturePresetSetting = Field( + task_names: list[str] = SettingsField( + default_factory=list, title="Task names" + ) + product_names: list[str] = SettingsField( + default_factory=list, title="Products names" + ) + capture_preset: CapturePresetSetting = SettingsField( default_factory=CapturePresetSetting, title="Capture Preset" ) class ExtractPlayblastSetting(BaseSettingsModel): - capture_preset: CapturePresetSetting = Field( + capture_preset: CapturePresetSetting = SettingsField( default_factory=CapturePresetSetting, title="DEPRECATED! Please use \"Profiles\" below. Capture Preset" ) - profiles: list[ProfilesModel] = Field( + profiles: list[ProfilesModel] = SettingsField( default_factory=list, title="Profiles" ) diff --git a/server_addon/maya/server/settings/publishers.py b/server_addon/maya/server/settings/publishers.py index e823efe681..3a6de2eb44 100644 --- a/server_addon/maya/server/settings/publishers.py +++ b/server_addon/maya/server/settings/publishers.py @@ -1,7 +1,8 @@ import json -from pydantic import Field, validator +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathModel, ensure_unique_names, ) @@ -35,9 +36,9 @@ def angular_unit_enum(): class BasicValidateModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class ValidateMeshUVSetMap1Model(BasicValidateModel): @@ -51,22 +52,24 @@ class ValidateNoAnimationModel(BasicValidateModel): class ValidateRigOutSetNodeIdsModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateSkinclusterDeformerSet") - optional: bool = Field(title="Optional") - allow_history_only: bool = Field(title="Allow history only") + enabled: bool = SettingsField(title="ValidateSkinclusterDeformerSet") + optional: bool = SettingsField(title="Optional") + allow_history_only: bool = SettingsField(title="Allow history only") class ValidateModelNameModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - database: bool = Field(title="Use database shader name definitions") - material_file: MultiplatformPathModel = Field( + enabled: bool = SettingsField(title="Enabled") + database: bool = SettingsField( + title="Use database shader name definitions" + ) + material_file: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Material File", description=( "Path to material file defining list of material names to check." ) ) - regex: str = Field( + regex: str = SettingsField( "(.*)_(\\d)*_(?P.*)_(GEO)", title="Validation regex", description=( @@ -74,7 +77,7 @@ class ValidateModelNameModel(BaseSettingsModel): " named capturing groups:(?P.*) for Asset name" ) ) - top_level_regex: str = Field( + top_level_regex: str = SettingsField( ".*_GRP", title="Top level group name regex", description=( @@ -85,15 +88,15 @@ class ValidateModelNameModel(BaseSettingsModel): class ValidateModelContentModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - validate_top_group: bool = Field(title="Validate one top group") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + validate_top_group: bool = SettingsField(title="Validate one top group") class ValidateTransformNamingSuffixModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - SUFFIX_NAMING_TABLE: str = Field( + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + SUFFIX_NAMING_TABLE: str = SettingsField( "{}", title="Suffix Naming Tables", widget="textarea", @@ -118,34 +121,34 @@ class ValidateTransformNamingSuffixModel(BaseSettingsModel): "The text can't be parsed as json object" ) return value - ALLOW_IF_NOT_IN_SUFFIX_TABLE: bool = Field( + ALLOW_IF_NOT_IN_SUFFIX_TABLE: bool = SettingsField( title="Allow if suffix not in table" ) class CollectMayaRenderModel(BaseSettingsModel): - sync_workfile_version: bool = Field( + sync_workfile_version: bool = SettingsField( title="Sync render version with workfile" ) class CollectFbxAnimationModel(BaseSettingsModel): - enabled: bool = Field(title="Collect Fbx Animation") + enabled: bool = SettingsField(title="Collect Fbx Animation") class CollectFbxCameraModel(BaseSettingsModel): - enabled: bool = Field(title="CollectFbxCamera") + enabled: bool = SettingsField(title="CollectFbxCamera") class CollectGLTFModel(BaseSettingsModel): - enabled: bool = Field(title="CollectGLTF") + enabled: bool = SettingsField(title="CollectGLTF") class ValidateFrameRangeModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateFrameRange") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - exclude_product_types: list[str] = Field( + enabled: bool = SettingsField(title="ValidateFrameRange") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + exclude_product_types: list[str] = SettingsField( default_factory=list, title="Exclude product types" ) @@ -155,15 +158,18 @@ class ValidateShaderNameModel(BaseSettingsModel): """ Shader name regex can use named capture group asset to validate against current asset name. """ - enabled: bool = Field(title="ValidateShaderName") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - regex: str = Field("(?P.*)_(.*)_SHD", title="Validation regex") + enabled: bool = SettingsField(title="ValidateShaderName") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + regex: str = SettingsField( + "(?P.*)_(.*)_SHD", + title="Validation regex" + ) class ValidateAttributesModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateAttributes") - attributes: str = Field( + enabled: bool = SettingsField(title="ValidateAttributes") + attributes: str = SettingsField( "{}", title="Attributes", widget="textarea") @validator("attributes") @@ -184,46 +190,50 @@ class ValidateAttributesModel(BaseSettingsModel): class ValidateLoadedPluginModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateLoadedPlugin") - optional: bool = Field(title="Optional") - whitelist_native_plugins: bool = Field( + enabled: bool = SettingsField(title="ValidateLoadedPlugin") + optional: bool = SettingsField(title="Optional") + whitelist_native_plugins: bool = SettingsField( title="Whitelist Maya Native Plugins" ) - authorized_plugins: list[str] = Field( + authorized_plugins: list[str] = SettingsField( default_factory=list, title="Authorized plugins" ) class ValidateMayaUnitsModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateMayaUnits") - optional: bool = Field(title="Optional") - validate_linear_units: bool = Field(title="Validate linear units") - linear_units: str = Field( + enabled: bool = SettingsField(title="ValidateMayaUnits") + optional: bool = SettingsField(title="Optional") + validate_linear_units: bool = SettingsField(title="Validate linear units") + linear_units: str = SettingsField( enum_resolver=linear_unit_enum, title="Linear Units" ) - validate_angular_units: bool = Field(title="Validate angular units") - angular_units: str = Field( + validate_angular_units: bool = SettingsField( + title="Validate angular units" + ) + angular_units: str = SettingsField( enum_resolver=angular_unit_enum, title="Angular units" ) - validate_fps: bool = Field(title="Validate fps") + validate_fps: bool = SettingsField(title="Validate fps") class ValidateUnrealStaticMeshNameModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateUnrealStaticMeshName") - optional: bool = Field(title="Optional") - validate_mesh: bool = Field(title="Validate mesh names") - validate_collision: bool = Field(title="Validate collison names") + enabled: bool = SettingsField(title="ValidateUnrealStaticMeshName") + optional: bool = SettingsField(title="Optional") + validate_mesh: bool = SettingsField(title="Validate mesh names") + validate_collision: bool = SettingsField(title="Validate collison names") class ValidateCycleErrorModel(BaseSettingsModel): - enabled: bool = Field(title="ValidateCycleError") - optional: bool = Field(title="Optional") - families: list[str] = Field(default_factory=list, title="Families") + enabled: bool = SettingsField(title="ValidateCycleError") + optional: bool = SettingsField(title="Optional") + families: list[str] = SettingsField( + default_factory=list, title="Families" + ) class ValidatePluginPathAttributesAttrModel(BaseSettingsModel): - name: str = Field(title="Node type") - value: str = Field(title="Attribute") + name: str = SettingsField(title="Node type") + value: str = SettingsField(title="Attribute") class ValidatePluginPathAttributesModel(BaseSettingsModel): @@ -234,9 +244,9 @@ class ValidatePluginPathAttributesModel(BaseSettingsModel): """ enabled: bool = True - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - attribute: list[ValidatePluginPathAttributesAttrModel] = Field( + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + attribute: list[ValidatePluginPathAttributesAttrModel] = SettingsField( default_factory=list, title="File Attribute" ) @@ -250,66 +260,68 @@ class ValidatePluginPathAttributesModel(BaseSettingsModel): # Validate Render Setting class RendererAttributesModel(BaseSettingsModel): _layout = "compact" - type: str = Field(title="Type") - value: str = Field(title="Value") + type: str = SettingsField(title="Type") + value: str = SettingsField(title="Value") class ValidateRenderSettingsModel(BaseSettingsModel): - arnold_render_attributes: list[RendererAttributesModel] = Field( + arnold_render_attributes: list[RendererAttributesModel] = SettingsField( default_factory=list, title="Arnold Render Attributes") - vray_render_attributes: list[RendererAttributesModel] = Field( + vray_render_attributes: list[RendererAttributesModel] = SettingsField( default_factory=list, title="VRay Render Attributes") - redshift_render_attributes: list[RendererAttributesModel] = Field( + redshift_render_attributes: list[RendererAttributesModel] = SettingsField( default_factory=list, title="Redshift Render Attributes") - renderman_render_attributes: list[RendererAttributesModel] = Field( + renderman_render_attributes: list[RendererAttributesModel] = SettingsField( default_factory=list, title="Renderman Render Attributes") class BasicValidateModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class ValidateCameraContentsModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - validate_shapes: bool = Field(title="Validate presence of shapes") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + validate_shapes: bool = SettingsField(title="Validate presence of shapes") class ExtractProxyAlembicModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - families: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + families: list[str] = SettingsField( default_factory=list, title="Families") class ExtractAlembicModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - families: list[str] = Field( + enabled: bool = SettingsField(title="Enabled") + families: list[str] = SettingsField( default_factory=list, title="Families") class ExtractObjModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") class ExtractMayaSceneRawModel(BaseSettingsModel): """Add loaded instances to those published families:""" - enabled: bool = Field(title="ExtractMayaSceneRaw") - add_for_families: list[str] = Field(default_factory=list, title="Families") + enabled: bool = SettingsField(title="ExtractMayaSceneRaw") + add_for_families: list[str] = SettingsField( + default_factory=list, title="Families" + ) class ExtractCameraAlembicModel(BaseSettingsModel): """ List of attributes that will be added to the baked alembic camera. Needs to be written in python list syntax. """ - enabled: bool = Field(title="ExtractCameraAlembic") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") - bake_attributes: str = Field( + enabled: bool = SettingsField(title="ExtractCameraAlembic") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") + bake_attributes: str = SettingsField( "[]", title="Base Attributes", widget="textarea" ) @@ -332,17 +344,19 @@ class ExtractCameraAlembicModel(BaseSettingsModel): class ExtractGLBModel(BaseSettingsModel): enabled: bool = True - active: bool = Field(title="Active") - ogsfx_path: str = Field(title="GLSL Shader Directory") + active: bool = SettingsField(title="Active") + ogsfx_path: str = SettingsField(title="GLSL Shader Directory") class ExtractLookArgsModel(BaseSettingsModel): - argument: str = Field(title="Argument") - parameters: list[str] = Field(default_factory=list, title="Parameters") + argument: str = SettingsField(title="Argument") + parameters: list[str] = SettingsField( + default_factory=list, title="Parameters" + ) class ExtractLookModel(BaseSettingsModel): - maketx_arguments: list[ExtractLookArgsModel] = Field( + maketx_arguments: list[ExtractLookArgsModel] = SettingsField( default_factory=list, title="Extra arguments for maketx command line" ) @@ -350,423 +364,437 @@ class ExtractLookModel(BaseSettingsModel): class ExtractGPUCacheModel(BaseSettingsModel): enabled: bool = True - families: list[str] = Field(default_factory=list, title="Families") - step: float = Field(1.0, ge=1.0, title="Step") - stepSave: int = Field(1, ge=1, title="Step Save") - optimize: bool = Field(title="Optimize Hierarchy") - optimizationThreshold: int = Field(1, ge=1, title="Optimization Threshold") - optimizeAnimationsForMotionBlur: bool = Field( + families: list[str] = SettingsField(default_factory=list, title="Families") + step: float = SettingsField(1.0, ge=1.0, title="Step") + stepSave: int = SettingsField(1, ge=1, title="Step Save") + optimize: bool = SettingsField(title="Optimize Hierarchy") + optimizationThreshold: int = SettingsField( + 1, ge=1, title="Optimization Threshold" + ) + optimizeAnimationsForMotionBlur: bool = SettingsField( title="Optimize Animations For Motion Blur" ) - writeMaterials: bool = Field(title="Write Materials") - useBaseTessellation: bool = Field(title="User Base Tesselation") + writeMaterials: bool = SettingsField(title="Write Materials") + useBaseTessellation: bool = SettingsField(title="User Base Tesselation") class PublishersModel(BaseSettingsModel): - CollectMayaRender: CollectMayaRenderModel = Field( + CollectMayaRender: CollectMayaRenderModel = SettingsField( default_factory=CollectMayaRenderModel, title="Collect Render Layers", section="Collectors" ) - CollectFbxAnimation: CollectFbxAnimationModel = Field( + CollectFbxAnimation: CollectFbxAnimationModel = SettingsField( default_factory=CollectFbxAnimationModel, title="Collect FBX Animation", ) - CollectFbxCamera: CollectFbxCameraModel = Field( + CollectFbxCamera: CollectFbxCameraModel = SettingsField( default_factory=CollectFbxCameraModel, title="Collect Camera for FBX export", ) - CollectGLTF: CollectGLTFModel = Field( + CollectGLTF: CollectGLTFModel = SettingsField( default_factory=CollectGLTFModel, title="Collect Assets for GLB/GLTF export" ) - ValidateInstanceInContext: BasicValidateModel = Field( + ValidateInstanceInContext: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Instance In Context", section="Validators" ) - ValidateContainers: BasicValidateModel = Field( + ValidateContainers: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Containers" ) - ValidateFrameRange: ValidateFrameRangeModel = Field( + ValidateFrameRange: ValidateFrameRangeModel = SettingsField( default_factory=ValidateFrameRangeModel, title="Validate Frame Range" ) - ValidateShaderName: ValidateShaderNameModel = Field( + ValidateShaderName: ValidateShaderNameModel = SettingsField( default_factory=ValidateShaderNameModel, title="Validate Shader Name" ) - ValidateShadingEngine: BasicValidateModel = Field( + ValidateShadingEngine: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Look Shading Engine Naming" ) - ValidateMayaColorSpace: BasicValidateModel = Field( + ValidateMayaColorSpace: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Colorspace" ) - ValidateAttributes: ValidateAttributesModel = Field( + ValidateAttributes: ValidateAttributesModel = SettingsField( default_factory=ValidateAttributesModel, title="Validate Attributes" ) - ValidateLoadedPlugin: ValidateLoadedPluginModel = Field( + ValidateLoadedPlugin: ValidateLoadedPluginModel = SettingsField( default_factory=ValidateLoadedPluginModel, title="Validate Loaded Plugin" ) - ValidateMayaUnits: ValidateMayaUnitsModel = Field( + ValidateMayaUnits: ValidateMayaUnitsModel = SettingsField( default_factory=ValidateMayaUnitsModel, title="Validate Maya Units" ) - ValidateUnrealStaticMeshName: ValidateUnrealStaticMeshNameModel = Field( - default_factory=ValidateUnrealStaticMeshNameModel, - title="Validate Unreal Static Mesh Name" + ValidateUnrealStaticMeshName: ValidateUnrealStaticMeshNameModel = ( + SettingsField( + default_factory=ValidateUnrealStaticMeshNameModel, + title="Validate Unreal Static Mesh Name" + ) ) - ValidateCycleError: ValidateCycleErrorModel = Field( + ValidateCycleError: ValidateCycleErrorModel = SettingsField( default_factory=ValidateCycleErrorModel, title="Validate Cycle Error" ) - ValidatePluginPathAttributes: ValidatePluginPathAttributesModel = Field( - default_factory=ValidatePluginPathAttributesModel, - title="Plug-in Path Attributes" + ValidatePluginPathAttributes: ValidatePluginPathAttributesModel = ( + SettingsField( + default_factory=ValidatePluginPathAttributesModel, + title="Plug-in Path Attributes" + ) ) - ValidateRenderSettings: ValidateRenderSettingsModel = Field( + ValidateRenderSettings: ValidateRenderSettingsModel = SettingsField( default_factory=ValidateRenderSettingsModel, title="Validate Render Settings" ) - ValidateResolution: BasicValidateModel = Field( + ValidateResolution: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Resolution Setting" ) - ValidateCurrentRenderLayerIsRenderable: BasicValidateModel = Field( - default_factory=BasicValidateModel, - title="Validate Current Render Layer Has Renderable Camera" + ValidateCurrentRenderLayerIsRenderable: BasicValidateModel = ( + SettingsField( + default_factory=BasicValidateModel, + title="Validate Current Render Layer Has Renderable Camera" + ) ) - ValidateGLSLMaterial: BasicValidateModel = Field( + ValidateGLSLMaterial: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate GLSL Material" ) - ValidateGLSLPlugin: BasicValidateModel = Field( + ValidateGLSLPlugin: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate GLSL Plugin" ) - ValidateRenderImageRule: BasicValidateModel = Field( + ValidateRenderImageRule: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Render Image Rule (Workspace)" ) - ValidateRenderNoDefaultCameras: BasicValidateModel = Field( + ValidateRenderNoDefaultCameras: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No Default Cameras Renderable" ) - ValidateRenderSingleCamera: BasicValidateModel = Field( + ValidateRenderSingleCamera: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Render Single Camera " ) - ValidateRenderLayerAOVs: BasicValidateModel = Field( + ValidateRenderLayerAOVs: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Render Passes/AOVs Are Registered" ) - ValidateStepSize: BasicValidateModel = Field( + ValidateStepSize: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Step Size" ) - ValidateVRayDistributedRendering: BasicValidateModel = Field( + ValidateVRayDistributedRendering: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="VRay Distributed Rendering" ) - ValidateVrayReferencedAOVs: BasicValidateModel = Field( + ValidateVrayReferencedAOVs: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="VRay Referenced AOVs" ) - ValidateVRayTranslatorEnabled: BasicValidateModel = Field( + ValidateVRayTranslatorEnabled: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="VRay Translator Settings" ) - ValidateVrayProxy: BasicValidateModel = Field( + ValidateVrayProxy: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="VRay Proxy Settings" ) - ValidateVrayProxyMembers: BasicValidateModel = Field( + ValidateVrayProxyMembers: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="VRay Proxy Members" ) - ValidateYetiRenderScriptCallbacks: BasicValidateModel = Field( + ValidateYetiRenderScriptCallbacks: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Yeti Render Script Callbacks" ) - ValidateYetiRigCacheState: BasicValidateModel = Field( + ValidateYetiRigCacheState: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Yeti Rig Cache State" ) - ValidateYetiRigInputShapesInInstance: BasicValidateModel = Field( + ValidateYetiRigInputShapesInInstance: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Yeti Rig Input Shapes In Instance" ) - ValidateYetiRigSettings: BasicValidateModel = Field( + ValidateYetiRigSettings: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Yeti Rig Settings" ) # Model - START - ValidateModelName: ValidateModelNameModel = Field( + ValidateModelName: ValidateModelNameModel = SettingsField( default_factory=ValidateModelNameModel, title="Validate Model Name", section="Model", ) - ValidateModelContent: ValidateModelContentModel = Field( + ValidateModelContent: ValidateModelContentModel = SettingsField( default_factory=ValidateModelContentModel, title="Validate Model Content", ) - ValidateTransformNamingSuffix: ValidateTransformNamingSuffixModel = Field( - default_factory=ValidateTransformNamingSuffixModel, - title="Validate Transform Naming Suffix", + ValidateTransformNamingSuffix: ValidateTransformNamingSuffixModel = ( + SettingsField( + default_factory=ValidateTransformNamingSuffixModel, + title="Validate Transform Naming Suffix", + ) ) - ValidateColorSets: BasicValidateModel = Field( + ValidateColorSets: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Color Sets", ) - ValidateMeshHasOverlappingUVs: BasicValidateModel = Field( + ValidateMeshHasOverlappingUVs: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Has Overlapping UVs", ) - ValidateMeshArnoldAttributes: BasicValidateModel = Field( + ValidateMeshArnoldAttributes: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Arnold Attributes", ) - ValidateMeshShaderConnections: BasicValidateModel = Field( + ValidateMeshShaderConnections: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Shader Connections", ) - ValidateMeshSingleUVSet: BasicValidateModel = Field( + ValidateMeshSingleUVSet: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Single UV Set", ) - ValidateMeshHasUVs: BasicValidateModel = Field( + ValidateMeshHasUVs: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Has UVs", ) - ValidateMeshLaminaFaces: BasicValidateModel = Field( + ValidateMeshLaminaFaces: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Lamina Faces", ) - ValidateMeshNgons: BasicValidateModel = Field( + ValidateMeshNgons: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Ngons", ) - ValidateMeshNonManifold: BasicValidateModel = Field( + ValidateMeshNonManifold: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Non-Manifold", ) - ValidateMeshNoNegativeScale: BasicValidateModel = Field( + ValidateMeshNoNegativeScale: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh No Negative Scale", ) - ValidateMeshNonZeroEdgeLength: BasicValidateModel = Field( + ValidateMeshNonZeroEdgeLength: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Edge Length Non Zero", ) - ValidateMeshNormalsUnlocked: BasicValidateModel = Field( + ValidateMeshNormalsUnlocked: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Normals Unlocked", ) - ValidateMeshUVSetMap1: ValidateMeshUVSetMap1Model = Field( + ValidateMeshUVSetMap1: ValidateMeshUVSetMap1Model = SettingsField( default_factory=ValidateMeshUVSetMap1Model, title="Validate Mesh UV Set Map 1", ) - ValidateMeshVerticesHaveEdges: BasicValidateModel = Field( + ValidateMeshVerticesHaveEdges: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Mesh Vertices Have Edges", ) - ValidateNoAnimation: ValidateNoAnimationModel = Field( + ValidateNoAnimation: ValidateNoAnimationModel = SettingsField( default_factory=ValidateNoAnimationModel, title="Validate No Animation", ) - ValidateNoNamespace: BasicValidateModel = Field( + ValidateNoNamespace: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No Namespace", ) - ValidateNoNullTransforms: BasicValidateModel = Field( + ValidateNoNullTransforms: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No Null Transforms", ) - ValidateNoUnknownNodes: BasicValidateModel = Field( + ValidateNoUnknownNodes: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No Unknown Nodes", ) - ValidateNodeNoGhosting: BasicValidateModel = Field( + ValidateNodeNoGhosting: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Node No Ghosting", ) - ValidateShapeDefaultNames: BasicValidateModel = Field( + ValidateShapeDefaultNames: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Shape Default Names", ) - ValidateShapeRenderStats: BasicValidateModel = Field( + ValidateShapeRenderStats: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Shape Render Stats", ) - ValidateShapeZero: BasicValidateModel = Field( + ValidateShapeZero: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Shape Zero", ) - ValidateTransformZero: BasicValidateModel = Field( + ValidateTransformZero: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Transform Zero", ) - ValidateUniqueNames: BasicValidateModel = Field( + ValidateUniqueNames: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Unique Names", ) - ValidateNoVRayMesh: BasicValidateModel = Field( + ValidateNoVRayMesh: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No V-Ray Proxies (VRayMesh)", ) - ValidateUnrealMeshTriangulated: BasicValidateModel = Field( + ValidateUnrealMeshTriangulated: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate if Mesh is Triangulated", ) - ValidateAlembicVisibleOnly: BasicValidateModel = Field( + ValidateAlembicVisibleOnly: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Alembic Visible Node", ) - ExtractProxyAlembic: ExtractProxyAlembicModel = Field( + ExtractProxyAlembic: ExtractProxyAlembicModel = SettingsField( default_factory=ExtractProxyAlembicModel, title="Extract Proxy Alembic", section="Model Extractors", ) - ExtractAlembic: ExtractAlembicModel = Field( + ExtractAlembic: ExtractAlembicModel = SettingsField( default_factory=ExtractAlembicModel, title="Extract Alembic", ) - ExtractObj: ExtractObjModel = Field( + ExtractObj: ExtractObjModel = SettingsField( default_factory=ExtractObjModel, title="Extract OBJ" ) # Model - END # Rig - START - ValidateRigContents: BasicValidateModel = Field( + ValidateRigContents: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Rig Contents", section="Rig", ) - ValidateRigJointsHidden: BasicValidateModel = Field( + ValidateRigJointsHidden: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Rig Joints Hidden", ) - ValidateRigControllers: BasicValidateModel = Field( + ValidateRigControllers: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Rig Controllers", ) - ValidateAnimatedReferenceRig: BasicValidateModel = Field( + ValidateAnimatedReferenceRig: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Animated Reference Rig", ) - ValidateAnimationContent: BasicValidateModel = Field( + ValidateAnimationContent: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Animation Content", ) - ValidateOutRelatedNodeIds: BasicValidateModel = Field( + ValidateOutRelatedNodeIds: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Animation Out Set Related Node Ids", ) - ValidateRigControllersArnoldAttributes: BasicValidateModel = Field( - default_factory=BasicValidateModel, - title="Validate Rig Controllers (Arnold Attributes)", + ValidateRigControllersArnoldAttributes: BasicValidateModel = ( + SettingsField( + default_factory=BasicValidateModel, + title="Validate Rig Controllers (Arnold Attributes)", + ) ) - ValidateSkeletalMeshHierarchy: BasicValidateModel = Field( + ValidateSkeletalMeshHierarchy: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skeletal Mesh Top Node", ) - ValidateSkeletonRigContents: BasicValidateModel = Field( + ValidateSkeletonRigContents: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skeleton Rig Contents" ) - ValidateSkeletonRigControllers: BasicValidateModel = Field( + ValidateSkeletonRigControllers: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skeleton Rig Controllers" ) - ValidateSkinclusterDeformerSet: BasicValidateModel = Field( + ValidateSkinclusterDeformerSet: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skincluster Deformer Relationships", ) - ValidateSkeletonRigOutputIds: BasicValidateModel = Field( + ValidateSkeletonRigOutputIds: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skeleton Rig Output Ids" ) - ValidateSkeletonTopGroupHierarchy: BasicValidateModel = Field( + ValidateSkeletonTopGroupHierarchy: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Skeleton Top Group Hierarchy", ) - ValidateRigOutSetNodeIds: ValidateRigOutSetNodeIdsModel = Field( + ValidateRigOutSetNodeIds: ValidateRigOutSetNodeIdsModel = SettingsField( default_factory=ValidateRigOutSetNodeIdsModel, title="Validate Rig Out Set Node Ids", ) - ValidateSkeletonRigOutSetNodeIds: ValidateRigOutSetNodeIdsModel = Field( - default_factory=ValidateRigOutSetNodeIdsModel, - title="Validate Skeleton Rig Out Set Node Ids", + ValidateSkeletonRigOutSetNodeIds: ValidateRigOutSetNodeIdsModel = ( + SettingsField( + default_factory=ValidateRigOutSetNodeIdsModel, + title="Validate Skeleton Rig Out Set Node Ids", + ) ) # Rig - END - ValidateCameraAttributes: BasicValidateModel = Field( + ValidateCameraAttributes: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Camera Attributes" ) - ValidateAssemblyName: BasicValidateModel = Field( + ValidateAssemblyName: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Assembly Name" ) - ValidateAssemblyNamespaces: BasicValidateModel = Field( + ValidateAssemblyNamespaces: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Assembly Namespaces" ) - ValidateAssemblyModelTransforms: BasicValidateModel = Field( + ValidateAssemblyModelTransforms: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Assembly Model Transforms" ) - ValidateAssRelativePaths: BasicValidateModel = Field( + ValidateAssRelativePaths: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Ass Relative Paths" ) - ValidateInstancerContent: BasicValidateModel = Field( + ValidateInstancerContent: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Instancer Content" ) - ValidateInstancerFrameRanges: BasicValidateModel = Field( + ValidateInstancerFrameRanges: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Instancer Cache Frame Ranges" ) - ValidateNoDefaultCameras: BasicValidateModel = Field( + ValidateNoDefaultCameras: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate No Default Cameras" ) - ValidateUnrealUpAxis: BasicValidateModel = Field( + ValidateUnrealUpAxis: BasicValidateModel = SettingsField( default_factory=BasicValidateModel, title="Validate Unreal Up-Axis Check" ) - ValidateCameraContents: ValidateCameraContentsModel = Field( + ValidateCameraContents: ValidateCameraContentsModel = SettingsField( default_factory=ValidateCameraContentsModel, title="Validate Camera Content" ) - ExtractPlayblast: ExtractPlayblastSetting = Field( + ExtractPlayblast: ExtractPlayblastSetting = SettingsField( default_factory=ExtractPlayblastSetting, title="Extract Playblast Settings", section="Extractors" ) - ExtractMayaSceneRaw: ExtractMayaSceneRawModel = Field( + ExtractMayaSceneRaw: ExtractMayaSceneRawModel = SettingsField( default_factory=ExtractMayaSceneRawModel, title="Maya Scene(Raw)" ) - ExtractCameraAlembic: ExtractCameraAlembicModel = Field( + ExtractCameraAlembic: ExtractCameraAlembicModel = SettingsField( default_factory=ExtractCameraAlembicModel, title="Extract Camera Alembic" ) - ExtractGLB: ExtractGLBModel = Field( + ExtractGLB: ExtractGLBModel = SettingsField( default_factory=ExtractGLBModel, title="Extract GLB" ) - ExtractLook: ExtractLookModel = Field( + ExtractLook: ExtractLookModel = SettingsField( default_factory=ExtractLookModel, title="Extract Look" ) - ExtractGPUCache: ExtractGPUCacheModel = Field( + ExtractGPUCache: ExtractGPUCacheModel = SettingsField( default_factory=ExtractGPUCacheModel, title="Extract GPU Cache", ) diff --git a/server_addon/maya/server/settings/render_settings.py b/server_addon/maya/server/settings/render_settings.py index b6163a04ce..15ff177e7f 100644 --- a/server_addon/maya/server/settings/render_settings.py +++ b/server_addon/maya/server/settings/render_settings.py @@ -1,7 +1,5 @@ """Providing models and values for Maya Render Settings.""" -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField def aov_separators_enum(): @@ -278,22 +276,22 @@ class AdditionalOptionsModel(BaseSettingsModel): """Additional Option""" _layout = "compact" - attribute: str = Field("", title="Attribute name") - value: str = Field("", title="Value") + attribute: str = SettingsField("", title="Attribute name") + value: str = SettingsField("", title="Value") class ArnoldSettingsModel(BaseSettingsModel): - image_prefix: str = Field(title="Image prefix template") - image_format: str = Field( + image_prefix: str = SettingsField(title="Image prefix template") + image_format: str = SettingsField( enum_resolver=arnold_image_format_enum, title="Output Image Format") - multilayer_exr: bool = Field(title="Multilayer (exr)") - tiled: bool = Field(title="Tiled (tif, exr)") - aov_list: list[str] = Field( + multilayer_exr: bool = SettingsField(title="Multilayer (exr)") + tiled: bool = SettingsField(title="Tiled (tif, exr)") + aov_list: list[str] = SettingsField( default_factory=list, enum_resolver=arnold_aov_list_enum, title="AOVs to create" ) - additional_options: list[AdditionalOptionsModel] = Field( + additional_options: list[AdditionalOptionsModel] = SettingsField( default_factory=list, title="Additional Arnold Options", description=( @@ -303,25 +301,25 @@ class ArnoldSettingsModel(BaseSettingsModel): class VraySettingsModel(BaseSettingsModel): - image_prefix: str = Field(title="Image prefix template") + image_prefix: str = SettingsField(title="Image prefix template") # engine was str because of JSON limitation (key must be string) - engine: str = Field( + engine: str = SettingsField( enum_resolver=lambda: [ {"label": "V-Ray", "value": "1"}, {"label": "V-Ray GPU", "value": "2"} ], title="Production Engine" ) - image_format: str = Field( + image_format: str = SettingsField( enum_resolver=vray_image_output_enum, title="Output Image Format" ) - aov_list: list[str] = Field( + aov_list: list[str] = SettingsField( default_factory=list, enum_resolver=vray_aov_list_enum, title="AOVs to create" ) - additional_options: list[AdditionalOptionsModel] = Field( + additional_options: list[AdditionalOptionsModel] = SettingsField( default_factory=list, title="Additional Vray Options", description=( @@ -332,29 +330,29 @@ class VraySettingsModel(BaseSettingsModel): class RedshiftSettingsModel(BaseSettingsModel): - image_prefix: str = Field(title="Image prefix template") + image_prefix: str = SettingsField(title="Image prefix template") # both engines are using the same enumerator, # both were originally str because of JSON limitation. - primary_gi_engine: str = Field( + primary_gi_engine: str = SettingsField( enum_resolver=redshift_engine_enum, title="Primary GI Engine" ) - secondary_gi_engine: str = Field( + secondary_gi_engine: str = SettingsField( enum_resolver=redshift_engine_enum, title="Secondary GI Engine" ) - image_format: str = Field( + image_format: str = SettingsField( enum_resolver=redshift_image_output_enum, title="Output Image Format" ) - multilayer_exr: bool = Field(title="Multilayer (exr)") - force_combine: bool = Field(title="Force combine beauty and AOVs") - aov_list: list[str] = Field( + multilayer_exr: bool = SettingsField(title="Multilayer (exr)") + force_combine: bool = SettingsField(title="Force combine beauty and AOVs") + aov_list: list[str] = SettingsField( default_factory=list, enum_resolver=redshift_aov_list_enum, title="AOVs to create" ) - additional_options: list[AdditionalOptionsModel] = Field( + additional_options: list[AdditionalOptionsModel] = SettingsField( default_factory=list, title="Additional Vray Options", description=( @@ -396,61 +394,61 @@ def renderman_sample_filters_enum(): class RendermanSettingsModel(BaseSettingsModel): - image_prefix: str = Field( + image_prefix: str = SettingsField( "", title="Image prefix template") - image_dir: str = Field( + image_dir: str = SettingsField( "", title="Image Output Directory") - display_filters: list[str] = Field( + display_filters: list[str] = SettingsField( default_factory=list, title="Display Filters", enum_resolver=renderman_display_filters ) - imageDisplay_dir: str = Field( + imageDisplay_dir: str = SettingsField( "", title="Image Display Filter Directory") - sample_filters: list[str] = Field( + sample_filters: list[str] = SettingsField( default_factory=list, title="Sample Filters", enum_resolver=renderman_sample_filters_enum ) - cryptomatte_dir: str = Field( + cryptomatte_dir: str = SettingsField( "", title="Cryptomatte Output Directory") - watermark_dir: str = Field( + watermark_dir: str = SettingsField( "", title="Watermark Filter Directory") - additional_options: list[AdditionalOptionsModel] = Field( + additional_options: list[AdditionalOptionsModel] = SettingsField( default_factory=list, title="Additional Renderer Options" ) class RenderSettingsModel(BaseSettingsModel): - apply_render_settings: bool = Field( + apply_render_settings: bool = SettingsField( title="Apply Render Settings on creation" ) - default_render_image_folder: str = Field( + default_render_image_folder: str = SettingsField( title="Default render image folder" ) - enable_all_lights: bool = Field( + enable_all_lights: bool = SettingsField( title="Include all lights in Render Setup Layers by default" ) - aov_separator: str = Field( + aov_separator: str = SettingsField( "underscore", title="AOV Separator character", enum_resolver=aov_separators_enum ) - reset_current_frame: bool = Field( + reset_current_frame: bool = SettingsField( title="Reset Current Frame") - remove_aovs: bool = Field( + remove_aovs: bool = SettingsField( title="Remove existing AOVs") - arnold_renderer: ArnoldSettingsModel = Field( + arnold_renderer: ArnoldSettingsModel = SettingsField( default_factory=ArnoldSettingsModel, title="Arnold Renderer") - vray_renderer: VraySettingsModel = Field( + vray_renderer: VraySettingsModel = SettingsField( default_factory=VraySettingsModel, title="Vray Renderer") - redshift_renderer: RedshiftSettingsModel = Field( + redshift_renderer: RedshiftSettingsModel = SettingsField( default_factory=RedshiftSettingsModel, title="Redshift Renderer") - renderman_renderer: RendermanSettingsModel = Field( + renderman_renderer: RendermanSettingsModel = SettingsField( default_factory=RendermanSettingsModel, title="Renderman Renderer") diff --git a/server_addon/maya/server/settings/scriptsmenu.py b/server_addon/maya/server/settings/scriptsmenu.py index 4ac2263f7a..6de43b5278 100644 --- a/server_addon/maya/server/settings/scriptsmenu.py +++ b/server_addon/maya/server/settings/scriptsmenu.py @@ -1,24 +1,22 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class ScriptsmenuSubmodel(BaseSettingsModel): """Item Definition""" _isGroup = True - type: str = Field(title="Type") - command: str = Field(title="Command") - sourcetype: str = Field(title="Source Type") - title: str = Field(title="Title") - tooltip: str = Field(title="Tooltip") - tags: list[str] = Field(default_factory=list, title="A list of tags") + type: str = SettingsField(title="Type") + command: str = SettingsField(title="Command") + sourcetype: str = SettingsField(title="Source Type") + title: str = SettingsField(title="Title") + tooltip: str = SettingsField(title="Tooltip") + tags: list[str] = SettingsField(default_factory=list, title="A list of tags") class ScriptsmenuModel(BaseSettingsModel): _isGroup = True - name: str = Field(title="Menu Name") - definition: list[ScriptsmenuSubmodel] = Field( + name: str = SettingsField(title="Menu Name") + definition: list[ScriptsmenuSubmodel] = SettingsField( default_factory=list, title="Menu Definition", description="Scriptmenu Items Definition" diff --git a/server_addon/maya/server/settings/templated_workfile_settings.py b/server_addon/maya/server/settings/templated_workfile_settings.py index ef81b31a07..f61f52f9ea 100644 --- a/server_addon/maya/server/settings/templated_workfile_settings.py +++ b/server_addon/maya/server/settings/templated_workfile_settings.py @@ -1,20 +1,23 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel, task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class WorkfileBuildProfilesModel(BaseSettingsModel): _layout = "expanded" - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field(default_factory=list, title="Task names") - path: str = Field("", title="Path to template") + task_names: list[str] = SettingsField(default_factory=list, title="Task names") + path: str = SettingsField("", title="Path to template") class TemplatedProfilesModel(BaseSettingsModel): - profiles: list[WorkfileBuildProfilesModel] = Field( + profiles: list[WorkfileBuildProfilesModel] = SettingsField( default_factory=list, title="Profiles" ) diff --git a/server_addon/maya/server/settings/workfile_build_settings.py b/server_addon/maya/server/settings/workfile_build_settings.py index 2c7fea85c4..ee0b793405 100644 --- a/server_addon/maya/server/settings/workfile_build_settings.py +++ b/server_addon/maya/server/settings/workfile_build_settings.py @@ -1,38 +1,41 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel, task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class ContextItemModel(BaseSettingsModel): _layout = "expanded" - product_name_filters: list[str] = Field( + product_name_filters: list[str] = SettingsField( default_factory=list, title="Product name Filters") - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types") - repre_names: list[str] = Field( + repre_names: list[str] = SettingsField( default_factory=list, title="Repre Names") - loaders: list[str] = Field( + loaders: list[str] = SettingsField( default_factory=list, title="Loaders") class WorkfileSettingModel(BaseSettingsModel): _layout = "expanded" - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, enum_resolver=task_types_enum, title="Task types") - tasks: list[str] = Field( + tasks: list[str] = SettingsField( default_factory=list, title="Task names") - current_context: list[ContextItemModel] = Field( + current_context: list[ContextItemModel] = SettingsField( default_factory=list, title="Current Context") - linked_assets: list[ContextItemModel] = Field( + linked_assets: list[ContextItemModel] = SettingsField( default_factory=list, title="Linked Assets") class ProfilesModel(BaseSettingsModel): - profiles: list[WorkfileSettingModel] = Field( + profiles: list[WorkfileSettingModel] = SettingsField( default_factory=list, title="Profiles" ) diff --git a/server_addon/muster/server/settings.py b/server_addon/muster/server/settings.py index e37c762870..e4a487c799 100644 --- a/server_addon/muster/server/settings.py +++ b/server_addon/muster/server/settings.py @@ -1,22 +1,21 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class TemplatesMapping(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: int = Field(title="mapping") + name: str = SettingsField(title="Name") + value: int = SettingsField(title="mapping") class MusterSettings(BaseSettingsModel): enabled: bool = True - MUSTER_REST_URL: str = Field( + MUSTER_REST_URL: str = SettingsField( "", title="Muster Rest URL", scope=["studio"], ) - templates_mapping: list[TemplatesMapping] = Field( + templates_mapping: list[TemplatesMapping] = SettingsField( default_factory=list, title="Templates mapping", ) diff --git a/server_addon/nuke/server/settings/common.py b/server_addon/nuke/server/settings/common.py index 2bc3c9be81..e0ee2b7b3d 100644 --- a/server_addon/nuke/server/settings/common.py +++ b/server_addon/nuke/server/settings/common.py @@ -1,7 +1,6 @@ import json -from pydantic import Field from ayon_server.exceptions import BadRequestException -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.types import ( ColorRGBA_float, ColorRGB_uint8 @@ -27,25 +26,25 @@ def validate_json_dict(value): class Vector2d(BaseSettingsModel): _layout = "compact" - x: float = Field(1.0, title="X") - y: float = Field(1.0, title="Y") + x: float = SettingsField(1.0, title="X") + y: float = SettingsField(1.0, title="Y") class Vector3d(BaseSettingsModel): _layout = "compact" - x: float = Field(1.0, title="X") - y: float = Field(1.0, title="Y") - z: float = Field(1.0, title="Z") + x: float = SettingsField(1.0, title="X") + y: float = SettingsField(1.0, title="Y") + z: float = SettingsField(1.0, title="Z") class Box(BaseSettingsModel): _layout = "compact" - x: float = Field(1.0, title="X") - y: float = Field(1.0, title="Y") - r: float = Field(1.0, title="R") - t: float = Field(1.0, title="T") + x: float = SettingsField(1.0, title="X") + y: float = SettingsField(1.0, title="Y") + r: float = SettingsField(1.0, title="R") + t: float = SettingsField(1.0, title="T") def formatable_knob_type_enum(): @@ -61,12 +60,12 @@ def formatable_knob_type_enum(): class Formatable(BaseSettingsModel): _layout = "compact" - template: str = Field( + template: str = SettingsField( "", placeholder="""{{key}} or {{key}};{{key}}""", title="Template" ) - to_type: str = Field( + to_type: str = SettingsField( "Text", title="To Knob type", enum_resolver=formatable_knob_type_enum, @@ -91,46 +90,46 @@ knob_types_enum = [ class KnobModel(BaseSettingsModel): _layout = "expanded" - type: str = Field( + type: str = SettingsField( title="Type", description="Switch between different knob types", enum_resolver=lambda: knob_types_enum, conditionalEnum=True ) - name: str = Field( + name: str = SettingsField( title="Name", placeholder="Name" ) - text: str = Field("", title="Value") - color_gui: ColorRGB_uint8 = Field( + text: str = SettingsField("", title="Value") + color_gui: ColorRGB_uint8 = SettingsField( (0, 0, 255), title="RGB Uint8", ) - boolean: bool = Field(False, title="Value") - number: int = Field(0, title="Value") - decimal_number: float = Field(0.0, title="Value") - vector_2d: Vector2d = Field( + boolean: bool = SettingsField(False, title="Value") + number: int = SettingsField(0, title="Value") + decimal_number: float = SettingsField(0.0, title="Value") + vector_2d: Vector2d = SettingsField( default_factory=Vector2d, title="Value" ) - vector_3d: Vector3d = Field( + vector_3d: Vector3d = SettingsField( default_factory=Vector3d, title="Value" ) - color: ColorRGBA_float = Field( + color: ColorRGBA_float = SettingsField( (0.0, 0.0, 1.0, 1.0), title="RGBA Float" ) - box: Box = Field( + box: Box = SettingsField( default_factory=Box, title="Value" ) - formatable: Formatable = Field( + formatable: Formatable = SettingsField( default_factory=Formatable, title="Formatable" ) - expression: str = Field( + expression: str = SettingsField( "", title="Expression" ) diff --git a/server_addon/nuke/server/settings/create_plugins.py b/server_addon/nuke/server/settings/create_plugins.py index 80aec51ae0..378d449b0b 100644 --- a/server_addon/nuke/server/settings/create_plugins.py +++ b/server_addon/nuke/server/settings/create_plugins.py @@ -1,6 +1,7 @@ -from pydantic import validator, Field +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names ) from .common import KnobModel @@ -16,20 +17,20 @@ def instance_attributes_enum(): class PrenodeModel(BaseSettingsModel): - name: str = Field( + name: str = SettingsField( title="Node name" ) - nodeclass: str = Field( + nodeclass: str = SettingsField( "", title="Node class" ) - dependent: str = Field( + dependent: str = SettingsField( "", title="Incoming dependency" ) - knobs: list[KnobModel] = Field( + knobs: list[KnobModel] = SettingsField( default_factory=list, title="Knobs", ) @@ -42,20 +43,20 @@ class PrenodeModel(BaseSettingsModel): class CreateWriteRenderModel(BaseSettingsModel): - temp_rendering_path_template: str = Field( + temp_rendering_path_template: str = SettingsField( title="Temporary rendering path template" ) - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( title="Default variants", default_factory=list ) - instance_attributes: list[str] = Field( + instance_attributes: list[str] = SettingsField( default_factory=list, enum_resolver=instance_attributes_enum, title="Instance attributes" ) - prenodes: list[PrenodeModel] = Field( + prenodes: list[PrenodeModel] = SettingsField( default_factory=list, title="Preceding nodes", ) @@ -68,20 +69,20 @@ class CreateWriteRenderModel(BaseSettingsModel): class CreateWritePrerenderModel(BaseSettingsModel): - temp_rendering_path_template: str = Field( + temp_rendering_path_template: str = SettingsField( title="Temporary rendering path template" ) - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( title="Default variants", default_factory=list ) - instance_attributes: list[str] = Field( + instance_attributes: list[str] = SettingsField( default_factory=list, enum_resolver=instance_attributes_enum, title="Instance attributes" ) - prenodes: list[PrenodeModel] = Field( + prenodes: list[PrenodeModel] = SettingsField( default_factory=list, title="Preceding nodes", ) @@ -94,20 +95,20 @@ class CreateWritePrerenderModel(BaseSettingsModel): class CreateWriteImageModel(BaseSettingsModel): - temp_rendering_path_template: str = Field( + temp_rendering_path_template: str = SettingsField( title="Temporary rendering path template" ) - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( title="Default variants", default_factory=list ) - instance_attributes: list[str] = Field( + instance_attributes: list[str] = SettingsField( default_factory=list, enum_resolver=instance_attributes_enum, title="Instance attributes" ) - prenodes: list[PrenodeModel] = Field( + prenodes: list[PrenodeModel] = SettingsField( default_factory=list, title="Preceding nodes", ) @@ -120,15 +121,15 @@ class CreateWriteImageModel(BaseSettingsModel): class CreatorPluginsSettings(BaseSettingsModel): - CreateWriteRender: CreateWriteRenderModel = Field( + CreateWriteRender: CreateWriteRenderModel = SettingsField( default_factory=CreateWriteRenderModel, title="Create Write Render" ) - CreateWritePrerender: CreateWritePrerenderModel = Field( + CreateWritePrerender: CreateWritePrerenderModel = SettingsField( default_factory=CreateWritePrerenderModel, title="Create Write Prerender" ) - CreateWriteImage: CreateWriteImageModel = Field( + CreateWriteImage: CreateWriteImageModel = SettingsField( default_factory=CreateWriteImageModel, title="Create Write Image" ) diff --git a/server_addon/nuke/server/settings/dirmap.py b/server_addon/nuke/server/settings/dirmap.py index 7e3c443957..3e1bac0739 100644 --- a/server_addon/nuke/server/settings/dirmap.py +++ b/server_addon/nuke/server/settings/dirmap.py @@ -1,14 +1,13 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class DirmapPathsSubmodel(BaseSettingsModel): _layout = "compact" - source_path: list[str] = Field( + source_path: list[str] = SettingsField( default_factory=list, title="Source Paths" ) - destination_path: list[str] = Field( + destination_path: list[str] = SettingsField( default_factory=list, title="Destination Paths" ) @@ -18,8 +17,8 @@ class DirmapSettings(BaseSettingsModel): """Nuke color management project settings.""" _isGroup: bool = True - enabled: bool = Field(title="enabled") - paths: DirmapPathsSubmodel = Field( + enabled: bool = SettingsField(title="enabled") + paths: DirmapPathsSubmodel = SettingsField( default_factory=DirmapPathsSubmodel, title="Dirmap Paths" ) diff --git a/server_addon/nuke/server/settings/general.py b/server_addon/nuke/server/settings/general.py index bcbb183952..d54c725dc1 100644 --- a/server_addon/nuke/server/settings/general.py +++ b/server_addon/nuke/server/settings/general.py @@ -1,23 +1,22 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class MenuShortcut(BaseSettingsModel): """Nuke general project settings.""" - create: str = Field( + create: str = SettingsField( title="Create..." ) - publish: str = Field( + publish: str = SettingsField( title="Publish..." ) - load: str = Field( + load: str = SettingsField( title="Load..." ) - manage: str = Field( + manage: str = SettingsField( title="Manage..." ) - build_workfile: str = Field( + build_workfile: str = SettingsField( title="Build Workfile..." ) @@ -25,7 +24,7 @@ class MenuShortcut(BaseSettingsModel): class GeneralSettings(BaseSettingsModel): """Nuke general project settings.""" - menu: MenuShortcut = Field( + menu: MenuShortcut = SettingsField( default_factory=MenuShortcut, title="Menu Shortcuts", ) diff --git a/server_addon/nuke/server/settings/gizmo.py b/server_addon/nuke/server/settings/gizmo.py index 4cdd614da8..ddb56f891c 100644 --- a/server_addon/nuke/server/settings/gizmo.py +++ b/server_addon/nuke/server/settings/gizmo.py @@ -1,52 +1,52 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathModel, MultiplatformPathListModel, ) class SubGizmoItem(BaseSettingsModel): - title: str = Field( + title: str = SettingsField( title="Label" ) - sourcetype: str = Field( + sourcetype: str = SettingsField( title="Type of usage" ) - command: str = Field( + command: str = SettingsField( title="Python command" ) - icon: str = Field( + icon: str = SettingsField( title="Icon Path" ) - shortcut: str = Field( + shortcut: str = SettingsField( title="Hotkey" ) class GizmoDefinitionItem(BaseSettingsModel): - gizmo_toolbar_path: str = Field( + gizmo_toolbar_path: str = SettingsField( title="Gizmo Menu" ) - sub_gizmo_list: list[SubGizmoItem] = Field( + sub_gizmo_list: list[SubGizmoItem] = SettingsField( default_factory=list, title="Sub Gizmo List") class GizmoItem(BaseSettingsModel): """Nuke gizmo item """ - toolbar_menu_name: str = Field( + toolbar_menu_name: str = SettingsField( title="Toolbar Menu Name" ) - gizmo_source_dir: MultiplatformPathListModel = Field( + gizmo_source_dir: MultiplatformPathListModel = SettingsField( default_factory=MultiplatformPathListModel, title="Gizmo Directory Path" ) - toolbar_icon_path: MultiplatformPathModel = Field( + toolbar_icon_path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Toolbar Icon Path" ) - gizmo_definition: list[GizmoDefinitionItem] = Field( + gizmo_definition: list[GizmoDefinitionItem] = SettingsField( default_factory=list, title="Gizmo Definition") diff --git a/server_addon/nuke/server/settings/imageio.py b/server_addon/nuke/server/settings/imageio.py index 19ad5ff24a..1b84457133 100644 --- a/server_addon/nuke/server/settings/imageio.py +++ b/server_addon/nuke/server/settings/imageio.py @@ -1,7 +1,8 @@ from typing import Literal -from pydantic import validator, Field +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names, ) @@ -10,17 +11,17 @@ from .common import KnobModel class NodesModel(BaseSettingsModel): _layout = "expanded" - plugins: list[str] = Field( + plugins: list[str] = SettingsField( default_factory=list, title="Used in plugins" ) - nuke_node_class: str = Field( + nuke_node_class: str = SettingsField( title="Nuke Node Class", ) class RequiredNodesModel(NodesModel): - knobs: list[KnobModel] = Field( + knobs: list[KnobModel] = SettingsField( default_factory=list, title="Knobs", ) @@ -33,12 +34,12 @@ class RequiredNodesModel(NodesModel): class OverrideNodesModel(NodesModel): - subsets: list[str] = Field( + subsets: list[str] = SettingsField( default_factory=list, title="Subsets" ) - knobs: list[KnobModel] = Field( + knobs: list[KnobModel] = SettingsField( default_factory=list, title="Knobs", ) @@ -51,11 +52,11 @@ class OverrideNodesModel(NodesModel): class NodesSetting(BaseSettingsModel): - required_nodes: list[RequiredNodesModel] = Field( + required_nodes: list[RequiredNodesModel] = SettingsField( title="Plugin required", default_factory=list ) - override_nodes: list[OverrideNodesModel] = Field( + override_nodes: list[OverrideNodesModel] = SettingsField( title="Plugin's node overrides", default_factory=list ) @@ -82,21 +83,21 @@ def ocio_configs_switcher_enum(): class WorkfileColorspaceSettings(BaseSettingsModel): """Nuke workfile colorspace preset. """ - color_management: Literal["Nuke", "OCIO"] = Field( + color_management: Literal["Nuke", "OCIO"] = SettingsField( title="Color Management Workflow" ) - native_ocio_config: str = Field( + native_ocio_config: str = SettingsField( title="Native OpenColorIO Config", description="Switch between native OCIO configs", enum_resolver=ocio_configs_switcher_enum, conditionalEnum=True ) - working_space: str = Field( + working_space: str = SettingsField( title="Working Space" ) - thumbnail_space: str = Field( + thumbnail_space: str = SettingsField( title="Thumbnail Space" ) @@ -104,44 +105,44 @@ class WorkfileColorspaceSettings(BaseSettingsModel): class ReadColorspaceRulesItems(BaseSettingsModel): _layout = "expanded" - regex: str = Field("", title="Regex expression") - colorspace: str = Field("", title="Colorspace") + regex: str = SettingsField("", title="Regex expression") + colorspace: str = SettingsField("", title="Colorspace") class RegexInputsModel(BaseSettingsModel): - inputs: list[ReadColorspaceRulesItems] = Field( + inputs: list[ReadColorspaceRulesItems] = SettingsField( default_factory=list, title="Inputs" ) class ViewProcessModel(BaseSettingsModel): - viewerProcess: str = Field( + viewerProcess: str = SettingsField( title="Viewer Process Name" ) class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -162,17 +163,17 @@ class ImageIOSettings(BaseSettingsModel): now: nuke/imageio/viewer/viewerProcess future: nuke/imageio/viewer """ - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management") - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) - viewer: ViewProcessModel = Field( + viewer: ViewProcessModel = SettingsField( default_factory=ViewProcessModel, title="Viewer", description="""Viewer profile is used during @@ -185,19 +186,19 @@ class ImageIOSettings(BaseSettingsModel): now: nuke/imageio/baking/viewerProcess future: nuke/imageio/baking """ - baking: ViewProcessModel = Field( + baking: ViewProcessModel = SettingsField( default_factory=ViewProcessModel, title="Baking", description="""Baking profile is used during publishing baked colorspace data at knob viewerProcess""" ) - workfile: WorkfileColorspaceSettings = Field( + workfile: WorkfileColorspaceSettings = SettingsField( default_factory=WorkfileColorspaceSettings, title="Workfile" ) - nodes: NodesSetting = Field( + nodes: NodesSetting = SettingsField( default_factory=NodesSetting, title="Nodes" ) @@ -205,7 +206,7 @@ class ImageIOSettings(BaseSettingsModel): - [ ] no need for `inputs` middle part. It can stay directly on `regex_inputs` """ - regex_inputs: RegexInputsModel = Field( + regex_inputs: RegexInputsModel = SettingsField( default_factory=RegexInputsModel, title="Assign colorspace to read nodes via rules" ) diff --git a/server_addon/nuke/server/settings/loader_plugins.py b/server_addon/nuke/server/settings/loader_plugins.py index 51e2c2149b..a5c3315fd4 100644 --- a/server_addon/nuke/server/settings/loader_plugins.py +++ b/server_addon/nuke/server/settings/loader_plugins.py @@ -1,54 +1,53 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class LoadImageModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( title="Enabled" ) - representations_include: list[str] = Field( + representations_include: list[str] = SettingsField( default_factory=list, title="Include representations" ) - node_name_template: str = Field( + node_name_template: str = SettingsField( title="Read node name template" ) class LoadClipOptionsModel(BaseSettingsModel): - start_at_workfile: bool = Field( + start_at_workfile: bool = SettingsField( title="Start at workfile's start frame" ) - add_retime: bool = Field( + add_retime: bool = SettingsField( title="Add retime" ) class LoadClipModel(BaseSettingsModel): - enabled: bool = Field( + enabled: bool = SettingsField( title="Enabled" ) - representations_include: list[str] = Field( + representations_include: list[str] = SettingsField( default_factory=list, title="Include representations" ) - node_name_template: str = Field( + node_name_template: str = SettingsField( title="Read node name template" ) - options_defaults: LoadClipOptionsModel = Field( + options_defaults: LoadClipOptionsModel = SettingsField( default_factory=LoadClipOptionsModel, title="Loader option defaults" ) class LoaderPuginsModel(BaseSettingsModel): - LoadImage: LoadImageModel = Field( + LoadImage: LoadImageModel = SettingsField( default_factory=LoadImageModel, title="Load Image" ) - LoadClip: LoadClipModel = Field( + LoadClip: LoadClipModel = SettingsField( default_factory=LoadClipModel, title="Load Clip" ) diff --git a/server_addon/nuke/server/settings/main.py b/server_addon/nuke/server/settings/main.py index b6729e7c2f..2cfc539e71 100644 --- a/server_addon/nuke/server/settings/main.py +++ b/server_addon/nuke/server/settings/main.py @@ -1,7 +1,8 @@ -from pydantic import validator, Field +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names ) @@ -49,50 +50,50 @@ from .templated_workfile_build import ( class NukeSettings(BaseSettingsModel): """Nuke addon settings.""" - general: GeneralSettings = Field( + general: GeneralSettings = SettingsField( default_factory=GeneralSettings, title="General", ) - imageio: ImageIOSettings = Field( + imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (imageio)", ) - dirmap: DirmapSettings = Field( + dirmap: DirmapSettings = SettingsField( default_factory=DirmapSettings, title="Nuke Directory Mapping", ) - scriptsmenu: ScriptsmenuSettings = Field( + scriptsmenu: ScriptsmenuSettings = SettingsField( default_factory=ScriptsmenuSettings, title="Scripts Menu Definition", ) - gizmo: list[GizmoItem] = Field( + gizmo: list[GizmoItem] = SettingsField( default_factory=list, title="Gizmo Menu") - create: CreatorPluginsSettings = Field( + create: CreatorPluginsSettings = SettingsField( default_factory=CreatorPluginsSettings, title="Creator Plugins", ) - publish: PublishPuginsModel = Field( + publish: PublishPuginsModel = SettingsField( default_factory=PublishPuginsModel, title="Publish Plugins", ) - load: LoaderPuginsModel = Field( + load: LoaderPuginsModel = SettingsField( default_factory=LoaderPuginsModel, title="Loader Plugins", ) - workfile_builder: WorkfileBuilderModel = Field( + workfile_builder: WorkfileBuilderModel = SettingsField( default_factory=WorkfileBuilderModel, title="Workfile Builder", ) - templated_workfile_build: TemplatedWorkfileBuildModel = Field( + templated_workfile_build: TemplatedWorkfileBuildModel = SettingsField( title="Templated Workfile Build", default_factory=TemplatedWorkfileBuildModel ) diff --git a/server_addon/nuke/server/settings/publish_plugins.py b/server_addon/nuke/server/settings/publish_plugins.py index 84457d2484..0d785e6505 100644 --- a/server_addon/nuke/server/settings/publish_plugins.py +++ b/server_addon/nuke/server/settings/publish_plugins.py @@ -1,6 +1,7 @@ -from pydantic import validator, Field +from pydantic import validator from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names, task_types_enum ) @@ -28,18 +29,18 @@ def nuke_product_types_enum(): class NodeModel(BaseSettingsModel): - name: str = Field( + name: str = SettingsField( title="Node name" ) - nodeclass: str = Field( + nodeclass: str = SettingsField( "", title="Node class" ) - dependent: str = Field( + dependent: str = SettingsField( "", title="Incoming dependency" ) - knobs: list[KnobModel] = Field( + knobs: list[KnobModel] = SettingsField( default_factory=list, title="Knobs", ) @@ -52,7 +53,7 @@ class NodeModel(BaseSettingsModel): class CollectInstanceDataModel(BaseSettingsModel): - sync_workfile_version_on_product_types: list[str] = Field( + sync_workfile_version_on_product_types: list[str] = SettingsField( default_factory=list, enum_resolver=nuke_product_types_enum, title="Sync workfile versions for familes" @@ -60,14 +61,14 @@ class CollectInstanceDataModel(BaseSettingsModel): class OptionalPluginModel(BaseSettingsModel): - enabled: bool = Field(True) - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(True) + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class ValidateKnobsModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - knobs: str = Field( + enabled: bool = SettingsField(title="Enabled") + knobs: str = SettingsField( "{}", title="Knobs", widget="textarea", @@ -79,31 +80,31 @@ class ValidateKnobsModel(BaseSettingsModel): class ExtractReviewDataModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") + enabled: bool = SettingsField(title="Enabled") class ExtractReviewDataLutModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") + enabled: bool = SettingsField(title="Enabled") class BakingStreamFilterModel(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, enum_resolver=nuke_render_publish_types_enum, title="Sync workfile versions for familes" ) - product_names: list[str] = Field( + product_names: list[str] = SettingsField( default_factory=list, title="Product names") class ReformatNodesRepositionNodes(BaseSettingsModel): - node_class: str = Field(title="Node class") - knobs: list[KnobModel] = Field( + node_class: str = SettingsField(title="Node class") + knobs: list[KnobModel] = SettingsField( default_factory=list, title="Node knobs") @@ -115,41 +116,41 @@ class ReformatNodesConfigModel(BaseSettingsModel): Order of reformat nodes is important. First reformat node will be applied first and last reformat node will be applied last. """ - enabled: bool = Field(False) - reposition_nodes: list[ReformatNodesRepositionNodes] = Field( + enabled: bool = SettingsField(False) + reposition_nodes: list[ReformatNodesRepositionNodes] = SettingsField( default_factory=list, title="Reposition knobs" ) class IntermediateOutputModel(BaseSettingsModel): - name: str = Field(title="Output name") - filter: BakingStreamFilterModel = Field( + name: str = SettingsField(title="Output name") + filter: BakingStreamFilterModel = SettingsField( title="Filter", default_factory=BakingStreamFilterModel) - read_raw: bool = Field( + read_raw: bool = SettingsField( False, title="Read raw switch" ) - viewer_process_override: str = Field( + viewer_process_override: str = SettingsField( "", title="Viewer process override" ) - bake_viewer_process: bool = Field( + bake_viewer_process: bool = SettingsField( True, title="Bake viewer process" ) - bake_viewer_input_process: bool = Field( + bake_viewer_input_process: bool = SettingsField( True, title="Bake viewer input process node (LUT)" ) - reformat_nodes_config: ReformatNodesConfigModel = Field( + reformat_nodes_config: ReformatNodesConfigModel = SettingsField( default_factory=ReformatNodesConfigModel, title="Reformat Nodes") - extension: str = Field( + extension: str = SettingsField( "mov", title="File extension" ) - add_custom_tags: list[str] = Field( + add_custom_tags: list[str] = SettingsField( title="Custom tags", default_factory=list) @@ -157,123 +158,123 @@ class ExtractReviewDataMovModel(BaseSettingsModel): """[deprecated] use Extract Review Data Baking Streams instead. """ - enabled: bool = Field(title="Enabled") - viewer_lut_raw: bool = Field(title="Viewer lut raw") - outputs: list[IntermediateOutputModel] = Field( + enabled: bool = SettingsField(title="Enabled") + viewer_lut_raw: bool = SettingsField(title="Viewer lut raw") + outputs: list[IntermediateOutputModel] = SettingsField( default_factory=list, title="Baking streams" ) class ExtractReviewIntermediatesModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - viewer_lut_raw: bool = Field(title="Viewer lut raw") - outputs: list[IntermediateOutputModel] = Field( + enabled: bool = SettingsField(title="Enabled") + viewer_lut_raw: bool = SettingsField(title="Viewer lut raw") + outputs: list[IntermediateOutputModel] = SettingsField( default_factory=list, title="Baking streams" ) class FSubmissionNoteModel(BaseSettingsModel): - enabled: bool = Field(title="enabled") - template: str = Field(title="Template") + enabled: bool = SettingsField(title="enabled") + template: str = SettingsField(title="Template") class FSubmistingForModel(BaseSettingsModel): - enabled: bool = Field(title="enabled") - template: str = Field(title="Template") + enabled: bool = SettingsField(title="enabled") + template: str = SettingsField(title="Template") class FVFXScopeOfWorkModel(BaseSettingsModel): - enabled: bool = Field(title="enabled") - template: str = Field(title="Template") + enabled: bool = SettingsField(title="enabled") + template: str = SettingsField(title="Template") class ExctractSlateFrameParamModel(BaseSettingsModel): - f_submission_note: FSubmissionNoteModel = Field( + f_submission_note: FSubmissionNoteModel = SettingsField( title="f_submission_note", default_factory=FSubmissionNoteModel ) - f_submitting_for: FSubmistingForModel = Field( + f_submitting_for: FSubmistingForModel = SettingsField( title="f_submitting_for", default_factory=FSubmistingForModel ) - f_vfx_scope_of_work: FVFXScopeOfWorkModel = Field( + f_vfx_scope_of_work: FVFXScopeOfWorkModel = SettingsField( title="f_vfx_scope_of_work", default_factory=FVFXScopeOfWorkModel ) class ExtractSlateFrameModel(BaseSettingsModel): - viewer_lut_raw: bool = Field(title="Viewer lut raw") - key_value_mapping: ExctractSlateFrameParamModel = Field( + viewer_lut_raw: bool = SettingsField(title="Viewer lut raw") + key_value_mapping: ExctractSlateFrameParamModel = SettingsField( title="Key value mapping", default_factory=ExctractSlateFrameParamModel ) class IncrementScriptVersionModel(BaseSettingsModel): - enabled: bool = Field(title="Enabled") - optional: bool = Field(title="Optional") - active: bool = Field(title="Active") + enabled: bool = SettingsField(title="Enabled") + optional: bool = SettingsField(title="Optional") + active: bool = SettingsField(title="Active") class PublishPuginsModel(BaseSettingsModel): - CollectInstanceData: CollectInstanceDataModel = Field( + CollectInstanceData: CollectInstanceDataModel = SettingsField( title="Collect Instance Version", default_factory=CollectInstanceDataModel, section="Collectors" ) - ValidateCorrectAssetContext: OptionalPluginModel = Field( + ValidateCorrectAssetContext: OptionalPluginModel = SettingsField( title="Validate Correct Folder Name", default_factory=OptionalPluginModel, section="Validators" ) - ValidateContainers: OptionalPluginModel = Field( + ValidateContainers: OptionalPluginModel = SettingsField( title="Validate Containers", default_factory=OptionalPluginModel ) - ValidateKnobs: ValidateKnobsModel = Field( + ValidateKnobs: ValidateKnobsModel = SettingsField( title="Validate Knobs", default_factory=ValidateKnobsModel ) - ValidateOutputResolution: OptionalPluginModel = Field( + ValidateOutputResolution: OptionalPluginModel = SettingsField( title="Validate Output Resolution", default_factory=OptionalPluginModel ) - ValidateGizmo: OptionalPluginModel = Field( + ValidateGizmo: OptionalPluginModel = SettingsField( title="Validate Gizmo", default_factory=OptionalPluginModel ) - ValidateBackdrop: OptionalPluginModel = Field( + ValidateBackdrop: OptionalPluginModel = SettingsField( title="Validate Backdrop", default_factory=OptionalPluginModel ) - ValidateScriptAttributes: OptionalPluginModel = Field( + ValidateScriptAttributes: OptionalPluginModel = SettingsField( title="Validate workfile attributes", default_factory=OptionalPluginModel ) - ExtractReviewData: ExtractReviewDataModel = Field( + ExtractReviewData: ExtractReviewDataModel = SettingsField( title="Extract Review Data", default_factory=ExtractReviewDataModel ) - ExtractReviewDataLut: ExtractReviewDataLutModel = Field( + ExtractReviewDataLut: ExtractReviewDataLutModel = SettingsField( title="Extract Review Data Lut", default_factory=ExtractReviewDataLutModel ) - ExtractReviewDataMov: ExtractReviewDataMovModel = Field( + ExtractReviewDataMov: ExtractReviewDataMovModel = SettingsField( title="Extract Review Data Mov", default_factory=ExtractReviewDataMovModel ) - ExtractReviewIntermediates: ExtractReviewIntermediatesModel = Field( + ExtractReviewIntermediates: ExtractReviewIntermediatesModel = SettingsField( title="Extract Review Intermediates", default_factory=ExtractReviewIntermediatesModel ) - ExtractSlateFrame: ExtractSlateFrameModel = Field( + ExtractSlateFrame: ExtractSlateFrameModel = SettingsField( title="Extract Slate Frame", default_factory=ExtractSlateFrameModel ) - IncrementScriptVersion: IncrementScriptVersionModel = Field( + IncrementScriptVersion: IncrementScriptVersionModel = SettingsField( title="Increment Workfile Version", default_factory=IncrementScriptVersionModel, section="Integrators" diff --git a/server_addon/nuke/server/settings/scriptsmenu.py b/server_addon/nuke/server/settings/scriptsmenu.py index 3dd6765920..7ffd6841d5 100644 --- a/server_addon/nuke/server/settings/scriptsmenu.py +++ b/server_addon/nuke/server/settings/scriptsmenu.py @@ -1,24 +1,23 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class ScriptsmenuSubmodel(BaseSettingsModel): """Item Definition""" _isGroup = True - type: str = Field(title="Type") - command: str = Field(title="Command") - sourcetype: str = Field(title="Source Type") - title: str = Field(title="Title") - tooltip: str = Field(title="Tooltip") + type: str = SettingsField(title="Type") + command: str = SettingsField(title="Command") + sourcetype: str = SettingsField(title="Source Type") + title: str = SettingsField(title="Title") + tooltip: str = SettingsField(title="Tooltip") class ScriptsmenuSettings(BaseSettingsModel): """Nuke script menu project settings.""" _isGroup = True - name: str = Field(title="Menu Name") - definition: list[ScriptsmenuSubmodel] = Field( + name: str = SettingsField(title="Menu Name") + definition: list[ScriptsmenuSubmodel] = SettingsField( default_factory=list, title="Definition", description="Scriptmenu Items Definition" diff --git a/server_addon/nuke/server/settings/templated_workfile_build.py b/server_addon/nuke/server/settings/templated_workfile_build.py index 0899be841e..12ebedf570 100644 --- a/server_addon/nuke/server/settings/templated_workfile_build.py +++ b/server_addon/nuke/server/settings/templated_workfile_build.py @@ -1,27 +1,27 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, task_types_enum, ) class TemplatedWorkfileProfileModel(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = Field( + task_names: list[str] = SettingsField( default_factory=list, title="Task names" ) - path: str = Field( + path: str = SettingsField( title="Path to template" ) - keep_placeholder: bool = Field( + keep_placeholder: bool = SettingsField( False, title="Keep placeholders") - create_first_version: bool = Field( + create_first_version: bool = SettingsField( True, title="Create first version" ) @@ -29,6 +29,6 @@ class TemplatedWorkfileProfileModel(BaseSettingsModel): class TemplatedWorkfileBuildModel(BaseSettingsModel): """Settings for templated workfile builder.""" - profiles: list[TemplatedWorkfileProfileModel] = Field( + profiles: list[TemplatedWorkfileProfileModel] = SettingsField( default_factory=list ) diff --git a/server_addon/nuke/server/settings/workfile_builder.py b/server_addon/nuke/server/settings/workfile_builder.py index 3ae3b08788..97961655f3 100644 --- a/server_addon/nuke/server/settings/workfile_builder.py +++ b/server_addon/nuke/server/settings/workfile_builder.py @@ -1,57 +1,57 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, task_types_enum, MultiplatformPathModel, ) class CustomTemplateModel(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - path: MultiplatformPathModel = Field( + path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Gizmo Directory Path" ) class BuilderProfileItemModel(BaseSettingsModel): - product_name_filters: list[str] = Field( + product_name_filters: list[str] = SettingsField( default_factory=list, title="Product name" ) - product_types: list[str] = Field( + product_types: list[str] = SettingsField( default_factory=list, title="Product types" ) - repre_names: list[str] = Field( + repre_names: list[str] = SettingsField( default_factory=list, title="Representations" ) - loaders: list[str] = Field( + loaders: list[str] = SettingsField( default_factory=list, title="Loader plugins" ) class BuilderProfileModel(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - tasks: list[str] = Field( + tasks: list[str] = SettingsField( default_factory=list, title="Task names" ) - current_context: list[BuilderProfileItemModel] = Field( + current_context: list[BuilderProfileItemModel] = SettingsField( default_factory=list, title="Current context" ) - linked_assets: list[BuilderProfileItemModel] = Field( + linked_assets: list[BuilderProfileItemModel] = SettingsField( default_factory=list, title="Linked assets/shots" ) @@ -60,17 +60,17 @@ class BuilderProfileModel(BaseSettingsModel): class WorkfileBuilderModel(BaseSettingsModel): """[deprecated] use Template Workfile Build Settings instead. """ - create_first_version: bool = Field( + create_first_version: bool = SettingsField( title="Create first workfile") - custom_templates: list[CustomTemplateModel] = Field( + custom_templates: list[CustomTemplateModel] = SettingsField( default_factory=list, title="Custom templates" ) - builder_on_start: bool = Field( + builder_on_start: bool = SettingsField( default=False, title="Run Builder at first workfile" ) - profiles: list[BuilderProfileModel] = Field( + profiles: list[BuilderProfileModel] = SettingsField( default_factory=list, title="Builder profiles" ) diff --git a/server_addon/photoshop/server/settings/creator_plugins.py b/server_addon/photoshop/server/settings/creator_plugins.py index 2fe63a7e3a..8acc213866 100644 --- a/server_addon/photoshop/server/settings/creator_plugins.py +++ b/server_addon/photoshop/server/settings/creator_plugins.py @@ -1,51 +1,49 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CreateImagePluginModel(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - active_on_create: bool = Field(True, title="Active by default") - mark_for_review: bool = Field(False, title="Review by default") - default_variants: list[str] = Field( + enabled: bool = SettingsField(True, title="Enabled") + active_on_create: bool = SettingsField(True, title="Active by default") + mark_for_review: bool = SettingsField(False, title="Review by default") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Variants" ) class AutoImageCreatorPluginModel(BaseSettingsModel): - enabled: bool = Field(False, title="Enabled") - active_on_create: bool = Field(True, title="Active by default") - mark_for_review: bool = Field(False, title="Review by default") - default_variant: str = Field("", title="Default Variants") + enabled: bool = SettingsField(False, title="Enabled") + active_on_create: bool = SettingsField(True, title="Active by default") + mark_for_review: bool = SettingsField(False, title="Review by default") + default_variant: str = SettingsField("", title="Default Variants") class CreateReviewPlugin(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - active_on_create: bool = Field(True, title="Active by default") - default_variant: str = Field("", title="Default Variants") + enabled: bool = SettingsField(True, title="Enabled") + active_on_create: bool = SettingsField(True, title="Active by default") + default_variant: str = SettingsField("", title="Default Variants") class CreateWorkfilelugin(BaseSettingsModel): - enabled: bool = Field(True, title="Enabled") - active_on_create: bool = Field(True, title="Active by default") - default_variant: str = Field("", title="Default Variants") + enabled: bool = SettingsField(True, title="Enabled") + active_on_create: bool = SettingsField(True, title="Active by default") + default_variant: str = SettingsField("", title="Default Variants") class PhotoshopCreatorPlugins(BaseSettingsModel): - ImageCreator: CreateImagePluginModel = Field( + ImageCreator: CreateImagePluginModel = SettingsField( title="Create Image", default_factory=CreateImagePluginModel, ) - AutoImageCreator: AutoImageCreatorPluginModel = Field( + AutoImageCreator: AutoImageCreatorPluginModel = SettingsField( title="Create Flatten Image", default_factory=AutoImageCreatorPluginModel, ) - ReviewCreator: CreateReviewPlugin = Field( + ReviewCreator: CreateReviewPlugin = SettingsField( title="Create Review", default_factory=CreateReviewPlugin, ) - WorkfileCreator: CreateWorkfilelugin = Field( + WorkfileCreator: CreateWorkfilelugin = SettingsField( title="Create Workfile", default_factory=CreateWorkfilelugin, ) diff --git a/server_addon/photoshop/server/settings/imageio.py b/server_addon/photoshop/server/settings/imageio.py index 56b7f2fa32..9178497c6c 100644 --- a/server_addon/photoshop/server/settings/imageio.py +++ b/server_addon/photoshop/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,30 +35,30 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIORemappingRulesModel(BaseSettingsModel): - host_native_name: str = Field( + host_native_name: str = SettingsField( title="Application native colorspace name" ) - ocio_name: str = Field(title="OCIO colorspace name") + ocio_name: str = SettingsField(title="OCIO colorspace name") class ImageIORemappingModel(BaseSettingsModel): - rules: list[ImageIORemappingRulesModel] = Field( + rules: list[ImageIORemappingRulesModel] = SettingsField( default_factory=list) class PhotoshopImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - remapping: ImageIORemappingModel = Field( + remapping: ImageIORemappingModel = SettingsField( title="Remapping colorspace names", default_factory=ImageIORemappingModel ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/photoshop/server/settings/main.py b/server_addon/photoshop/server/settings/main.py index ae7705b3db..b6474d6d29 100644 --- a/server_addon/photoshop/server/settings/main.py +++ b/server_addon/photoshop/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import PhotoshopImageIOModel from .creator_plugins import PhotoshopCreatorPlugins, DEFAULT_CREATE_SETTINGS @@ -10,22 +9,22 @@ from .workfile_builder import WorkfileBuilderPlugin class PhotoshopSettings(BaseSettingsModel): """Photoshop Project Settings.""" - imageio: PhotoshopImageIOModel = Field( + imageio: PhotoshopImageIOModel = SettingsField( default_factory=PhotoshopImageIOModel, title="OCIO config" ) - create: PhotoshopCreatorPlugins = Field( + create: PhotoshopCreatorPlugins = SettingsField( default_factory=PhotoshopCreatorPlugins, title="Creator plugins" ) - publish: PhotoshopPublishPlugins = Field( + publish: PhotoshopPublishPlugins = SettingsField( default_factory=PhotoshopPublishPlugins, title="Publish plugins" ) - workfile_builder: WorkfileBuilderPlugin = Field( + workfile_builder: WorkfileBuilderPlugin = SettingsField( default_factory=WorkfileBuilderPlugin, title="Workfile Builder" ) diff --git a/server_addon/photoshop/server/settings/publish_plugins.py b/server_addon/photoshop/server/settings/publish_plugins.py index 21e7d670f0..c59526135c 100644 --- a/server_addon/photoshop/server/settings/publish_plugins.py +++ b/server_addon/photoshop/server/settings/publish_plugins.py @@ -1,6 +1,4 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField create_flatten_image_enum = [ @@ -22,30 +20,30 @@ color_code_enum = [ class ColorCodeMappings(BaseSettingsModel): - color_code: list[str] = Field( + color_code: list[str] = SettingsField( title="Color codes for layers", default_factory=list, enum_resolver=lambda: color_code_enum, ) - layer_name_regex: list[str] = Field( + layer_name_regex: list[str] = SettingsField( default_factory=list, title="Layer name regex" ) - product_type: str = Field( + product_type: str = SettingsField( "", title="Resulting product type" ) - product_name_template: str = Field( + product_name_template: str = SettingsField( "", title="Product name template" ) class ExtractedOptions(BaseSettingsModel): - tags: list[str] = Field( + tags: list[str] = SettingsField( title="Tags", default_factory=list ) @@ -57,19 +55,19 @@ class CollectColorCodedInstancesPlugin(BaseSettingsModel): instances. (Applicable only for remote publishing!)""" - enabled: bool = Field(True, title="Enabled") - create_flatten_image: str = Field( + enabled: bool = SettingsField(True, title="Enabled") + create_flatten_image: str = SettingsField( "", title="Create flatten image", enum_resolver=lambda: create_flatten_image_enum, ) - flatten_product_type_template: str = Field( + flatten_product_type_template: str = SettingsField( "", title="Subset template for flatten image" ) - color_code_mapping: list[ColorCodeMappings] = Field( + color_code_mapping: list[ColorCodeMappings] = SettingsField( title="Color code mappings", default_factory=ColorCodeMappings, ) @@ -77,30 +75,30 @@ class CollectColorCodedInstancesPlugin(BaseSettingsModel): class CollectReviewPlugin(BaseSettingsModel): """Should review product be created""" - enabled: bool = Field(True, title="Enabled") + enabled: bool = SettingsField(True, title="Enabled") class CollectVersionPlugin(BaseSettingsModel): """Synchronize version for image and review instances by workfile version""" # noqa - enabled: bool = Field(True, title="Enabled") + enabled: bool = SettingsField(True, title="Enabled") class ValidateContainersPlugin(BaseSettingsModel): """Check that workfile contains latest version of loaded items""" # noqa _isGroup = True enabled: bool = True - optional: bool = Field(False, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(False, title="Optional") + active: bool = SettingsField(True, title="Active") class ValidateNamingPlugin(BaseSettingsModel): """Validate naming of products and layers""" # noqa - invalid_chars: str = Field( + invalid_chars: str = SettingsField( '', title="Regex pattern of invalid characters" ) - replace_char: str = Field( + replace_char: str = SettingsField( '', title="Replacement character" ) @@ -108,19 +106,19 @@ class ValidateNamingPlugin(BaseSettingsModel): class ExtractImagePlugin(BaseSettingsModel): """Currently only jpg and png are supported""" - formats: list[str] = Field( + formats: list[str] = SettingsField( title="Extract Formats", default_factory=list, ) class ExtractReviewPlugin(BaseSettingsModel): - make_image_sequence: bool = Field( + make_image_sequence: bool = SettingsField( False, title="Make an image sequence instead of flatten image" ) - max_downscale_size: int = Field( + max_downscale_size: int = SettingsField( 8192, title="Maximum size of sources for review", description="FFMpeg can only handle limited resolution for creation of review and/or thumbnail", # noqa @@ -128,48 +126,48 @@ class ExtractReviewPlugin(BaseSettingsModel): le=16384, # less or equal ) - jpg_options: ExtractedOptions = Field( + jpg_options: ExtractedOptions = SettingsField( title="Extracted jpg Options", default_factory=ExtractedOptions ) - mov_options: ExtractedOptions = Field( + mov_options: ExtractedOptions = SettingsField( title="Extracted mov Options", default_factory=ExtractedOptions ) class PhotoshopPublishPlugins(BaseSettingsModel): - CollectColorCodedInstances: CollectColorCodedInstancesPlugin = Field( + CollectColorCodedInstances: CollectColorCodedInstancesPlugin = SettingsField( title="Collect Color Coded Instances", default_factory=CollectColorCodedInstancesPlugin, ) - CollectReview: CollectReviewPlugin = Field( + CollectReview: CollectReviewPlugin = SettingsField( title="Collect Review", default_factory=CollectReviewPlugin, ) - CollectVersion: CollectVersionPlugin = Field( + CollectVersion: CollectVersionPlugin = SettingsField( title="Collect Version", default_factory=CollectVersionPlugin, ) - ValidateContainers: ValidateContainersPlugin = Field( + ValidateContainers: ValidateContainersPlugin = SettingsField( title="Validate Containers", default_factory=ValidateContainersPlugin, ) - ValidateNaming: ValidateNamingPlugin = Field( + ValidateNaming: ValidateNamingPlugin = SettingsField( title="Validate naming of products and layers", default_factory=ValidateNamingPlugin, ) - ExtractImage: ExtractImagePlugin = Field( + ExtractImage: ExtractImagePlugin = SettingsField( title="Extract Image", default_factory=ExtractImagePlugin, ) - ExtractReview: ExtractReviewPlugin = Field( + ExtractReview: ExtractReviewPlugin = SettingsField( title="Extract Review", default_factory=ExtractReviewPlugin, ) diff --git a/server_addon/photoshop/server/settings/workfile_builder.py b/server_addon/photoshop/server/settings/workfile_builder.py index 68db05270d..4b00b99272 100644 --- a/server_addon/photoshop/server/settings/workfile_builder.py +++ b/server_addon/photoshop/server/settings/workfile_builder.py @@ -1,16 +1,18 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel, MultiplatformPathModel +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + MultiplatformPathModel, +) class CustomBuilderTemplate(BaseSettingsModel): _layout = "expanded" - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", ) - path: MultiplatformPathModel = Field( + path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel, title="Template path" ) @@ -18,12 +20,12 @@ class CustomBuilderTemplate(BaseSettingsModel): class WorkfileBuilderPlugin(BaseSettingsModel): _title = "Workfile Builder" - create_first_version: bool = Field( + create_first_version: bool = SettingsField( False, title="Create first workfile" ) - custom_templates: list[CustomBuilderTemplate] = Field( + custom_templates: list[CustomBuilderTemplate] = SettingsField( default_factory=CustomBuilderTemplate, title="Template profiles" ) diff --git a/server_addon/resolve/server/imageio.py b/server_addon/resolve/server/imageio.py index c2bfcd40d0..9540f5d1d9 100644 --- a/server_addon/resolve/server/imageio.py +++ b/server_addon/resolve/server/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,30 +35,30 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIORemappingRulesModel(BaseSettingsModel): - host_native_name: str = Field( + host_native_name: str = SettingsField( title="Application native colorspace name" ) - ocio_name: str = Field(title="OCIO colorspace name") + ocio_name: str = SettingsField(title="OCIO colorspace name") class ImageIORemappingModel(BaseSettingsModel): - rules: list[ImageIORemappingRulesModel] = Field( + rules: list[ImageIORemappingRulesModel] = SettingsField( default_factory=list) class ResolveImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - remapping: ImageIORemappingModel = Field( + remapping: ImageIORemappingModel = SettingsField( title="Remapping colorspace names", default_factory=ImageIORemappingModel ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/resolve/server/settings.py b/server_addon/resolve/server/settings.py index 326f6bea1e..dcdb2f1b27 100644 --- a/server_addon/resolve/server/settings.py +++ b/server_addon/resolve/server/settings.py @@ -1,91 +1,90 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import ResolveImageIOModel class CreateShotClipModels(BaseSettingsModel): - hierarchy: str = Field( + hierarchy: str = SettingsField( "{folder}/{sequence}", title="Shot parent hierarchy", section="Shot Hierarchy And Rename Settings" ) - clipRename: bool = Field( + clipRename: bool = SettingsField( True, title="Rename clips" ) - clipName: str = Field( + clipName: str = SettingsField( "{track}{sequence}{shot}", title="Clip name template" ) - countFrom: int = Field( + countFrom: int = SettingsField( 10, title="Count sequence from" ) - countSteps: int = Field( + countSteps: int = SettingsField( 10, title="Stepping number" ) - folder: str = Field( + folder: str = SettingsField( "shots", title="{folder}", section="Shot Template Keywords" ) - episode: str = Field( + episode: str = SettingsField( "ep01", title="{episode}" ) - sequence: str = Field( + sequence: str = SettingsField( "sq01", title="{sequence}" ) - track: str = Field( + track: str = SettingsField( "{_track_}", title="{track}" ) - shot: str = Field( + shot: str = SettingsField( "sh###", title="{shot}" ) - vSyncOn: bool = Field( + vSyncOn: bool = SettingsField( False, title="Enable Vertical Sync", section="Vertical Synchronization Of Attributes" ) - workfileFrameStart: int = Field( + workfileFrameStart: int = SettingsField( 1001, title="Workfiles Start Frame", section="Shot Attributes" ) - handleStart: int = Field( + handleStart: int = SettingsField( 10, title="Handle start (head)" ) - handleEnd: int = Field( + handleEnd: int = SettingsField( 10, title="Handle end (tail)" ) class CreatorPuginsModel(BaseSettingsModel): - CreateShotClip: CreateShotClipModels = Field( + CreateShotClip: CreateShotClipModels = SettingsField( default_factory=CreateShotClipModels, title="Create Shot Clip" ) class ResolveSettings(BaseSettingsModel): - launch_openpype_menu_on_start: bool = Field( + launch_openpype_menu_on_start: bool = SettingsField( False, title="Launch OpenPype menu on start of Resolve" ) - imageio: ResolveImageIOModel = Field( + imageio: ResolveImageIOModel = SettingsField( default_factory=ResolveImageIOModel, title="Color Management (ImageIO)" ) - create: CreatorPuginsModel = Field( + create: CreatorPuginsModel = SettingsField( default_factory=CreatorPuginsModel, title="Creator plugins", ) diff --git a/server_addon/royal_render/server/settings.py b/server_addon/royal_render/server/settings.py index 677d7e2671..6e077feb3e 100644 --- a/server_addon/royal_render/server/settings.py +++ b/server_addon/royal_render/server/settings.py @@ -1,5 +1,8 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel, MultiplatformPathModel +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + MultiplatformPathModel, +) class CustomPath(MultiplatformPathModel): @@ -8,18 +11,20 @@ class CustomPath(MultiplatformPathModel): class ServerListSubmodel(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Name") - value: CustomPath = Field( + name: str = SettingsField("", title="Name") + value: CustomPath = SettingsField( default_factory=CustomPath ) class CollectSequencesFromJobModel(BaseSettingsModel): - review: bool = Field(True, title="Generate reviews from sequences") + review: bool = SettingsField( + True, title="Generate reviews from sequences" + ) class PublishPluginsModel(BaseSettingsModel): - CollectSequencesFromJob: CollectSequencesFromJobModel = Field( + CollectSequencesFromJob: CollectSequencesFromJobModel = SettingsField( default_factory=CollectSequencesFromJobModel, title="Collect Sequences from the Job" ) @@ -31,19 +36,19 @@ class RoyalRenderSettings(BaseSettingsModel): # - both system and project settings contained 'rr_path' # where project settings did choose one of rr_path from system settings # that is not possible in AYON - rr_paths: list[ServerListSubmodel] = Field( + rr_paths: list[ServerListSubmodel] = SettingsField( default_factory=list, title="Royal Render Root Paths", scope=["studio"], ) # This was 'rr_paths' in project settings and should be enum of # 'rr_paths' from system settings, but that's not possible in AYON - selected_rr_paths: list[str] = Field( + selected_rr_paths: list[str] = SettingsField( default_factory=list, title="Selected Royal Render Paths", section="---", ) - publish: PublishPluginsModel = Field( + publish: PublishPluginsModel = SettingsField( default_factory=PublishPluginsModel, title="Publish plugins", ) diff --git a/server_addon/substancepainter/server/settings/imageio.py b/server_addon/substancepainter/server/settings/imageio.py index e301d3d865..ea685047b0 100644 --- a/server_addon/substancepainter/server/settings/imageio.py +++ b/server_addon/substancepainter/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class ImageIOSettings(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/substancepainter/server/settings/main.py b/server_addon/substancepainter/server/settings/main.py index f8397c3c08..f80fa9fe1e 100644 --- a/server_addon/substancepainter/server/settings/main.py +++ b/server_addon/substancepainter/server/settings/main.py @@ -1,20 +1,19 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import ImageIOSettings, DEFAULT_IMAGEIO_SETTINGS class ShelvesSettingsModel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: str = Field(title="Path") + name: str = SettingsField(title="Name") + value: str = SettingsField(title="Path") class SubstancePainterSettings(BaseSettingsModel): - imageio: ImageIOSettings = Field( + imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (ImageIO)" ) - shelves: list[ShelvesSettingsModel] = Field( + shelves: list[ShelvesSettingsModel] = SettingsField( default_factory=list, title="Shelves" ) diff --git a/server_addon/timers_manager/server/settings.py b/server_addon/timers_manager/server/settings.py index a5c5721a57..774940730c 100644 --- a/server_addon/timers_manager/server/settings.py +++ b/server_addon/timers_manager/server/settings.py @@ -1,24 +1,23 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class TimersManagerSettings(BaseSettingsModel): - auto_stop: bool = Field( + auto_stop: bool = SettingsField( True, title="Auto stop timer", scope=["studio"], ) - full_time: int = Field( + full_time: int = SettingsField( 15, title="Max idle time", scope=["studio"], ) - message_time: float = Field( + message_time: float = SettingsField( 0.5, title="When dialog will show", scope=["studio"], ) - disregard_publishing: bool = Field( + disregard_publishing: bool = SettingsField( False, title="Disregard publishing", scope=["studio"], diff --git a/server_addon/traypublisher/server/settings/creator_plugins.py b/server_addon/traypublisher/server/settings/creator_plugins.py index 345cb92e63..bf66d9a088 100644 --- a/server_addon/traypublisher/server/settings/creator_plugins.py +++ b/server_addon/traypublisher/server/settings/creator_plugins.py @@ -1,6 +1,4 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class BatchMovieCreatorPlugin(BaseSettingsModel): @@ -8,24 +6,24 @@ class BatchMovieCreatorPlugin(BaseSettingsModel): asset is parsed from file names ('asset.mov', 'asset_v001.mov', 'my_asset_to_publish.mov')""" - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( title="Default variants", default_factory=list ) - default_tasks: list[str] = Field( + default_tasks: list[str] = SettingsField( title="Default tasks", default_factory=list ) - extensions: list[str] = Field( + extensions: list[str] = SettingsField( title="Extensions", default_factory=list ) class TrayPublisherCreatePluginsModel(BaseSettingsModel): - BatchMovieCreator: BatchMovieCreatorPlugin = Field( + BatchMovieCreator: BatchMovieCreatorPlugin = SettingsField( title="Batch Movie Creator", default_factory=BatchMovieCreatorPlugin ) diff --git a/server_addon/traypublisher/server/settings/editorial_creators.py b/server_addon/traypublisher/server/settings/editorial_creators.py index ac0ff0afc7..d9f5e302a4 100644 --- a/server_addon/traypublisher/server/settings/editorial_creators.py +++ b/server_addon/traypublisher/server/settings/editorial_creators.py @@ -1,18 +1,20 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel, task_types_enum +from ayon_server.settings import ( + BaseSettingsModel, + SettingsField, + task_types_enum, +) class ClipNameTokenizerItem(BaseSettingsModel): _layout = "expanded" - name: str = Field("", title="Tokenizer name") - regex: str = Field("", title="Tokenizer regex") + name: str = SettingsField("", title="Tokenizer name") + regex: str = SettingsField("", title="Tokenizer regex") class ShotAddTasksItem(BaseSettingsModel): _layout = "expanded" - name: str = Field('', title="Key") - task_type: str = Field( + name: str = SettingsField('', title="Key") + task_type: str = SettingsField( title="Task type", enum_resolver=task_types_enum ) @@ -20,7 +22,7 @@ class ShotAddTasksItem(BaseSettingsModel): class ShotRenameSubmodel(BaseSettingsModel): enabled: bool = True - shot_rename_template: str = Field( + shot_rename_template: str = SettingsField( "", title="Shot rename template" ) @@ -36,16 +38,16 @@ parent_type_enum = [ class TokenToParentConvertorItem(BaseSettingsModel): # TODO - was 'type' must be renamed in code to `parent_type` - parent_type: str = Field( + parent_type: str = SettingsField( "Project", enum_resolver=lambda: parent_type_enum ) - name: str = Field( + name: str = SettingsField( "", title="Parent token name", description="Unique name used in `Parent path template`" ) - value: str = Field( + value: str = SettingsField( "", title="Parent token value", description="Template where any text, Anatomy keys and Tokens could be used" # noqa @@ -54,12 +56,12 @@ class TokenToParentConvertorItem(BaseSettingsModel): class ShotHierarchySubmodel(BaseSettingsModel): enabled: bool = True - parents_path: str = Field( + parents_path: str = SettingsField( "", title="Parents path template", description="Using keys from \"Token to parent convertor\" or tokens directly" # noqa ) - parents: list[TokenToParentConvertorItem] = Field( + parents: list[TokenToParentConvertorItem] = SettingsField( default_factory=TokenToParentConvertorItem, title="Token to parent convertor" ) @@ -73,22 +75,22 @@ output_file_type = [ class ProductTypePresetItem(BaseSettingsModel): - product_type: str = Field("", title="Product type") + product_type: str = SettingsField("", title="Product type") # TODO add placeholder '< Inherited >' - variant: str = Field("", title="Variant") - review: bool = Field(True, title="Review") - output_file_type: str = Field( + variant: str = SettingsField("", title="Variant") + review: bool = SettingsField(True, title="Review") + output_file_type: str = SettingsField( ".mp4", enum_resolver=lambda: output_file_type ) class EditorialSimpleCreatorPlugin(BaseSettingsModel): - default_variants: list[str] = Field( + default_variants: list[str] = SettingsField( default_factory=list, title="Default Variants" ) - clip_name_tokenizer: list[ClipNameTokenizerItem] = Field( + clip_name_tokenizer: list[ClipNameTokenizerItem] = SettingsField( default_factory=ClipNameTokenizerItem, description=( "Using Regex expression to create tokens. \nThose can be used" @@ -96,25 +98,25 @@ class EditorialSimpleCreatorPlugin(BaseSettingsModel): "\n\nTokens should be decorated with \"_\" on each side" ) ) - shot_rename: ShotRenameSubmodel = Field( + shot_rename: ShotRenameSubmodel = SettingsField( title="Shot Rename", default_factory=ShotRenameSubmodel ) - shot_hierarchy: ShotHierarchySubmodel = Field( + shot_hierarchy: ShotHierarchySubmodel = SettingsField( title="Shot Hierarchy", default_factory=ShotHierarchySubmodel ) - shot_add_tasks: list[ShotAddTasksItem] = Field( + shot_add_tasks: list[ShotAddTasksItem] = SettingsField( title="Add tasks to shot", default_factory=ShotAddTasksItem ) - product_type_presets: list[ProductTypePresetItem] = Field( + product_type_presets: list[ProductTypePresetItem] = SettingsField( default_factory=list ) class TraypublisherEditorialCreatorPlugins(BaseSettingsModel): - editorial_simple: EditorialSimpleCreatorPlugin = Field( + editorial_simple: EditorialSimpleCreatorPlugin = SettingsField( title="Editorial simple creator", default_factory=EditorialSimpleCreatorPlugin, ) diff --git a/server_addon/traypublisher/server/settings/imageio.py b/server_addon/traypublisher/server/settings/imageio.py index 3df0d2f2fb..06a18a39ca 100644 --- a/server_addon/traypublisher/server/settings/imageio.py +++ b/server_addon/traypublisher/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class TrayPublisherImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/traypublisher/server/settings/main.py b/server_addon/traypublisher/server/settings/main.py index fad96bef2f..760c529f49 100644 --- a/server_addon/traypublisher/server/settings/main.py +++ b/server_addon/traypublisher/server/settings/main.py @@ -1,5 +1,4 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import TrayPublisherImageIOModel from .simple_creators import ( @@ -22,23 +21,23 @@ from .publish_plugins import ( class TraypublisherSettings(BaseSettingsModel): """Traypublisher Project Settings.""" - imageio: TrayPublisherImageIOModel = Field( + imageio: TrayPublisherImageIOModel = SettingsField( default_factory=TrayPublisherImageIOModel, title="Color Management (ImageIO)" ) - simple_creators: list[SimpleCreatorPlugin] = Field( + simple_creators: list[SimpleCreatorPlugin] = SettingsField( title="Simple Create Plugins", default_factory=SimpleCreatorPlugin, ) - editorial_creators: TraypublisherEditorialCreatorPlugins = Field( + editorial_creators: TraypublisherEditorialCreatorPlugins = SettingsField( title="Editorial Creators", default_factory=TraypublisherEditorialCreatorPlugins, ) - create: TrayPublisherCreatePluginsModel = Field( + create: TrayPublisherCreatePluginsModel = SettingsField( title="Create", default_factory=TrayPublisherCreatePluginsModel ) - publish: TrayPublisherPublishPlugins = Field( + publish: TrayPublisherPublishPlugins = SettingsField( title="Publish Plugins", default_factory=TrayPublisherPublishPlugins ) diff --git a/server_addon/traypublisher/server/settings/publish_plugins.py b/server_addon/traypublisher/server/settings/publish_plugins.py index 8c844f29f2..f413c86227 100644 --- a/server_addon/traypublisher/server/settings/publish_plugins.py +++ b/server_addon/traypublisher/server/settings/publish_plugins.py @@ -1,13 +1,11 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class ValidatePluginModel(BaseSettingsModel): _isGroup = True enabled: bool = True - optional: bool = Field(True, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(True, title="Optional") + active: bool = SettingsField(True, title="Active") class ValidateFrameRangeModel(ValidatePluginModel): @@ -17,15 +15,15 @@ class ValidateFrameRangeModel(ValidatePluginModel): class TrayPublisherPublishPlugins(BaseSettingsModel): - CollectFrameDataFromAssetEntity: ValidatePluginModel = Field( + CollectFrameDataFromAssetEntity: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Collect Frame Data From Folder Entity", ) - ValidateFrameRange: ValidateFrameRangeModel = Field( + ValidateFrameRange: ValidateFrameRangeModel = SettingsField( title="Validate Frame Range", default_factory=ValidateFrameRangeModel, ) - ValidateExistingVersion: ValidatePluginModel = Field( + ValidateExistingVersion: ValidatePluginModel = SettingsField( title="Validate Existing Version", default_factory=ValidatePluginModel, ) diff --git a/server_addon/traypublisher/server/settings/simple_creators.py b/server_addon/traypublisher/server/settings/simple_creators.py index 8335b9d34e..924eeedd23 100644 --- a/server_addon/traypublisher/server/settings/simple_creators.py +++ b/server_addon/traypublisher/server/settings/simple_creators.py @@ -1,42 +1,40 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class SimpleCreatorPlugin(BaseSettingsModel): _layout = "expanded" - product_type: str = Field("", title="Product type") + product_type: str = SettingsField("", title="Product type") # TODO add placeholder - identifier: str = Field("", title="Identifier") - label: str = Field("", title="Label") - icon: str = Field("", title="Icon") - default_variants: list[str] = Field( + identifier: str = SettingsField("", title="Identifier") + label: str = SettingsField("", title="Label") + icon: str = SettingsField("", title="Icon") + default_variants: list[str] = SettingsField( default_factory=list, title="Default Variants" ) - description: str = Field( + description: str = SettingsField( "", title="Description", widget="textarea" ) - detailed_description: str = Field( + detailed_description: str = SettingsField( "", title="Detailed Description", widget="textarea" ) - allow_sequences: bool = Field( + allow_sequences: bool = SettingsField( False, title="Allow sequences" ) - allow_multiple_items: bool = Field( + allow_multiple_items: bool = SettingsField( False, title="Allow multiple items" ) - allow_version_control: bool = Field( + allow_version_control: bool = SettingsField( False, title="Allow version control" ) - extensions: list[str] = Field( + extensions: list[str] = SettingsField( default_factory=list, title="Extensions" ) diff --git a/server_addon/tvpaint/server/settings/create_plugins.py b/server_addon/tvpaint/server/settings/create_plugins.py index 349bfdd288..89c3a52774 100644 --- a/server_addon/tvpaint/server/settings/create_plugins.py +++ b/server_addon/tvpaint/server/settings/create_plugins.py @@ -1,44 +1,43 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class CreateWorkfileModel(BaseSettingsModel): - enabled: bool = Field(True) - default_variant: str = Field(title="Default variant") - default_variants: list[str] = Field( + enabled: bool = SettingsField(True) + default_variant: str = SettingsField(title="Default variant") + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants") class CreateReviewModel(BaseSettingsModel): - enabled: bool = Field(True) - active_on_create: bool = Field(True, title="Active by default") - default_variant: str = Field(title="Default variant") - default_variants: list[str] = Field( + enabled: bool = SettingsField(True) + active_on_create: bool = SettingsField(True, title="Active by default") + default_variant: str = SettingsField(title="Default variant") + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants") class CreateRenderSceneModel(BaseSettingsModel): - enabled: bool = Field(True) - active_on_create: bool = Field(True, title="Active by default") - mark_for_review: bool = Field(True, title="Review by default") - default_pass_name: str = Field(title="Default beauty pass") - default_variant: str = Field(title="Default variant") - default_variants: list[str] = Field( + enabled: bool = SettingsField(True) + active_on_create: bool = SettingsField(True, title="Active by default") + mark_for_review: bool = SettingsField(True, title="Review by default") + default_pass_name: str = SettingsField(title="Default beauty pass") + default_variant: str = SettingsField(title="Default variant") + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants") class CreateRenderLayerModel(BaseSettingsModel): - mark_for_review: bool = Field(True, title="Review by default") - default_pass_name: str = Field(title="Default beauty pass") - default_variant: str = Field(title="Default variant") - default_variants: list[str] = Field( + mark_for_review: bool = SettingsField(True, title="Review by default") + default_pass_name: str = SettingsField(title="Default beauty pass") + default_variant: str = SettingsField(title="Default variant") + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants") class CreateRenderPassModel(BaseSettingsModel): - mark_for_review: bool = Field(True, title="Review by default") - default_variant: str = Field(title="Default variant") - default_variants: list[str] = Field( + mark_for_review: bool = SettingsField(True, title="Review by default") + default_variant: str = SettingsField(title="Default variant") + default_variants: list[str] = SettingsField( default_factory=list, title="Default variants") @@ -58,35 +57,35 @@ class AutoDetectCreateRenderModel(BaseSettingsModel): Would create group names "L010", "L020", ... """ - enabled: bool = Field(True) - allow_group_rename: bool = Field(title="Allow group rename") - group_name_template: str = Field(title="Group name template") - group_idx_offset: int = Field(1, title="Group index Offset", ge=1) - group_idx_padding: int = Field(4, title="Group index Padding", ge=1) + enabled: bool = SettingsField(True) + allow_group_rename: bool = SettingsField(title="Allow group rename") + group_name_template: str = SettingsField(title="Group name template") + group_idx_offset: int = SettingsField(1, title="Group index Offset", ge=1) + group_idx_padding: int = SettingsField(4, title="Group index Padding", ge=1) class CreatePluginsModel(BaseSettingsModel): - create_workfile: CreateWorkfileModel = Field( + create_workfile: CreateWorkfileModel = SettingsField( default_factory=CreateWorkfileModel, title="Create Workfile" ) - create_review: CreateReviewModel = Field( + create_review: CreateReviewModel = SettingsField( default_factory=CreateReviewModel, title="Create Review" ) - create_render_scene: CreateRenderSceneModel = Field( + create_render_scene: CreateRenderSceneModel = SettingsField( default_factory=CreateReviewModel, title="Create Render Scene" ) - create_render_layer: CreateRenderLayerModel= Field( + create_render_layer: CreateRenderLayerModel= SettingsField( default_factory=CreateRenderLayerModel, title="Create Render Layer" ) - create_render_pass: CreateRenderPassModel = Field( + create_render_pass: CreateRenderPassModel = SettingsField( default_factory=CreateRenderPassModel, title="Create Render Pass" ) - auto_detect_render: AutoDetectCreateRenderModel = Field( + auto_detect_render: AutoDetectCreateRenderModel = SettingsField( default_factory=AutoDetectCreateRenderModel, title="Auto-Detect Create Render", ) diff --git a/server_addon/tvpaint/server/settings/filters.py b/server_addon/tvpaint/server/settings/filters.py index 009febae06..9720e82281 100644 --- a/server_addon/tvpaint/server/settings/filters.py +++ b/server_addon/tvpaint/server/settings/filters.py @@ -1,12 +1,10 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField class FiltersSubmodel(BaseSettingsModel): _layout = "compact" - name: str = Field(title="Name") - value: str = Field( + name: str = SettingsField(title="Name") + value: str = SettingsField( "", title="Textarea", widget="textarea", @@ -14,6 +12,6 @@ class FiltersSubmodel(BaseSettingsModel): class PublishFiltersModel(BaseSettingsModel): - env_search_replace_values: list[FiltersSubmodel] = Field( + env_search_replace_values: list[FiltersSubmodel] = SettingsField( default_factory=list ) diff --git a/server_addon/tvpaint/server/settings/imageio.py b/server_addon/tvpaint/server/settings/imageio.py index 50f8b7eef4..aaf3fbf34e 100644 --- a/server_addon/tvpaint/server/settings/imageio.py +++ b/server_addon/tvpaint/server/settings/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class TVPaintImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/tvpaint/server/settings/main.py b/server_addon/tvpaint/server/settings/main.py index 102acfaf3d..c6b6c9ab12 100644 --- a/server_addon/tvpaint/server/settings/main.py +++ b/server_addon/tvpaint/server/settings/main.py @@ -1,6 +1,6 @@ -from pydantic import Field from ayon_server.settings import ( BaseSettingsModel, + SettingsField, ensure_unique_names, ) @@ -15,23 +15,23 @@ from .publish_plugins import ( class TvpaintSettings(BaseSettingsModel): - imageio: TVPaintImageIOModel = Field( + imageio: TVPaintImageIOModel = SettingsField( default_factory=TVPaintImageIOModel, title="Color Management (ImageIO)" ) - stop_timer_on_application_exit: bool = Field( + stop_timer_on_application_exit: bool = SettingsField( title="Stop timer on application exit") - create: CreatePluginsModel = Field( + create: CreatePluginsModel = SettingsField( default_factory=CreatePluginsModel, title="Create plugins" ) - publish: PublishPluginsModel = Field( + publish: PublishPluginsModel = SettingsField( default_factory=PublishPluginsModel, title="Publish plugins") - load: LoadPluginsModel = Field( + load: LoadPluginsModel = SettingsField( default_factory=LoadPluginsModel, title="Load plugins") - workfile_builder: WorkfileBuilderPlugin = Field( + workfile_builder: WorkfileBuilderPlugin = SettingsField( default_factory=WorkfileBuilderPlugin, title="Workfile Builder" ) diff --git a/server_addon/tvpaint/server/settings/publish_plugins.py b/server_addon/tvpaint/server/settings/publish_plugins.py index 76c7eaac01..0623524c92 100644 --- a/server_addon/tvpaint/server/settings/publish_plugins.py +++ b/server_addon/tvpaint/server/settings/publish_plugins.py @@ -1,11 +1,9 @@ -from pydantic import Field - -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.types import ColorRGBA_uint8 class CollectRenderInstancesModel(BaseSettingsModel): - ignore_render_pass_transparency: bool = Field( + ignore_render_pass_transparency: bool = SettingsField( title="Ignore Render Pass opacity" ) @@ -13,15 +11,15 @@ class CollectRenderInstancesModel(BaseSettingsModel): class ExtractSequenceModel(BaseSettingsModel): """Review BG color is used for whole scene review and for thumbnails.""" # TODO Use alpha color - review_bg: ColorRGBA_uint8 = Field( + review_bg: ColorRGBA_uint8 = SettingsField( (255, 255, 255, 1.0), title="Review BG color") class ValidatePluginModel(BaseSettingsModel): enabled: bool = True - optional: bool = Field(True, title="Optional") - active: bool = Field(True, title="Active") + optional: bool = SettingsField(True, title="Optional") + active: bool = SettingsField(True, title="Active") def compression_enum(): @@ -44,7 +42,7 @@ class ExtractConvertToEXRModel(BaseSettingsModel): enabled: bool = False replace_pngs: bool = True - exr_compression: str = Field( + exr_compression: str = SettingsField( "ZIP", enum_resolver=compression_enum, title="EXR Compression" @@ -53,46 +51,46 @@ class ExtractConvertToEXRModel(BaseSettingsModel): class LoadImageDefaultModel(BaseSettingsModel): _layout = "expanded" - stretch: bool = Field(title="Stretch") - timestretch: bool = Field(title="TimeStretch") - preload: bool = Field(title="Preload") + stretch: bool = SettingsField(title="Stretch") + timestretch: bool = SettingsField(title="TimeStretch") + preload: bool = SettingsField(title="Preload") class LoadImageModel(BaseSettingsModel): - defaults: LoadImageDefaultModel = Field( + defaults: LoadImageDefaultModel = SettingsField( default_factory=LoadImageDefaultModel ) class PublishPluginsModel(BaseSettingsModel): - CollectRenderInstances: CollectRenderInstancesModel = Field( + CollectRenderInstances: CollectRenderInstancesModel = SettingsField( default_factory=CollectRenderInstancesModel, title="Collect Render Instances") - ExtractSequence: ExtractSequenceModel = Field( + ExtractSequence: ExtractSequenceModel = SettingsField( default_factory=ExtractSequenceModel, title="Extract Sequence") - ValidateProjectSettings: ValidatePluginModel = Field( + ValidateProjectSettings: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Project Settings") - ValidateMarks: ValidatePluginModel = Field( + ValidateMarks: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate MarkIn/Out") - ValidateStartFrame: ValidatePluginModel = Field( + ValidateStartFrame: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Scene Start Frame") - ValidateAssetName: ValidatePluginModel = Field( + ValidateAssetName: ValidatePluginModel = SettingsField( default_factory=ValidatePluginModel, title="Validate Folder Name") - ExtractConvertToEXR: ExtractConvertToEXRModel = Field( + ExtractConvertToEXR: ExtractConvertToEXRModel = SettingsField( default_factory=ExtractConvertToEXRModel, title="Extract Convert To EXR") class LoadPluginsModel(BaseSettingsModel): - LoadImage: LoadImageModel = Field( + LoadImage: LoadImageModel = SettingsField( default_factory=LoadImageModel, title="Load Image") - ImportImage: LoadImageModel = Field( + ImportImage: LoadImageModel = SettingsField( default_factory=LoadImageModel, title="Import Image") diff --git a/server_addon/tvpaint/server/settings/workfile_builder.py b/server_addon/tvpaint/server/settings/workfile_builder.py index e0aba5da7e..0799497bf9 100644 --- a/server_addon/tvpaint/server/settings/workfile_builder.py +++ b/server_addon/tvpaint/server/settings/workfile_builder.py @@ -1,30 +1,29 @@ -from pydantic import Field - from ayon_server.settings import ( BaseSettingsModel, + SettingsField, MultiplatformPathModel, task_types_enum, ) class CustomBuilderTemplate(BaseSettingsModel): - task_types: list[str] = Field( + task_types: list[str] = SettingsField( default_factory=list, title="Task types", enum_resolver=task_types_enum ) - template_path: MultiplatformPathModel = Field( + template_path: MultiplatformPathModel = SettingsField( default_factory=MultiplatformPathModel ) class WorkfileBuilderPlugin(BaseSettingsModel): _title = "Workfile Builder" - create_first_version: bool = Field( + create_first_version: bool = SettingsField( False, title="Create first workfile" ) - custom_templates: list[CustomBuilderTemplate] = Field( + custom_templates: list[CustomBuilderTemplate] = SettingsField( default_factory=CustomBuilderTemplate ) diff --git a/server_addon/unreal/server/imageio.py b/server_addon/unreal/server/imageio.py index dde042ba47..853d476587 100644 --- a/server_addon/unreal/server/imageio.py +++ b/server_addon/unreal/server/imageio.py @@ -1,29 +1,29 @@ -from pydantic import Field, validator -from ayon_server.settings import BaseSettingsModel +from pydantic import validator +from ayon_server.settings import BaseSettingsModel, SettingsField from ayon_server.settings.validators import ensure_unique_names class ImageIOConfigModel(BaseSettingsModel): - override_global_config: bool = Field( + override_global_config: bool = SettingsField( False, title="Override global OCIO config" ) - filepath: list[str] = Field( + filepath: list[str] = SettingsField( default_factory=list, title="Config path" ) class ImageIOFileRuleModel(BaseSettingsModel): - name: str = Field("", title="Rule name") - pattern: str = Field("", title="Regex pattern") - colorspace: str = Field("", title="Colorspace name") - ext: str = Field("", title="File extension") + name: str = SettingsField("", title="Rule name") + pattern: str = SettingsField("", title="Regex pattern") + colorspace: str = SettingsField("", title="Colorspace name") + ext: str = SettingsField("", title="File extension") class ImageIOFileRulesModel(BaseSettingsModel): - activate_host_rules: bool = Field(False) - rules: list[ImageIOFileRuleModel] = Field( + activate_host_rules: bool = SettingsField(False) + rules: list[ImageIOFileRuleModel] = SettingsField( default_factory=list, title="Rules" ) @@ -35,14 +35,14 @@ class ImageIOFileRulesModel(BaseSettingsModel): class UnrealImageIOModel(BaseSettingsModel): - activate_host_color_management: bool = Field( + activate_host_color_management: bool = SettingsField( True, title="Enable Color Management" ) - ocio_config: ImageIOConfigModel = Field( + ocio_config: ImageIOConfigModel = SettingsField( default_factory=ImageIOConfigModel, title="OCIO config" ) - file_rules: ImageIOFileRulesModel = Field( + file_rules: ImageIOFileRulesModel = SettingsField( default_factory=ImageIOFileRulesModel, title="File Rules" ) diff --git a/server_addon/unreal/server/settings.py b/server_addon/unreal/server/settings.py index 110ccc563a..5f54fb6c75 100644 --- a/server_addon/unreal/server/settings.py +++ b/server_addon/unreal/server/settings.py @@ -1,11 +1,10 @@ -from pydantic import Field -from ayon_server.settings import BaseSettingsModel +from ayon_server.settings import BaseSettingsModel, SettingsField from .imageio import UnrealImageIOModel class ProjectSetup(BaseSettingsModel): - dev_mode: bool = Field( + dev_mode: bool = SettingsField( False, title="Dev mode" ) @@ -21,32 +20,32 @@ def _render_format_enum(): class UnrealSettings(BaseSettingsModel): - imageio: UnrealImageIOModel = Field( + imageio: UnrealImageIOModel = SettingsField( default_factory=UnrealImageIOModel, title="Color Management (ImageIO)" ) - level_sequences_for_layouts: bool = Field( + level_sequences_for_layouts: bool = SettingsField( False, title="Generate level sequences when loading layouts" ) - delete_unmatched_assets: bool = Field( + delete_unmatched_assets: bool = SettingsField( False, title="Delete assets that are not matched" ) - render_config_path: str = Field( + render_config_path: str = SettingsField( "", title="Render Config Path" ) - preroll_frames: int = Field( + preroll_frames: int = SettingsField( 0, title="Pre-roll frames" ) - render_format: str = Field( + render_format: str = SettingsField( "png", title="Render format", enum_resolver=_render_format_enum ) - project_setup: ProjectSetup = Field( + project_setup: ProjectSetup = SettingsField( default_factory=ProjectSetup, title="Project Setup", ) From 4709676b511e96a287abe3cf93e5085d98d3a88a Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Fri, 26 Jan 2024 17:24:41 +0100 Subject: [PATCH 191/198] Fusion: provide better logging for validate saver crash due type error (#6082) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * OP-7467 - move get_tool_resolution to classmethod Doesn't make much sense to have it outside of class. Debugging of it is impossible there (because of missing logger). Imho. * OP-7467 - add check for frame Limits uncaught error when resolution info is None, which could happen when saver is not connected. * OP-7467 - remove debugging messages * OP-7467 - enhance get_invalid Handle exception to select broken saver in the Publisher UI. * OP-7467 - refactor check Here it makes more sense. We try to run some expression, but it might still result in None. --------- Co-authored-by: Libor Batek <112623825+LiborBatek@users.noreply.github.com> Co-authored-by: Jakub Ježek --- .../publish/validate_saver_resolution.py | 115 ++++++++++-------- 1 file changed, 63 insertions(+), 52 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py b/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py index f6aba170c0..b28af3409d 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_resolution.py @@ -8,55 +8,6 @@ from openpype.hosts.fusion.api.action import SelectInvalidAction from openpype.hosts.fusion.api import comp_lock_and_undo_chunk -def get_tool_resolution(tool, frame): - """Return the 2D input resolution to a Fusion tool - - If the current tool hasn't been rendered its input resolution - hasn't been saved. To combat this, add an expression in - the comments field to read the resolution - - Args - tool (Fusion Tool): The tool to query input resolution - frame (int): The frame to query the resolution on. - - Returns: - tuple: width, height as 2-tuple of integers - - """ - comp = tool.Composition - - # False undo removes the undo-stack from the undo list - with comp_lock_and_undo_chunk(comp, "Read resolution", False): - # Save old comment - old_comment = "" - has_expression = False - if tool["Comments"][frame] != "": - if tool["Comments"].GetExpression() is not None: - has_expression = True - old_comment = tool["Comments"].GetExpression() - tool["Comments"].SetExpression(None) - else: - old_comment = tool["Comments"][frame] - tool["Comments"][frame] = "" - - # Get input width - tool["Comments"].SetExpression("self.Input.OriginalWidth") - width = int(tool["Comments"][frame]) - - # Get input height - tool["Comments"].SetExpression("self.Input.OriginalHeight") - height = int(tool["Comments"][frame]) - - # Reset old comment - tool["Comments"].SetExpression(None) - if has_expression: - tool["Comments"].SetExpression(old_comment) - else: - tool["Comments"][frame] = old_comment - - return width, height - - class ValidateSaverResolution( pyblish.api.InstancePlugin, OptionalPyblishPluginMixin ): @@ -87,19 +38,79 @@ class ValidateSaverResolution( @classmethod def get_invalid(cls, instance): - resolution = cls.get_resolution(instance) + saver = instance.data["tool"] + try: + resolution = cls.get_resolution(instance) + except PublishValidationError: + resolution = None expected_resolution = cls.get_expected_resolution(instance) if resolution != expected_resolution: - saver = instance.data["tool"] return [saver] @classmethod def get_resolution(cls, instance): saver = instance.data["tool"] first_frame = instance.data["frameStartHandle"] - return get_tool_resolution(saver, frame=first_frame) + return cls.get_tool_resolution(saver, frame=first_frame) @classmethod def get_expected_resolution(cls, instance): data = instance.data["assetEntity"]["data"] return data["resolutionWidth"], data["resolutionHeight"] + + @classmethod + def get_tool_resolution(cls, tool, frame): + """Return the 2D input resolution to a Fusion tool + + If the current tool hasn't been rendered its input resolution + hasn't been saved. To combat this, add an expression in + the comments field to read the resolution + + Args + tool (Fusion Tool): The tool to query input resolution + frame (int): The frame to query the resolution on. + + Returns: + tuple: width, height as 2-tuple of integers + + """ + comp = tool.Composition + + # False undo removes the undo-stack from the undo list + with comp_lock_and_undo_chunk(comp, "Read resolution", False): + # Save old comment + old_comment = "" + has_expression = False + + if tool["Comments"][frame] not in ["", None]: + if tool["Comments"].GetExpression() is not None: + has_expression = True + old_comment = tool["Comments"].GetExpression() + tool["Comments"].SetExpression(None) + else: + old_comment = tool["Comments"][frame] + tool["Comments"][frame] = "" + # Get input width + tool["Comments"].SetExpression("self.Input.OriginalWidth") + if tool["Comments"][frame] is None: + raise PublishValidationError( + "Cannot get resolution info for frame '{}'.\n\n " + "Please check that saver has connected input.".format( + frame + ) + ) + + width = int(tool["Comments"][frame]) + + # Get input height + tool["Comments"].SetExpression("self.Input.OriginalHeight") + height = int(tool["Comments"][frame]) + + # Reset old comment + tool["Comments"].SetExpression(None) + if has_expression: + tool["Comments"].SetExpression(old_comment) + else: + tool["Comments"][frame] = old_comment + + return width, height From f39c6e9ef9eb5544572c407b55ee31b7d702684a Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 26 Jan 2024 18:01:18 +0100 Subject: [PATCH 192/198] formatting changes --- server_addon/applications/server/settings.py | 24 ++++++++++++++----- server_addon/core/server/settings/main.py | 4 +++- .../core/server/settings/publish_plugins.py | 8 ++++--- .../flame/server/settings/publish_plugins.py | 8 ++++--- server_addon/hiero/server/settings/filters.py | 4 +++- server_addon/maya/server/settings/creators.py | 4 +++- server_addon/maya/server/settings/imageio.py | 12 ++++++---- server_addon/maya/server/settings/loaders.py | 4 +++- server_addon/maya/server/settings/main.py | 4 +++- .../maya/server/settings/scriptsmenu.py | 4 +++- .../settings/templated_workfile_settings.py | 4 +++- server_addon/nuke/server/settings/main.py | 2 -- 12 files changed, 57 insertions(+), 25 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 710bbbf9ee..e0a59604c8 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -41,7 +41,9 @@ class AppVariant(BaseSettingsModel): arguments: MultiplatformStrList = SettingsField( default_factory=MultiplatformStrList, title="Arguments" ) - environment: str = SettingsField("{}", title="Environment", widget="textarea") + environment: str = SettingsField( + "{}", title="Environment", widget="textarea" + ) @validator("environment") def validate_json(cls, value): @@ -57,7 +59,9 @@ class AppGroup(BaseSettingsModel): label: str = SettingsField("", title="Label") host_name: str = SettingsField("", title="Host name") icon: str = SettingsField("", title="Icon") - environment: str = SettingsField("{}", title="Environment", widget="textarea") + environment: str = SettingsField( + "{}", title="Environment", widget="textarea" + ) variants: list[AppVariant] = SettingsField( default_factory=list, @@ -87,7 +91,9 @@ class AdditionalAppGroup(BaseSettingsModel): label: str = SettingsField("", title="Label") host_name: str = SettingsField("", title="Host name") icon: str = SettingsField("", title="Icon") - environment: str = SettingsField("{}", title="Environment", widget="textarea") + environment: str = SettingsField( + "{}", title="Environment", widget="textarea" + ) variants: list[AppVariantWithPython] = SettingsField( default_factory=list, @@ -107,8 +113,12 @@ class ToolVariantModel(BaseSettingsModel): label: str = SettingsField("", title="Label") host_names: list[str] = SettingsField(default_factory=list, title="Hosts") # TODO use applications enum if possible - app_variants: list[str] = SettingsField(default_factory=list, title="Applications") - environment: str = SettingsField("{}", title="Environments", widget="textarea") + app_variants: list[str] = SettingsField( + default_factory=list, title="Applications" + ) + environment: str = SettingsField( + "{}", title="Environments", widget="textarea" + ) @validator("environment") def validate_json(cls, value): @@ -118,7 +128,9 @@ class ToolVariantModel(BaseSettingsModel): class ToolGroupModel(BaseSettingsModel): name: str = SettingsField("", title="Name") label: str = SettingsField("", title="Label") - environment: str = SettingsField("{}", title="Environments", widget="textarea") + environment: str = SettingsField( + "{}", title="Environments", widget="textarea" + ) variants: list[ToolVariantModel] = SettingsField(default_factory=list) @validator("environment") diff --git a/server_addon/core/server/settings/main.py b/server_addon/core/server/settings/main.py index 1ebfc5a4ca..1bdfcefe19 100644 --- a/server_addon/core/server/settings/main.py +++ b/server_addon/core/server/settings/main.py @@ -55,7 +55,9 @@ class CoreImageIOFileRulesModel(BaseSettingsModel): class CoreImageIOConfigModel(BaseSettingsModel): - filepath: list[str] = SettingsField(default_factory=list, title="Config path") + filepath: list[str] = SettingsField( + default_factory=list, title="Config path" + ) class CoreImageIOBaseModel(BaseSettingsModel): diff --git a/server_addon/core/server/settings/publish_plugins.py b/server_addon/core/server/settings/publish_plugins.py index 61e35e02d4..7dfb01a215 100644 --- a/server_addon/core/server/settings/publish_plugins.py +++ b/server_addon/core/server/settings/publish_plugins.py @@ -715,9 +715,11 @@ class CleanUpFarmModel(BaseSettingsModel): class PublishPuginsModel(BaseSettingsModel): - CollectAnatomyInstanceData: CollectAnatomyInstanceDataModel = SettingsField( - default_factory=CollectAnatomyInstanceDataModel, - title="Collect Anatomy Instance Data" + CollectAnatomyInstanceData: CollectAnatomyInstanceDataModel = ( + SettingsField( + default_factory=CollectAnatomyInstanceDataModel, + title="Collect Anatomy Instance Data" + ) ) CollectAudio: CollectAudioModel = SettingsField( default_factory=CollectAudioModel, diff --git a/server_addon/flame/server/settings/publish_plugins.py b/server_addon/flame/server/settings/publish_plugins.py index 2c21034c44..decb00fcfa 100644 --- a/server_addon/flame/server/settings/publish_plugins.py +++ b/server_addon/flame/server/settings/publish_plugins.py @@ -32,9 +32,11 @@ class AddTasksModel(BaseSettingsModel): class CollectTimelineInstancesModel(BaseSettingsModel): _isGroup = True - xml_preset_attrs_from_comments: list[XMLPresetAttrsFromCommentsModel] = SettingsField( - default_factory=list, - title="XML presets attributes parsable from segment comments" + xml_preset_attrs_from_comments: list[XMLPresetAttrsFromCommentsModel] = ( + SettingsField( + default_factory=list, + title="XML presets attributes parsable from segment comments" + ) ) add_tasks: list[AddTasksModel] = SettingsField( default_factory=list, diff --git a/server_addon/hiero/server/settings/filters.py b/server_addon/hiero/server/settings/filters.py index 9642f93f7e..095d30a004 100644 --- a/server_addon/hiero/server/settings/filters.py +++ b/server_addon/hiero/server/settings/filters.py @@ -15,7 +15,9 @@ class PublishGUIFilterItemModel(BaseSettingsModel): class PublishGUIFiltersModel(BaseSettingsModel): _layout = "compact" name: str = SettingsField(title="Name") - value: list[PublishGUIFilterItemModel] = SettingsField(default_factory=list) + value: list[PublishGUIFilterItemModel] = SettingsField( + default_factory=list + ) @validator("value") def validate_unique_outputs(cls, value): diff --git a/server_addon/maya/server/settings/creators.py b/server_addon/maya/server/settings/creators.py index 6b5583e726..5f3b850a1f 100644 --- a/server_addon/maya/server/settings/creators.py +++ b/server_addon/maya/server/settings/creators.py @@ -111,7 +111,9 @@ class CreateAssModel(BasicCreatorModel): class CreateReviewModel(BasicCreatorModel): - useMayaTimeline: bool = SettingsField(title="Use Maya Timeline for Frame Range.") + useMayaTimeline: bool = SettingsField( + title="Use Maya Timeline for Frame Range." + ) class CreateVrayProxyModel(BaseSettingsModel): diff --git a/server_addon/maya/server/settings/imageio.py b/server_addon/maya/server/settings/imageio.py index 34338b24e4..f4cdf3fbff 100644 --- a/server_addon/maya/server/settings/imageio.py +++ b/server_addon/maya/server/settings/imageio.py @@ -48,7 +48,9 @@ class ColorManagementPreferenceV2Model(BaseSettingsModel): Please migrate all to 'imageio/workfile' and enable it. """ - enabled: bool = SettingsField(True, title="Use Color Management Preference v2") + enabled: bool = SettingsField( + True, title="Use Color Management Preference v2" + ) renderSpace: str = SettingsField(title="Rendering Space") displayName: str = SettingsField(title="Display") @@ -92,9 +94,11 @@ class ImageIOSettings(BaseSettingsModel): title="Workfile" ) # Deprecated - colorManagementPreference_v2: ColorManagementPreferenceV2Model = SettingsField( - default_factory=ColorManagementPreferenceV2Model, - title="DEPRECATED: Color Management Preference v2 (Maya 2022+)" + colorManagementPreference_v2: ColorManagementPreferenceV2Model = ( + SettingsField( + default_factory=ColorManagementPreferenceV2Model, + title="DEPRECATED: Color Management Preference v2 (Maya 2022+)" + ) ) colorManagementPreference: ColorManagementPreferenceModel = SettingsField( default_factory=ColorManagementPreferenceModel, diff --git a/server_addon/maya/server/settings/loaders.py b/server_addon/maya/server/settings/loaders.py index 1d5b972056..15d4275b80 100644 --- a/server_addon/maya/server/settings/loaders.py +++ b/server_addon/maya/server/settings/loaders.py @@ -40,7 +40,9 @@ class ColorsSetting(BaseSettingsModel): class ReferenceLoaderModel(BaseSettingsModel): namespace: str = SettingsField(title="Namespace") group_name: str = SettingsField(title="Group name") - display_handle: bool = SettingsField(title="Display Handle On Load References") + display_handle: bool = SettingsField( + title="Display Handle On Load References" + ) class ImportLoaderModel(BaseSettingsModel): diff --git a/server_addon/maya/server/settings/main.py b/server_addon/maya/server/settings/main.py index ddfb797f8a..f7f62e219d 100644 --- a/server_addon/maya/server/settings/main.py +++ b/server_addon/maya/server/settings/main.py @@ -37,7 +37,9 @@ class MayaSettings(BaseSettingsModel): title="Explicit Plugins Loading") imageio: ImageIOSettings = SettingsField( default_factory=ImageIOSettings, title="Color Management (imageio)") - mel_workspace: str = SettingsField(title="Maya MEL Workspace", widget="textarea") + mel_workspace: str = SettingsField( + title="Maya MEL Workspace", widget="textarea" + ) ext_mapping: list[ExtMappingItemModel] = SettingsField( default_factory=list, title="Extension Mapping") maya_dirmap: MayaDirmapModel = SettingsField( diff --git a/server_addon/maya/server/settings/scriptsmenu.py b/server_addon/maya/server/settings/scriptsmenu.py index 6de43b5278..d01dff1621 100644 --- a/server_addon/maya/server/settings/scriptsmenu.py +++ b/server_addon/maya/server/settings/scriptsmenu.py @@ -9,7 +9,9 @@ class ScriptsmenuSubmodel(BaseSettingsModel): sourcetype: str = SettingsField(title="Source Type") title: str = SettingsField(title="Title") tooltip: str = SettingsField(title="Tooltip") - tags: list[str] = SettingsField(default_factory=list, title="A list of tags") + tags: list[str] = SettingsField( + default_factory=list, title="A list of tags" + ) class ScriptsmenuModel(BaseSettingsModel): diff --git a/server_addon/maya/server/settings/templated_workfile_settings.py b/server_addon/maya/server/settings/templated_workfile_settings.py index f61f52f9ea..1baa2c895c 100644 --- a/server_addon/maya/server/settings/templated_workfile_settings.py +++ b/server_addon/maya/server/settings/templated_workfile_settings.py @@ -12,7 +12,9 @@ class WorkfileBuildProfilesModel(BaseSettingsModel): title="Task types", enum_resolver=task_types_enum ) - task_names: list[str] = SettingsField(default_factory=list, title="Task names") + task_names: list[str] = SettingsField( + default_factory=list, title="Task names" + ) path: str = SettingsField("", title="Path to template") diff --git a/server_addon/nuke/server/settings/main.py b/server_addon/nuke/server/settings/main.py index 2cfc539e71..2b269f1fce 100644 --- a/server_addon/nuke/server/settings/main.py +++ b/server_addon/nuke/server/settings/main.py @@ -1,5 +1,3 @@ -from pydantic import validator - from ayon_server.settings import ( BaseSettingsModel, SettingsField, From 41d0d0bd3b604b0185c931a510936e449d95e8b0 Mon Sep 17 00:00:00 2001 From: Jakub Trllo Date: Fri, 26 Jan 2024 18:03:26 +0100 Subject: [PATCH 193/198] formatting changes 2 --- .../core/server/settings/publish_plugins.py | 20 +++++++++++++------ .../nuke/server/settings/publish_plugins.py | 8 +++++--- .../server/settings/publish_plugins.py | 8 +++++--- .../tvpaint/server/settings/create_plugins.py | 10 +++++++--- 4 files changed, 31 insertions(+), 15 deletions(-) diff --git a/server_addon/core/server/settings/publish_plugins.py b/server_addon/core/server/settings/publish_plugins.py index 7dfb01a215..7aa86aafa6 100644 --- a/server_addon/core/server/settings/publish_plugins.py +++ b/server_addon/core/server/settings/publish_plugins.py @@ -232,7 +232,9 @@ class ExtractOIIOTranscodeOutputModel(BaseSettingsModel): title="OIIOtool arguments") tags: list[str] = SettingsField(default_factory=list, title="Tags") - custom_tags: list[str] = SettingsField(default_factory=list, title="Custom Tags") + custom_tags: list[str] = SettingsField( + default_factory=list, title="Custom Tags" + ) class ExtractOIIOTranscodeProfileModel(BaseSettingsModel): @@ -320,7 +322,9 @@ class ExtractReviewFilterModel(BaseSettingsModel): families: list[str] = SettingsField(default_factory=list, title="Families") product_names: list[str] = SettingsField( default_factory=list, title="Product names") - custom_tags: list[str] = SettingsField(default_factory=list, title="Custom Tags") + custom_tags: list[str] = SettingsField( + default_factory=list, title="Custom Tags" + ) single_frame_filter: str = SettingsField( "everytime", description=( @@ -623,9 +627,11 @@ class IntegrateProductGroupModel(BaseSettingsModel): """ _isGroup = True - product_grouping_profiles: list[IntegrateProductGroupProfile] = SettingsField( - default_factory=list, - title="Product group profiles" + product_grouping_profiles: list[IntegrateProductGroupProfile] = ( + SettingsField( + default_factory=list, + title="Product group profiles" + ) ) @@ -706,7 +712,9 @@ class CleanUpModel(BaseSettingsModel): default_factory=list, title="Patterns (regex)" ) - remove_temp_renders: bool = SettingsField(False, title="Remove Temp renders") + remove_temp_renders: bool = SettingsField( + False, title="Remove Temp renders" + ) class CleanUpFarmModel(BaseSettingsModel): diff --git a/server_addon/nuke/server/settings/publish_plugins.py b/server_addon/nuke/server/settings/publish_plugins.py index 0d785e6505..02ee9b3bab 100644 --- a/server_addon/nuke/server/settings/publish_plugins.py +++ b/server_addon/nuke/server/settings/publish_plugins.py @@ -266,9 +266,11 @@ class PublishPuginsModel(BaseSettingsModel): title="Extract Review Data Mov", default_factory=ExtractReviewDataMovModel ) - ExtractReviewIntermediates: ExtractReviewIntermediatesModel = SettingsField( - title="Extract Review Intermediates", - default_factory=ExtractReviewIntermediatesModel + ExtractReviewIntermediates: ExtractReviewIntermediatesModel = ( + SettingsField( + title="Extract Review Intermediates", + default_factory=ExtractReviewIntermediatesModel + ) ) ExtractSlateFrame: ExtractSlateFrameModel = SettingsField( title="Extract Slate Frame", diff --git a/server_addon/photoshop/server/settings/publish_plugins.py b/server_addon/photoshop/server/settings/publish_plugins.py index c59526135c..c4a392d490 100644 --- a/server_addon/photoshop/server/settings/publish_plugins.py +++ b/server_addon/photoshop/server/settings/publish_plugins.py @@ -138,9 +138,11 @@ class ExtractReviewPlugin(BaseSettingsModel): class PhotoshopPublishPlugins(BaseSettingsModel): - CollectColorCodedInstances: CollectColorCodedInstancesPlugin = SettingsField( - title="Collect Color Coded Instances", - default_factory=CollectColorCodedInstancesPlugin, + CollectColorCodedInstances: CollectColorCodedInstancesPlugin = ( + SettingsField( + title="Collect Color Coded Instances", + default_factory=CollectColorCodedInstancesPlugin, + ) ) CollectReview: CollectReviewPlugin = SettingsField( title="Collect Review", diff --git a/server_addon/tvpaint/server/settings/create_plugins.py b/server_addon/tvpaint/server/settings/create_plugins.py index 89c3a52774..b3351dca28 100644 --- a/server_addon/tvpaint/server/settings/create_plugins.py +++ b/server_addon/tvpaint/server/settings/create_plugins.py @@ -60,8 +60,12 @@ class AutoDetectCreateRenderModel(BaseSettingsModel): enabled: bool = SettingsField(True) allow_group_rename: bool = SettingsField(title="Allow group rename") group_name_template: str = SettingsField(title="Group name template") - group_idx_offset: int = SettingsField(1, title="Group index Offset", ge=1) - group_idx_padding: int = SettingsField(4, title="Group index Padding", ge=1) + group_idx_offset: int = SettingsField( + 1, title="Group index Offset", ge=1 + ) + group_idx_padding: int = SettingsField( + 4, title="Group index Padding", ge=1 + ) class CreatePluginsModel(BaseSettingsModel): @@ -77,7 +81,7 @@ class CreatePluginsModel(BaseSettingsModel): default_factory=CreateReviewModel, title="Create Render Scene" ) - create_render_layer: CreateRenderLayerModel= SettingsField( + create_render_layer: CreateRenderLayerModel = SettingsField( default_factory=CreateRenderLayerModel, title="Create Render Layer" ) From 867193d889a5e7b653fad2c46de5b789a4aa8a0a Mon Sep 17 00:00:00 2001 From: Ynbot Date: Sat, 27 Jan 2024 03:24:20 +0000 Subject: [PATCH 194/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index ddfb3ebeeb..2f2fc517b8 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.5" +__version__ = "3.18.6-nightly.1" From eacb3431e2e58c3b489a87cfb48b795338129724 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 27 Jan 2024 03:25:03 +0000 Subject: [PATCH 195/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index fd6999604a..039b42bff3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.6-nightly.1 - 3.18.5 - 3.18.5-nightly.3 - 3.18.5-nightly.2 @@ -134,7 +135,6 @@ body: - 3.15.8 - 3.15.8-nightly.3 - 3.15.8-nightly.2 - - 3.15.8-nightly.1 validations: required: true - type: dropdown From 40f8578d793de90caf83fc7c565f7ec54c973dc3 Mon Sep 17 00:00:00 2001 From: farrizabalaga Date: Mon, 29 Jan 2024 17:28:35 -0700 Subject: [PATCH 196/198] Fix traypublisher asset/folderPath bug when updating instances --- openpype/hosts/traypublisher/api/plugin.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/traypublisher/api/plugin.py b/openpype/hosts/traypublisher/api/plugin.py index 14c66fa08f..6859b85a46 100644 --- a/openpype/hosts/traypublisher/api/plugin.py +++ b/openpype/hosts/traypublisher/api/plugin.py @@ -221,9 +221,16 @@ class SettingsCreator(TrayPublishCreator): ): filtered_instance_data.append(instance) - asset_names = { - instance["asset"] - for instance in filtered_instance_data} + if AYON_SERVER_ENABLED: + asset_names = { + instance["folderPath"] + for instance in filtered_instance_data + } + else: + asset_names = { + instance["asset"] + for instance in filtered_instance_data + } subset_names = { instance["subset"] for instance in filtered_instance_data} @@ -231,7 +238,10 @@ class SettingsCreator(TrayPublishCreator): asset_names, subset_names ) for instance in filtered_instance_data: - asset_name = instance["asset"] + if AYON_SERVER_ENABLED: + asset_name = instance["folderPath"] + else: + asset_name = instance["asset"] subset_name = instance["subset"] version = subset_docs_by_asset_id[asset_name][subset_name] instance["creator_attributes"]["version_to_use"] = version From 246731f1dcc0d7931a9016bbc5a5b12a1e517126 Mon Sep 17 00:00:00 2001 From: Ynbot Date: Wed, 31 Jan 2024 03:24:55 +0000 Subject: [PATCH 197/198] [Automated] Bump version --- openpype/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/version.py b/openpype/version.py index 2f2fc517b8..6cbe5ba6cd 100644 --- a/openpype/version.py +++ b/openpype/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring Pype version.""" -__version__ = "3.18.6-nightly.1" +__version__ = "3.18.6-nightly.2" From 9a129100fc6fdf2828792440f8bf9aa3d501b19b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 31 Jan 2024 03:25:30 +0000 Subject: [PATCH 198/198] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 039b42bff3..cd81171b73 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to OpenPype Tray options: + - 3.18.6-nightly.2 - 3.18.6-nightly.1 - 3.18.5 - 3.18.5-nightly.3 @@ -134,7 +135,6 @@ body: - 3.15.9-nightly.1 - 3.15.8 - 3.15.8-nightly.3 - - 3.15.8-nightly.2 validations: required: true - type: dropdown