Use PublishError along publishing

client/ayon_houdini/api/lib.py

@@ -26,6 +26,7 @@
 from ayon_core.pipeline.workfile.workfile_template_builder import (
     TemplateProfileNotFound
 )
+from ayon_core.pipeline.publish import PublishError
 from ayon_core.tools.utils import PopupUpdateKeys, SimplePopup
 from ayon_core.tools.utils.host_tools import get_tool_by_name
 
@@ -106,7 +107,7 @@ def get_output_parameter(node):
     elif node_type == "vray_renderer":
         return node.parm("SettingsOutput_img_file_path")
 
-    raise TypeError("Node type '%s' not supported" % node_type)
+    raise PublishError(f"Node type '{node_type}' is not supported")
 
 
 def get_lops_rop_context_options(
@@ -140,7 +141,8 @@ def get_lops_rop_context_options(
                 end: float = ropnode.evalParm("f2")
                 inc: float = ropnode.evalParm("f3")
             else:
-                raise ValueError("Unsupported trange value: %s" % trange)
+                raise PublishError(f"Unsupported trange value: {trange}"
+                                   f" for rop node: {ropnode.path()}")
             rop_context_options["ropcook"] = 1.0
             rop_context_options["ropstart"] = start
             rop_context_options["ropend"] = end
@@ -160,7 +162,8 @@ def get_lops_rop_context_options(
         elif option_type == "float":
             value: float = ropnode.evalParm(f"optionfloatvalue{i}")
         else:
-            raise ValueError(f"Unsupported option type: {option_type}")
+            raise PublishError(f"Unsupported option type: {option_type}"
+                               f" on rop node: '{ropnode.path()}'")
         rop_context_options[name] = value
 
     return rop_context_options
@@ -286,9 +289,11 @@ def render_rop(ropnode, frame_range=None):
         # The hou.Error is not inherited from a Python Exception class,
         # so we explicitly capture the houdini error, otherwise pyblish
         # will remain hanging.
-        import traceback
-        traceback.print_exc()
-        raise RuntimeError("Render failed: {0}".format(exc))
+        raise PublishError(
+            "Render failed or interrupted",
+            description=f"An Error occurred while rendering {ropnode.path()}",
+            detail=f"{exc}"
+        )
 
 
 def imprint(node, data, update=False):
@@ -655,7 +660,7 @@ def get_top_referenced_parm(parm):
     processed = set()  # disallow infinite loop
     while True:
         if parm.path() in processed:
-            raise RuntimeError("Parameter references result in cycle.")
+            raise PublishError("Parameter references result in cycle.")
 
         processed.add(parm.path())
 
@@ -671,7 +676,8 @@ def get_top_referenced_parm(parm):
 def evalParmNoFrame(node, parm, pad_character="#"):
 
     parameter = node.parm(parm)
-    assert parameter, "Parameter does not exist: %s.%s" % (node, parm)
+    if not parameter:
+        raise PublishError(f"Parameter does not exist: {node}.{parm}")
 
     # If the parameter has a parameter reference, then get that
     # parameter instead as otherwise `unexpandedString()` fails.
@@ -681,8 +687,10 @@ def evalParmNoFrame(node, parm, pad_character="#"):
     try:
         raw = parameter.unexpandedString()
     except hou.Error as exc:
-        print("Failed: %s" % parameter)
-        raise RuntimeError(exc)
+        raise PublishError(
+            f"Failed: {parameter}",
+            detail=f"{exc}"
+        )
 
     def replace(match):
         padding = 1
@@ -726,8 +734,10 @@ def get_color_management_preferences():
         config_path = preferences["config"]
         config = PyOpenColorIO.Config.CreateFromFile(config_path)
         display = config.getDefaultDisplay()
-        assert display == preferences["display"], \
-            "Houdini default OCIO display must match config default display"
+        if display != preferences["display"]:
+            raise PublishError(
+                "Houdini default OCIO display must match config default display"
+            )
         view = config.getDefaultView(display)
         preferences["display"] = display
         preferences["view"] = view

client/ayon_houdini/api/usd.py

@@ -10,6 +10,9 @@
 import ayon_api
 from pxr import Usd, Sdf, Tf, Vt, UsdRender
 
+from ayon_core.pipeline.publish import PublishError
+
+
 log = logging.getLogger(__name__)
 
 
@@ -205,8 +208,8 @@ def get_configured_save_layers(usd_rop, strip_above_layer_break=True):
     lop_node = get_usd_rop_loppath(usd_rop)
     stage = lop_node.stage(apply_viewport_overrides=False)
     if not stage:
-        raise RuntimeError(
-            "No valid USD stage for ROP node: " "%s" % usd_rop.path()
+        raise PublishError(
+            f"No valid USD stage for ROP node: '{usd_rop.path()}' "
         )
 
     root_layer = stage.GetRootLayer()

client/ayon_houdini/plugins/publish/collect_output_node.py

@@ -1,5 +1,5 @@
 import pyblish.api
-from ayon_core.pipeline.publish import KnownPublishError
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 
 
@@ -67,8 +67,8 @@ def process(self, instance):
             out_node = node.parm("startnode").evalAsNode()
 
         else:
-            raise KnownPublishError(
-                "ROP node type '{}' is not supported.".format(node_type)
+            raise PublishError(
+                f"ROP node type '{node_type}' is not supported."
             )
 
         if not out_node:

client/ayon_houdini/plugins/publish/collect_render_products.py

@@ -6,6 +6,7 @@
 
 import pyblish.api
 
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 from ayon_houdini.api.usd import (
     get_usd_render_rop_rendersettings
@@ -107,10 +108,10 @@ def replace(match):
                 filename = os.path.join(dirname, filename_base)
                 filename = filename.replace("\\", "/")
 
-            assert "#" in filename, (
-                "Couldn't resolve render product name "
-                "with frame number: %s" % name
-            )
+            if "#" not in filename:
+                raise PublishError(
+                    f"Couldn't resolve render product name with frame number: {name}"
+                )
 
             filenames.append(filename)
 

client/ayon_houdini/plugins/publish/collect_usd_layers.py

@@ -5,6 +5,7 @@
 import pyblish.api
 
 from ayon_core.pipeline.create import get_product_name
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 import ayon_houdini.api.usd as usdlib
 
@@ -27,8 +28,8 @@ def copy_instance_data(instance_src, instance_dest, attr):
             in the source instance's data.
 
     Raises:
-        KeyError: If the key does not exist on the source instance.
-        AssertionError: If a parent key already exists on the destination
+        PublishError: If the key does not exist on the source instance.
+        PublishError: If a parent key already exists on the destination
             instance but is not of the correct type (= is not a dict)
 
     """
@@ -38,12 +39,15 @@ def copy_instance_data(instance_src, instance_dest, attr):
     keys = attr.split(".")
     for i, key in enumerate(keys):
         if key not in src_data:
-            break
+            raise PublishError(
+                f"key '{key}' does not exist on the source instance."
+            )
 
         src_value = src_data[key]
         if i != len(key):
             dest_data = dest_data.setdefault(key, {})
-            assert isinstance(dest_data, dict), "Destination must be a dict"
+            if not isinstance(dest_data, dict):
+                raise PublishError("Destination must be a dict.")
             src_data = src_value
         else:
             # Last iteration - assign the value

client/ayon_houdini/plugins/publish/extract_render.py

@@ -3,6 +3,7 @@
 
 import pyblish.api
 
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 
 
@@ -81,7 +82,8 @@ def process(self, instance):
             if not os.path.exists(frame)
         ]
         if missing_frames:
-            # TODO: Use user friendly error reporting.
-            raise RuntimeError("Failed to complete render extraction. "
-                               "Missing output files: {}".format(
-                                   missing_frames))
+            missing_frames = "\n\n ●  ".join(missing_frames)
+            raise PublishError(
+                "Failed to complete render extraction.",
+                detail=f"Missing output files:\n\n ●  {missing_frames}"
+            )

client/ayon_houdini/plugins/publish/extract_rop.py

@@ -2,6 +2,7 @@
 import pyblish.api
 
 from ayon_core.pipeline import publish
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 from ayon_houdini.api.lib import splitext
 
@@ -73,7 +74,11 @@ def validate_expected_frames(self, instance: pyblish.api.Instance):
             if not os.path.isfile(os.path.join(staging_dir, filename))
         ]
         if missing_filenames:
-            raise RuntimeError(f"Missing frames: {missing_filenames}")
+            missing_filenames = "\n\n ●  ".join(missing_filenames)
+            raise PublishError(
+                "Failed to complete render extraction.",
+                detail=f"Missing frames:\n\n ●  {missing_filenames}"
+            )
 
     def update_representation_data(self,
                                    instance: pyblish.api.Instance,

client/ayon_houdini/plugins/publish/extract_usd.py

@@ -5,6 +5,7 @@
 
 from ayon_core.pipeline.entity_uri import construct_ayon_entity_uri
 from ayon_core.pipeline.publish.lib import get_instance_expected_output_path
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import plugin
 from ayon_houdini.api.lib import render_rop
 from ayon_houdini.api.usd import remap_paths
@@ -47,7 +48,8 @@ def process(self, instance):
         with remap_paths(ropnode, mapping):
             render_rop(ropnode)
 
-        assert os.path.exists(output), "Output does not exist: %s" % output
+        if not os.path.exists(output):
+            PublishError(f"Output does not exist: {output}")
 
         if "representations" not in instance.data:
             instance.data["representations"] = []
@@ -135,5 +137,7 @@ def get_source_paths(
         # Single file
         return [os.path.join(staging, files)]
 
-    raise TypeError(f"Unsupported type for representation files: {files} "
-                    "(supports list or str)")
+    raise PublishError(
+        f"Unsupported type for representation files: {files}"
+        " (supports list or str)"
+    )

client/ayon_houdini/plugins/publish/increment_current_file.py

@@ -4,7 +4,7 @@
 from ayon_core.pipeline import registered_host
 from ayon_core.pipeline.publish import (
     get_errored_plugins_from_context,
-    KnownPublishError
+    PublishError
 )
 
 from ayon_houdini.api import plugin
@@ -37,7 +37,7 @@ def process(self, context):
             plugin.__name__ == "HoudiniSubmitPublishDeadline"
             for plugin in errored_plugins
         ):
-            raise KnownPublishError(
+            raise PublishError(
                 "Skipping incrementing current file because "
                 "submission to deadline failed."
             )
@@ -46,8 +46,9 @@ def process(self, context):
         host = registered_host()
         current_file = host.current_file()
         if context.data["currentFile"] != current_file:
-            raise KnownPublishError(
-                "Collected filename mismatches from current scene name."
+            raise PublishError(
+                f"Collected filename '{context.data['currentFile']}'"
+                f" mismatches from current scene name '{current_file}'."
             )
 
         new_filepath = version_up(current_file)

client/ayon_houdini/plugins/publish/save_scene.py

@@ -1,6 +1,8 @@
+import inspect
 import pyblish.api
 
 from ayon_core.pipeline import registered_host
+from ayon_core.pipeline.publish import PublishError
 
 from ayon_houdini.api import plugin
 
@@ -16,12 +18,25 @@ def process(self, context):
         # Filename must not have changed since collecting
         host = registered_host()
         current_file = host.get_current_workfile()
-        assert context.data['currentFile'] == current_file, (
-            "Collected filename from current scene name."
-        )
+        if context.data['currentFile'] != current_file:
+            raise PublishError(
+                f"Collected filename '{context.data['currentFile']}' differs"
+                f" from current scene name '{current_file}'.",
+                description=self.get_error_description()
+            )
 
         if host.workfile_has_unsaved_changes():
             self.log.info("Saving current file: {}".format(current_file))
             host.save_workfile(current_file)
         else:
             self.log.debug("No unsaved changes, skipping file save..")
+
+    def get_error_description(self):
+        return inspect.cleandoc(
+            """### Scene File Name Change During Publishing
+
+            This error occurs when you validate the scene and then save it as a new file manually, or if you open a new file and continue publishing.
+
+            Please reset the publisher and publish without changing the scene file midway.
+            """
+        )

client/ayon_houdini/plugins/publish/validate_frame_token.py

@@ -1,7 +1,7 @@
 import hou
 
 import pyblish.api
-
+from ayon_core.pipeline.publish import PublishError
 from ayon_houdini.api import lib, plugin
 
 
@@ -31,8 +31,8 @@ def process(self, instance):
 
         invalid = self.get_invalid(instance)
         if invalid:
-            raise RuntimeError(
-                "Output settings do no match for '%s'" % instance
+            raise PublishError(
+                f"Output settings do no match for '{instance}'" 
             )
 
     @classmethod