Skip to content

hda.py

Utility functions for working with Houdini Digital Assets (HDAs).

This module provides utilities for managing and updating HDAs, particularly focusing on section management and source file synchronization.

Note

All operations that modify HDAs automatically handle update mode management to ensure consistent state.

update_hda_sections_from_source_files(hdas=None)

Update HDA sections with contents from their source files.

Updates each section's content by reading from source files specified in the HDA's extra options. Source file paths should be defined in the extra options with keys in the format "{section_name}/Source".

Parameters:

Name Type Description Default
hdas Optional[Union[Node, List[Node]]]

HDA node or list of HDA nodes to update. If None, uses selected nodes.

 None
Example

Update a specific HDA

node = hou.node('/obj/my_hda') update_hda_sections_from_source_files(node)

Update multiple HDAs

nodes = [hou.node('/obj/hda1'), hou.node('/obj/hda2')] update_hda_sections_from_source_files(nodes)

Update selected HDAs

update_hda_sections_from_source_files()

Notes
  • The function maintains a summary of successful updates and errors
  • Sections without specified source files are skipped
  • Empty source files are skipped
  • Updates are performed with update mode set to Manual

Since: 1.0.0

Source code in utils/hda.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
@pause_update_mode
def update_hda_sections_from_source_files(hdas: Optional[Union[hou.Node, List[hou.Node]]] = None) -> None:
    """Update HDA sections with contents from their source files.

    Updates each section's content by reading from source files specified in the HDA's
    extra options. Source file paths should be defined in the extra options with keys
    in the format "{section_name}/Source".

    Args:
        hdas: HDA node or list of HDA nodes to update. If None, uses selected nodes.

    Example:
        # Update a specific HDA
        >>> node = hou.node('/obj/my_hda')
        >>> update_hda_sections_from_source_files(node)

        # Update multiple HDAs
        >>> nodes = [hou.node('/obj/hda1'), hou.node('/obj/hda2')]
        >>> update_hda_sections_from_source_files(nodes)

        # Update selected HDAs
        >>> update_hda_sections_from_source_files()

    Notes:
        - The function maintains a summary of successful updates and errors
        - Sections without specified source files are skipped
        - Empty source files are skipped
        - Updates are performed with update mode set to Manual

    Since: 1.0.0
    """
    # Handle input types
    if hdas is None:
        hdas = hou.selectedNodes()
    elif isinstance(hdas, hou.Node):
        hdas = [hdas]

    # Track overall success
    success_count = 0
    error_count = 0

    for hda in hdas:
        try:
            definition = hda.type().definition()
            if not definition:
                print(f"Warning: {hda.path()} is not an HDA")
                continue

            sections = definition.sections()
            extra_options = definition.extraFileOptions()
            section_updates = 0

            for section_name, section in sections.items():
                source_key = f"{section_name}/Source"

                # Skip if source not specified
                if source_key not in extra_options:
                    continue

                # Skip if source path is empty
                source_path = extra_options[source_key].strip()
                if not source_path:
                    continue

                source_path = Path(source_path)
                if not source_path.exists():
                    print(f"Warning: Source file not found for {definition.description()}: {source_path}")
                    continue

                try:
                    file_contents = source_path.read_text()
                    if file_contents.strip():
                        section.setContents(file_contents)
                        section_updates += 1
                        print(f"{definition.description()}: Updated section {section_name} from {source_path}")
                except Exception as e:
                    print(f"{definition.description()}: Error reading {source_path}: {str(e)}")
                    error_count += 1

            if section_updates > 0:
                print(f"{definition.description()}: Updated {section_updates} sections")
                success_count += 1

        except Exception as e:
            print(f"Error processing HDA {definition.description()}: {str(e)}")
            error_count += 1

    # Print summary
    if success_count or error_count:
        print(f"\nUpdate Summary:")
        print(f"Successfully processed: {success_count} HDAs")
        if error_count:
            print(f"Errors encountered: {error_count}")
    else:
        print("No HDAs were processed")