From 7e883fc1674e6ca46bad5cca1fa64d4d9484289c Mon Sep 17 00:00:00 2001 From: Jack P Date: Fri, 15 Dec 2023 10:25:24 +0000 Subject: [PATCH 01/14] feat: added new saver output ext validator --- .../validate_saver_output_extension.py | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py new file mode 100644 index 0000000000..8ece175344 --- /dev/null +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -0,0 +1,59 @@ +import os + +import pyblish.api +from openpype.pipeline import PublishValidationError +from openpype.pipeline.publish import RepairAction +from openpype.hosts.fusion.api.action import SelectInvalidAction + + +class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): + """ + Temp docstring + """ + + order = pyblish.api.ValidatorOrder + label = "Validate Saver Output Extension" + families = ["render"] + hosts = ["fusion"] + actions = [SelectInvalidAction, RepairAction] + + @classmethod + def get_invalid(cls, instance): + saver = instance.data["tool"] + output_path = saver.Clip[1] + current_ext = get_file_extension(output_path) + ext = instance.data["image_format"] + if not current_ext == ext: + return (saver, current_ext, ext) + + def process(self, instance): + saver = instance.data["tool"] + current_ext = get_file_extension(saver.Clip[1]) + expected_ext = instance.data["image_format"] + + if not current_ext == expected_ext: + raise PublishValidationError( + f"Instance {saver.Name} output image format does not match the current publish selection.\n\n" + f"Current: {current_ext}\n\n" + f"Expected: {expected_ext}\n\n" + "You can use the repair action to update this instance.", + title=self.label, + ) + + @classmethod + def repair(cls, instance): + saver = instance.data["tool"] + output_path = saver.Clip[1] + ext = get_file_extension(output_path) + output_path = output_path.replace( + f".{ext}", f".{instance.data['image_format']}" + ) + saver.SetData( + "openpype.creator_attributes.image_format", + instance.data["image_format"], + ) + saver.Clip[1] = output_path + + +def get_file_extension(full_path): + return os.path.splitext(full_path)[1].replace(".", "") From 19fe8e0c1b5d2803cd7644253cd3ebedc2ddae55 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 10:50:17 +0000 Subject: [PATCH 02/14] chore: removed redunant function + small refactor --- .../publish/validate_saver_output_extension.py | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index 8ece175344..7c668d4467 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -17,21 +17,12 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): hosts = ["fusion"] actions = [SelectInvalidAction, RepairAction] - @classmethod - def get_invalid(cls, instance): - saver = instance.data["tool"] - output_path = saver.Clip[1] - current_ext = get_file_extension(output_path) - ext = instance.data["image_format"] - if not current_ext == ext: - return (saver, current_ext, ext) - def process(self, instance): saver = instance.data["tool"] - current_ext = get_file_extension(saver.Clip[1]) - expected_ext = instance.data["image_format"] + current_extension = get_file_extension(saver.Clip[1]) + expected_extension = instance.data["image_format"] - if not current_ext == expected_ext: + if current_ext != expected_ext: raise PublishValidationError( f"Instance {saver.Name} output image format does not match the current publish selection.\n\n" f"Current: {current_ext}\n\n" From 1cc824c099119234031b7770b653b5bf89185df5 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 10:50:28 +0000 Subject: [PATCH 03/14] chore: updated docstring --- .../plugins/publish/validate_saver_output_extension.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index 7c668d4467..b96a136a9d 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -8,7 +8,10 @@ from openpype.hosts.fusion.api.action import SelectInvalidAction class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): """ - Temp docstring + Validate Saver Output Extension matches Publish menu + + This ensures that if the user tweaks the 'Output File Extension' in the publish menu, + it is respected during the publish. """ order = pyblish.api.ValidatorOrder From f7a1a029c768e167e2fe001e4b9030f4f6396433 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 10:50:55 +0000 Subject: [PATCH 04/14] refactor: get_file_ext to use lstrip instead of replace --- .../fusion/plugins/publish/validate_saver_output_extension.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index b96a136a9d..ce2e671d4b 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -46,8 +46,7 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): "openpype.creator_attributes.image_format", instance.data["image_format"], ) - saver.Clip[1] = output_path def get_file_extension(full_path): - return os.path.splitext(full_path)[1].replace(".", "") + return os.path.splitext(full_path)[1].lstrip(".") From fb90d78160703aab838c16ce88026e0372c7abcf Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 10:51:28 +0000 Subject: [PATCH 05/14] refactor: improved repair function --- .../publish/validate_saver_output_extension.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index ce2e671d4b..2b6d4f2f19 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -1,5 +1,4 @@ import os - import pyblish.api from openpype.pipeline import PublishValidationError from openpype.pipeline.publish import RepairAction @@ -38,10 +37,13 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): def repair(cls, instance): saver = instance.data["tool"] output_path = saver.Clip[1] - ext = get_file_extension(output_path) - output_path = output_path.replace( - f".{ext}", f".{instance.data['image_format']}" - ) + + root, old_extension = os.path.splitext(output_path) + new_extension = instance.data["image_format"] + + new_output_path = f"{root}.{new_extension}" + saver.Clip[1] = new_output_path + saver.SetData( "openpype.creator_attributes.image_format", instance.data["image_format"], From 9e69e5d48e75d8b47bb0317fc78bb848f04ac9c0 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 11:23:03 +0000 Subject: [PATCH 06/14] fix: typo --- .../fusion/plugins/publish/validate_saver_output_extension.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index 2b6d4f2f19..c19c297f97 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -24,7 +24,7 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): current_extension = get_file_extension(saver.Clip[1]) expected_extension = instance.data["image_format"] - if current_ext != expected_ext: + if current_extension != expected_extension: raise PublishValidationError( f"Instance {saver.Name} output image format does not match the current publish selection.\n\n" f"Current: {current_ext}\n\n" From e4b24189d1d84be4af09652a9f2533b336d51af4 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 11:25:12 +0000 Subject: [PATCH 07/14] fix: more typos.. love when my lsp isn't working --- .../fusion/plugins/publish/validate_saver_output_extension.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index c19c297f97..f10f1d68ba 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -27,8 +27,8 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): if current_extension != expected_extension: raise PublishValidationError( f"Instance {saver.Name} output image format does not match the current publish selection.\n\n" - f"Current: {current_ext}\n\n" - f"Expected: {expected_ext}\n\n" + f"Current: {current_extension}\n\n" + f"Expected: {expected_extension}\n\n" "You can use the repair action to update this instance.", title=self.label, ) From b5b1be262e760ba01406468a9d4d643f1bfb9919 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 11:28:54 +0000 Subject: [PATCH 08/14] chore: added optional tag for testing --- .../fusion/plugins/publish/validate_saver_output_extension.py | 1 + 1 file changed, 1 insertion(+) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index f10f1d68ba..0862e0ac61 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -17,6 +17,7 @@ class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): label = "Validate Saver Output Extension" families = ["render"] hosts = ["fusion"] + optional = True actions = [SelectInvalidAction, RepairAction] def process(self, instance): From 437246c090af27eacd65af52e0d8e28bb7d6ec30 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 11:36:15 +0000 Subject: [PATCH 09/14] chore: added optional class inherit for testing --- .../plugins/publish/validate_saver_output_extension.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index 0862e0ac61..ea55832288 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -1,11 +1,16 @@ import os import pyblish.api -from openpype.pipeline import PublishValidationError +from openpype.pipeline import ( + PublishValidationError, + OptionalPyblishPluginMixin, +) from openpype.pipeline.publish import RepairAction from openpype.hosts.fusion.api.action import SelectInvalidAction -class ValidateSaverOutputExtension(pyblish.api.InstancePlugin): +class ValidateSaverOutputExtension( + pyblish.api.InstancePlugin, OptionalPyblishPluginMixin +): """ Validate Saver Output Extension matches Publish menu From 289eb1f4c8e6d11f34fc66157ed38b3d86ede9ac Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 11:46:18 +0000 Subject: [PATCH 10/14] fix: added check for optional behaviour --- .../fusion/plugins/publish/validate_saver_output_extension.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py index ea55832288..746bb5eb6f 100644 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py @@ -26,6 +26,9 @@ class ValidateSaverOutputExtension( actions = [SelectInvalidAction, RepairAction] def process(self, instance): + if not self.is_active(instance.data): + return + saver = instance.data["tool"] current_extension = get_file_extension(saver.Clip[1]) expected_extension = instance.data["image_format"] From 839e8153e384055b5f990975491ab01301b5857d Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 14:30:32 +0000 Subject: [PATCH 11/14] feat: create_saver now respects changes to creator_attributes --- openpype/hosts/fusion/plugins/create/create_saver.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/openpype/hosts/fusion/plugins/create/create_saver.py b/openpype/hosts/fusion/plugins/create/create_saver.py index 6e71b41541..c75a780a2a 100644 --- a/openpype/hosts/fusion/plugins/create/create_saver.py +++ b/openpype/hosts/fusion/plugins/create/create_saver.py @@ -119,10 +119,9 @@ class CreateSaver(NewCreator): if "subset" not in data: return - original_subset = tool.GetData("openpype.subset") - subset = data["subset"] - if original_subset != subset: - self._configure_saver_tool(data, tool, subset) + original_data = tool.GetData("openpype") + if original_data != data["creator_attributes"]: + self._configure_saver_tool(data, tool, data["subset"]) def _configure_saver_tool(self, data, tool, subset): formatting_data = deepcopy(data) From 23d0c166dfc55ba6e276993d1c967715a70484c3 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 14:33:38 +0000 Subject: [PATCH 12/14] chore: removed redundant validator this is no longer needed since the creator now respects changes to attributes --- .../validate_saver_output_extension.py | 63 ------------------- 1 file changed, 63 deletions(-) delete mode 100644 openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py diff --git a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py b/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py deleted file mode 100644 index 746bb5eb6f..0000000000 --- a/openpype/hosts/fusion/plugins/publish/validate_saver_output_extension.py +++ /dev/null @@ -1,63 +0,0 @@ -import os -import pyblish.api -from openpype.pipeline import ( - PublishValidationError, - OptionalPyblishPluginMixin, -) -from openpype.pipeline.publish import RepairAction -from openpype.hosts.fusion.api.action import SelectInvalidAction - - -class ValidateSaverOutputExtension( - pyblish.api.InstancePlugin, OptionalPyblishPluginMixin -): - """ - Validate Saver Output Extension matches Publish menu - - This ensures that if the user tweaks the 'Output File Extension' in the publish menu, - it is respected during the publish. - """ - - order = pyblish.api.ValidatorOrder - label = "Validate Saver Output Extension" - families = ["render"] - hosts = ["fusion"] - optional = True - actions = [SelectInvalidAction, RepairAction] - - def process(self, instance): - if not self.is_active(instance.data): - return - - saver = instance.data["tool"] - current_extension = get_file_extension(saver.Clip[1]) - expected_extension = instance.data["image_format"] - - if current_extension != expected_extension: - raise PublishValidationError( - f"Instance {saver.Name} output image format does not match the current publish selection.\n\n" - f"Current: {current_extension}\n\n" - f"Expected: {expected_extension}\n\n" - "You can use the repair action to update this instance.", - title=self.label, - ) - - @classmethod - def repair(cls, instance): - saver = instance.data["tool"] - output_path = saver.Clip[1] - - root, old_extension = os.path.splitext(output_path) - new_extension = instance.data["image_format"] - - new_output_path = f"{root}.{new_extension}" - saver.Clip[1] = new_output_path - - saver.SetData( - "openpype.creator_attributes.image_format", - instance.data["image_format"], - ) - - -def get_file_extension(full_path): - return os.path.splitext(full_path)[1].lstrip(".") From 3c272e4a7db54366c7c171b530de5688b947a5a9 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 14:48:36 +0000 Subject: [PATCH 13/14] fix: typo in comparison of data --- openpype/hosts/fusion/plugins/create/create_saver.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openpype/hosts/fusion/plugins/create/create_saver.py b/openpype/hosts/fusion/plugins/create/create_saver.py index c75a780a2a..b2235bd2b6 100644 --- a/openpype/hosts/fusion/plugins/create/create_saver.py +++ b/openpype/hosts/fusion/plugins/create/create_saver.py @@ -119,7 +119,7 @@ class CreateSaver(NewCreator): if "subset" not in data: return - original_data = tool.GetData("openpype") + original_data = tool.GetData("openpype.creator_attributes") if original_data != data["creator_attributes"]: self._configure_saver_tool(data, tool, data["subset"]) From 940103feeeb233d933d71d552d0e3e0ab8744480 Mon Sep 17 00:00:00 2001 From: JackP Date: Fri, 15 Dec 2023 15:50:11 +0000 Subject: [PATCH 14/14] refactor: more accurately specified the conditions of '_configure_saver_tool' calls --- .../hosts/fusion/plugins/create/create_saver.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/openpype/hosts/fusion/plugins/create/create_saver.py b/openpype/hosts/fusion/plugins/create/create_saver.py index b2235bd2b6..5870828b41 100644 --- a/openpype/hosts/fusion/plugins/create/create_saver.py +++ b/openpype/hosts/fusion/plugins/create/create_saver.py @@ -119,9 +119,17 @@ class CreateSaver(NewCreator): if "subset" not in data: return - original_data = tool.GetData("openpype.creator_attributes") - if original_data != data["creator_attributes"]: - self._configure_saver_tool(data, tool, data["subset"]) + 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)