debug

Classes:

• Application –
• DebugMeta –
• EventFilter –
• GraphicsScene –

Functions:

• measure_exec_time_ms –
• print_func_name –
• print_perf_timepoints –
• print_var –
• print_vs_output_colorspace_info –
• profile_cpu –

qevent_info module-attribute

qevent_info = {
    0: ("None", "invalid event"),
    1: ("Timer", "timer event"),
    2: ("MouseButtonPress", "mouse button pressed"),
    3: ("MouseButtonRelease", "mouse button released"),
    4: ("MouseButtonDblClick", "mouse button double click"),
    5: ("MouseMove", "mouse move"),
    6: ("KeyPress", "key pressed"),
    7: ("KeyRelease", "key released"),
    8: ("FocusIn", "keyboard focus received"),
    9: ("FocusOut", "keyboard focus lost"),
    23: ("FocusAboutToChange", "keyboard focus is about to be lost"),
    10: ("Enter", "mouse enters widget"),
    11: ("Leave", "mouse leaves widget"),
    12: ("Paint", "paint widget"),
    13: ("Move", "move widget"),
    14: ("Resize", "resize widget"),
    15: ("Create", "after widget creation"),
    16: ("Destroy", "during widget destruction"),
    17: ("Show", "widget is shown"),
    18: ("Hide", "widget is hidden"),
    19: ("Close", "request to close widget"),
    20: ("Quit", "request to quit application"),
    21: ("ParentChange", "widget has been reparented"),
    131: ("ParentAboutToChange", "sent just before the parent change is done"),
    22: ("ThreadChange", "object has changed threads"),
    24: ("WindowActivate", "window was activated"),
    25: ("WindowDeactivate", "window was deactivated"),
    26: ("ShowToParent", "widget is shown to parent"),
    27: ("HideToParent", "widget is hidden to parent"),
    31: ("Wheel", "wheel event"),
    33: ("WindowTitleChange", "window title changed"),
    34: ("WindowIconChange", "icon changed"),
    35: ("ApplicationWindowIconChange", "application icon changed"),
    36: ("ApplicationFontChange", "application font changed"),
    37: (
        "ApplicationLayoutDirectionChange",
        "application layout direction changed",
    ),
    38: ("ApplicationPaletteChange", "application palette changed"),
    39: ("PaletteChange", "widget palette changed"),
    40: ("Clipboard", "internal clipboard event"),
    42: ("Speech", "reserved for speech input"),
    43: ("MetaCall", "meta call event"),
    50: ("SockAct", "socket activation"),
    132: ("WinEventAct", "win event activation"),
    52: ("DeferredDelete", "deferred delete event"),
    60: ("DragEnter", "drag moves into widget"),
    61: ("DragMove", "drag moves in widget"),
    62: ("DragLeave", "drag leaves or is cancelled"),
    63: ("Drop", "actual drop"),
    64: ("DragResponse", "drag accepted/rejected"),
    68: ("ChildAdded", "new child widget"),
    69: ("ChildPolished", "polished child widget"),
    71: ("ChildRemoved", "deleted child widget"),
    73: ("ShowWindowRequest", "widget's window should be mapped"),
    74: ("PolishRequest", "widget should be polished"),
    75: ("Polish", "widget is polished"),
    76: ("LayoutRequest", "widget should be relayouted"),
    77: ("UpdateRequest", "widget should be repainted"),
    78: ("UpdateLater", "request update() later"),
    79: ("EmbeddingControl", "ActiveX embedding"),
    80: ("ActivateControl", "ActiveX activation"),
    81: ("DeactivateControl", "ActiveX deactivation"),
    82: ("ContextMenu", "context popup menu"),
    83: ("InputMethod", "input method"),
    87: ("TabletMove", "Wacom tablet event"),
    88: ("LocaleChange", "the system locale changed"),
    89: ("LanguageChange", "the application language changed"),
    90: ("LayoutDirectionChange", "the layout direction changed"),
    91: ("Style", "internal style event"),
    92: ("TabletPress", "tablet press"),
    93: ("TabletRelease", "tablet release"),
    94: ("OkRequest", "CE (Ok) button pressed"),
    95: ("HelpRequest", "CE (?)  button pressed"),
    96: ("IconDrag", "proxy icon dragged"),
    97: ("FontChange", "font has changed"),
    98: ("EnabledChange", "enabled state has changed"),
    99: ("ActivationChange", "window activation has changed"),
    100: ("StyleChange", "style has changed"),
    101: ("IconTextChange", "icon text has changed.Deprecated."),
    102: ("ModifiedChange", "modified state has changed"),
    109: ("MouseTrackingChange", "mouse tracking state has changed"),
    103: ("WindowBlocked", "window is about to be blocked modally"),
    104: ("WindowUnblocked", "windows modal blocking has ended"),
    105: ("WindowStateChange", ""),
    106: ("ReadOnlyChange", "readonly state has changed"),
    110: ("ToolTip", ""),
    111: ("WhatsThis", ""),
    112: ("StatusTip", ""),
    113: ("ActionChanged", ""),
    114: ("ActionAdded", ""),
    115: ("ActionRemoved", ""),
    116: ("FileOpen", "file open request"),
    117: ("Shortcut", "shortcut triggered"),
    51: ("ShortcutOverride", "shortcut override request"),
    118: ("WhatsThisClicked", ""),
    120: ("ToolBarChange", "toolbar visibility toggled"),
    121: (
        "ApplicationActivate",
        "deprecated. Use ApplicationStateChange instead.",
    ),
    122: (
        "ApplicationDeactivate",
        "deprecated. Use ApplicationStateChange instead.",
    ),
    123: ("QueryWhatsThis", "query what's this widget help"),
    124: ("EnterWhatsThisMode", ""),
    125: ("LeaveWhatsThisMode", ""),
    126: ("ZOrderChange", "child widget has had its z-order changed"),
    127: ("HoverEnter", "mouse cursor enters a hover widget"),
    128: ("HoverLeave", "mouse cursor leaves a hover widget"),
    129: ("HoverMove", "mouse cursor move inside a hover widget"),
    150: ("EnterEditFocus", "enter edit mode in keypad navigation"),
    151: ("LeaveEditFocus", "enter edit mode in keypad navigation"),
    152: ("AcceptDropsChange", ""),
    154: ("ZeroTimerEvent", "Used for Windows Zero timer events"),
    155: ("GraphicsSceneMouseMove", "GraphicsView"),
    156: ("GraphicsSceneMousePress", ""),
    157: ("GraphicsSceneMouseRelease", ""),
    158: ("GraphicsSceneMouseDoubleClick", ""),
    159: ("GraphicsSceneContextMenu", ""),
    160: ("GraphicsSceneHoverEnter", ""),
    161: ("GraphicsSceneHoverMove", ""),
    162: ("GraphicsSceneHoverLeave", ""),
    163: ("GraphicsSceneHelp", ""),
    164: ("GraphicsSceneDragEnter", ""),
    165: ("GraphicsSceneDragMove", ""),
    166: ("GraphicsSceneDragLeave", ""),
    167: ("GraphicsSceneDrop", ""),
    168: ("GraphicsSceneWheel", ""),
    169: ("KeyboardLayoutChange", "keyboard layout changed"),
    170: (
        "DynamicPropertyChange",
        "A dynamic property was changed through setProperty/property",
    ),
    171: ("TabletEnterProximity", ""),
    172: ("TabletLeaveProximity", ""),
    173: ("NonClientAreaMouseMove", ""),
    174: ("NonClientAreaMouseButtonPress", ""),
    175: ("NonClientAreaMouseButtonRelease", ""),
    176: ("NonClientAreaMouseButtonDblClick", ""),
    177: (
        "MacSizeChange",
        "when the Qt::WA_Mac{Normal,Small,Mini}Size changes",
    ),
    178: (
        "ContentsRectChange",
        "sent by QWidget::setContentsMargins (internal)",
    ),
    179: (
        "MacGLWindowChange",
        "Internal! the window of the GLWidget has changed",
    ),
    180: ("FutureCallOut", ""),
    181: ("GraphicsSceneResize", ""),
    182: ("GraphicsSceneMove", ""),
    183: ("CursorChange", ""),
    184: ("ToolTipChange", ""),
    185: ("NetworkReplyUpdated", "Internal for QNetworkReply"),
    186: ("GrabMouse", ""),
    187: ("UngrabMouse", ""),
    188: ("GrabKeyboard", ""),
    189: ("UngrabKeyboard", ""),
    191: (
        "MacGLClearDrawable",
        "Internal Cocoa, the window has changed, so we must clear",
    ),
    192: ("StateMachineSignal", ""),
    193: ("StateMachineWrapped", ""),
    194: ("TouchBegin", ""),
    195: ("TouchUpdate", ""),
    196: ("TouchEnd", ""),
    197: ("NativeGesture", "QtGui native gesture"),
    199: ("RequestSoftwareInputPanel", ""),
    200: ("CloseSoftwareInputPanel", ""),
    203: ("WinIdChange", ""),
    198: ("Gesture", ""),
    202: ("GestureOverride", ""),
    204: ("ScrollPrepare", ""),
    205: ("Scroll", ""),
    206: ("Expose", ""),
    207: ("InputMethodQuery", ""),
    208: ("OrientationChange", "Screen orientation has changed"),
    209: ("TouchCancel", ""),
    210: ("ThemeChange", ""),
    211: ("SockClose", "socket closed"),
    212: ("PlatformPanel", ""),
    213: ("StyleAnimationUpdate", "style animation target should be updated"),
    214: ("ApplicationStateChange", ""),
    215: ("WindowChangeInternal", "internal for QQuickWidget"),
    216: ("ScreenChangeInternal", ""),
    217: (
        "PlatformSurface",
        "Platform surface created or about to be destroyed",
    ),
    218: ("Pointer", "QQuickPointerEvent; ### Qt 6: QPointerEvent"),
    219: ("TabletTrackingChange", "tablet tracking state has changed"),
    512: ("reserved", "reserved for Qt Jambi's MetaCall event"),
    513: ("reserved", "reserved for Qt Jambi's DeleteOnMainThread event"),
    1000: ("User", "first user event id"),
    65535: ("MaxUser", "last user event id"),
}

Application

Bases: QApplication

Methods:

• notify –

Attributes:

• enter_count –

enter_count class-attribute instance-attribute

enter_count = 0

notify

notify(obj: QObject, event: QEvent) -> bool

Source code

def notify(self, obj: QObject, event: QEvent) -> bool:
    import sys

    isex = False
    try:
        self.enter_count += 1
        ret, time = cast(tuple[bool, float], measure_exec_time_ms(
            QApplication.notify, True, False)(self, obj, event))
        self.enter_count -= 1

        if type(event).__name__ == 'QEvent' and event.type() in qevent_info:
            event_name = qevent_info[event.type()][0]
        else:
            event_name = type(event).__name__

        try:
            obj_name = obj.objectName()
        except RuntimeError:
            obj_name = ''

        if obj_name == '':
            try:
                if obj.parent() is not None and obj.parent().objectName() != '':
                    obj_name = '(parent) ' + obj.parent().objectName()
            except RuntimeError:
                pass

        recursive_indent = 2 * (self.enter_count - 1)

        logging.debug(
            f'{time:7.3f} ms, receiver: {type(obj).__name__:>25}, event: {event.type():3d} '
            f'{" " * recursive_indent + event_name:<30}, name: {obj_name}'
        )

        return ret
    except BaseException:
        isex = True
        logging.error('Application: unexpected error')
        logging.debug(*sys.exc_info())
        return False
    finally:
        if isex:
            self.quit()

DebugMeta

Bases: DebugMetaBase

Methods:

• dummy_method –

dummy_method

dummy_method(name: str, *args: Any, **kwargs: Any) -> Any

Source code

def dummy_method(self, name: str, *args: Any, **kwargs: Any) -> Any:
    method = getattr(super(GraphicsScene, GraphicsScene), name)
    method = measure_exec_time_ms(method)
    return method(self, *args, **kwargs)

DebugMetaBase

Bases: type, wrappertype

EventFilter

EventFilter(main: MainWindow)

Bases: QObject

Methods:

• eventFilter –
• print_toolbars_state –
• run_get_frame_test –

Attributes:

• main –

Source code

def __init__(self, main: MainWindow) -> None:
    super().__init__()
    self.main = main

main instance-attribute

main = main

eventFilter

eventFilter(obj: QObject, event: QEvent) -> bool

Source code

def eventFilter(self, obj: QObject, event: QEvent) -> bool:
    if (event.type() == QEvent.Type.Show):
        logging.debug('--------------------------------')
        logging.debug(f'{obj.objectName()}')
        logging.debug('event:       Show')
        logging.debug(f'spontaneous: {event.spontaneous()}')
        logging.debug('')
        self.print_toolbars_state()
    elif (event.type() == QEvent.Type.Hide):
        logging.debug('--------------------------------')
        logging.debug(f'{obj.objectName()}')
        logging.debug('event:       Hide')
        logging.debug(f'spontaneous: {event.spontaneous()}')
        logging.debug('')
        self.print_toolbars_state()

    # return QObject.eventFilter(object, event)
    return False

print_toolbars_state

print_toolbars_state() -> None

Source code

def print_toolbars_state(self) -> None:
    logging.debug(f'main toolbar:     {self.main.isVisible()}')
    if hasattr(self.main.toolbars, 'playback'):
        logging.debug(f'playback toolbar: {self.main.toolbars.playback.isVisible()}')
    if hasattr(self.main.toolbars, 'scening'):
        logging.debug(f'scening toolbar:  {self.main.toolbars.scening.isVisible()}')
    if hasattr(self.main.toolbars, 'misc'):
        logging.debug(f'misc toolbar:     {self.main.toolbars.misc.isVisible()}')

run_get_frame_test

run_get_frame_test() -> None

Source code

def run_get_frame_test(self) -> None:
    N = 10

    start_frame_async = 1000
    total_async = 0
    for i in range(start_frame_async, start_frame_async + N):
        s1 = perf_counter_ns()
        f1 = self.main.current_output.source.original_clip.get_frame_async(i)
        f1.result()
        s2 = perf_counter_ns()
        logging.debug(f'async test time: {s2 - s1} ns')
        if i != start_frame_async:
            total_async += s2 - s1

    start_frame_sync = 2000
    total_sync = 0

    for i in range(start_frame_sync, start_frame_sync + N):
        s1 = perf_counter_ns()
        self.main.current_output.source.original_clip.get_frame(i)
        s2 = perf_counter_ns()
        if i != start_frame_sync:
            total_sync += s2 - s1

    logging.debug('')
    logging.debug(f'Async average: {total_async / N - 1} ns, {1_000_000_000 / (total_async / N - 1)} fps')
    logging.debug(f'Sync average:  {total_sync  / N - 1} ns, {1_000_000_000 / (total_sync  / N - 1)} fps')

GraphicsScene

Bases: QGraphicsScene

Methods:

• event –

event

event(event: QEvent) -> bool

Source code

def event(self, event: QEvent) -> bool:
    t0 = perf_counter_ns()
    ret = super().event(event)
    t1 = perf_counter_ns()
    interval = t1 - t0
    if interval > 5_000_000:
        logging.debug(self.__class__.__name__ + '.event()')
        logging.debug(f'{interval / 1_000_000}: {event.type()}')

    return ret

measure_exec_time_ms

measure_exec_time_ms(
    func: Callable[..., T],
    return_exec_time: bool = False,
    print_exec_time: bool = True,
) -> Callable[..., T | tuple[T, float]]

Source code

def measure_exec_time_ms(
    func: Callable[..., T], return_exec_time: bool = False, print_exec_time: bool = True
) -> Callable[..., T | tuple[T, float]]:
    @wraps(func)
    def decorator(*args: Any, **kwargs: Any) -> T | tuple[T, float]:
        t1 = perf_counter_ns()
        ret = func(*args, **kwargs)
        t2 = perf_counter_ns()
        exec_time = (t2 - t1) / 1_000_000
        if print_exec_time:
            logging.debug(f'{exec_time:7.3f} ms: {func.__name__}()')
        if return_exec_time:
            return ret, exec_time
        return ret
    return decorator

print_func_name

print_func_name() -> None

Source code

def print_func_name() -> None:
    logging.debug(f'{inspect.stack()[1][3]}()')

print_perf_timepoints

print_perf_timepoints(*args: int) -> None

Source code

def print_perf_timepoints(*args: int) -> None:
    if len(args) < 2:
        raise ValueError('At least 2 timepoints required')
    for i in range(1, len(args)):
        logging.debug(f'{i}: {args[i] - args[i-1]} ns')

print_var

print_var(var: Any) -> None

Source code

def print_var(var: Any) -> None:
    frame = inspect.currentframe()
    assert frame
    assert frame.f_back

    s = inspect.getframeinfo(frame.f_back).code_context
    assert s
    r = re.search(r"\((.*)\)", s[0])
    s = frame = None
    assert r
    logging.debug(f'{r.group(1)}: {var}')

print_vs_output_colorspace_info

print_vs_output_colorspace_info(vs_output: VideoNode) -> None

Source code

def print_vs_output_colorspace_info(vs_output: vs.VideoNode) -> None:
    props = vs_output.get_frame(0).props

    logging.debug('Matrix: {}, Transfer: {}, Primaries: {}, Range: {}'.format(
        Matrix.from_video(props) if '_Matrix' in props else None,
        Transfer.from_video(props) if '_Transfer' in props else None,
        Primaries.from_video(props) if '_Primaries' in props else None,
        ColorRange.from_video(props) if '_ColorRange' in props else None,
    ))

profile_cpu

profile_cpu(func: Callable[..., T]) -> Callable[..., T]

Source code

def profile_cpu(func: Callable[..., T]) -> Callable[..., T]:
    @wraps(func)
    def decorator(*args: Any, **kwargs: Any) -> T:
        from cProfile import Profile
        from pstats import SortKey, Stats

        p = Profile(perf_counter_ns, 0.000_000_001, True, False)
        ret = p.runcall(func, *args, **kwargs)

        s = Stats(p)
        s.sort_stats(SortKey.TIME)
        s.print_stats(10)
        return ret
    return decorator