script_editor_highlighter.py

from maya import OpenMayaUI, cmds
import shiboken2
import logging
try:
    from PySide2 import QtCore, QtGui, QtWidgets
except ImportError:
    from PySide6 import QtCore, QtGui, QtWidgets


def maya_useNewAPI():  # noqa
    pass  # dummy method to tell Maya this plugin uses Maya Python API 2.0


logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)


# TODO : finish implementing python keyword highlighting in stack traces
class PythonSyntaxRules(object):
    keywords = [
        "False",
        "await",
        "else",
        "import",
        "pass",
        "None",
        "break",
        "except",
        "in",
        "raise",
        "True",
        "class",
        "finally",
        "is",
        "return",
        "and",
        "continue",
        "for",
        "lambda",
        "try",
        "as",
        "def",
        "from",
        "nonlocal",
        "while",
        "assert",
        "del",
        "global",
        "not",
        "with",
        "async",
        "elif",
        "if",
        "or",
        "yield",
    ]

    kOrange = QtGui.QColor(255, 80, 0)

    keyword_format = QtGui.QTextCharFormat()
    keyword_format.setForeground(kOrange)

    Rules = []
    # For some reason this doesn't work as a list comprehension and yields an "undefined" for
    # keyword format in the following list comprehension :
    # Rules = [(QtCore.QRegExp(r"((\s){}(\s))".format(keyword)), keyword_format) for keyword in keywords]
    for keyword in keywords:
        Rules.append((QtCore.QRegExp(r"((\s){}(\s))".format(keyword)), keyword_format))


class StdOut_Syntax(QtGui.QSyntaxHighlighter):

    kWhite = QtGui.QColor(200, 200, 200)
    kRed = QtGui.QColor(255, 0, 0)
    kOrange = QtGui.QColor(255, 160, 0)
    kGreen = QtGui.QColor(16, 255, 8)
    kBlue = QtGui.QColor(35, 160, 255)
    kLightBlue = QtGui.QColor(70, 200, 255)

    rx_error = QtCore.QRegExp(r"[Ee][Rr][Rr][Oo][Rr]")
    error_format = QtGui.QTextCharFormat()
    error_format.setForeground(kRed)

    rx_warning = QtCore.QRegExp(r"[Ww][Aa][Rr][Nn][Ii][Nn][Gg]")
    warning_format = QtGui.QTextCharFormat()
    warning_format.setForeground(kOrange)

    rx_debug = QtCore.QRegExp(r"[Dd][Ee][Bb][Uu][Gg]")
    debug_format = QtGui.QTextCharFormat()
    debug_format.setForeground(kLightBlue)

    rx_debug = QtCore.QRegExp(r"[Ss][Uu][Cc][Cc][Ee][Ss]")
    debug_format = QtGui.QTextCharFormat()
    debug_format.setForeground(kGreen)

    rx_traceback_start = QtCore.QRegExp("Traceback \(most recent call last\)")
    traceback_format = QtGui.QTextCharFormat()
    traceback_format.setForeground(kBlue)

    default_format = QtGui.QTextCharFormat()
    default_format.setForeground(kWhite)

    Rules = [
        (rx_debug, debug_format),
        (rx_warning, warning_format),
        (rx_error, error_format),
    ]

    def __init__(self, parent):
        super(StdOut_Syntax, self).__init__(parent)
        self.parent = parent
        self.normal, self.traceback = range(2)

    def highlightBlock(self, t):
        self.setCurrentBlockState(self.normal)
        if self.isTraceback(t):
            self.setFormat(0, len(t), self.traceback_format)
            self.setCurrentBlockState(self.traceback)
        else:
            self.line_formatting(t)

    def line_formatting(self, t):
        for regex, formatting in StdOut_Syntax.Rules:
            i = regex.indexIn(t)
            if i > 0:
                self.setFormat(0, len(t), formatting)

    def isTraceback(self, t):
        return (
            self.previousBlockState() == self.normal
            and self.rx_traceback_start.indexIn(t) > 0
        ) or (self.previousBlockState() == self.traceback and t.startswith("#   "))


def __se_highlight():
    logger.debug("Attaching highlighter")
    i = 1
    while True:
        script_editor_output_name = "cmdScrollFieldReporter{0}".format(i)
        script_editor_output_object = OpenMayaUI.MQtUtil.findControl(script_editor_output_name)
        if not script_editor_output_object:
            break
        script_editor_output_widget = shiboken2.wrapInstance(int(script_editor_output_object), QtWidgets.QTextEdit)
        logger.debug(script_editor_output_widget)
        StdOut_Syntax(script_editor_output_widget.document())
        logger.debug("Done attaching highlighter to : %s" % script_editor_output_widget)
        i += 1


__qt_focus_change_callback = {"cmdScrollFieldReporter": __se_highlight}


def __on_focus_changed(old_widget, new_widget):
    if new_widget:
        widget_name = new_widget.objectName()
        for callback in [
            name for name in __qt_focus_change_callback if widget_name.startswith(name)
        ]:
            __qt_focus_change_callback[callback]()


def setup_highlighter():
    try:
        app = QtWidgets.QApplication.instance()
        app.focusChanged.connect(__on_focus_changed)
        __se_highlight()
    except Exception as exp:
        pass


def initializePlugin(plugin):
    cmds.evalDeferred(setup_highlighter)


def uninitializePlugin(plugin):
    ...# todo