459 lines
9.8 KiB
Python
459 lines
9.8 KiB
Python
|
import unittest
|
||
|
|
import pygame.constants
|
||
|
|
|
||
|
|
|
||
|
|
SDL2 = pygame.get_sdl_version()[0] >= 2
|
||
|
|
|
||
|
|
|
||
|
|
# K_* and KSCAN_* common names.
|
||
|
|
K_AND_KSCAN_COMMON_NAMES = (
|
||
|
|
"UNKNOWN",
|
||
|
|
"BACKSPACE",
|
||
|
|
"TAB",
|
||
|
|
"CLEAR",
|
||
|
|
"RETURN",
|
||
|
|
"PAUSE",
|
||
|
|
"ESCAPE",
|
||
|
|
"SPACE",
|
||
|
|
"COMMA",
|
||
|
|
"MINUS",
|
||
|
|
"PERIOD",
|
||
|
|
"SLASH",
|
||
|
|
"0",
|
||
|
|
"1",
|
||
|
|
"2",
|
||
|
|
"3",
|
||
|
|
"4",
|
||
|
|
"5",
|
||
|
|
"6",
|
||
|
|
"7",
|
||
|
|
"8",
|
||
|
|
"9",
|
||
|
|
"SEMICOLON",
|
||
|
|
"EQUALS",
|
||
|
|
"LEFTBRACKET",
|
||
|
|
"BACKSLASH",
|
||
|
|
"RIGHTBRACKET",
|
||
|
|
"DELETE",
|
||
|
|
"KP0",
|
||
|
|
"KP1",
|
||
|
|
"KP2",
|
||
|
|
"KP3",
|
||
|
|
"KP4",
|
||
|
|
"KP5",
|
||
|
|
"KP6",
|
||
|
|
"KP7",
|
||
|
|
"KP8",
|
||
|
|
"KP9",
|
||
|
|
"KP_PERIOD",
|
||
|
|
"KP_DIVIDE",
|
||
|
|
"KP_MULTIPLY",
|
||
|
|
"KP_MINUS",
|
||
|
|
"KP_PLUS",
|
||
|
|
"KP_ENTER",
|
||
|
|
"KP_EQUALS",
|
||
|
|
"UP",
|
||
|
|
"DOWN",
|
||
|
|
"RIGHT",
|
||
|
|
"LEFT",
|
||
|
|
"INSERT",
|
||
|
|
"HOME",
|
||
|
|
"END",
|
||
|
|
"PAGEUP",
|
||
|
|
"PAGEDOWN",
|
||
|
|
"F1",
|
||
|
|
"F2",
|
||
|
|
"F3",
|
||
|
|
"F4",
|
||
|
|
"F5",
|
||
|
|
"F6",
|
||
|
|
"F7",
|
||
|
|
"F8",
|
||
|
|
"F9",
|
||
|
|
"F10",
|
||
|
|
"F11",
|
||
|
|
"F12",
|
||
|
|
"F13",
|
||
|
|
"F14",
|
||
|
|
"F15",
|
||
|
|
"NUMLOCK",
|
||
|
|
"CAPSLOCK",
|
||
|
|
"SCROLLOCK",
|
||
|
|
"RSHIFT",
|
||
|
|
"LSHIFT",
|
||
|
|
"RCTRL",
|
||
|
|
"LCTRL",
|
||
|
|
"RALT",
|
||
|
|
"LALT",
|
||
|
|
"RMETA",
|
||
|
|
"LMETA",
|
||
|
|
"LSUPER",
|
||
|
|
"RSUPER",
|
||
|
|
"MODE",
|
||
|
|
"HELP",
|
||
|
|
"PRINT",
|
||
|
|
"SYSREQ",
|
||
|
|
"BREAK",
|
||
|
|
"MENU",
|
||
|
|
"POWER",
|
||
|
|
"EURO",
|
||
|
|
)
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
K_AND_KSCAN_COMMON_NAMES += (
|
||
|
|
"KP_0",
|
||
|
|
"KP_1",
|
||
|
|
"KP_2",
|
||
|
|
"KP_3",
|
||
|
|
"KP_4",
|
||
|
|
"KP_5",
|
||
|
|
"KP_6",
|
||
|
|
"KP_7",
|
||
|
|
"KP_8",
|
||
|
|
"KP_9",
|
||
|
|
"NUMLOCKCLEAR",
|
||
|
|
"SCROLLLOCK",
|
||
|
|
"RGUI",
|
||
|
|
"LGUI",
|
||
|
|
"PRINTSCREEN",
|
||
|
|
"CURRENCYUNIT",
|
||
|
|
"CURRENCYSUBUNIT",
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
# Constants that have the same value.
|
||
|
|
K_AND_KSCAN_COMMON_OVERLAPS = ()
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
K_AND_KSCAN_COMMON_OVERLAPS += (
|
||
|
|
("KP0", "KP_0"),
|
||
|
|
("KP1", "KP_1"),
|
||
|
|
("KP2", "KP_2"),
|
||
|
|
("KP3", "KP_3"),
|
||
|
|
("KP4", "KP_4"),
|
||
|
|
("KP5", "KP_5"),
|
||
|
|
("KP6", "KP_6"),
|
||
|
|
("KP7", "KP_7"),
|
||
|
|
("KP8", "KP_8"),
|
||
|
|
("KP9", "KP_9"),
|
||
|
|
("NUMLOCK", "NUMLOCKCLEAR"),
|
||
|
|
("SCROLLOCK", "SCROLLLOCK"),
|
||
|
|
("LSUPER", "LMETA", "LGUI"),
|
||
|
|
("RSUPER", "RMETA", "RGUI"),
|
||
|
|
("PRINT", "PRINTSCREEN"),
|
||
|
|
("BREAK", "PAUSE"),
|
||
|
|
("EURO", "CURRENCYUNIT"),
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
def create_overlap_set(constant_names):
|
||
|
|
"""Helper function to find overlapping constant values/names.
|
||
|
|
|
||
|
|
Returns a set of fronzensets:
|
||
|
|
set(frozenset(names of overlapping constants), ...)
|
||
|
|
"""
|
||
|
|
# Create an overlap dict.
|
||
|
|
overlap_dict = {}
|
||
|
|
|
||
|
|
for name in constant_names:
|
||
|
|
value = getattr(pygame.constants, name)
|
||
|
|
overlap_dict.setdefault(value, set()).add(name)
|
||
|
|
|
||
|
|
# Get all entries with more than 1 value.
|
||
|
|
overlaps = set()
|
||
|
|
|
||
|
|
for overlap_names in overlap_dict.values():
|
||
|
|
if len(overlap_names) > 1:
|
||
|
|
overlaps.add(frozenset(overlap_names))
|
||
|
|
|
||
|
|
return overlaps
|
||
|
|
|
||
|
|
|
||
|
|
class KConstantsTests(unittest.TestCase):
|
||
|
|
"""Test K_* (key) constants."""
|
||
|
|
|
||
|
|
# K_* specific names.
|
||
|
|
K_SPECIFIC_NAMES = (
|
||
|
|
"a",
|
||
|
|
"b",
|
||
|
|
"c",
|
||
|
|
"d",
|
||
|
|
"e",
|
||
|
|
"f",
|
||
|
|
"g",
|
||
|
|
"h",
|
||
|
|
"i",
|
||
|
|
"j",
|
||
|
|
"k",
|
||
|
|
"l",
|
||
|
|
"m",
|
||
|
|
"n",
|
||
|
|
"o",
|
||
|
|
"p",
|
||
|
|
"q",
|
||
|
|
"r",
|
||
|
|
"s",
|
||
|
|
"t",
|
||
|
|
"u",
|
||
|
|
"v",
|
||
|
|
"w",
|
||
|
|
"x",
|
||
|
|
"y",
|
||
|
|
"z",
|
||
|
|
"QUOTE",
|
||
|
|
"BACKQUOTE",
|
||
|
|
"EXCLAIM",
|
||
|
|
"QUOTEDBL",
|
||
|
|
"HASH",
|
||
|
|
"DOLLAR",
|
||
|
|
"AMPERSAND",
|
||
|
|
"LEFTPAREN",
|
||
|
|
"RIGHTPAREN",
|
||
|
|
"ASTERISK",
|
||
|
|
"PLUS",
|
||
|
|
"COLON",
|
||
|
|
"LESS",
|
||
|
|
"GREATER",
|
||
|
|
"QUESTION",
|
||
|
|
"AT",
|
||
|
|
"CARET",
|
||
|
|
"UNDERSCORE",
|
||
|
|
)
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
K_SPECIFIC_NAMES += ("PERCENT",)
|
||
|
|
|
||
|
|
# Create a sequence of all the K_* constant names.
|
||
|
|
K_NAMES = tuple("K_" + n for n in K_AND_KSCAN_COMMON_NAMES + K_SPECIFIC_NAMES)
|
||
|
|
|
||
|
|
def test_k__existence(self):
|
||
|
|
"""Ensures K constants exist."""
|
||
|
|
for name in self.K_NAMES:
|
||
|
|
self.assertTrue(
|
||
|
|
hasattr(pygame.constants, name), "missing constant {}".format(name)
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_k__type(self):
|
||
|
|
"""Ensures K constants are the correct type."""
|
||
|
|
for name in self.K_NAMES:
|
||
|
|
value = getattr(pygame.constants, name)
|
||
|
|
|
||
|
|
self.assertIs(type(value), int)
|
||
|
|
|
||
|
|
def test_k__value_overlap(self):
|
||
|
|
"""Ensures no unexpected K constant values overlap."""
|
||
|
|
EXPECTED_OVERLAPS = set(
|
||
|
|
[
|
||
|
|
frozenset(["K_" + n for n in item])
|
||
|
|
for item in K_AND_KSCAN_COMMON_OVERLAPS
|
||
|
|
]
|
||
|
|
)
|
||
|
|
|
||
|
|
overlaps = create_overlap_set(self.K_NAMES)
|
||
|
|
|
||
|
|
self.assertSetEqual(overlaps, EXPECTED_OVERLAPS)
|
||
|
|
|
||
|
|
|
||
|
|
@unittest.skipIf(not SDL2, "requires SDL2")
|
||
|
|
class KscanConstantsTests(unittest.TestCase):
|
||
|
|
"""Test KSCAN_* (scancode) constants."""
|
||
|
|
|
||
|
|
# KSCAN_* specific names.
|
||
|
|
KSCAN_SPECIFIC_NAMES = (
|
||
|
|
"A",
|
||
|
|
"B",
|
||
|
|
"C",
|
||
|
|
"D",
|
||
|
|
"E",
|
||
|
|
"F",
|
||
|
|
"G",
|
||
|
|
"H",
|
||
|
|
"I",
|
||
|
|
"J",
|
||
|
|
"K",
|
||
|
|
"L",
|
||
|
|
"M",
|
||
|
|
"N",
|
||
|
|
"O",
|
||
|
|
"P",
|
||
|
|
"Q",
|
||
|
|
"R",
|
||
|
|
"S",
|
||
|
|
"T",
|
||
|
|
"U",
|
||
|
|
"V",
|
||
|
|
"W",
|
||
|
|
"X",
|
||
|
|
"Y",
|
||
|
|
"Z",
|
||
|
|
"APOSTROPHE",
|
||
|
|
"GRAVE",
|
||
|
|
"INTERNATIONAL1",
|
||
|
|
"INTERNATIONAL2",
|
||
|
|
"INTERNATIONAL3",
|
||
|
|
"INTERNATIONAL4",
|
||
|
|
"INTERNATIONAL5",
|
||
|
|
"INTERNATIONAL6",
|
||
|
|
"INTERNATIONAL7",
|
||
|
|
"INTERNATIONAL8",
|
||
|
|
"INTERNATIONAL9",
|
||
|
|
"LANG1",
|
||
|
|
"LANG2",
|
||
|
|
"LANG3",
|
||
|
|
"LANG4",
|
||
|
|
"LANG5",
|
||
|
|
"LANG6",
|
||
|
|
"LANG7",
|
||
|
|
"LANG8",
|
||
|
|
"LANG9",
|
||
|
|
"NONUSBACKSLASH",
|
||
|
|
"NONUSHASH",
|
||
|
|
)
|
||
|
|
|
||
|
|
# Create a sequence of all the KSCAN_* constant names.
|
||
|
|
KSCAN_NAMES = tuple(
|
||
|
|
"KSCAN_" + n for n in K_AND_KSCAN_COMMON_NAMES + KSCAN_SPECIFIC_NAMES
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_kscan__existence(self):
|
||
|
|
"""Ensures KSCAN constants exist."""
|
||
|
|
for name in self.KSCAN_NAMES:
|
||
|
|
self.assertTrue(
|
||
|
|
hasattr(pygame.constants, name), "missing constant {}".format(name)
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_kscan__type(self):
|
||
|
|
"""Ensures KSCAN constants are the correct type."""
|
||
|
|
for name in self.KSCAN_NAMES:
|
||
|
|
value = getattr(pygame.constants, name)
|
||
|
|
|
||
|
|
self.assertIs(type(value), int)
|
||
|
|
|
||
|
|
def test_kscan__value_overlap(self):
|
||
|
|
"""Ensures no unexpected KSCAN constant values overlap."""
|
||
|
|
EXPECTED_OVERLAPS = set(
|
||
|
|
[
|
||
|
|
frozenset(["KSCAN_" + n for n in item])
|
||
|
|
for item in K_AND_KSCAN_COMMON_OVERLAPS
|
||
|
|
]
|
||
|
|
)
|
||
|
|
|
||
|
|
overlaps = create_overlap_set(self.KSCAN_NAMES)
|
||
|
|
|
||
|
|
self.assertSetEqual(overlaps, EXPECTED_OVERLAPS)
|
||
|
|
|
||
|
|
|
||
|
|
class KmodConstantsTests(unittest.TestCase):
|
||
|
|
"""Test KMOD_* (key modifier) constants."""
|
||
|
|
|
||
|
|
# KMOD_* constant names.
|
||
|
|
KMOD_CONSTANTS = (
|
||
|
|
"KMOD_NONE",
|
||
|
|
"KMOD_LSHIFT",
|
||
|
|
"KMOD_RSHIFT",
|
||
|
|
"KMOD_SHIFT",
|
||
|
|
"KMOD_LCTRL",
|
||
|
|
"KMOD_RCTRL",
|
||
|
|
"KMOD_CTRL",
|
||
|
|
"KMOD_LALT",
|
||
|
|
"KMOD_RALT",
|
||
|
|
"KMOD_ALT",
|
||
|
|
"KMOD_LMETA",
|
||
|
|
"KMOD_RMETA",
|
||
|
|
"KMOD_META",
|
||
|
|
"KMOD_NUM",
|
||
|
|
"KMOD_CAPS",
|
||
|
|
"KMOD_MODE",
|
||
|
|
)
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
KMOD_CONSTANTS += ("KMOD_LGUI", "KMOD_RGUI", "KMOD_GUI")
|
||
|
|
|
||
|
|
def test_kmod__existence(self):
|
||
|
|
"""Ensures KMOD constants exist."""
|
||
|
|
for name in self.KMOD_CONSTANTS:
|
||
|
|
self.assertTrue(
|
||
|
|
hasattr(pygame.constants, name), "missing constant {}".format(name)
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_kmod__type(self):
|
||
|
|
"""Ensures KMOD constants are the correct type."""
|
||
|
|
for name in self.KMOD_CONSTANTS:
|
||
|
|
value = getattr(pygame.constants, name)
|
||
|
|
|
||
|
|
self.assertIs(type(value), int)
|
||
|
|
|
||
|
|
def test_kmod__value_overlap(self):
|
||
|
|
"""Ensures no unexpected KMOD constant values overlap."""
|
||
|
|
# KMODs that have the same values.
|
||
|
|
EXPECTED_OVERLAPS = set()
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
EXPECTED_OVERLAPS.update(
|
||
|
|
[
|
||
|
|
frozenset(["KMOD_LGUI", "KMOD_LMETA"]),
|
||
|
|
frozenset(["KMOD_RGUI", "KMOD_RMETA"]),
|
||
|
|
frozenset(["KMOD_GUI", "KMOD_META"]),
|
||
|
|
]
|
||
|
|
)
|
||
|
|
|
||
|
|
overlaps = create_overlap_set(self.KMOD_CONSTANTS)
|
||
|
|
|
||
|
|
self.assertSetEqual(overlaps, EXPECTED_OVERLAPS)
|
||
|
|
|
||
|
|
def test_kmod__no_bitwise_overlap(self):
|
||
|
|
"""Ensures certain KMOD constants have no overlapping bits."""
|
||
|
|
NO_BITWISE_OVERLAP = (
|
||
|
|
"KMOD_NONE",
|
||
|
|
"KMOD_LSHIFT",
|
||
|
|
"KMOD_RSHIFT",
|
||
|
|
"KMOD_LCTRL",
|
||
|
|
"KMOD_RCTRL",
|
||
|
|
"KMOD_LALT",
|
||
|
|
"KMOD_RALT",
|
||
|
|
"KMOD_LMETA",
|
||
|
|
"KMOD_RMETA",
|
||
|
|
"KMOD_NUM",
|
||
|
|
"KMOD_CAPS",
|
||
|
|
"KMOD_MODE",
|
||
|
|
)
|
||
|
|
|
||
|
|
kmods = 0
|
||
|
|
|
||
|
|
for name in NO_BITWISE_OVERLAP:
|
||
|
|
value = getattr(pygame.constants, name)
|
||
|
|
|
||
|
|
self.assertFalse(kmods & value)
|
||
|
|
|
||
|
|
kmods |= value
|
||
|
|
|
||
|
|
def test_kmod__bitwise_overlap(self):
|
||
|
|
"""Ensures certain KMOD constants have overlapping bits."""
|
||
|
|
# KMODS that are comprised of other KMODs.
|
||
|
|
KMOD_COMPRISED_DICT = {
|
||
|
|
"KMOD_SHIFT": ("KMOD_LSHIFT", "KMOD_RSHIFT"),
|
||
|
|
"KMOD_CTRL": ("KMOD_LCTRL", "KMOD_RCTRL"),
|
||
|
|
"KMOD_ALT": ("KMOD_LALT", "KMOD_RALT"),
|
||
|
|
"KMOD_META": ("KMOD_LMETA", "KMOD_RMETA"),
|
||
|
|
}
|
||
|
|
|
||
|
|
if SDL2:
|
||
|
|
KMOD_COMPRISED_DICT.update({"KMOD_GUI": ("KMOD_LGUI", "KMOD_RGUI")})
|
||
|
|
|
||
|
|
for base_name, seq_names in KMOD_COMPRISED_DICT.items():
|
||
|
|
expected_value = 0 # Reset.
|
||
|
|
|
||
|
|
for name in seq_names:
|
||
|
|
expected_value |= getattr(pygame.constants, name)
|
||
|
|
|
||
|
|
value = getattr(pygame.constants, base_name)
|
||
|
|
|
||
|
|
self.assertEqual(value, expected_value)
|
||
|
|
|
||
|
|
|
||
|
|
################################################################################
|
||
|
|
|
||
|
|
|
||
|
|
if __name__ == "__main__":
|
||
|
|
unittest.main()
|