File: test_swallow.py

package info (click to toggle)
qtile 0.34.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,004 kB
  • sloc: python: 49,959; ansic: 4,371; xml: 324; sh: 260; makefile: 218
file content (93 lines) | stat: -rw-r--r-- 2,888 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
import pytest

import libqtile
from libqtile import config
from libqtile.backend.x11.core import Core
from libqtile.confreader import Config
from libqtile.lazy import lazy


# Function that increments a counter
@lazy.function
def swallow_inc(qtile):
    qtile.test_data += 1
    return True


# Config with multiple keys and swallow parameters
class SwallowConfig(Config):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        @libqtile.hook.subscribe.startup
        def _():
            libqtile.qtile.test_data = 0

    keys = [
        config.Key(
            ["control"],
            "k",
            swallow_inc(),
        ),
        config.Key(["control"], "j", swallow_inc(), swallow=False),
        config.Key(["control"], "i", swallow_inc().when(layout="idonotexist")),
        config.Key(
            ["control"],
            "o",
            swallow_inc().when(layout="idonotexist"),
            swallow_inc(),
        ),
    ]


# Helper to send process_key_event to the core manager
# It also looks up the keysym and mask to pass to it
def send_process_key_event(manager, key):
    keysym, mask = Core.lookup_key(None, key)
    output = manager.c.eval(f"self.process_key_event({keysym}, {mask})[1]")
    # Assert if eval successful
    assert output[0]
    # Convert the string to a bool
    return output[1] == "True"


def get_test_counter(manager):
    output = manager.c.eval("self.test_data")
    # Assert if eval successful
    assert output[0]
    return int(output[1])


@pytest.mark.parametrize("manager", [SwallowConfig], indirect=True)
def test_swallow(manager):
    # The first key needs to be True as swallowing is not set here
    # We expect the second key to not be handled, as swallow is set to False
    # The third needs to not be swallowed as the layout .when(...) check does not succeed
    # The fourth needs to be True as one of the functions is executed due to passing the .when(...) check
    expectedexecuted = [True, True, False, True]
    expectedswallow = [True, False, False, True]

    # Loop over all the keys in the config and assert
    prev_counter = 0
    for index, key in enumerate(SwallowConfig.keys):
        assert send_process_key_event(manager, key) == expectedswallow[index]

        # Test if the function was executed like we expected
        counter = get_test_counter(manager)
        if expectedexecuted[index]:
            assert counter > prev_counter
        else:
            assert counter == prev_counter
        prev_counter = counter

    not_used_key = config.Key(
        ["control"],
        "h",
        swallow_inc(),
    )

    # This key is not defined in the config so it should not be handled
    assert not send_process_key_event(manager, not_used_key)

    # This key is not defined so test data is not incremented
    assert get_test_counter(manager) == prev_counter