Skip to content

Support for unicode in using pyclip #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support for unicode in using pyclip #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 29 additions & 35 deletions actions/WriteText/helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

from loguru import logger as log
import time
import pyclip
Copy link

@ImDevinC ImDevinC Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because this plugin doesn't have a backend, this will require pyclip to be installed in the root StreamController plugin. Is there a way to accomplish this same functionality without using a third party implementation?


def get_valid_key_names() -> list[str]:
"""Returns a list of valid key names."""
Expand All @@ -29,14 +30,33 @@ def check_caps_lock() -> bool:

def keyboard_write(ui: UInput, text: str, delay: float = 0.01):
caps_lock_is_on = check_caps_lock()
for char in text:
is_unicode = False
unicode_bytes = char.encode("unicode_escape")
# '\u' or '\U' for unicode, or '\x' for UTF-8
if unicode_bytes[0] == 92 and unicode_bytes[1] in [85, 117, 120]:
is_unicode = True

if char in _KEY_MAPPING:

has_unicode = any(char not in _KEY_MAPPING for char in text)

if has_unicode:
log.debug(f"Text contains Unicode characters, using clipboard method for entire text")

try:
original_clipboard = pyclip.paste()
except Exception:
original_clipboard = ""

pyclip.copy(text)

ui.write(e.EV_KEY, e.KEY_LEFTCTRL, 1)
ui.write(e.EV_KEY, e.KEY_V, 1)
ui.write(e.EV_KEY, e.KEY_V, 0)
ui.write(e.EV_KEY, e.KEY_LEFTCTRL, 0)

ui.syn()
time.sleep(delay)

try:
pyclip.copy(original_clipboard)
except Exception:
pass
else:
for char in text:
keycode = _KEY_MAPPING[char]
need_shift = False

Expand All @@ -58,32 +78,6 @@ def keyboard_write(ui: UInput, text: str, delay: float = 0.01):
# send keys
ui.syn()
time.sleep(delay)
elif is_unicode:
unicode_hex = hex(int(unicode_bytes[2:], 16))
unicode_hex_keys = unicode_hex[2:]

# hold shift + ctrl
ui.write(e.EV_KEY, e.KEY_LEFTSHIFT, 1)
ui.write(e.EV_KEY, e.KEY_LEFTCTRL, 1)

# press 'U' to initiate unicode sequence
ui.write(e.EV_KEY, e.KEY_U, 1)
ui.write(e.EV_KEY, e.KEY_U, 0)

# press unicode codepoint keys
for hex_char in unicode_hex_keys:
keycode = _KEY_MAPPING[hex_char]
ui.write(e.EV_KEY, keycode, 1)
ui.write(e.EV_KEY, keycode, 0)

# release shift + ctrl
ui.write(e.EV_KEY, e.KEY_LEFTSHIFT, 0)
ui.write(e.EV_KEY, e.KEY_LEFTCTRL, 0)

# send keys
ui.syn()
else:
log.warning(f"Unsupported character: {char}")

def parse_key_combination(key_combination: str) -> list[int]:
keys = key_combination.lower().split('+')
Expand Down Expand Up @@ -118,4 +112,4 @@ def press_key_combination(ui: UInput, key_combination: str, delay: float = 0.01)
# from evdev import ecodes
# ui = UInput({ecodes.EV_KEY: range(0, 300),
# ecodes.EV_REL: [ecodes.REL_X, ecodes.REL_Y]}, name="stream-controller-os-plugin")
# keyboard_write(ui, text)
# keyboard_write(ui, text)