tapper 2023.1.2

Modern Hotkey and Macro Tool

tapper is a Python package that allows for convenient, versatile, cross-platform hotkeys, macros and key remaps.

Functionality

On the tin, tapper might remind you of pynput, autohotkey and similar tools - and indeed, they were an inspiration.

In practice it aims to do a lot more and is more flexible. Here are some of the advantages:

• Cross-platform. Your scripts will work on across devices, and you don't need to learn separate tools for each platform.
• Easy to learn API, convenient for both simple and complex scripts.
• Responsiveness when rapidly typing or clicking.
• Per-window or otherwise conditional hotkeys.
• Suppressing the key that triggered the action. (surprising how commonly this is absent in other tools)
• Built-in suite of convenient, well-tested helper functions.

Example

from tapper import root, Group, Tap, start, helper

root.add(
    {"a": "b", "b": "a",  # remap "a" and "b"
    "h": "Hello,$(50ms) world!"},  # Sleeps for 0.05 sec in the middle
    Group(win="notepad").add({"alt+enter": "f11"}),  # fullscreen toggle
    Group(win_exec="chrome.exe").add(
        Tap("=", "mmb", cursor_in=((0, 0), (1700, 45)))  # close tabs with "="
    ),
    {"shift+caps": helper.actions.record_toggle(print)}  # record actions, print when done
)
start()

Installation

Install Python 3.10 or later, then install via pip:

pip install git+https://github.com/IGalat/tapper.git#egg=tapper[all]

For Linux, see this.

How to use

Here's a simple example: making the backtick key type underscore instead.

from tapper import root, start

root.add({"`": "_"})

start()

This tells tapper to click (press and release) "_" when "`" is pressed.

On tapper.start, the supplied dictionary gets transformed into a Tap, and text action into send(text).

It can be written like this:

root.add(Tap("`", lambda: send("_")))

Writing it out like this is more verbose, but has additional versatility:

root.add(Tap("`", "_", win="notepad", toggled_off="caps"))

Now this Tap can trigger only when notepad is the foreground window, and only if caps_lock is off.

---

For send most of the versatility is in text, but an explicit invoke allows to set an interval between clicks:

send("hello", interval=0.5)

Would send h, wait 0.5 sec, send e, wait 0.5 sec, and so on.

---

Ok, what if you need to do several actions only for notepad? Adding win="notepad" to each Tap is cumbersome, but you can Group them:

root.add(Group(win="notepad").add({
    "`": "_",
   "print_screen": "enter"
  }))

Now print screen will click enter when in notepad.

The string translates un-bracketed letters to symbol (like enter instead of e,n,t,e,r), assuming there is only that one symbol.

If you want to send letters, use send("enter"). And send("$(enter)") will again send enter.

send has a lot of capabilities in $(), such as pressing key combinations, sleep, mouse move - see Reference section.

Additionally, for enter and tab there are one-char equivalents:\n and \t.

Groups can contain Groups, root is just a Group as well.

---

There is a special Group which is not a child of root, control_group - it's always checked first, and exists for controlling tapper itself.

By default, it has following hotkeys:

from tapper import helper, control_group
control_group.add({"f3": helper.controls.restart,
"alt+f3": helper.controls.terminate})

These are only added if you didn't add any Taps to control_group.

---

Alternatively, call to tapper.init() gives access to the commands but Taps won't be listened to:

from tapper import init, send, window
init()
send("Immediately on launch type this text.")
print(f"Currently active window: {window.active()}")

You can start tapper after this. It allows for tapper-related actions on script startup.

Before init or start components are not initialized.

Usage philosophy

A single script is all you need. Group the Taps and dicts for convenience and performance, add them to the root Group.

Add conditions (keyword args) to Groups and Taps to make them only trigger in a specific context.

Use either functions or text as actions - text will be parsed and corresponding keys pressed.

Customize your control_group or use existing controls to always have a way to control the flow of tapper. It has the highest priority and will be triggered before root.

Within root, priority is last-to-first, so set more general Taps/Groups first, and more specific last.

Configure which actions can be executed concurrently, and which cannot - by default if an action is running, others cannot trigger.

How it works

Each aspect, such as keyboard, window etc has an OS-specific adapter.

For receiving signals it is blocking, which is the only way to suppress signals that trigger actions, so there is an input delay that depends on how long processing takes.

Reference

What you have access to:

• Controllers: allow you to check status and give commands. from tapper import kb, mouse, window
  • Keyboard. Get key state or issue commands; get/set language. For commands send is more convenient though.
  • Mouse. Same thing.
  • Window. Get state, check if window is open/active, set window as active, close, max/min/restore.
• Tap, Group, root, control_group.
• Conditions for Tap and Group: only if all conditions work, will triggering actions be possible.
• send - a versatile text-to-command tool.
• Multi-language support.
• Concurrency control for actions.
• Events pub/sub: subscribe to device to get all non-emulated signals.
• Convenience functions:
  • repeat actions while key is pressed, until toggled or custom condition.
  • record actions and get back sendable text; use it to make permanent macros or playback at will.
  • picture assist*
  • and more to come! Leave your requests in github issues.
• Config settings for more flexibility.

Conditions

These are used as keyword args:

Group(some_condition=some_eval_function).add(
  Tap("a", "b", toggled_on="num_lock")
)

Existing Conditions wrap your supplied argument into a function(Callable), and this is called every time Tap/Group may fire.

If bool(callable result) is True for every Condition for that Tap/Group, it can trigger.

Here are existing Conditions:

Name	Value type expected	Meaning	Example
trigger_if	Callable	Your custom function. bool(result) gets called directly.	trigger_if=lambda: datetime.datetime.now().month > 5 trigger_if=my_eval_fn_with_no_params trigger_if=partial(my_fn, "input param")
lang	str or int or Lang	Language is the specified one. See Multi-language support section below.	lang="ua" lang=1046
lang_not	str or int or Lang	Opposite of previous.	lang_not="en"
toggled_on	str	Keyboard key is toggled on. Applicable to all keys, though usually only "lock" keys matter.	toggled_on="num_lock"
toggled_off	str	Opposite of previous.	toggled_off="caps"
kb_key_pressed	str	Keyboard key is currently pressed.	kb_key_pressed=" "
kb_key_not_pressed	str	Opposite of previous.	kb_key_not_pressed="esc"
mouse_key_pressed	str	Same as kb_key_pressed for mouse.	mouse_key_pressed="right_mouse_button"
mouse_key_not_pressed	str	Same as kb_key_not_pressed for mouse.	mouse_key_not_pressed="rmb"
cursor_near	(int, int) or ((int, int), int)	Cursor is within circular area of target. Accepts (x, y) or ((x, y), radius). Default radius is 50.	cursor_near=(500, 720) cursor_near=((860, 650), 400)
cursor_in	(int, int, int, int)	Cursor is within a rectangle (min_x, min_y, max_x, max_y)	cursor_in=((100, 100, 250, 300))
win	str	Window with this name or exec is active. Comparison is not strict, so if supplied arg is contained with ignorecase, it's good enough.	win="youtube" win="notepad"
win_title	str	Same as "win", but only titles are considered.	win_title="chrome" # won't work unless page contains "chrome". win_title="youtube" # will only work when page name is "youtube", or if "youtube" is in the name of a document of notepad, etc.
win_exec	str	Window with this exact exec is active.	win_exec="chrome.exe"
open_win	str	Window with this name or exec is open on taskbar, but not necessarily the main window. Does not consider windows in tray. Not strict.	open_win="zoom"
open_win_title	str	Same as "open_win", but only titles are considered.	open_win_title="favourite song name in a player or youtube"
open_win_exec	str	Same as "open_win", but only execs are considered, and strict.	open_win_exec="notepad++.exe"

You can easily write your own, then add them.

send command allows you to:

• click character keys: Hello world!. This will respect the shift position and bring it back to where it was.
• click other keyboard/mouse keys: $(ctrl;lmb) - same as $(ctrl)$(lmb) - will click left control, then left mouse button.
• press combinations: $(alt+shift+c,v,v) will press down alt, shift, then click c, v, v, and release shift and alt.
• sleep: $(50ms) will sleep for 50 milliseconds(0.05 sec), $(3s) - for 3 sec.
• keys up/down/on/off: $(a up;caps off)$(b down;num_lock on) will release "a", click caps if it is on(otherwise nothing), press down "b"(no repeats), and click num lock if it is off. WARNING: "b" will stay pressed after this, which when unintended can cause bad experience. Avoid using "down" without "up" afterwards. If a key is stuck pressed, click it manually to release.
• press for a time: $(lmb 0.5s) will press left mouse button for half a sec, then release.
• repeat key multiple times: $(lmb 2x) will double-click left mouse button.
• move cursor: $(x100y100) will move cursor to x=100, y=100; $(x100y100r) will move cursor relative to current position.
• combine the above: bye, gotta work.$(ctrl 0.5s+c down;x400y650;lmb 2x;1s;caps off)hello colleagues!
• set interval between key presses: send("$(q 5x;esc)\t", interval=0.1) will insert a sleep(0.1 sec) between every "q", escape, and tab.
• (Mostly useful for playback of recorded actions, see below) regulate speed of sleep: send("hi $(30s)there", interval=1s, speed=5) will reduce 30s sleep to 6s, intervals of 1s are unaffected.

Symbols and aliases

Both send and hotkeys allow for aliases.

Alias is a symbol that refers to one or more other symbols, such as shift for [left_shift, right_shift]; lmb for left_mouse_button.

Here is a list of all keys and aliases for keyboard and mouse.

You can call get_possible_signal_symbols() for kb/mouse to get them as well.

Multi-language support

Get current window language with:

current_lang = tapper.kb.lang()

Make a check for a specific language:

if tapper.kb.lang("en"):

Set language:

tapper.kb.set_lang("ua", system_wide=True)  # for all apps
tapper.kb.set_lang("es")  # for current app

Transliterate and send your string in a different language:

from tapper.helper import lang
def say_hi_in_ukrainian():
    tapper.kb.set_lang("ua")
    send(lang.to_en("ua", "Привіт!"))

Or if you have many strings:

ua = lambda text: lang.to_en("ua", text)
send(ua("Їжак"))
send(ua("І Жак"))

You can use language identifiers en-US, aliases where they exist en, locale codes 1033, or objects you got from tapper.kb.lang().

See currently supported languages here.

If you need another language - it's very easy to add, use this and make a pull request!

Concurrency of actions

By default, a running action will block triggering of other actions.

You can configure it differently:

tapper.config.action_runner_executors_threads = [1, 20]

root.add({"a": "$(1s)1", "b": "$(1s)2"}, Tap("c", "$(1s)3", executor=1), Tap("d", "$(1s)4", executor=1))

Clicking a and b will result in 1 but not 2 being typed. But c and d have a separate queue of 20 threads, so you can trigger them many times concurrently.

Suppression of trigger key

By default, trigger key is suppressed:

Tap("a+b", "hoy")

This will result in ahoy, as b is suppressed. You can modify this per-Tap/Group, or default in config:

default_trigger_suppression = ListenerResult.PROPAGATE
# or
Tap("h+e", "llo", suppress_trigger=ListenerResult.PROPAGATE)

This will result in hello not hllo.

Pub/sub

This is not main use of tapper, but you will receive Signals when subscribing to devices:

from tapper.util import event
from tapper.model.types_ import Signal

keylog_list = []

def my_function(signal: Signal):
    keylog_list.append(signal)

event.subscribe("keyboard", my_function)
event.subscribe("mouse", my_function)

# and when necessary
event.unsubscribe("keyboard", my_function)
event.unsubscribe("mouse", my_function)

This is not blocking, events are received in separate listener threads.

Convenience functions

from tapper.helper import actions, controls

Actions repeat

helpers.action.repeat_while repeats while the condition function returns something that gets bool(result) == True.

Tap("t", repeat_while(lambda: datetime.datetime.now().hour >= 22,
                        send("Go to sleep!"),
                        period_s=1200,
                        max_repeats=4))

This will upon pressing t start looping, and if the hour is 22 or later, will type the phrase immediately and then every 20 min (1200 sec).

It will stop looping at midnight (as hour is < 22 now), or after 4 iterations.

---

helpers.action.repeat_while_pressed will repeat the action as long as the specified key is pressed. It doesn't have to be the same key as in hotkey:

Tap("a", repeat_while_pressed("ctrl", retry_my_stuff_function, 1, 15))
Tap("b", repeat_while_pressed("b", retry_my_stuff_function))

Pressing a will do at most 15 iterations, 1 second apart, as long as ctrl is pressed.

Pressing b will run repeats as long as b is held down, and will use defaults - infinite retries 0.1 sec apart.

Note: retries will be executed in a separate thread, not the one that called the function.

---

helpers.action.toggle_repeat will start repeating on first click, end on the second.

Tap("ctrl+l", toggle_repeat(send("\nrpal 6.2 LF ICC 25HM with prof\n"), 27))

One ctrl+l click will start sending the phrase immediately and every 27 sec, another will stop it.

---

Actions recording and playback/saving

You can record your actions, then get a string you can send.

recording: str = ""

def set_recording(new_recording: str) -> None:
    global recording
    recording = new_recording

root.add(Group("recording").add(        {
            "f7": actions.record_toggle(set_recording),
            "ctrl+f7": actions.record_start(),
            "alt+f7": actions.record_stop(set_recording),
            "f8": lambda: send(recording, interval=0.1, speed=2),
            "ctrl+f8": lambda: pyperclip.copy(recording),
        }))

On pressing f7 or ctrl+f7, it'll start recording, then on f7 or alt+f7 recording will stop, transform to string, and set_recording function will be called with that string.

In this example we're saving the recording, and then on f8 it will play back on double speed and with set interval.

ctrl+f8 will copy it to your clipboard (using external lib pyperclip) so you can save it for a macro.

You can supply a RecordConfig to record_toggle or record_stop to modify details about the string you get.

---

Image and pixel search, snip

from tapper.helper import img

allows you to:

• search for an image on a screen (or in image), fuzzy search is an option
• wait for image (or one of the images) to appear
• snip the screen easily and save in a format convenient for tapper usage
• all of this for a single pixel, which works much faster

---

Tap("f2", img.snip())

Move cursor to a spot, press f2, move to another spot, press f2 - and now you have a saved .png file - partial screenshot of a rectangle between first and second mouse positions, with name like snip-(BBOX_953_531_997_686).png, where in brackets are coordinates of top-left and bottom-right corners of the image on the screen.

This now can be used to search the picture:

if img.find("snip-(BBOX_953_531_997_686).png"):
    do_my_stuff()

You can also specify the bounding box separately, or not at all:

img.find(("my_pic.png", (953, 531, 997, 686)))  # bbox separate from name
img.find("my_pic.png")  # search the whole screen

Note that using the same bbox the image was snipped with means searching that exact position on the screen. To search a more broad position but not the whole screen, set coordinates appropriately.

Fuzzy search allows you to search for an image like what you supplied:

img.find("my_pic.png", precision=0.8)

---

To wait for an image:

img.wait_for("my_pic.png")

This will regularly take screenshots and check if the picture is found on screen.

You can control the search interval and timeout:

img.wait_for("my_pic.png", timeout=15, interval=0.5)

---

If you expect one of the images to appear, use wait_for_one_of:

yes_btn = "yes.png", (-100, 213, -56, 412)
no_btn = "no(BBOX_-100_213_-56_412).png"
close_btn = "close.png"

btn = img.wait_for_one_of([yes_btn, no_btn, close_btn])

if btn == yes_btn:
    continue_flow()
elif btn == no_btn:
    warn()
elif btn == close_btn:
    close_app()
else:
    raise ValueError

Each image may have a different bounding box.

---

Similar functions for pixel:

"f2": img.pixel_str(pyperclip.copy)

Press f2 once, and you'll get a string of RGB color and xy-position of the pixel to your clipboard, like:

"(255, 255, 255), (1919, 1079)"

Or get the same thing as tuples:

def my_pixel_callback(color: tuple[int, int, int], coords: tuple[int, int]):
  ...

"f2": img.pixel_info(my_pixel_callback)

There is an immediate, non-callback option:

my_pixel = pixel_get_color(1920 - 1, 1080 - 1)
assert my_pixel == (64, 45, 182)

---

Use the string from img.pixel_str to find or wait for a pixel:

my_pixel_precise_coords = (255, 255, 255), (1919, 1079)
if img.pixel_find(my_pixel_precise_coords):
    ...

if img.pixel_wait_for((255, 255, 255), (1000, 1020, 1919, 1079)):  # search in wider area
    ...

yes_btn_pixel = (67, 240, 13), (560, 780)  # will only be searched for in one spot
no_btn_pixel = (255, 13, 13), None  # will be searched for on the whole screen, as bbox=None
if img.pixel_wait_for_one_of([yes_btn_pixel, no_btn_pixel]):
    ...

---

Functions for image and pixel allow searching and snipping an image instead of screen.

This may be a pathname, or numpy-array.

This exists for efficiency, as taking screenshot every time in a loop or a function is slow.

sct = img.get_snip()
for i in range(100):
    bbox = (i, i, i + 100, i + 1)
    if img.find((my_img_of_horizontal_line_100_by_1_px, bbox), sct):
    return i

Config

See config file for information on what you can configure.

Changelog