Trace module#

Summary: The Trace module provides performance tracking utility classes for counting, timing, measuring, recording, and reporting events.

Trace – Utilities for counting and recording events.

Classes:

`AggregateNode`
`Collector`
`Reporter`

Functions:

`TraceFunction`(obj)	A decorator that enables tracing the function that it decorates.
`TraceMethod`(obj)	A convenience.
`TraceScope`(label)	A context manager that calls BeginEvent on the global collector on enter and EndEvent on exit.

class pxr.Trace.AggregateNode#

Attributes:

`children`
`count`
`exclusiveCount`
`exclusiveTime`
`expanded`
`expired`	True if this object has expired, False otherwise.
`id`
`inclusiveTime`
`key`

property children#

property count#

property exclusiveCount#

property exclusiveTime#

property expanded#

property expired#: True if this object has expired, False otherwise.

property id#

property inclusiveTime#

property key#

class pxr.Trace.Collector#

Methods:

`BeginEvent`
`BeginEventAtTime`
`Clear`
`EndEvent`
`EndEventAtTime`
`GetLabel`

Attributes:

`enabled`
`expired`	True if this object has expired, False otherwise.
`pythonTracingEnabled`

BeginEvent()#

BeginEventAtTime()#

Clear()#

EndEvent()#

EndEventAtTime()#

GetLabel()#

property enabled#

property expired#: True if this object has expired, False otherwise.

property pythonTracingEnabled#

class pxr.Trace.Reporter#

Methods:

`ClearTree`
`GetLabel`
`Report`
`ReportChromeTracing`
`ReportChromeTracingToFile`
`ReportTimes`
`UpdateTraceTrees`

Attributes:

`aggregateTreeRoot`
`expired`	True if this object has expired, False otherwise.
`foldRecursiveCalls`
`globalReporter`
`groupByFunction`
`shouldAdjustForOverheadAndNoise`

ClearTree()#

GetLabel()#

Report()#

ReportChromeTracing()#

ReportChromeTracingToFile()#

ReportTimes()#

UpdateTraceTrees()#

property aggregateTreeRoot#

property expired#: True if this object has expired, False otherwise.

property foldRecursiveCalls#

globalReporter = <pxr.Trace.Reporter object>#

property groupByFunction#

property shouldAdjustForOverheadAndNoise#

pxr.Trace.TraceFunction(obj)#: A decorator that enables tracing the function that it decorates. If you decorate with ‘TraceFunction’ the function will be traced in the global collector.

pxr.Trace.TraceMethod(obj)#: A convenience. Same as TraceFunction but changes the recorded label to use the term ‘method’ rather than ‘function’.

pxr.Trace.TraceScope(label)#: A context manager that calls BeginEvent on the global collector on enter and EndEvent on exit.