feat(nuke): adding Collect | Validate | Extract Gizmo family

pype/plugins/nuke/publish/collect_gizmo.py

@@ -0,0 +1,56 @@
+import pyblish.api
+import pype.api as pype
+import nuke
+
+
+@pyblish.api.log
+class CollectGizmo(pyblish.api.InstancePlugin):
+    """Collect Gizmo (group) node instance and its content
+    """
+
+    order = pyblish.api.CollectorOrder + 0.22
+    label = "Collect Gizmo (Group)"
+    hosts = ["nuke"]
+    families = ["gizmo"]
+
+    def process(self, instance):
+
+        grpn = instance[0]
+
+        # add family to familiess
+        instance.data["families"].insert(0, instance.data["family"])
+        # make label nicer
+        instance.data["label"] = "{0} ({1} nodes)".format(
+            grpn.name(), len(instance) - 1)
+
+        # Get frame range
+        handle_start = instance.context.data["handleStart"]
+        handle_end = instance.context.data["handleEnd"]
+        first_frame = int(nuke.root()["first_frame"].getValue())
+        last_frame = int(nuke.root()["last_frame"].getValue())
+
+        # get version
+        version = pype.get_version_from_path(nuke.root().name())
+        instance.data['version'] = version
+
+        # Add version data to instance
+        version_data = {
+            "handles": handle_start,
+            "handleStart": handle_start,
+            "handleEnd": handle_end,
+            "frameStart": first_frame + handle_start,
+            "frameEnd": last_frame - handle_end,
+            "version": int(version),
+            "families": [instance.data["family"]] + instance.data["families"],
+            "subset": instance.data["subset"],
+            "fps": instance.context.data["fps"]
+        }
+
+        instance.data.update({
+            "versionData": version_data,
+            "frameStart": first_frame,
+            "frameEnd": last_frame,
+            "subsetGroup": "gizmos"
+        })
+        self.log.info("Gizmo content collected: `{}`".format(instance[:]))
+        self.log.info("Gizmo instance collected: `{}`".format(instance))

pype/plugins/nuke/publish/extract_gizmo.py

@@ -0,0 +1,95 @@
+import pyblish.api
+from avalon.nuke import lib as anlib
+from pype.nuke import lib as pnlib
+from pype.nuke import utils as pnutils
+import nuke
+import os
+import pype
+
+
+class ExtractGizmo(pype.api.Extractor):
+    """Extracting Gizmo (Group) node
+
+    Will create nuke script only with the Gizmo node.
+    """
+
+    order = pyblish.api.ExtractorOrder
+    label = "Extract Gizmo (Group)"
+    hosts = ["nuke"]
+    families = ["gizmo"]
+
+    def process(self, instance):
+        tmp_nodes = list()
+        orig_grpn = instance[0]
+        # Define extract output file path
+        stagingdir = self.staging_dir(instance)
+        filename = "{0}.nk".format(instance.name)
+        path = os.path.join(stagingdir, filename)
+
+        # maintain selection
+        with anlib.maintained_selection():
+            orig_grpn_name = orig_grpn.name()
+            tmp_grpn_name = orig_grpn_name + "_tmp"
+            # select original group node
+            anlib.select_nodes([orig_grpn])
+
+            # copy to clipboard
+            nuke.nodeCopy("%clipboard%")
+
+            # reset selection to none
+            anlib.reset_selection()
+
+            # paste clipboard
+            nuke.nodePaste("%clipboard%")
+
+            # assign pasted node
+            copy_grpn = nuke.selectedNode()
+            copy_grpn.setXYpos((orig_grpn.xpos() + 120), orig_grpn.ypos())
+
+            # convert gizmos to groups
+            pnutils.bake_gizmos_recursively(copy_grpn)
+
+            # remove avalonknobs
+            knobs = copy_grpn.knobs()
+            avalon_knobs = [k for k in knobs.keys()
+                            for ak in ["avalon:", "ak:"]
+                            if ak in k]
+            avalon_knobs.append("publish")
+            for ak in avalon_knobs:
+                copy_grpn.removeKnob(knobs[ak])
+
+            # add to temporary nodes
+            tmp_nodes.append(copy_grpn)
+
+            # swap names
+            orig_grpn.setName(tmp_grpn_name)
+            copy_grpn.setName(orig_grpn_name)
+
+            # create tmp nk file
+            # save file to the path
+            nuke.nodeCopy(path)
+
+            # Clean up
+            for tn in tmp_nodes:
+                nuke.delete(tn)
+
+            # rename back to original
+            orig_grpn.setName(orig_grpn_name)
+
+        if "representations" not in instance.data:
+            instance.data["representations"] = []
+
+        # create representation
+        representation = {
+            'name': 'gizmo',
+            'ext': 'nk',
+            'files': filename,
+            "stagingDir": stagingdir
+        }
+        instance.data["representations"].append(representation)
+
+        self.log.info("Extracted instance '{}' to: {}".format(
+            instance.name, path))
+
+        self.log.info("Data {}".format(
+            instance.data))

pype/plugins/nuke/publish/validate_gizmo.py

@@ -0,0 +1,58 @@
+import pyblish
+from avalon.nuke import lib as anlib
+import nuke
+
+
+class OpenFailedGroupNode(pyblish.api.Action):
+    """
+    Centering failed instance node in node grap
+    """
+
+    label = "Open Gizmo in Node Graph"
+    icon = "wrench"
+    on = "failed"
+
+    def process(self, context, plugin):
+
+        # Get the errored instances
+        failed = []
+        for result in context.data["results"]:
+            if (result["error"] is not None and result["instance"] is not None
+                    and result["instance"] not in failed):
+                failed.append(result["instance"])
+
+        # Apply pyblish.logic to get the instances for the plug-in
+        instances = pyblish.api.instances_by_plugin(failed, plugin)
+
+        # maintain selection
+        with anlib.maintained_selection():
+            # collect all failed nodes xpos and ypos
+            for instance in instances:
+                grpn = instance[0]
+                nuke.showDag(grpn)
+
+
+@pyblish.api.log
+class ValidateGizmo(pyblish.api.InstancePlugin):
+    """Validate amount of output nodes in gizmo (group) node"""
+
+    order = pyblish.api.ValidatorOrder
+    optional = True
+    families = ["gizmo"]
+    label = "Validate Gizmo (Group)"
+    hosts = ["nuke"]
+    actions = [OpenFailedGroupNode]
+
+    def process(self, instance):
+        grpn = instance[0]
+
+        with grpn:
+            connections_out = nuke.allNodes('Output')
+            msg_multiple_outputs = "Only one outcoming connection from "
+            "\"{}\" is allowed".format(instance.data["name"])
+            assert len(connections_out) <= 1, msg_multiple_outputs
+
+            connections_in = nuke.allNodes('Input')
+            msg_missing_inputs = "At least one Input node has to be used in: "
+            "\"{}\"".format(instance.data["name"])
+            assert len(connections_in) >= 1, msg_missing_inputs