Python allows us to work with user input in its programs. We can also work with hardware devices in Python.<\/p>\n
In this article, we will discuss how to detect keypress in Python.
\n
Table of Contents<\/p>
keyboard<\/code> module to detect keypress in Python<\/span><\/h2>\nThe keyboard<\/code> module is well equipped with different functions to perform operations related to keyboard input, detecting-simulating key presses, and more. This module works normally on Windows but requires the device to be rooted on Linux devices. To detect keypress, we can use a few functions from this module.<\/p>\nThe read_key()<\/code> function from this module is used to read the key pressed by the user. We can check whether the pressed key matches our specified key. <\/p>\nSee the following example.<\/p>\n
\nimport keyboard\nif keyboard.read_key() == \"a\":\n print(\"A Key Pressed\") \n<\/pre>\nOutput:<\/strong><\/p>\n\nA Key Pressed\n<\/div>\nIf you get output as below:<\/p>\n
\nModuleNotFoundError: No module named ‘keyboard’\n<\/div>\nYou need to install keyboard module first.
\nYou can use following command to install keyboard module.<\/p>\n
\npip install keyboard\n<\/div>\nThe wait()<\/code> function waits for the user to press some specific key and then resume the program execution.<\/p>\nFor example,<\/p>\n
\nimport keyboard\nkeyboard.wait(\"a\")\nprint(\"A Key Pressed\") \n<\/pre>\nOutput:<\/strong><\/p>\n\nA Key Pressed\n<\/div>\nWe can also use the is_pressed()<\/code> function to check whether a specific key is pressed or not. It will return a True or False value.<\/p>\nFor example,<\/p>\n
\nimport keyboard\nwhile True:\n if keyboard.is_pressed(\"a\"):\n print(keyboard.is_pressed('a'))\n print(\"A Key Pressed\")\n break \n<\/pre>\nOutput:<\/strong><\/p>\n\nTrue
\nA Key Pressed\n<\/div>\nThe on_press_key()<\/code> function can execute a function when a specific key is pressed. We have to pass the function and the required key as parameters to this function.<\/p>\nWe will use this function in the following code.<\/p>\n
\nimport keyboard\nkeyboard.on_press_key(\"a\", lambda _:print(\"A Key Pressed\")) \n<\/pre>\nOutput:<\/strong><\/p>\n\nA Key Pressed\n<\/div>\nUsing the pynput<\/code> module to detect keypress in Python<\/span><\/h2>\nThe pynput<\/code> module allows us to work with different input devices like keyboard and mouse.<\/p>\nWe will create two functions that will be collected using the Listener<\/code> function of this module.<\/p>\nSee the following code.<\/p>\n
\nfrom pynput.keyboard import Key, Listener\ndef press(key):\n print(key)\ndef release(key):\n if key == Key.space:\n return False #Returns False to stop the listener\n##If spacebar is pressed it will stop\nwith Listener( \n on_press=press,\n on_release=release) as listener:\n listener.join() \n<\/pre>\nOutput:<\/strong><\/p>\n\n‘a’
\n‘b’
\nKey.space\n<\/div>\nThere are a lot of things happening in the above example.<\/p>\n
\n- The
press()<\/code> function will be executed when we press the key and print the key.<\/li>\n- Similarly, the
on_release()<\/code> function will be executed when the key is released.<\/li>\n- These two functions are collected in the
Listener()<\/code> function using the on_press<\/code> and on_release<\/code> parameters.<\/li>\n- We can also stop the
Listener()<\/code> function by pressing some specific key. In our example, if the spacebar is pressed, the release<\/code> function will return False and the Listener()<\/code> function will stop.<\/li>\n<\/ul>\nUsing the msvcrt<\/code> module to detect keypress in Python<\/span><\/h2>\nThe msvcrt<\/code> is another Windows-only module that can detect keypresses.<\/p>\nWe will detect a keypress and print that key using the following code.<\/p>\n
\nimport msvcrt\nwhile True:\n if msvcrt.kbhit():\n k = msvcrt.getch()\n print(\"Key Pressed\", k)\n break \n<\/pre>\n\nKey Pressed b’r’\n<\/div>\nIn the above example,<\/p>\n
\n- The
kbhit()<\/code> function waits for a key to be pressed and returns True when it is pressed.<\/li>\n- The
getch()<\/code> function returns the key pressed in a byte string. Notice the b<\/code> in the output.<\/li>\n- The
break<\/code> statement will come out of this code block. If it is removed, then the code will keep on executing.
\nThat’s all about how to detect keypress in Python.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"Table of ContentsUsing the keyboard module to detect keypress in PythonUsing the pynput module to detect keypress in PythonUsing the msvcrt module to detect keypress in Python Python allows us to work with user input in its programs. We can also work with hardware devices in Python. In this article, we will discuss how to […]<\/p>\n","protected":false},"author":1,"featured_media":15249,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"_mi_skip_tracking":false},"categories":[145],"tags":[],"_links":{"self":[{"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/posts\/15237"}],"collection":[{"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/comments?post=15237"}],"version-history":[{"count":0,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/posts\/15237\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/media\/15249"}],"wp:attachment":[{"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/media?parent=15237"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/categories?post=15237"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/java2blog.com\/wp-json\/wp\/v2\/tags?post=15237"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}