Differential D4286 Diff 13458 tests/python/event_simulate/modules/easy_keys.py

Changeset View

Standalone View

tests/python/event_simulate/modules/easy_keys.py

This file was added.

				# Apache License, Version 2.0
				brechtUnsubmitted Not Done Inline Actions Maybe name this `simulator.py` instead of `easy_keys.py`? brecht: Maybe name this `simulator.py` instead of `easy_keys.py`?
				campbellbartonAuthorUnsubmitted Done Inline Actions It's still called easy_keys, but it's just part of the tests in SVN, dont have strong opinion, it's just helper module, not something more general for the moment. Could rename `event_simulator_helper.py` campbellbarton: It's still called easy_keys, but it's just part of the tests in SVN, dont have strong opinion…

				import bpy
				event_types = tuple(
				e.identifier.lower()
				for e in bpy.types.Event.bl_rna.properties["type"].enum_items_static
				)
				del bpy

				# We don't normally care about which one.
				event_types_alias = {
				"ctrl": "left_ctrl",
				"shift": "left_shift",
				"alt": "left_alt",
				}

				import string

				# TODO, there are a few more we could add
				event_types_text = (
				('ZERO', "0", False),
				('ONE', "1", False),
				('TWO', "2", False),
				('THREE', "3", False),
				('FOUR', "4", False),
				('FIVE', "5", False),
				('SIX', "6", False),
				('SEVEN', "7", False),
				('EIGHT', "8", False),
				('NINE', "9", False),

				('ZERO', "=", True),
				('ONE', "!", True),
				('TWO', "@", True),
				('THREE', "#", True),
				('FOUR', "$", True),
				('FIVE', "%", True),
				('SIX', "^", True),
				('SEVEN', "&", True),
				('EIGHT', "*", True),
				('NINE', "-", True),

				('ACCENT_GRAVE', "`", False),
				('ACCENT_GRAVE', "~", True),

				('SEMI_COLON', ";", False),
				('SEMI_COLON', ":", True),

				('PERIOD', ".", False),
				('PERIOD', ">", True),

				('COMMA', ",", False),
				('COMMA', "<", True),

				('QUOTE', "'", False),
				('QUOTE', '"', True),

				('MINUS', "-", False),
				('MINUS', "_", True),

				('SLASH', "/", False),
				('SLASH', "?", True),

				('BACK_SLASH', "\\", False),
				('BACK_SLASH', "\|", True),

				('EQUAL', "=", False),
				('EQUAL', "+", True),

				*((ch_upper, ch, False) for (ch_upper, ch) in zip(string.ascii_uppercase, string.ascii_lowercase)),
				*((ch, ch, True) for ch in string.ascii_uppercase),

				('SPACE', " ", False),
				)

				event_types_text_from_char = {ch: (ty, is_shift) for (ty, ch, is_shift) in event_types_text}
				event_types_text_from_event = {(ty, is_shift): ch for (ty, ch, is_shift) in event_types_text}


				class _EventBuilder:
				__slots__ = (
				"_event_gen",
				"_ty",
				"_parent",
				)
				def __init__(self, event_gen, ty):
				self._event_gen = event_gen
				self._ty = ty
				brechtUnsubmitted Done Inline Actions `ty` -> `event_type` would be more clear brecht: `ty` -> `event_type` would be more clear
				self._parent = None

				def __call__(self, count=1):
				for _ in range(count):
				self.tap()
				return self._event_gen

				def _key_press_release(self, do_press=False, do_release=False):
				assert(do_press or do_release)
				build_keys = []
				e = self
				while e is not None:
				build_keys.append(e._ty.upper())
				e = e._parent
				build_keys.reverse()

				ty_pressed = set()
				events = [None, None]
				for i, value in enumerate(('PRESS', 'RELEASE')):
				if value == 'RELEASE':
				build_keys.reverse()
				for ty in build_keys:
				if value == 'PRESS':
				ty_pressed.add(ty)
				else:
				ty_pressed.remove(ty)

				if (not do_press) and value == 'PRESS':
				continue
				if (not do_release) and value == 'RELEASE':
				continue

				shift = 'LEFT_SHIFT' in ty_pressed or 'RIGHT_SHIFT' in ty_pressed
				ctrl = 'LEFT_CTRL' in ty_pressed or 'RIGHT_CTRL' in ty_pressed
				shift = 'LEFT_SHIFT' in ty_pressed or 'RIGHT_SHIFT' in ty_pressed
				alt = 'LEFT_ALT' in ty_pressed or 'RIGHT_ALT' in ty_pressed
				oskey = 'OSKEY' in ty_pressed

				unicode = None
				if value == 'PRESS':
				if ctrl is False and alt is False and oskey is False:
				unicode = event_types_text_from_event.get((ty, shift))
				if unicode is None and shift:
				# Some keys don't care about shift
				unicode = event_types_text_from_event.get((ty, False))

				event = self._event_gen._window.event_simulate(
				type=ty,
				value=value,
				unicode=unicode,
				shift=shift,
				ctrl=ctrl,
				alt=alt,
				oskey=oskey,
				# typically mouse coords.
				**self._event_gen._event_simulate_kw,
				)
				events[i] = event
				return tuple(events)

				def tap(self):
				return self._key_press_release(do_press=True, do_release=True)

				def press(self):
				return self._key_press_release(do_press=True)[0]

				def release(self):
				return self._key_press_release(do_release=True)[1]

				def cursor_motion(self, coords):
				coords = list(coords)
				self._event_gen.cursor_position_set(*coords[0], move=True)
				yield

				event = self.press()
				shift = event.shift
				ctrl = event.ctrl
				shift = event.shift
				alt = event.alt
				oskey = event.oskey
				yield

				for x, y in coords:
				self._event_gen._window.event_simulate(
				type='MOUSEMOVE',
				value='NOTHING',
				unicode=None,
				shift=shift,
				ctrl=ctrl,
				alt=alt,
				oskey=oskey,
				x=x,
				y=y
				)
				yield
				self._event_gen.cursor_position_set(x, y, move=False)
				self.release()
				yield

				def __getattr__(self, attr):
				attr = event_types_alias.get(attr, attr)
				if attr in event_types:
				e = _EventBuilder(self._event_gen, attr)
				e._parent = self
				return e
				raise Exception(f"{attr!r} not found in {event_types!r}")


				class EventGenerate:
				__slots__ = (
				"_window",
				"_event_simulate_kw",
				)
				def __init__(self, window):
				self._window = window
				self._event_simulate_kw = {}

				self.cursor_position_set(window.width // 2, window.height // 2)

				def cursor_position_set(self, x, y, move=False):
				self._event_simulate_kw["x"] = x
				self._event_simulate_kw["y"] = y
				if move:
				self._window.event_simulate(
				type='MOUSEMOVE',
				value='NOTHING',
				x=x,
				y=y,
				)

				def text(self, text):
				""" Type in entire phrases. """
				for ch in text:
				ty, shift = event_types_text_from_char[ch]
				ty = ty.lower()
				if shift:
				eb = getattr(_EventBuilder(self, 'left_shift'), ty)
				else:
				eb = _EventBuilder(self, ty)
				eb.tap()
				return self

				def __getattr__(self, attr):
				attr = event_types_alias.get(attr, attr)
				if attr in event_types:
				return _EventBuilder(self, attr)
				raise Exception(f"{attr!r} not found in {event_types!r}")


				def run(event_iter):
				import bpy
				TICKS = 4 # 3 works, 4 to be on the safe side.
				def event_step():
				# Run once 'TICKS' is reached.
				if event_step._ticks < TICKS:
				event_step._ticks += 1
				return 0.0
				event_step._ticks = 0

				val = next(event_step.run_events, False)
				if isinstance(val, EventGenerate) or val is None:
				return 0.0
				if val is Finish:
				return None
				else:
				raise Exception(f"{val!r} of type {type(val)!r} not supported")


				event_step.run_events = iter(event_iter)
				event_step._ticks = 0

				bpy.app.timers.register(event_step, first_interval=0.0)


				def tweak_preferences(preferences):
				""" Set preferences useful for automation.
				"""
				preferences.view.show_splash = False
				preferences.view.smooth_view = 0
				preferences.view.use_quit_dialog = False
				preferences.filepaths.use_auto_save_temporary_files = False


				# Only for comparison.
				Finish = object()