base_import_handler

Base Hook for other Houdini import node handlers.

These include:

• alembic_import_handler

• file_handler

• image_handler

Module Contents

Classes

ImportNodeHandler

Base class for all import node handlers.

HookBaseClass

class ImportNodeHandler

Bases: HookBaseClass

Base class for all import node handlers.

ACCEPTS_MULTI_SELECTION = False

DEFAULT_FILE_DATA

DEFAULT_WORK_FILE_DATA

FILECHOOSER_PATTERN = *

HOU_FILE_TYPE

INPUT_PARM

LATEST_COMPLETE_POLICY = <LATEST COMPLETE>

LATEST_POLICY = <LATEST>

NODE_CATEGORY = Sop

NODE_TYPE = alembic

NOTHING_ON_DISK = Nothing on disk

NO_FILE = No file selected

NO_NODE = No node selected

NO_PUBLISH = No publish selected

NO_VERSIONS = No version

SEQUENCE_REGEX = -9999

SGTK_BROWSE = sgtk_browse

SGTK_CURRENT_TAB = sgtk_current_tab

SGTK_FILE_DATA = sgtk_file_data

SGTK_FILE_PATH = sgtk_file_path

SGTK_FILE_REFRESH_VERSIONS = sgtk_file_refresh_versions

SGTK_FILE_RESOLVED_VERSION = sgtk_file_resolved_version

SGTK_FILE_VERSION = sgtk_file_version

SGTK_ID = sgtk_id

SGTK_LAST_USED = sgtk_last_used

SGTK_NAME = sgtk_name

SGTK_NODE_NAME = sgtk_node_name

SGTK_NODE_PARM = sgtk_node_parm

SGTK_PATH_FILE = sgtk_path_selection3

SGTK_PATH_PUBLISH = sgtk_path_selection1

SGTK_PATH_SELECTION = sgtk_path_selection11

SGTK_PATH_WORK = sgtk_path_selection2

SGTK_PUBLISH_DATA = sgtk_publish_data

SGTK_WORK_FILE_DATA = sgtk_work_file_data

SGTK_WORK_REFRESH_VERSIONS = sgtk_work_refresh_versions

SGTK_WORK_RESOLVED_VERSION = sgtk_work_resolved_version

SGTK_WORK_VERSION = sgtk_work_version

VALID_FILE_TYPES = valid_file_types

VERSION_POLICIES

WORK_VERSION_REGEX

WORK_VERSION_TEMPLATE = v{}

_convert_path_to_houdini_seq(self, path)

Convert incoming sequence paths into houdini formatted ones. ($F4)

Parameters

path (str) – The incoming file path.

Returns

A houdini-formatted sequence path.

_create_sgtk_folder(self, node)

Create the sgtk folder template.

This contains the common parameters used by all node handlers.

Parameters

• node – A hou.Node instance.

• use_sgtk_default (bool) – Whether the “Use Shotgun” checkbox is to be checked by default.

_create_sgtk_parm_fields(self, node, hou=None)

Create the sgtk folder template.

This contains the common parameters used by all node handlers.

Parameters

• node – A hou.Node instance.

• use_sgtk_default (bool) – Whether the “Use Shotgun” checkbox is to be checked by default.

• hou – The houdini module. We have to lazy load the houdini python module here, but not in the hooks, so use hook’s imports and pass it for efficiency.

_create_sgtk_parms(self, node)

Create the parameters that are going to live within the sgtk folder.

Parameters

node – A hou.Node instance.

Return type

list(hou.ParmTemplate)

_customise_parameter_group(self, node, parameter_group, sgtk_folder)

Here is where you define where the sgtk folder is to be placed, but also any other parameters that you wish to add to the node.

Parameters

• node – A hou.Node instance.

• parameter_group – The node’s ParmGroup.

• sgtk_folder – A hou.ParmFolderTemplate containing sgtk parameters.

_enable_sgtk(self, node, sgtk_enabled)

Enable/disable the sgtk parameters.

Parameters

• node – A hou.Node instance.

• sgtk_enabled (bool) – The state to set the parameters to.

static _escape_publish_data(publish_data_str)

Utility to escape publish data strings for json loading.

Parameters

publish_data_str (str) – The serialised publish data.

Returns

A string that json can deal with.

static _extract_versions(versions_and_statuses)

Extract just the versions from the versions and statuses dict.

Parameters

versions_and_statuses (list(dict)) – The versions and statuses.

Return type

list(int)

_get_all_versions(self, node)

Get all the available versions off the given node.

Parameters

node – A hou.Node instance.

Return type

list(int)

_get_all_versions_and_statuses(self, node)

_get_file_versions(self, node)

Get all the file versions from the stored data on this node.

Parameters

node – A hou.Node instance.

Return type

list(int)

_get_node_file_parms(self, parent_node)

Get all the parameters on the given node that are of the type hou.stringParmType.FileReference.

Parameters

parent_node – A hou.Node instance.

Return type

list(str)

static _get_path_from_sg_data(data)

Get the file path from the publish data.

Parameters

data (dict) – The publish data.

Returns

str

static _get_search_filters_from_publish_data(publish_data)

Construct search filters from the publish data.

Parameters

publish_data (dict) – The publish data to use for the query.

Return type

list

_get_template_fields_and_work_versions(self, parent_node, parm_name)

Get the template, template fields and all versions from the file path associated with the given node and parameter name.

This method will initially use the node handler for the given node to retrieve the template, then falls back to sgtk.Sgtk.template_from_path().

If no template can be found, all versions will be calculated using regexes that look for v# in the file path.

Parameters

• parent_node – The node to retrieve the data from.

• parm_name – The name of the parameter that contains the file path.

Returns

A tuple of sgtk.Template, dict and list(int)

_get_work_versions(self, node)

Get all the versions from the stored data on this node.

Parameters

node – A hou.Node instance.

Return type

list(int)

_load_from_shotgun(self, node)

Open a shotgun loader dialogue and populate the node from the selection made.

Parameters

node – A hou.Node instance.

_path_selection(self, node)

Get the index of the current path selection.

Parameters

node – A hou.Node instance.

Return type

int

_populate_from_file_data(self, node)

Populate the node’s File tab from the saved file data.

Parameters

node – A hou.Node instance.

_populate_from_work_file_data(self, node)

Populate the node’s work file tab from the saved work file data.

Parameters

node – A hou.Node instance.

_refresh_file_path(self, node)

Refresh the file paths generated by the node handler.

Parameters

node – A hou.Node instance.

_refresh_file_path_from_node(self, node)

Use another node to populate the file path on this node.

Parameters

node – A hou.Node instance.

_refresh_file_path_from_path(self, node)

Use another file path to update the file path on this node.

Parameters

node – A hou.Node instance.

_refresh_file_path_from_publish_data(self, node, publish_data)

Refresh the file path from the given publish data.

Parameters

• node – A hou.Node instance.

• publish_data (dict) – The publush data to populate from.

_remove_sgtk_items_from_parm_group(self, parameter_group)

Remove all sgtk parameters from the node’s parameter template group.

Parameters

parameter_group (ParmGroup) – The parameter group containing sgtk parameters.

_replace_version_in_path(self, path, version)

Replace the version numbers in the file path with the given version.

Parameters

• path – The old version path.

• version – The version number to update the path to.

Returns

The updated file path.

_resolve_all_versions_from_path(self, path)

Extract all the versions on disk from the given file path.

Looks for v# in the path to determine the version number.

If the path exists on disk, but does not contain a version number, 1 will be returned. An empty list will be returned if no files exist on disk.

Parameters

path – The path to check against.

Return type

list(int)

_resolve_all_versions_statuses(self, publish_data)

Get all the available versions and their pipeline statuses from the given entity publish data.

Parameters

publish_data (dict) – The publish data to use for the query.

Returns

A list(dict) of versions and relating statuses.

_resolve_version(self, all_versions_and_statuses, current)

From a given string, resolve the current version. Either a specified version or the next version in the sequence.

Parameters

• all_versions_and_statuses (list(dict)) – All the existing versions and their pipeline status.

• current (str) – The currently selected version option.

Return type

int

_resolve_work_version(self, all_versions, current)

From a given string, resolve the current version. Either a specified version or the next version in the sequence.

Parameters

• all_versions (list(int)) – All the existing versions.

• current (str) – The currently selected version option.

Return type

int or NoneType

_restore_sgtk_parms(self, node)

Restore any removed sgtk parameters onto the given node.

Parameters

node – A hou.Node instance containing sgtk parameters.

_retrieve_publish_data(self, node)

Retrieve publish data off the given node.

Parameters

node – A hou.Node instance.

Return type

dict

_set_up_node(self, node, parameter_group)

Set up a node for use with shotgun pipeline.

Parameters

• node – A hou.Node instance.

• parameter_group – A ParmGroup instance.

_update_publish_data_parm(self, node, publish_data, version_policy)

Update the publish data parm on the node with the publish data and version policy.

Parameters

• node – A hou.Node instance.

• publish_data (dict) – The publish data.

• version_policy (str) – The version policy.

_update_version_from_publish_data(self, node, publish_data, version_policy)

Update the version parameter from the given publish data and version policy.

Parameters

• node – A hou.Node instance.

• publish_data (dict) – The publish data.

• version_policy (str) – The version policy.

static _validate_publish_data(publish_data)

Validate the publish data.

Must include: - entity - project - name - published_file_type

Return type

bool

enable_sgtk(self, kwargs)

Callback to enable/disable the sgtk parameters.

get_input_paths(self, node)

Get all the input paths from the given node.

Parameters

node – A hou.Node instance containing sgtk parameters.

Return type

list(str)

load_from_shotgun(self, kwargs)

Callback to open a shotgun loader dialogue and populate the node from the selection made.

on_loaded(self, node)

Extended to ensure versions are also refreshed on farm i.e. no UI.

Parameters

node (hou.Node) – Node just loaded into scene upon file open.

populate_file_versions(self, kwargs)

Populate the file versions menu with all available versions and <LATEST>.

Return type

list(str)

populate_node_from_publish_data(self, node, publish_data, version_policy=None)

Populate the node from the given publish data.

Parameters

• node – A hou.Node instance.

• publish_data (dict) – The publish data.

• version_policy (str) – The version policy.

populate_node_parms_menu(self, kwargs)

Populate the parameter name menu.

Return type

list(str)

populate_work_versions(self, kwargs)

Populate the work versions menu with all available versions and <LATEST>.

Return type

list(str)

refresh_file_path_from_version(self, kwargs)

Callback to refresh the file paths generated by the node handler when the version is updated.

refresh_from_file_path(self, kwargs)

Callback to refresh the file path when the File tab is active.

refresh_from_file_selection(self, kwargs)

Callback to refresh the node’s file path when the file selection is changed.

refresh_from_file_version(self, kwargs)

Callback to refresh the file path when the file version parameter is changed.

refresh_from_node_selection(self, kwargs)

Call back to refresh the file path when the node selection is changed.

refresh_from_parm_selection(self, kwargs)

Callback to refresh the file path when the parameter selection is changed.

refresh_from_selection(self, kwargs)

Callback to refresh the node’s file path when the tab selection changes.

refresh_from_work_version(self, kwargs)

Callback to refresh the file path when the work version parameter is changed.

refresh_work_path(self, kwargs)

Callback to refresh the file path when the Work tab is active.

property valid_file_types(self)

List of all the valid file types for this node handler.

Return type

list(str)