Houdini 19.0 Executing tasks with PDG/TOPs pdg

pdg.cookType module

The enumeration of possible cook modes

This enum contains the possible cook types that can be passed to the pdg.GraphContext._cook(..) method, using a pdg.CookOptions object.

Values

pdg.cookType.Full

Performs a full cook of all nodes in the graph

pdg.cookType.GenerateFull

Generates static items for all nodes in the graph

pdg.cookType.GenerateNode

Generates the graph down to a particular node. Upstream dynamic nodes will be cooked if needed.

pdg.cookType.Node

Cooks the graph for a particular node. Upstream nodes will only be cooked if necessary.

pdg.cookType.StaticDepsFull

Does a static cook of the whole graph. This consists of doing a GenerateFull, and then calling the onScheduleStatic implementation of the user’s custom scheduler.

Note that this is a fairly obscure cook mode, and will not work out of the box with stock schedulers.

pdg.cookType.StaticDepsGen

Generates static items for all nodes in the graph. This is provided for backward compatibility, and is the same as using GenerateFull.

pdg.cookType.StaticDepsNode

The same as StaticDepsFull, but for a particular node.

pdg

attributes

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.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.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

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

data

pdg.dataType

The enumeration of PDG data types
pdg.generationType

The type of work item generation being performed by generation callbacks

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

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.Port

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

Dependency graph node subclass representing a processor.
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.ServiceManager

Object containing the registry of all PDG services
pdg.serviceOwner

Indicates the owner of a PDG service
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.WorkItem

A work item in the PDG graph.
pdg.WorkItemData

Exposes methods to access work item data through Python
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.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