Nuke: simplified deadline submission on write node - AY-974

client/ayon_core/hosts/nuke/api/lib.py

@@ -1022,6 +1022,16 @@ def script_name():
  return nuke.root().knob("name").value()
 
 
+def add_button_headless_farm_submission(node):
+ name = "headlessFarmSubmission"
+ label = "Headless Farm Submission"
+ value = "from ayon_core.hosts.nuke.api.utils import submit_headless_farm;"
+ value += "submit_headless_farm(nuke.thisNode())"
+ knob = nuke.PyScript_Knob(name, label, value)
+ knob.clearFlag(nuke.STARTLINE)
+ node.addKnob(knob)
+
+
 def add_button_write_to_read(node):
  name = "createReadNode"
  label = "Read From Rendered"
@@ -1144,6 +1154,17 @@ def create_write_node(
  Return:
  node (obj): group node with avalon data as Knobs
  '''
+ # Ensure name does not contain any invalid characters.
+ special_chars = re.escape("!@#$%^&*()=[]{}|\\;',.<>/?~+-")
+ special_chars_regex = re.compile(f"[{special_chars}]")
+ found_special_characters = list(special_chars_regex.findall(name))
+
+ msg = (
+ f"Special characters found in name \"{name}\": "
+ f"{' '.join(found_special_characters)}"
+ )
+ assert not found_special_characters, msg
+
  prenodes = prenodes or []
 
  # filtering variables
@@ -1268,6 +1289,10 @@ def create_write_node(
  link.setFlag(0x1000)
  GN.addKnob(link)
 
+ # Adding render farm submission button.
+ if data.get("headless_farm_submission", False):
+ add_button_headless_farm_submission(GN)
+
  # adding write to read button
  add_button_write_to_read(GN)
 

client/ayon_core/hosts/nuke/api/utils.py

@@ -1,11 +1,18 @@
 import os
 import re
+import traceback
 
 import nuke
 
-from ayon_core import resources
+import pyblish.util
+import pyblish.api
 from qtpy import QtWidgets
 
+from ayon_core import resources
+from ayon_core.pipeline import registered_host
+from ayon_core.tools.utils import show_message_dialog
+from ayon_core.pipeline.create import CreateContext
+
 
 def set_context_favorites(favorites=None):
  """ Adding favorite folders to nuke's browser
@@ -142,3 +149,86 @@ def is_headless():
  bool: headless
  """
  return QtWidgets.QApplication.instance() is None
+
+
+def create_error_report(context):
+ """Create an error report based on the given pyblish context.
+
+ This function iterates through the results in the context and formats any
+ errors into a comprehensive error report.
+
+ Args:
+ context (dict): Pyblish context.
+
+ Returns:
+ tuple: A tuple containing a boolean indicating success and a string
+ representing the error message.
+ """
+
+ error_message = ""
+ success = True
+ for result in context.data["results"]:
+ if result["success"]:
+ continue
+
+ success = False
+
+ err = result["error"]
+ error_message += "\n"
+ error_message += err.formatted_traceback
+
+ return success, error_message
+
+
+def submit_headless_farm(node):
+ # Ensure code is executed in root context.
+ if nuke.root() == nuke.thisNode():
+ _submit_headless_farm(node)
+ else:
+ # If not in root context, move to the root context and then execute the
+ # code.
+ with nuke.root():
+ _submit_headless_farm(node)
+
+
+def _submit_headless_farm(node):
+ """Headless farm submission
+
+ This function prepares the context for farm submission, validates it,
+ extracts relevant data, copies the current workfile to a timestamped copy,
+ and submits the job to the farm.
+
+ Args:
+ node (Node): The node for which the farm submission is being made.
+ """
+
+ host = registered_host()
+ create_context = CreateContext(host)
+
+ # Ensure CreateInstance is enabled.
+ for instance in create_context.instances:
+ if node.name() != instance.transient_data["node"].name():
+ continue
+
+ instance.data["active"] = True
+
+ context = pyblish.api.Context()
+ context.data["create_context"] = create_context
+ # Used in pyblish plugin to determine which instance to publish.
+ context.data["node_name"] = node.name()
+ # Used in pyblish plugins to determine whether to run or not.
+ context.data["headless_farm"] = True
+
+ context = pyblish.util.publish(context)
+
+ success, error_report = create_error_report(context)
+
+ if not success:
+ show_message_dialog(
+ "Collection Errors", error_report, level="critical"
+ )
+ return
+
+ show_message_dialog(
+ "Submission Successful", "Submission to the farm was successful."
+ )

client/ayon_core/hosts/nuke/plugins/create/create_write_image.py

@@ -65,12 +65,15 @@ def _get_frame_source_number(self):
  )
 
  def create_instance_node(self, product_name, instance_data):
+ settings = self.project_settings["nuke"]["create"]["CreateWriteImage"]
+ settings = settings["instance_attributes"]
 
  # add fpath_template
  write_data = {
  "creator": self.__class__.__name__,
  "productName": product_name,
- "fpath_template": self.temp_rendering_path_template
+ "fpath_template": self.temp_rendering_path_template,
+ "headless_farm_submission": "headless_farm_submission" in settings
  }
  write_data.update(instance_data)
 

client/ayon_core/hosts/nuke/plugins/create/create_write_prerender.py

@@ -46,11 +46,15 @@ def get_pre_create_attr_defs(self):
  return attr_defs
 
  def create_instance_node(self, product_name, instance_data):
+ settings = self.project_settings["nuke"]["create"]
+ settings = settings["CreateWritePrerender"]["instance_attributes"]
+
  # add fpath_template
  write_data = {
  "creator": self.__class__.__name__,
  "productName": product_name,
- "fpath_template": self.temp_rendering_path_template
+ "fpath_template": self.temp_rendering_path_template,
+ "headless_farm_submission": "headless_farm_submission" in settings
  }
 
  write_data.update(instance_data)

client/ayon_core/hosts/nuke/plugins/create/create_write_render.py

@@ -40,11 +40,17 @@ def get_pre_create_attr_defs(self):
  return attr_defs
 
  def create_instance_node(self, product_name, instance_data):
+ settings = self.project_settings["nuke"]["create"]["CreateWriteRender"]
+ instance_attributes = settings["instance_attributes"]
+
  # add fpath_template
  write_data = {
  "creator": self.__class__.__name__,
  "productName": product_name,
- "fpath_template": self.temp_rendering_path_template
+ "fpath_template": self.temp_rendering_path_template,
+ "headless_farm_submission": (
+ "headless_farm_submission" in instance_attributes
+ )
  }
 
  write_data.update(instance_data)

client/ayon_core/hosts/nuke/plugins/publish/collect_headless_farm.py

@@ -0,0 +1,47 @@
+import pyblish.api
+
+
+class CollectHeadlessFarm(pyblish.api.ContextPlugin):
+ """Setup instances for headless farm submission."""
+
+ # Needs to be after CollectFromCreateContext
+ order = pyblish.api.CollectorOrder - 0.4
+ label = "Collect Headless Farm"
+ hosts = ["nuke"]
+
+ def process(self, context):
+ if not context.data.get("headless_farm", False):
+ return
+
+ for instance in context:
+ if instance.data["family"] == "workfile":
+ instance.data["active"] = False
+ continue
+
+ # Filter out all other instances.
+ node = instance.data["transientData"]["node"]
+ if node.name() != instance.context.data["node_name"]:
+ instance.data["active"] = False
+ continue
+
+ instance.data["families"].append("headless_farm")
+
+
+class SetupHeadlessFarm(pyblish.api.InstancePlugin):
+ """Setup instance for headless farm submission."""
+
+ order = pyblish.api.CollectorOrder + 0.4999
+ label = "Setup Headless Farm"
+ hosts = ["nuke"]
+ families = ["headless_farm"]
+
+ def process(self, instance):
+ # Enable for farm publishing.
+ instance.data["farm"] = True
+
+ # Clear the families as we only want the main family, ei. no review
+ # etc.
+ instance.data["families"] = ["headless_farm"]
+
+ # Use the workfile instead of published.
+ instance.data["use_published_workfile"] = False

client/ayon_core/hosts/nuke/plugins/publish/extract_headless_farm.py

@@ -0,0 +1,36 @@
+import os
+from datetime import datetime
+import shutil
+
+import pyblish.api
+
+from ayon_core.pipeline import registered_host
+
+
+class ExtractHeadlessFarm(pyblish.api.InstancePlugin):
+ """Copy the workfile to a timestamped copy."""
+
+ order = pyblish.api.ExtractorOrder + 0.499
+ label = "Extract Headless Farm"
+ hosts = ["nuke"]
+ families = ["headless_farm"]
+
+ def process(self, instance):
+ if not instance.context.data.get("headless_farm", False):
+ return
+
+ host = registered_host()
+ current_datetime = datetime.now()
+ formatted_timestamp = current_datetime.strftime("%Y%m%d%H%M%S")
+ base, ext = os.path.splitext(host.current_file())
+
+ directory = os.path.join(os.path.dirname(base), "farm_submissions")
+ if not os.path.exists(directory):
+ os.makedirs(directory)
+
+ filename = "{}_{}{}".format(
+ os.path.basename(base), formatted_timestamp, ext
+ )
+ path = os.path.join(directory, filename).replace("\\", "/")
+ instance.context.data["currentFile"] = path
+ shutil.copy(host.current_file(), path)

client/ayon_core/hosts/nuke/plugins/publish/increment_script_version.py

@@ -13,6 +13,8 @@ class IncrementScriptVersion(pyblish.api.ContextPlugin):
  hosts = ['nuke']
 
  def process(self, context):
+ if context.data.get("headless_farm", False):
+ return
 
  assert all(result["success"] for result in context.data["results"]), (
  "Publishing not successful so version is not increased.")

client/ayon_core/modules/deadline/plugins/publish/submit_nuke_deadline.py

@@ -128,8 +128,11 @@ def process(self, instance):
  render_path = instance.data['path']
  script_path = context.data["currentFile"]
 
- use_published_workfile = instance.data["attributeValues"].get(
- "use_published_workfile", self.use_published_workfile
+ use_published_workfile = instance.data.get(
+ "use_published_workfile",
+ instance.data["attributeValues"].get(
+ "use_published_workfile", self.use_published_workfile
+ )
  )
  if use_published_workfile:
  script_path = self._get_published_workfile_path(context)

client/ayon_core/plugins/publish/validate_version.py

@@ -1,8 +1,10 @@
 import pyblish.api
-from ayon_core.pipeline.publish import PublishValidationError
+from ayon_core.pipeline.publish import (
+ PublishValidationError, OptionalPyblishPluginMixin
+)
 
 
-class ValidateVersion(pyblish.api.InstancePlugin):
+class ValidateVersion(pyblish.api.InstancePlugin, OptionalPyblishPluginMixin):
  """Validate instance version.
 
  AYON does not allow overwriting previously published versions.
@@ -18,6 +20,9 @@ class ValidateVersion(pyblish.api.InstancePlugin):
  active = True
 
  def process(self, instance):
+ if not self.is_active(instance.data):
+ return
+
  version = instance.data.get("version")
  latest_version = instance.data.get("latestVersion")
 

server_addon/nuke/package.py

@@ -1,3 +1,3 @@
 name = "nuke"
 title = "Nuke"
-version = "0.1.11"
+version = "0.1.12"

server_addon/nuke/server/settings/create_plugins.py

@@ -12,7 +12,11 @@ def instance_attributes_enum():
  return [
  {"value": "reviewable", "label": "Reviewable"},
  {"value": "farm_rendering", "label": "Farm rendering"},
- {"value": "use_range_limit", "label": "Use range limit"}
+ {"value": "use_range_limit", "label": "Use range limit"},
+ {
+ "value": "headless_farm_submission",
+ "label": "Headless Farm Submission"
+ }
  ]