debug module
The debug
module provides tools for use with TouchDesigner's builtin debug
statement. It also contains utilities for customizing those statements and building customized debug output. This module is a member of Tdu Module.
You can use the debugControl component in the palette to set up debug
behavior without using Python.
Members
style
→ types.SimpleNamespace
:
A namespace containing information about how to process
debug
statements. This data is not meant to be changed directly. Instead, use the setStyle function below.
Methods
debug(*args)
→ None
:
Print all args and extra debug info (default is DAT and line number) to texport. To change behavior, use the debugControl component or setStyle function (below).
TIP: Usedebug
instead of
setStyle(printStyle=None, showDAT=None, showFunction=None, showLineNo=None, timeStamp=' ', suppress=None, formatOverride=None, functionOverride=None)
→ None
:
Set the style for the built in TD debug function. Any arguments passed as None will leave that feature unchanged.
printStyle
:
'pprint'
=convert non-string args to pprint.pformat(arg, indent=4, sort_dicts=False). Makes lists, dicts, etc. easily readable'pprint_sorted'
=convert non-string args to pprint.pformat(arg, indent=4). Makes lists, dicts, etc. easily readable. Dict keys will be alphabetized'repr'
=convert non-string args to repr(arg)- otherwise, convert non-string args to str(arg)
showDAT
: in debug message, show the DAT where debug was calledshowFunction
: in debug message, show function where debug was calledshowLineNo
: in debug message, show line number where debug was calledsuppress
: if True, suppress (don't print) any debug callstimeStamp
: Python time format code.formatOverride
: overrides the default message that debug prints. You can use {0}, {1}, and {2} for DAT, function, and line numberfunctionOverride
: overrides the builtin TD debug function. This function will be called with all arguments from any debug calls in your project. Set to False to remove override.
debugs(*args)
→ str
:
Return the string that would be printed by the debug function. To change behavior, use the debugControl component or setStyle function (above). This is a utility function for building custom debug systems.
info(*args, stackOffset=0)
→ list
:
Return all args and extra debug info as processed by the debug function. To change behavior, use the debugControl component or setStyle function (above). This is a utility function for building custom debug systems.
TouchDesigner Build: