Lib/test/test_tkinter/support.py

import functools
import time
import tkinter
import unittest
from test import support


def setUpModule():
    wantobjects = support.get_resource_value('wantobjects')
    if wantobjects is not None:
        unittest.enterModuleContext(
            support.swap_attr(tkinter, 'wantobjects', int(wantobjects)))

class AbstractTkTest:

    @classmethod
    def setUpClass(cls):
        cls._old_support_default_root = tkinter._support_default_root
        destroy_default_root()
        tkinter.NoDefaultRoot()
        cls.root = tkinter.Tk()
        cls.wantobjects = cls.root.wantobjects()
        if support.is_resource_enabled('wantobjects'):
            assert cls.wantobjects == int(support.get_resource_value('wantobjects'))
        # De-maximize main window.
        # Some window managers can maximize new windows.
        cls.root.wm_state('normal')
        try:
            cls.root.wm_attributes(zoomed=False)
        except tkinter.TclError:
            pass

    @classmethod
    def tearDownClass(cls):
        cls.root.update_idletasks()
        cls.root.destroy()
        del cls.root
        tkinter._default_root = None
        tkinter._support_default_root = cls._old_support_default_root

    def setUp(self):
        self.root.deiconify()

    def tearDown(self):
        for w in self.root.winfo_children():
            w.destroy()
        self.root.withdraw()

    def require_mapped(self, widget, timeout=None):
        """Realize *widget*, or skip the test if the window manager will
        not map it (e.g. a tiling WM or a headless/contended display).

        Use this instead of a bare update() before querying realized
        geometry (winfo_width(), identify(), coords(), place_info(), ...).
        See gh-69134, gh-74941 and bpo-40722.
        """
        if timeout is None:
            timeout = support.LOOPBACK_TIMEOUT
        if not wait_until_mapped(widget, timeout):
            self.skipTest('widget was not mapped by the window manager '
                          f'(timed out after {timeout:g}s)')


class AbstractDialogTest(AbstractTkTest):
    # Tk delivers generated keyboard events to the focused window.  Hide the
    # root window, otherwise the window manager can take the focus back from
    # the dialog (gh-154357).

    def setUp(self):
        super().setUp()
        self.root.withdraw()


class AbstractDefaultRootTest:

    def setUp(self):
        self._old_support_default_root = tkinter._support_default_root
        destroy_default_root()
        tkinter._support_default_root = True
        self.wantobjects = tkinter.wantobjects

    def tearDown(self):
        destroy_default_root()
        tkinter._default_root = None
        tkinter._support_default_root = self._old_support_default_root

    def _test_widget(self, constructor):
        # no master passing
        x = constructor()
        self.assertIsNotNone(tkinter._default_root)
        self.assertIs(x.master, tkinter._default_root)
        self.assertIs(x.tk, tkinter._default_root.tk)
        x.destroy()
        destroy_default_root()
        tkinter.NoDefaultRoot()
        self.assertRaises(RuntimeError, constructor)
        self.assertNotHasAttr(tkinter, '_default_root')


def destroy_default_root():
    if getattr(tkinter, '_default_root', None):
        tkinter._default_root.update_idletasks()
        tkinter._default_root.destroy()
        tkinter._default_root = None

def wait_until_mapped(widget, timeout=None, *, full_size=False):
    """Wait until *widget* is actually mapped and laid out by the window
    manager, so that realized-geometry queries (winfo_width(), identify(),
    coords(), ...) return meaningful values.

    Return True once the widget is mapped with a non-trivial size, or False
    if that has not happened within *timeout* seconds (default:
    ``support.LOOPBACK_TIMEOUT``).  Unlike Misc.wait_visibility(), this
    never blocks indefinitely, so it is safe under a window manager that
    never maps the window (see gh-69134, gh-74941, bpo-40722).

    If *full_size* is true, also wait until the realized size reaches the
    requested size, so that per-pixel queries near an edge (e.g. identify())
    are reliable even under load.
    """
    if timeout is None:
        timeout = support.LOOPBACK_TIMEOUT
    deadline = time.monotonic() + timeout
    widget.update_idletasks()
    reset = False
    while True:
        widget.update()  # drain pending Map/Configure events
        if widget.winfo_ismapped():
            if full_size:
                w_ok = widget.winfo_width() >= widget.winfo_reqwidth() > 1
                h_ok = widget.winfo_height() >= widget.winfo_reqheight() > 1
            else:
                w_ok = widget.winfo_width() > 1
                h_ok = widget.winfo_height() > 1
            if w_ok and h_ok:
                return True
            if full_size and not reset:
                # Tk no longer resizes the toplevel to fit its content if
                # the window manager has resized it.  Undo this.
                widget.winfo_toplevel().wm_geometry('')
                reset = True
        if time.monotonic() >= deadline:
            return False
        time.sleep(0.01)


def simulate_mouse_click(widget, x, y):
    """Generate proper events to click at the x, y position (tries to act
    like an X server)."""
    widget.event_generate('<Enter>', x=0, y=0)
    widget.event_generate('<Motion>', x=x, y=y)
    widget.event_generate('<ButtonPress-1>', x=x, y=y)
    widget.event_generate('<ButtonRelease-1>', x=x, y=y)


import _tkinter
tcl_version = tuple(map(int, _tkinter.TCL_VERSION.split('.')))
tk_version = tuple(map(int, _tkinter.TK_VERSION.split('.')))

def requires_tk(*version):
    if len(version) <= 2 and tk_version >= version:
        return lambda test: test

    def deco(test):
        @functools.wraps(test)
        def newtest(self):
            root = getattr(self, 'root', None)
            if get_tk_patchlevel(root) < version:
                self.skipTest('requires Tk version >= ' +
                                '.'.join(map(str, version)))
            test(self)
        return newtest
    return deco

_tk_patchlevel = None
def get_tk_patchlevel(root):
    global _tk_patchlevel
    if _tk_patchlevel is None:
        _tk_patchlevel = tkinter._parse_version(root.tk.globalgetvar('tk_patchLevel'))
    return _tk_patchlevel

units = {
    'c': 72 / 2.54,     # centimeters
    'i': 72,            # inches
    'm': 72 / 25.4,     # millimeters
    'p': 1,             # points
}

def pixels_conv(value):
    return float(value[:-1]) * units[value[-1:]]

def tcl_obj_eq(actual, expected):
    if actual == expected:
        return True
    if isinstance(actual, _tkinter.Tcl_Obj):
        if isinstance(expected, str):
            return str(actual) == expected
    if isinstance(actual, tuple):
        if isinstance(expected, tuple):
            return (len(actual) == len(expected) and
                    all(tcl_obj_eq(act, exp)
                        for act, exp in zip(actual, expected)))
    return False

def widget_eq(actual, expected):
    if actual == expected:
        return True
    if isinstance(actual, (str, tkinter.Widget)):
        if isinstance(expected, (str, tkinter.Widget)):
            return str(actual) == str(expected)
    return False