Documentation

This is a python console panel for use in DCCs with access to a python interpreter that have limited or no support for interacting with said interpreter.

Panel

Once installed, the console is registered as a panel in the DCC and is available in the Shotgun menu. In apps that support embedded Toolkit panels (maya, nuke, houdini), the console will display in a docked panel. When using with older versions of these DCCs or in a DCC that does not support panels, the console will simply be shown as a regular Toolkit dialog.

Editor

The console has an input area for editing python. The input editor includes line numbers, highlights the cursor's current line, and does some basic syntax highlighting. The console attempts to use the palette of the DCC to give it an integrated look and feel.

Output

The output area displays the results of the executed python. Echoing the source python commands is turned on by default and is differentiated in the output by being prefixed with >>>. There is a toggle for turning the echo off. Syntax and Runtime errors are shown in red with a full stack trace for debugging.

Buttons

Output

• Clear - Clear the contents of the output browser.
• Echo - Toggle echoing the executed commands in the output browser.

Input

• Clear - Clear the contents of the editor.
• Open - Open a file in the editor.
• Save - Save the current contents of the editor to a file.
• Execute - Execute the contents of the editor

Globals

Some Shotgun/Toolkit globals are pre-defined in the console, similar to what is available in the Shotgun Engine for the shell.

• Tk API handle is available via the tk variable
• Shotgun API handle is available via the shotgun variable
• The current context is stored in the context variable
• The shell engine can be accessed via the engine variable