File: __init__.py

package info (click to toggle)
pygame 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,624 kB
  • sloc: ansic: 66,926; python: 48,742; javascript: 1,153; objc: 224; sh: 121; makefile: 59; cpp: 25
file content (201 lines) | stat: -rw-r--r-- 4,429 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
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
import os
import pygame
import sys
import tempfile
import time

is_pygame_pkg = __name__.startswith("pygame.tests.")

###############################################################################


def tostring(row):
    """Convert row of bytes to string.  Expects `row` to be an
    ``array``.
    """
    return row.tobytes()


def geterror():
    return sys.exc_info()[1]


###############################################################################

this_dir = os.path.dirname(os.path.abspath(__file__))
trunk_dir = os.path.split(os.path.split(this_dir)[0])[0]
if is_pygame_pkg:
    test_module = "tests"
else:
    test_module = "test"


def trunk_relative_path(relative):
    return os.path.normpath(os.path.join(trunk_dir, relative))


def fixture_path(path):
    return trunk_relative_path(os.path.join(test_module, "fixtures", path))


def example_path(path):
    return trunk_relative_path(os.path.join("examples", path))


sys.path.insert(0, trunk_relative_path("."))


################################## TEMP FILES #################################


def get_tmp_dir():
    return tempfile.mkdtemp()


###############################################################################


def question(q):
    return input(f"\n{q.rstrip(' ')} (y/n): ").lower().strip() == "y"


def prompt(p):
    return input(f"\n{p.rstrip(' ')} (press enter to continue): ")


#################################### HELPERS ##################################


def rgba_between(value, minimum=0, maximum=255):
    if value < minimum:
        return minimum
    elif value > maximum:
        return maximum
    else:
        return value


def combinations(seqs):
    """

    Recipe 496807 from ActiveState Python CookBook

    Non recursive technique for getting all possible combinations of a sequence
    of sequences.

    """

    r = [[]]
    for x in seqs:
        r = [i + [y] for y in x for i in r]
    return r


def gradient(width, height):
    """

    Yields a pt and corresponding RGBA tuple, for every (width, height) combo.
    Useful for generating gradients.

    Actual gradient may be changed, no tests rely on specific values.

    Used in transform.rotate lossless tests to generate a fixture.

    """

    for l in range(width):
        for t in range(height):
            yield (l, t), tuple(map(rgba_between, (l, t, l, l + t)))


def rect_area_pts(rect):
    for l in range(rect.left, rect.right):
        for t in range(rect.top, rect.bottom):
            yield l, t


def rect_perimeter_pts(rect):
    """

    Returns pts ((L, T) tuples) encompassing the perimeter of a rect.

    The order is clockwise:

          topleft to topright
         topright to bottomright
      bottomright to bottomleft
       bottomleft to topleft

    Duplicate pts are not returned

    """
    clock_wise_from_top_left = (
        [(l, rect.top) for l in range(rect.left, rect.right)],
        [(rect.right - 1, t) for t in range(rect.top + 1, rect.bottom)],
        [(l, rect.bottom - 1) for l in range(rect.right - 2, rect.left - 1, -1)],
        [(rect.left, t) for t in range(rect.bottom - 2, rect.top, -1)],
    )

    for line in clock_wise_from_top_left:
        yield from line


def rect_outer_bounds(rect):
    """

     Returns topleft outerbound if possible and then the other pts, that are
     "exclusive" bounds of the rect

    ?------O
     |RECT|      ?|0)uterbound
     |----|
    O      O

    """
    return ([(rect.left - 1, rect.top)] if rect.left else []) + [
        rect.topright,
        rect.bottomleft,
        rect.bottomright,
    ]


def import_submodule(module):
    m = __import__(module)
    for n in module.split(".")[1:]:
        m = getattr(m, n)
    return m


class SurfaceSubclass(pygame.Surface):
    """A subclassed Surface to test inheritance."""

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.test_attribute = True


def test():
    """

    Lightweight test for helpers

    """

    r = pygame.Rect(0, 0, 10, 10)
    assert rect_outer_bounds(r) == [(10, 0), (0, 10), (10, 10)]  # tr # bl # br

    assert len(list(rect_area_pts(r))) == 100

    r = pygame.Rect(0, 0, 3, 3)
    assert list(rect_perimeter_pts(r)) == [
        (0, 0),
        (1, 0),
        (2, 0),  # tl -> tr
        (2, 1),
        (2, 2),  # tr -> br
        (1, 2),
        (0, 2),  # br -> bl
        (0, 1),  # bl -> tl
    ]

    print("Tests: OK")