code_gallery

Web News Blog Press Pricing

Learn

Training

Profiles

Executive

Templates

Animation VFX

Code

Code Gallery Designer

v5.20

Nuke

Check Nuke Color

Jorge Hernandez Ibañez 04/12/2025

Tags

Check Nuke Color

Jorge Herna…

Action v3

04/12/2025

Nuke

Pseudo-Code

Parameters

Talk with TD Support

Import to my Pipeline

Code

import nuke
import pipelinepro as pipeline
import os

# Example dictionary with the expected color management settings as defaults
# test_color = {
#     'viewerProcess.lut': 'sRGB',
#     'int8Lut': 'sRGB',
#     'int16Lut': 'sRGB',
#     'logLut': 'Cineon',
#     'floatLut': 'linear',
#     'workingSpaceLut': 'linear',
#     'monitorLut': 'rec709',
#     'thumbnailLut': 'sRGB',
#     'customOCIOConfigPath': '',
#     'OCIO_config': 'nuke-default',
#     'colorManagement': 'Nuke'
# }

def exec_query(query):
    """
    Sends a query to the pipeline database through the custom pipeline module.

Args:
        query (str): The query string in GraphQL format.

Returns:
        dict or None: The response data if successful, otherwise None.
    """
    if query.find("token:") < 0:
        print("Warning: The token key is not included in"
              " the query, it will probably fail.")
    try:
        response = pipeline.query(query)
    except Exception as e:
        print("Error on DB query: ", e)
        return
    return response

def get_project_color_config(filename):
    """
    Queries the pipeline database to retrieve the color configuration of the project
    associated with the given filename.

Args:
        filename (str): The name of the file (typically the script name).

Returns:
        dict or None: The color configuration dictionary if found, otherwise None.
    """
    query = """
    query {
      file(fileName: "{filename}", token: "{token}"){
        project{
          name
          key
          color_config: data(field:"nuke_config_color")
        }
      }
    }
    """
    query = query.replace("{filename}", filename)
    response = exec_query(query)
    if not response:
        return
    file_data = response.get("file")
    if not file_data:
        return
    color_config = file_data.get("project", {}).get("color_config")
    return color_config

def is_right_root_color(color_config):
    """
    Compares the current color management settings in Nuke's root node against the project config.

Args:
        color_config (dict): The color config dictionary from the project.

Returns:
        list: A list of mismatched knobs, each as a tuple with knob name, label, current and expected value.
    """
    root = nuke.root()
    wrong_values = []
    for knob, value in color_config.items():
        if not root.knob(knob):
            continue  # The knob does not exist in root
        current_value = root[knob].value()
        if current_value != value:
            wrong_values.append((knob, root[knob].name(), current_value, value))
    return wrong_values

def set_right_root_color(color_config):
    """
    Applies the project’s color config to the root node in Nuke.

Args:
        color_config (dict): The expected configuration to apply.
    """
    root = nuke.root()
    # Set high-priority color management knobs first
    priority_knobs = ["colorManagement", "OCIO_config", "customOCIOConfigPath"]
    for knob in priority_knobs:
        if color_config.get(knob) is None:
            continue
        current_value = root[knob].value()
        if current_value != color_config[knob]:
            root[knob].setValue(color_config[knob])
    # Set the remaining knobs
    for knob, value in color_config.items():
        if not root.knob(knob):
            continue
        if knob in priority_knobs:
            continue
        current_value = root[knob].value()
        if current_value != value:
            root[knob].setValue(value)

def check_process():
    """
    Main check function to validate if the current script matches the project's color config.

Returns:
        tuple: (bool, str or False) Whether the check passed, and the error message if it failed.
    """
    filename = os.path.basename(nuke.root().name())
    if filename == "root":
        return False, "The checker needs a saved file to run on."
    color_config = get_project_color_config(filename)
    if not color_config:
        return True, "No color config found in project"
    wrong_values = is_right_root_color(color_config)
    
    if not wrong_values:
        check_result = True
        check_error = False
    else:
        check_result = False
        check_error = ("Some color knobs are not properly set:\n"
                       "- Knob Name: Current Value -> Right Value\n")
        check_error += "\n".join([f"- {k[1]}: {k[2]} -> {k[3]}" for k in wrong_values])
    return check_result, check_error

def fix_process():
    """
    Applies the project's color config settings to the Nuke script.

Returns:
        bool: True if fix was attempted (assumes it succeeded).
    """
    filename = os.path.basename(nuke.root().name())
    if filename == "root":
        return False, "The checker needs a saved file to run on."
    color_config = get_project_color_config(filename)
    set_right_root_color(color_config)
    return True

#---------------------------------------------------------------------------------------------
def check(): # UI Functions, dont change
    check_result, check_error = check_process()
    
    if check_result:
        return True
    else:
        return check_error

def fix(): # UI Functions, dont change
    fix_result = fix_process()
    check_result = check()
    return fix_result, check_result

Import Action

1. Copy Key

Copy

2. Go to your Action pannel

Go