console_panel

console_panel#

Classes#

MessageLevel

Create a collection of name/value pairs.

ConsolePanel

Console panel to show information / errors.

Console

Non-interactable console widget.

Module Contents#

class console_panel.MessageLevel(*args, **kwds)#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
<Color.RED: 1>

  • value lookup:

    >>> Color(1)
<Color.RED: 1>

  • name lookup:

    >>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

INFO#
SUCCESS#
WARNING#
ERROR#
class console_panel.ConsolePanel(name='Console', parent=None, **kwargs)#

Bases: spark.graph_editor.widgets.dock_panel.QDockPanel

Console panel to show information / errors.

Parameters:

  • name (str)

  • parent (PySide6.QtWidgets.QWidget)

console#
clear()#
Return type:

None

publish_message(level, message)#
Parameters:
Return type:

None

class console_panel.Console(parent=None)#

Bases: PySide6.QtWidgets.QWidget

Non-interactable console widget.

content#
vscrollbar#
add_message(level, text)#

Add a message to the console.

Parameters:
Return type:

None

info(text)#
Parameters:

text (str)

Return type:

None

success(text)#
Parameters:

text (str)

Return type:

None

warning(text)#
Parameters:

text (str)

Return type:

None

error(text)#
Parameters:

text (str)

Return type:

None

clear()#

Remove all messages from the console.

Return type:

None

scrollToBottom(minimum, maximum)#
Contents