| Inheritence |
|
This class exposes ways to access information about a work item in PDG. Work items can be looked up by name using the pdg.Graph.workItemByName method, or by id using the pdg.Graph.workItemById method.
pdg.Node objects also provide methods to access the work items owned by that node.
Methods
addAttrib(name, type:
pdg.attribType)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
Adds an attribute with the specified name and type. If the attribute already exists and has the same type, the existing attribute is returned. Otherwise, if the attribute exists with a different type an exception is thrown.
addEnvironmentVar(str)
Adds an environment variable to the work item’s environment
This method is deprecated. Add an attribute using pdg.WorkItem.addAttrib
and set the pdg.attribFlag.EnvExport flag on the attribute instead.
addEventHandler(handler, filter:
pdg.EventType, pass_handler=False)
→ pdg.EventHandler
Adds an event handler to the work item, with a value of the type of event to receive. The handler should be a callable that accepts one argument of type pdg.Event.
If pass_handler is True, the handler itself is passed as the first argument to
the function, otherwise only the event object is passed to the function.
addEventHandler(handle, event_types:
pdg.EventType, pass_handler=False)
→ pdg.EventHandler
Adds an event handler to the work item, with a list of the types of events to receive. The handler should be a callable that accepts one argument of type pdg.Event.
If pass_handler is True, the handler itself is passed as the first argument to
the function, otherwise only the event object is passed to the function.
addExpectedResultData(result, tag, own=True)
Adds an expected result file for the work item, with the specified tag. The
optional own parameter indicates whether the work item owns the file,
which is used when PDG deletes output files from disk.
addResultData(result, tag, checksum, own=True)
Adds an result file for the work item, with the specified tag and file
checksum value. The optional own parameter indicates whether the work item
owns the file, which is used when PDG deletes output files from disk.
attrib(name)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
Returns the work item attribute with the specified name, or None if no
such attribute exists. The attribute will be one of the supported
attribute types listed in pdg.attribType. Can also be written as
work_item.attrib[name].
attrib(name, type)
→ pdg.AttributeFile or pdg.AttributeFloat or pdg.AttributeInt or pdg.AttributePyObject or pdg.AttributeString
Returns the work item attribute with the specified name and type, or None
if no such attribute exists.
attribMatch(pattern)
→ list
of str
Returns the list of attribute names from the work item that match the specified pdg.AttributePattern instance.
attribNames()
→ list
of str
Returns the list of attribute names currently stored on the work item.
attribNames(type)
→ list
of str
Returns the list of attribute names currently stored on the work item with the specified type.
attribArray(name)
→ list
of int
, float
, str
or pdg.File
Returns the array stored on an attribute.
attribValue(name, index=0)
→ int
, float
, str
or pdg.File
Returns the value of an attribute at the specified index. Can also be
written as work_item[name][index].
attribValues()
→ dict
of list
of int
, float
, and str
Returns the map of all attribute names to values on the work item
attribValues(type)
→ dict
of list
of int
, float
, or str
Returns the map of all attribute names to values on the work item, of the specified pdg.attribType.
attribType(name)
→ pdg.attribType
Returns the type of the attribute with the specified name, or
pdg.attribType.Undefined if no attribute with that name exists.
clearAttribs()
Clears all attribute on the work item
clearAttribs(type)
Clears all attribute on the work item, of the specified type.
clearEnvironment()
Clears the work item’s environment and stops it from inheriting variables from the parent work item.
This method is deprecated. Remove attributes that have the
pdg.attribFlag.EnvExport flag set instead.
clearResultData()
Clears all result files on the work item.
cookWarning(message)
Adds a warning message to the node which owns this work item.
dirty(delete, remove_outputs)
Dirties the work item, or deletes it if delete is set to True.
If remove_outputs is True, then it will also delete the file results
on disk generated by this work item.
envLookup(key)
→ int
, float
, or str
Returns the value of an environment variable on the work item.
This method is deprecated. Look up the attribute using
pdg.WorkItem.attrib and check for the pdg.attribType.EnvExport flag.
eraseAttrib(name)
Erases an attribute with the specified name.
fileAttribArray(name)
→ list
of pdg.File
Returns the file attribute array
fileAttribValue(name, index=0)
→ pdg.File
Returns the file attribute value at the specified index
floatAttribArray(name)
→ list
of float
Returns the floating point attribute array
floatAttribValue(name, index=0)
→ float
Returns the floating point attribute value at the specified index
firstResultDataForTag(tag)
→ str
Returns the file path to the result for the specified tag.
hasAttrib(name)
→ bool
Returns true if the work item has the specified attribute
hasEnvironmentVar(name)
→ bool
Returns True if the work item has the specified environment variable defined, else False.
Note that this function is deprecated. Environment variables are now
implemented as attributes, so it is possible to check for an environment
variable by looking up an attribute and check if it has the
pdg.attribFlag.EnvExport flag set.
hasDependency(work_item)
→ bool
Returns true if this work item depends on the other work item.
invalidateCache()
Invalidates the file cache of this work item and any downstream dependents. This will cause work items in nodes with the cache mode set to Automatic to recook, even if their cache files are found on disk.
intAttribArray(name)
→ list
of int
Returns the integer attribute array
intAttribValue(name, index=0)
→ int
Returns the integer attribute value at the specified index
lockAttributes()
→ pdg.LockAttributesBlock
Locks this work item’s attributes using a context manager. For the duration
of the context manager it is safe to modify attributes on the work item.
Note that this method should not be called from within a PDG node callback,
such as onGenerate or onPartition. The node will already ensure that the
callback can safely access all of the workitems.
For example:
with item.lockAttributes(): item.setIntAttrib("example", 10)
loopBegin(int)
→ pdg.WorkItem
Returns the loop begin parent item at the given loop depth, or None if
this item is not in a loop or the depth is out of bounds.
makeActive()
→ pdg.ActiveItemBlock
Makes this work item active for parameter evaluation, using a Python context
manager. All parameters evaluated during the lifetime of the context manager
block will use this work item when computing @attribute or pdgattribute
function values. For example:
with item.makeActive(): val = item.node["parm"].evaluateString()
numericAttribute(str)
→ int
or float
Returns a attribute value for a given attribute string. This can be
either an attribute name like foo, or a name and a component suffix like
foo.x or foo.2.
This method is deprecated. Look up the attribute using item.attrib(name)
and call attrib.asString() instead.
pyObjectAttribValue(name) ->
object`
Returns the Python object stored on the specified attribute.
removeEventHandler(handler)
Removes an event handler from the work item.
removeAllEventHandlers()
Removes all event handlers from the work item.
renameAttrib(src_name, dst_name, overwrite_existing=False)
→ bool
Renames the attribute with src_name to dst_name.
resultDataForTag(tag)
→ array
of pdg.File
Returns the result data entries for a specified tag. The results are returned as a pdg.File objects.
serializeData()
→ str
Serializes the work item’s data to a string.
serializeDataToFile(filepath)
Serializes the work item’s data to a file.
setAttribFlag(name, flag, set)
Sets or clears the pdg.attribFlag on the specified attribute.
setCommand(command)
Sets the work item’s command value to specified command string.
setFileAttrib(name, value, index=0)
Sets a file attribute value at the specified index. If the attribute does not exist it will be created.
setFileAttrib(name, array)
Sets a file attribute array. If the attribute does not exist it will be created.
setFloatAttrib(name, value, index=0)
Sets an float attribute value at the specified index. If the attribute does not exist it will be created.
setFloatAttrib(name, array)
Sets a float attribute array. If the attribute does not exist it will be created.
setFrame(frame, step=1.0)
Sets the frame, and optional the frame step size, for the work item.
setIntAttrib(name, value, index=0)
Sets an integer attribute value at the specified index. If the attribute does not exist it will be created.
setIntAttrib(name, array)
Sets an integer attribute array. If the attribute does not exist it will be created.
setIsPostCook(is_postcook)
Sets whether or not this work item needs to run the onPostCookTask
callback when it completes cooking. The callback is only run if the node
that owns the work item has an onPostCookTask implementaton defined.
setPyObjectAttrib(name, value)
Sets a Python object attribute value. The attribute will increment the ref count on the object to ensure that it exists for the duration of the attribute itself.
setStringAttrib(name, value, index=0)
Sets a string attribute value at the specified index. If the attribute does not exist it will be created.
setStringAttrib(name, array)
Sets a stringattribute array. If the attribute does not exist it will be created.
stringAttribute(name)
→ str
Looks up a string attribute value on the work item. This can be either a
plain attribute name like foo, or a name and component suffix like
foo.x.
This method is deprecated. Look up the attribute using item.attrib(name)
and call attrib.asString() instead.
stringAttribArray(name) ->
listof
str`
Returns the string attribute array
stringAttribValue(name, index=0) ->
str`
Returns the string attribute value at the specified index.
updateResultData(index, file, tag, checksum, own)
Updates the result data a given index.
baseName
: str
Property
The base name of the work item, not necessarily unique.
batchIndex
: int
Property
If the work item is in a batch, this property contains the items' index within that batch.
batchParent
: pdg.BatchWorkItem
Property
The batch parent if this work item is in a batch, else None.
command
: str
Property
The command string for the work item.
cookDuration
: int
Property
The cook duration performance stat for the work item, if it has cooked.
data
: pdg.WorkItemData
Property
The data object for the work item, which contains it attribute values.
dependencies
: list
of pdg.WorkItem
Property
The list of work items that this work item depends on.
dependents
: list
of pdg.WorkItem
Property
The list of work items that depend on this work item.
dependencyState
: pdg.workItemState
Property
The "worst" cooked dependency state. If all dependencies were cooked
successfully the property will be set to pdg.workItemState.CookedSuccess.
If any dependencies were canceled the dependencyState will be
pdg.workItemState.CookedCancel, unless a dependency failed in which case
the state will be pdg.workItemState.CookedFail.
environment
: dict
of int
, float
, and str
Property
A dictionary mapping variable names to values in the work item’s environment.
expectedInputResultData
: list
of pdg.File
Property
The list of all inputs, including expected files, which are stored as pdg.File objects.
expectedResultData
: list
of pdg.File
Property
The list of expected results for the work item, which are stored as pdg.File objects.
frame
: float
Property
The frame value associated with the work item.
frameStep
: float
Property
The frame step size associated with the work item.
hasFrame
: bool
Property
Set to True if the work item has a frame, else False.
id
: int
Property
The id of the work item, unique within the pdg.GraphContext that contains the item.
index
: index
Property
The sort/ordering index for the work item.
inputResultData
: list
of pdg.File
Property
The list of input results for this work item, e.g the output files collected from all dependencies.
isControl
: bool
Property
Set to True if this work item is an internal control item, else False.
isInProcess
: bool
Property
Set to True if this work item will cook in process instead of spawning
a child process using the active scheduler.
isNoGenerate
: bool
Property
Set to True if this work item will not generate child items in downstream
nodes.
isOutOfProcess
: bool
Property
Set to True if this work item will cook out of process. Note that is
possible for an item to return False for both isInProcess and
isOutOfProcess if that work item does not cook at all. For example, a
work item in an 
Attribute Create TOP node
does not cook, and will therefore return False for both.
isPartition
: bool
Property
Set to True is this work item is a Static or Dynamic partition.
isPostCook
: bool
Property
Set to True if this work item will run the post cook hook after the
beinged marked as completed, else False.
isStatic
: bool
Property
Set to True if the work item is a static, Regular work item.
isSuccessful
: bool
Property
Set to True if the work item in a successful cooked state, either
pdg.workItemState.CookedSuccess or pdg.workItemState.CookedCache.
isUnsuccessful
: bool
Property
Set to True if the work item in a unsuccessful cooked state, either
pdg.workItemState.CookedCancel or pdg.workItemState.CookedFail.
name
: str
Property
The unique name for the work item. Only unique within the pdg.GraphContext.
parent
: pdg.WorkItem
Property
The upstream work item from which this work item was generated.
partitionItems
: list
of pdg.WorkItem
Property
If the work item is a partition, this list contains the work items that the partition depends on. Otherwise, the list is empty.
priority
: int
Property
The priority of the work item, with 0 being the highest priority.
resultData
: list
of pdg.File
Property
The list of result data for the work item, containing tuples of the form.
state
: pdg.workItemState
Property
The current state of the work item.
staticAncestors
: list
of pdg.WorkItem
Property
The static ancestors of the work item, which are nearest upstream static items if this is a dynamic item, or the item itself if the item is static.
type
: pdg.workItemType
Property
The type object that constructed the work item.