Python неблокирующий консольный ввод
Я пытаюсь сделать простой клиент IRC на Python (как проект, пока я изучаю язык).
У меня есть цикл, который я использую, чтобы получать и анализировать то, что отправляет мне IRC-сервер, но если я использую raw_input чтобы вводить материал, он останавливает цикл в своих треках, пока я не введу что-то (очевидно).
Как я могу что-то ввести без остановки цикла?
Заранее спасибо.
(Я не думаю, что мне нужно публиковать код, я просто хочу что-то ввести без остановки цикла 1).
РЕДАКТИРОВАТЬ: я на Windows.
16 ответов
Для Windows, только консоль, используйте msvcrt модуль:
import msvcrt
num = 0
done = False
while not done:
print(num)
num += 1
if msvcrt.kbhit():
print "you pressed",msvcrt.getch(),"so now i will quit"
done = True
Для Linux эта статья описывает следующее решение, оно требует termios модуль:
import sys
import select
import tty
import termios
def isData():
return select.select([sys.stdin], [], [], 0) == ([sys.stdin], [], [])
old_settings = termios.tcgetattr(sys.stdin)
try:
tty.setcbreak(sys.stdin.fileno())
i = 0
while 1:
print(i)
i += 1
if isData():
c = sys.stdin.read(1)
if c == '\x1b': # x1b is ESC
break
finally:
termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_settings)
Для кроссплатформенности или, если вам нужен графический интерфейс, вы можете использовать Pygame:
import pygame
from pygame.locals import *
def display(str):
text = font.render(str, True, (255, 255, 255), (159, 182, 205))
textRect = text.get_rect()
textRect.centerx = screen.get_rect().centerx
textRect.centery = screen.get_rect().centery
screen.blit(text, textRect)
pygame.display.update()
pygame.init()
screen = pygame.display.set_mode( (640,480) )
pygame.display.set_caption('Python numbers')
screen.fill((159, 182, 205))
font = pygame.font.Font(None, 17)
num = 0
done = False
while not done:
display( str(num) )
num += 1
pygame.event.pump()
keys = pygame.key.get_pressed()
if keys[K_ESCAPE]:
done = True
Это самое удивительное решение1, которое я когда-либо видел. Вставлено здесь в случае, если ссылка идет вниз:
#!/usr/bin/env python
'''
A Python class implementing KBHIT, the standard keyboard-interrupt poller.
Works transparently on Windows and Posix (Linux, Mac OS X). Doesn't work
with IDLE.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
'''
import os
# Windows
if os.name == 'nt':
import msvcrt
# Posix (Linux, OS X)
else:
import sys
import termios
import atexit
from select import select
class KBHit:
def __init__(self):
'''Creates a KBHit object that you can call to do various keyboard things.
'''
if os.name == 'nt':
pass
else:
# Save the terminal settings
self.fd = sys.stdin.fileno()
self.new_term = termios.tcgetattr(self.fd)
self.old_term = termios.tcgetattr(self.fd)
# New terminal setting unbuffered
self.new_term[3] = (self.new_term[3] & ~termios.ICANON & ~termios.ECHO)
termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.new_term)
# Support normal-terminal reset at exit
atexit.register(self.set_normal_term)
def set_normal_term(self):
''' Resets to normal terminal. On Windows this is a no-op.
'''
if os.name == 'nt':
pass
else:
termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.old_term)
def getch(self):
''' Returns a keyboard character after kbhit() has been called.
Should not be called in the same program as getarrow().
'''
s = ''
if os.name == 'nt':
return msvcrt.getch().decode('utf-8')
else:
return sys.stdin.read(1)
def getarrow(self):
''' Returns an arrow-key code after kbhit() has been called. Codes are
0 : up
1 : right
2 : down
3 : left
Should not be called in the same program as getch().
'''
if os.name == 'nt':
msvcrt.getch() # skip 0xE0
c = msvcrt.getch()
vals = [72, 77, 80, 75]
else:
c = sys.stdin.read(3)[2]
vals = [65, 67, 66, 68]
return vals.index(ord(c.decode('utf-8')))
def kbhit(self):
''' Returns True if keyboard character was hit, False otherwise.
'''
if os.name == 'nt':
return msvcrt.kbhit()
else:
dr,dw,de = select([sys.stdin], [], [], 0)
return dr != []
# Test
if __name__ == "__main__":
kb = KBHit()
print('Hit any key, or ESC to exit')
while True:
if kb.kbhit():
c = kb.getch()
if ord(c) == 27: # ESC
break
print(c)
kb.set_normal_term()
1 Сделано Саймоном Д. Леви, частью компиляции программного обеспечения, которое он написал и выпустил по лицензии GNU Lesser General Public License.
Мой любимый способ получить неблокирующий ввод - использовать python input() в потоке:
import threading
class KeyboardThread(threading.Thread):
def __init__(self, input_cbk = None, name='keyboard-input-thread'):
self.input_cbk = input_cbk
super(KeyboardThread, self).__init__(name=name)
self.start()
def run(self):
while True:
self.input_cbk(input()) #waits to get input + Return
showcounter = 0 #something to demonstrate the change
def my_callback(inp):
#evaluate the keyboard input
print('You Entered:', inp, ' Counter is at:', showcounter)
#start the Keyboard thread
kthread = KeyboardThread(my_callback)
while True:
#the normal program executes without blocking. here just counting up
showcounter += 1
Независимо от ОС, только внутренние библиотеки, поддерживает ввод нескольких символов
Вот решение, которое работает под Linux и Windows, используя отдельный поток:
import sys
import threading
import time
import Queue
def add_input(input_queue):
while True:
input_queue.put(sys.stdin.read(1))
def foobar():
input_queue = Queue.Queue()
input_thread = threading.Thread(target=add_input, args=(input_queue,))
input_thread.daemon = True
input_thread.start()
last_update = time.time()
while True:
if time.time()-last_update>0.5:
sys.stdout.write(".")
last_update = time.time()
if not input_queue.empty():
print "\ninput:", input_queue.get()
foobar()
В Linux приведен рефакторинг кода mizipzor, который делает это немного проще, если вам придется использовать этот код в нескольких местах.
import sys
import select
import tty
import termios
class NonBlockingConsole(object):
def __enter__(self):
self.old_settings = termios.tcgetattr(sys.stdin)
tty.setcbreak(sys.stdin.fileno())
return self
def __exit__(self, type, value, traceback):
termios.tcsetattr(sys.stdin, termios.TCSADRAIN, self.old_settings)
def get_data(self):
if select.select([sys.stdin], [], [], 0) == ([sys.stdin], [], []):
return sys.stdin.read(1)
return False
Вот как это использовать: этот код будет печатать счетчик, который продолжает расти, пока вы не нажмете ESC.
with NonBlockingConsole() as nbc:
i = 0
while 1:
print i
i += 1
if nbc.get_data() == '\x1b': # x1b is ESC
break
Я думаю, что библиотека проклятий может помочь.
import curses
import datetime
stdscr = curses.initscr()
curses.noecho()
stdscr.nodelay(1) # set getch() non-blocking
stdscr.addstr(0,0,"Press \"p\" to show count, \"q\" to exit...")
line = 1
try:
while 1:
c = stdscr.getch()
if c == ord('p'):
stdscr.addstr(line,0,"Some text here")
line += 1
elif c == ord('q'): break
"""
Do more things
"""
finally:
curses.endwin()
.... возвращаясь к первоначальному вопросу ...
Я тоже изучаю питон, это стоило мне большого количества чтений документации, примеров и взлома головы ... но я думаю, что нашел легкое, простое, короткое и совместимое решение ... просто используя input (), потоки и списки
'''
what i thought:
- input() in another thread
- that were filling a global strings list
- strings are being popped in the main thread
'''
import threading
consoleBuffer = []
def consoleInput():
global consoleBuffer
while True:
consoleBuffer.append(input())
threading.Thread(target=consoleInput).start() # start the thread
import time # just to demonstrate non blocking parallel processing
while True:
time.sleep(2) # avoid 100% cpu
print(time.time()) # just to demonstrate non blocking parallel processing
while consoleBuffer:
print(repr(consoleBuffer.pop(0)))
БОНУС:
ctrl-c нажатие клавиши может быть легко обработано с
try:
# do whatever
except KeyboardInterrupt:
print('cancelled by user') or exit() # overload
Я бы сделал то, что сказал Микки Чан, но я бы использовал unicurses вместо нормальных проклятий.Unicurses универсален (работает на всех или хотя бы почти на всех операционных системах)
Если вам нужен только один «выход» из цикла, вы можете перехватить сигнал Ctrl-C.
Это кроссплатформенный и очень простой!
import signal
import sys
def signal_handler(sig, frame):
print('You pressed Ctrl+C!')
sys.exit(0)
signal.signal(signal.SIGINT, signal_handler)
while True:
# do your work here
Поскольку я нашел один из приведенных выше ответов полезным, вот пример аналогичного подхода. Этот код создает эффект метронома при вводе данных.
Разница в том, что в этом коде вместо класса используется замыкание, что мне кажется более простым. Этот пример также включает флаг для уничтожения потока через
my_thread.stop = True, но без использования глобальной переменной. Я делаю это с помощью (ab), используя тот факт, что функции Python являются объектами и, следовательно, могут быть исправлены как обезьяны, даже изнутри самих себя.
Примечание. Остановку потоков следует выполнять с осторожностью. Если в вашем потоке есть данные, требующие какого-либо процесса очистки, или если поток порождал свои собственные потоки, этот подход бесцеремонно уничтожит эти процессы.
# Begin metronome sound while accepting input.
# After pressing enter, turn off the metronome sound.
# Press enter again to restart the process.
import threading
import time
import winsound # Only on Windows
beat_length = 1 # Metronome speed
def beat_thread():
beat_thread.stop = False # Monkey-patched flag
frequency, duration = 2500, 10
def run(): # Closure
while not beat_thread.stop: # Run until flag is True
winsound.Beep(frequency, duration)
time.sleep(beat_length - duration/1000)
threading.Thread(target=run).start()
while True:
beat_thread()
input("Input with metronome. Enter to finish.\n")
beat_thread.stop = True # Flip monkey-patched flag
input("Metronome paused. Enter to continue.\n\n")
С python3.3 и выше вы можете использовать asyncio Модуль, как указано в этом ответе. Вам придется пересмотреть свой код, хотя, чтобы работать с asyncio, Запрашивать ввод пользователя с использованием экземпляра python asyncio.create_server
Решение от marco — правильная идея, но я решил упростить его до минимально возможного кода без каких-либо классов. Кроме того, он фактически показывает вам, как получить пользовательский ввод с библиотекой очередей, а не просто распечатать его:
import time, threading, queue
def collect(que):
msg = input()
que.put(msg)
que = queue.Queue()
thread = threading.Thread(target=collect, args=[que])
thread.start()
while thread.is_alive():
time.sleep(1)
print("The main thread continues while we wait for you...")
msg = que.get()
print('You typed:', msg)
В этом примере основной поток продолжается бесконечно (обработка данных или что-то еще), периодически проверяя, не ввел ли пользователь какие-либо данные в порожденный поток. Когда это происходит, он возвращает пользовательский ввод.
Я успешно использовал эту идею в своем собственном скрипте для создания отладчика, в котором я могу ввести «напечатать имя переменной» в любой момент основного цикла, и он выдает мне значения в реальном времени без остановки.
Ниже приводится оболочка класса для одного из вышеуказанных решений:
#!/usr/bin/env python3
import threading
import queue
class NonBlockingInput:
def __init__(self, exit_condition):
self.exit_condition = exit_condition
self.input_queue = queue.Queue()
self.input_thread = threading.Thread(target=self.read_kbd_input, args=(), daemon=True)
self.input_thread.start()
def read_kbd_input(self):
done_queueing_input = False
while not done_queueing_input:
console_input = input()
self.input_queue.put(console_input)
if console_input.strip() == self.exit_condition:
done_queueing_input = True
def input_queued(self):
return_value = False
if self.input_queue.qsize() > 0:
return_value = True
return return_value
def input_get(self):
return_value = ""
if self.input_queue.qsize() > 0:
return_value = self.input_queue.get()
return return_value
if __name__ == '__main__':
NON_BLOCK_INPUT = NonBlockingInput(exit_condition='quit')
DONE_PROCESSING = False
INPUT_STR = ""
while not DONE_PROCESSING:
if NON_BLOCK_INPUT.input_queued():
INPUT_STR = NON_BLOCK_INPUT.input_get()
if INPUT_STR.strip() == "quit":
DONE_PROCESSING = True
else:
print("{}".format(INPUT_STR))
Я писал программу с использованием Linux, которая имеет больший основной цикл, который требует регулярных обновлений, но также должен читать символы неблокирующим образом. Но при сбросе дисплея также теряется входной буфер. Это решение, которое я придумал. Каждый раз после обновления экрана он устанавливает терминал в неблокирующий режим, ожидает прохождения основного цикла и затем интерпретирует стандартный ввод. После этого терминал сбрасывается на исходные настройки.
#!/usr/bin/python3
import sys, select, os, tty, termios, time
i = 0
l = True
oldtty = termios.tcgetattr(sys.stdin)
stdin_no = sys.stdin.fileno()
while l:
os.system('clear')
print("I'm doing stuff. Press a 'q' to stop me!")
print(i)
tty.setcbreak(stdin_no)
time.sleep(0.5)
if sys.stdin in select.select([sys.stdin], [], [], 0.0)[0]:
line = sys.stdin.read(1)
print (line, len(line))
if "q" in line:
l = False
else:
pass
termios.tcsetattr(stdin_no, termios.TCSADRAIN, oldtty)
i += 1
В приведенном ниже примере допускается неблокирующее чтение из stdin как под Windows (проверено только под Windows 10), так и под Linux, не требуя внешних зависимостей или использования потоковой передачи. Он работает с копируемым текстом, он отключает ECHO, поэтому его можно использовать, например, для какого-то настраиваемого пользовательского интерфейса и использует цикл, поэтому было бы легко обрабатывать все, что было введено в него.
Учитывая вышеизложенное, пример предназначен для интерактивного телетайпа, а не для ввода по конвейеру.
#!/usr/bin/env python3
import sys
if(sys.platform == "win32"):
import msvcrt
import ctypes
from ctypes import wintypes
kernel32 = ctypes.windll.kernel32
oldStdinMode = ctypes.wintypes.DWORD()
# Windows standard handle -10 refers to stdin
kernel32.GetConsoleMode(kernel32.GetStdHandle(-10), ctypes.byref(oldStdinMode))
# Disable ECHO and line-mode
# https://docs.microsoft.com/en-us/windows/console/setconsolemode
kernel32.SetConsoleMode(kernel32.GetStdHandle(-10), 0)
else:
# POSIX uses termios
import select, termios, tty
oldStdinMode = termios.tcgetattr(sys.stdin)
_ = termios.tcgetattr(sys.stdin)
# Disable ECHO and line-mode
_[3] = _[3] & ~(termios.ECHO | termios.ICANON)
# Don't block on stdin.read()
_[6][termios.VMIN] = 0
_[6][termios.VTIME] = 0
termios.tcsetattr(sys.stdin, termios.TCSAFLUSH, _)
def readStdin():
if(sys.platform == "win32"):
return msvcrt.getwch() if(msvcrt.kbhit()) else ""
else:
return sys.stdin.read(1)
def flushStdin():
if(sys.platform == "win32"):
kernel32.FlushConsoleInputBuffer(kernel32.GetStdHandle(-10))
else:
termios.tcflush(sys.stdin, termios.TCIFLUSH)
try:
userInput = ""
print("Type something: ", end = "", flush = True)
flushStdin()
while 1:
peek = readStdin()
if(len(peek) > 0):
# Stop input on NUL, Ctrl+C, ESC, carriage return, newline, backspace, EOF, EOT
if(peek not in ["\0", "\3", "\x1b", "\r", "\n", "\b", "\x1a", "\4"]):
userInput += peek
# This is just to show the user what they typed.
# Can be skipped, if one doesn't need this.
sys.stdout.write(peek)
sys.stdout.flush()
else:
break
flushStdin()
print(f"\nuserInput length: {len(userInput)}, contents: \"{userInput}\"")
finally:
if(sys.platform == "win32"):
kernel32.SetConsoleMode(kernel32.GetStdHandle(-10), oldStdinMode)
else:
termios.tcsetattr(sys.stdin, termios.TCSAFLUSH, oldStdinMode)
в ответ на @Yan King Yin .. я использую это более простое решение для обработки разрыва Ctrl+C
import time # optional, to avoid infinite loops eat 100% cpu
try:
while someCondition():
time.sleep(0.1) # to avoid infinite loops eat 100% cpu
# do something
except KeyboardInterrupt:
print('cancelled by user')
exit()