Houdini 20.5 Executing tasks with PDG/TOPs pdg

pdg.Event class

Represents an event that occurred while the graph was running.

If you set up an event handler on a node, work item or graph (using pdg.Node.addEventHandler, pdg.WorkItem.addEventHandler or pdg.GraphContext.addEventHandler), PDG passes an Event object to the handler when the corresponding event occurs as the PDG graph is cooking.

Methods ¶

context : pdg.GraphContext

Property

The PDG graph context that emitted the event, or contains the pdg.Node that emitted the event.

The PDG graph context that emitted the event, or contains the pdg.Node that emitted the event.

currentState : pdg.workItemState

Property

If the event is a work item event, this is set to the current state of the work item.

If the event is a work item event, this is set to the current state of the work item.

dependencyId : int

Property

If the event is a dependency or parent change event, this is the id of the dependency/parent work item

If the event is a dependency or parent change event, this is the id of the dependency/parent work item

lastState : pdg.workItemState

Property

If the event is a work item state change event, this is set to the previous work item state.

If the event is a work item state change event, this is set to the previous work item state.

message : str

Property

If the event is a warning or error, this string contains the message associated with that warning/error.

If the event is a warning or error, this string contains the message associated with that warning/error.

node : pdg.Node

Property

The node that the event was emitted from, or None if it as a top level context event

The node that the event was emitted from, or None if it as a top level context event

type : pdg.EventType

Property

The event type

The event type

workItemId : int

Property

The id of the work item, if the event is a work item related event. This can be passed to pdg.Graph.workItemById.

The id of the work item, if the event is a work item related event.

pdg

attributes ¶

pdg.AttributeDictionary

A dictionary array work item attribute.
pdg.AttributeFile

A file array work item attribute.
pdg.AttributeFloat

An floating point array work item attribute.
pdg.AttributeInt

An integer array work item attribute.
pdg.AttributePattern

A utility for matching attribute names to a pattern.
pdg.AttributePyObject

A Python object work item attribute.
pdg.AttributeSplit

A utility for splitting lists of work item by attribute or frame value
pdg.AttributeString

A string array work item attribute.
pdg.BasePattern

Base class for pdg.AttributePattern and pdg.ValuePattern.
pdg.File

A file object with a path and associated metadata
pdg.FilterPattern

A utility for matching attribute value ranges
pdg.PathMap

Functions for mapping file paths
pdg.PathMapEntry

An entry in the global path map
pdg.ValuePattern

A utility for matching values or producing arrays of values
pdg.attribErrorLevel

The enumeration of error handling options when adding attributes to a work item
pdg.attribFlag

The enumeration of work item attribute flags
pdg.attribMatchType

The enumeration of the default attribute pattern match types
pdg.attribMergeType

The enumeration of different merge operations that can be applied to attributes
pdg.attribOverwrite

The enumeration of work item attribute overwrite options
pdg.attribType

The enumeration of work item attribute types
pdg.fileTransferType

The enumeration of file transfer destination types
pdg.fileType

The enumeration of file types
pdg.pathMapMatchType

Enumeration of string matching types used when comparing a path mapping entry with an input string

cooking ¶

pdg.CookOptions

Container for cook options.
pdg.EvaluationOptions

Container for graph evaluation options
pdg.cacheMode

The enumeration of file caching modes available on processor nodes
pdg.cookType

The enumeration of possible cook modes
pdg.generateWhen

The enumeration of work item generation modes supported by processor nodes
pdg.regenerateReason

Enumeration of possible reasons for a node to regenerate during the cook

customtypes ¶

pdg.Dictionary

Wraps a nested dictionary object in Python, used with Dictionary Array attributes

data ¶

pdg.dataType

The enumeration of PDG data types
pdg.generationType

The type of work item generation being performed by generation callbacks

debugging ¶

pdg.debugLevelCache

The enumeration of cache debug log levels
pdg.debugLevelExpression

The enumeration of attribute expression debug log levels
pdg.debugLevelNode

The enumeration of node debug log levels
pdg.debugLevelScheduler

The enumeration of scheduler debug log levels
pdg.debugLevelService

The enumeration of service debug log levels
pdg.debugLevelTransfer

The enumeration of file transfer debug log levels
pdg.debugLevelTypeRegistration

The enumeration of type registration debug log levels
pdg.debugLevelWorkItem

The enumeration of work item debug log levels
pdg.debugLogType

The enumeration of debug logs available in PDG
pdg.debugging

Debug logging utilities

events ¶

pdg.Event

Represents an event that occurred while the graph was running.
pdg.EventEmitter

Base class for objects that are able to emit events
pdg.EventHandler

Represents a handler function added to a node or graph.
pdg.EventType

The type of a pdg.Event
pdg.PyEventHandler

Represents a handler function added to a node or graph from Python

exceptions ¶

pdg.AttribError

Generic exception raised when an error occurs when accessing work item attributes
pdg.CookError

Generic exception raised when an error running the graph.
pdg.ServiceError

Generic exception raised when an error occurs during a PDG service manager operation

expressions ¶

pdg.EvaluationContext

A module with global functions that operate on the thread-local evaluation context

internal ¶

pdg.MemoryInfo

Memory info about a node and its work items

nodes ¶

pdg.Dependency

Represents an external dependency of a node.
pdg.FeedbackBegin

Dependency graph processor node subclass for feedback loop begin blocks
pdg.FileDependency

Represents a node’s dependence on the existence of an external file.
pdg.Graph

Represents the dependency graph within the GraphContext object.
pdg.GraphContext

The top level object in a dependency graph.
pdg.Node

Base class for dependency graph nodes.
pdg.NodeOptions

Summary info used to configure a pdg.Node instance
pdg.NodeStats

Generate and cook time information for a PDG node
pdg.Port

An input, output or parameter on a PDG Node
pdg.Processor

Dependency graph node subclass representing a processor.
pdg.nodeStatType

Cook time statistics exposed by a PDG node
pdg.nodeSubtype

The subtype of PDG node type
pdg.nodeType

The primary type of a PDG node
pdg.portType

The type of a pdg.Port object

schedulers ¶

pdg.Scheduler

A scheduler object that has its type implemented in Python.
pdg.SchedulerBase

Represents a scheduler in the dependency graph.
pdg.workItemDataSource

The ways that the scheduler can transfer work item data to remote machines

services ¶

pdg.Service

Object that represents a service
pdg.ServiceClientInfo

Object that contains information about a running service client
pdg.ServiceManager

Object containing the registry of all PDG services
pdg.serviceBlockCookType

Enumerations of options for how a work item in a service block should cook
pdg.serviceClientLogType

The log type used by a service client
pdg.serviceOwner

Indicates the owner of a PDG service
pdg.serviceResetType

Reset operation type, used when configuring a server to reset clients when memory is exceeded
pdg.serviceState

Indicates the state of a PDG service

types ¶

pdg.TransferPair

A utility class return as the result of a custom file transfer handler
pdg.TypeRegistry

Object containing registry of all custom node, work item, and scheduler types.
pdg.acceptResult

The return type of a onAcceptWorkItem callback
pdg.cacheResult

The enumeration of cache results that can be returned by a custom cache handler
pdg.dirtyHandlerType

The enumeration of possible dirty handler types
pdg.language

The enumeration of languages used to define custom PDG types
pdg.regenerateResult

The enumeration of possible result returned by a custom regeneration handler
pdg.registeredType

The type of object when registering a custom class with PDG
pdg.result

The return type of a node callback implementation
pdg.scheduleResult

The return type of a scheduler’s onScheduler callback implementation
pdg.tickResult

The return type of a onTick callback
pdg.transferResult

The enumeration of file transfers results that can be returned by a custom transfer handler
pdg.workItemReadyResult

The return type of a scheduler’s isWorkItemReady call

workitems ¶

pdg.BatchWorkItem

Represents a batch work item, which contains multiple child work items.
pdg.ConstWorkItemList

A list of read-only work items
pdg.DependencyHolder

Container object for dependency pairs.
pdg.PartitionHolder

Keeps track of work items inside a partition.
pdg.ScriptWorkItemData

Custom work item data type for items that cook using a Python script
pdg.WorkItem

A work item in the PDG graph.
pdg.WorkItemData

Exposes methods to access work item data through Python
pdg.WorkItemDirty

Stores an in-progress Work Item dirty operation that can applied later
pdg.WorkItemHolder

Container object for work items.
pdg.WorkItemList

A list of work items
pdg.WorkItemOptions

You can pass this object to WorkItemHolder.addWorkItem() to create a work item with the specified options.
pdg.WorkItemStats

Cook time information for a work item
pdg.batchActivation

The enumeration of batch activation conditions
pdg.cloneMode

The enumeration of clone modes that can be used when generating work items
pdg.platform

The enumeration of platforms
pdg.workItemCacheState

The current cache state of the work item
pdg.workItemCookType

The cook type of the work item
pdg.workItemDirtyType

The type of dirty being performed on the graph
pdg.workItemExecutionType

The execution type of the work item
pdg.workItemLogType

Work item log message type
pdg.workItemStatType

Processing time statistics exposed by a PDG work item
pdg.workItemState

The cook state of the work item
pdg.workItemType

The type of the work item