Is it possible to create a custom Keyboard Interrupt key in Python?

Question

I am writing a python script that has an infinite loop and for me to stop I use the usual Keyboard Interrupt key Ctrl+c but I was wondering if I can set one of my own like by pressing space once the program can stop I want it to have the same function as Ctrl+c So if it is possible how can I assign it?

Well, this is more a question of setting up your terminal/IDE/whatever. Some might have the functionality to rebind keys. — KTibow, Dec 28 '21 at 15:49
See here is my problem I want to be set within the script so whoever has access to the code will press the same universal button to sop the code — SAM Acc, Dec 28 '21 at 15:51
There are many ways you could go about this: 1. Set up your terminal/IDE (I might be able to help) 2. Create a global keybind (I can recommend a library and how to use it) 3. Look at STDIN in a thread (No clue how you would do this) — KTibow, Dec 28 '21 at 15:54
Let us [continue this discussion in chat](https://chat.stackoverflow.com/rooms/240502/discussion-between-ktibow-and-sam-acc). — KTibow, Dec 28 '21 at 15:58

score 0 · Answer 1 · answered Dec 28 '21 at 16:17

0

You can add a listener to check when your keys are pressed and then stop your script

from pynput.keyboard import Listener

def on_press(key):
    # check that it is the key you want and exit your script for example

with Listener(on_press=on_press) as listener:
    listener.join()

# do your stuff here
while True:
    pass

answered Dec 28 '21 at 16:17

Jimmy Fraiture

370
1
2
15

So in the def function I put the key I want to assign? – SAM Acc Dec 28 '21 at 16:19
It's not working can you apply it to this code so I can see how this works https://www.online-python.com/L9lTSey4GH – SAM Acc Dec 28 '21 at 16:25
def on_press(key): if key == keyboard.Key.esc: raise KeyboardInterrupt – Jimmy Fraiture Dec 28 '21 at 18:01
You cannot make it work on an online executor since keys are manage by the navigator – Jimmy Fraiture Dec 28 '21 at 18:01
yeah just write the code even if it doesn't work because I can't seem to understand how I am supposed to arrange the code – SAM Acc Dec 29 '21 at 16:20

score 0 · Answer 2 · answered Jan 02 '22 at 16:37

0

For creating the keyboard listener (Based on Jimmy Fraiture's answer and comments), and on Space stop the script using exit() (Suggested here)

from pynput.keyboard import Listener

def on_press(key):
    # If Space was pressed (not pressed and released), stop the execution altogether 
    if (key == Key.space):
        print('Stopping...')
        exit()

with Listener(on_press=on_press) as listener:
    listener.join()


while True:
    print('Just doing my own thing...\n')

answered Jan 02 '22 at 16:37

Chrimle

490
1
4
10

thank you I will try this now and keep you posteed – SAM Acc Jan 02 '22 at 16:46
that did not work – SAM Acc Jan 02 '22 at 16:52
As suggested [here](https://stackoverflow.com/questions/67875573/exit-loop-with-pynput-input), you will have to create another thread to be responsible for the listener. But that makes me think you will have to use some of the other "stop"-commands I linked in my answer, because now you not only want to kill the listener, but _also_ the thread doing your while-loop. – Chrimle Jan 02 '22 at 16:59

score 0 · Accepted Answer · answered Jan 11 '22 at 16:36

0

from pynput.keyboard import Listener
     while True:
         if keyboard.is_pressed("space"):
             exit()

answered Jan 11 '22 at 16:36

SAM Acc

38
8

Is it possible to create a custom Keyboard Interrupt key in Python?

3 Answers3

Linked