textcanvas 3.8.0

Draw to the terminal like an HTML Canvas.
Documentation 
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

import datetime as dt
import doctest
import time
import unittest
from unittest.mock import Mock

import textcanvas.utils
from textcanvas.textcanvas import TextCanvas
from textcanvas.utils import GameLoop

textcanvas.utils.print = Mock()  # type: ignore


def load_tests(
    loader: unittest.TestLoader, tests: unittest.TestSuite, ignore: str
) -> unittest.TestSuite:
    """Add module doctests."""
    tests.addTests(doctest.DocTestSuite(textcanvas.utils))
    return tests


class TestGameLoop(unittest.TestCase):
    def test_loop_fixed(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop() -> str | None:
            nonlocal i
            i += 1
            if i == 4:
                return None
            canvas.draw_text(f"{i}", i - 1, 0)
            return canvas.to_string()

        GameLoop.loop_fixed(dt.timedelta(milliseconds=1), loop)

        self.assertEqual(canvas.to_string(), "123\n⠀⠀⠀\n")
        self.assertEqual(i, 4)

    def test_loop_fixed_exits_on_none(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop() -> str | None:
            nonlocal i
            i += 1
            if i == 2:
                return None
            canvas.draw_text(f"{i}", 0, 0)
            return canvas.to_string()

        GameLoop.loop_fixed(dt.timedelta(milliseconds=1), loop)

        # First iteration passed.
        self.assertEqual(canvas.to_string(), "1⠀⠀\n⠀⠀⠀\n")
        # Second iteration stopped.
        self.assertEqual(i, 2)

    def test_loop_fixed_exits_on_keyboard_interrupt(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop() -> str | None:
            nonlocal i
            i += 1
            if i == 2:
                raise KeyboardInterrupt
            canvas.draw_text(f"{i}", 0, 0)
            return canvas.to_string()

        GameLoop.loop_fixed(dt.timedelta(milliseconds=1), loop)

        # First iteration passed.
        self.assertEqual(canvas.to_string(), "1⠀⠀\n⠀⠀⠀\n")
        # Second iteration stopped.
        self.assertEqual(i, 2)

    def test_loop_fixed_takes_longer_than_time_step(self) -> None:
        i = 0

        def loop() -> str | None:
            nonlocal i
            i += 1
            if i == 2:
                return None
            # 10ms > 1ms
            time.sleep(dt.timedelta(milliseconds=10).total_seconds())
            return ""

        GameLoop.loop_fixed(dt.timedelta(milliseconds=1), loop)

    def test_loop_variable(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop(_: float) -> str | None:
            nonlocal i
            i += 1
            if i == 4:
                return None
            canvas.draw_text(f"{i}", i - 1, 0)
            return canvas.to_string()

        GameLoop.loop_variable(loop)

        self.assertEqual(canvas.to_string(), "123\n⠀⠀⠀\n")
        self.assertEqual(i, 4)

    def test_loop_variable_exits_on_none(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop(_: float) -> str | None:
            nonlocal i
            i += 1
            if i == 2:
                return None
            canvas.draw_text(f"{i}", 0, 0)
            return canvas.to_string()

        GameLoop.loop_variable(loop)

        # First iteration passed.
        self.assertEqual(canvas.to_string(), "1⠀⠀\n⠀⠀⠀\n")
        # Second iteration stopped.
        self.assertEqual(i, 2)

    def test_loop_variable_exits_on_keyboard_interrupt(self) -> None:
        canvas = TextCanvas(3, 2)

        i = 0

        def loop(_: float) -> str | None:
            nonlocal i
            i += 1
            if i == 2:
                raise KeyboardInterrupt
            canvas.draw_text(f"{i}", 0, 0)
            return canvas.to_string()

        GameLoop.loop_variable(loop)

        # First iteration passed.
        self.assertEqual(canvas.to_string(), "1⠀⠀\n⠀⠀⠀\n")
        # Second iteration stopped.
        self.assertEqual(i, 2)


if __name__ == "__main__":
    unittest.main()