Skip to content

Add polling rate named arg to all input functions #6

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
AceMouse wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add polling rate named arg to all input functions #6

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
25 changes: 15 additions & 10 deletions pytimedinput/pytimedinput.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import termios


def timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, maxLength: int = 0, allowCharacters: str = "", endCharacters: str = "\x1b\n\r") -> Tuple[str, bool]:
def timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, maxLength: int = 0, allowCharacters: str = "", endCharacters: str = "\x1b\n\r", pollRate: float = 0) -> Tuple[str, bool]:
"""Ask the user for text input with an optional timeout and limit on allowed characters.

Args:
Expand All @@ -21,6 +21,7 @@ def timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, ma
maxLength (int, optional): Maximum length of input user is to be allowed to type. Defaults to 0, use 0 to disable.
allowCharacters (str, optional): Which characters the user is allowed to enter. Defaults to "", ie. any character.
endCharacters (str, optional): On which characters to stop accepting input. Defaults to "\\x1b\\n\\r", ie. ESC and Enter. Cannot be empty.
pollRate (float, optional): How long to sleep between polls. Defaults to 0, use 0 to disable.

Returns:
Tuple[str, bool]: The characters input by the user and whether the input timed out or not.
Expand All @@ -29,65 +30,67 @@ def timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, ma
return "", False
if(len(endCharacters) == 0):
return "", False
return __timedInput(prompt, timeout, resetOnInput, maxLength, allowCharacters, endCharacters)
return __timedInput(prompt, timeout, resetOnInput, maxLength, allowCharacters, endCharacters, pollRate)


def timedKey(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowCharacters: str = "") -> Tuple[str, bool]:
def timedKey(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowCharacters: str = "", pollRate: float = 0) -> Tuple[str, bool]:
"""Ask the user to press a single key out of an optional list of allowed ones.

Args:
prompt (str, optional): The prompt to be displayed to the user. Defaults to "".
timeout (int, optional): How many seconds to wait for input. Defaults to 5, use -1 to wait forever.
resetOnInput (bool, optional): Reset the timeout-timer any time user presses a key. Defaults to True.
allowCharacters (str, optional): Which characters the user is allowed to enter. Defaults to "", ie. any character.
pollRate (float, optional): How long to sleep between polls. Defaults to 0, use 0 to disable.

Returns:
Tuple[str, bool]: Which key the user pressed and whether the input timed out or not.
"""
return __timedInput(prompt, timeout, resetOnInput, maxLength=1, allowCharacters=allowCharacters, endCharacters="", inputType="single")
return __timedInput(prompt, timeout, resetOnInput, maxLength=1, allowCharacters=allowCharacters, endCharacters="", inputType="single", pollRate = pollRate)


def timedInteger(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowNegative: bool = True) -> Tuple[Union[int, None], bool]:
def timedInteger(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowNegative: bool = True, pollRate: float = 0) -> Tuple[Union[int, None], bool]:
"""Ask the user to enter an integer value.

Args:
prompt (str, optional): The prompt to be displayed to the user. Defaults to "".
timeout (int, optional): How many seconds to wait for input. Defaults to 5, use -1 to wait forever.
resetOnInput (bool, optional): Reset the timeout-timer any time user presses a key. Defaults to True.
allowNegative (bool, optional): Whether to allow the user to enter a negative value or not.
pollRate (float, optional): How long to sleep between polls. Defaults to 0, use 0 to disable.

Returns:
Tuple[Union[int, None], bool]: The value entered by the user and whether the input timed out or not.
"""
userInput, timedOut = __timedInput(
prompt, timeout, resetOnInput, allowCharacters="-" if(allowNegative) else "", inputType="integer")
prompt, timeout, resetOnInput, allowCharacters="-" if(allowNegative) else "", inputType="integer", pollRate = pollRate)
try:
return int(userInput), timedOut
except:
return None, timedOut


def timedFloat(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowNegative: bool = True) -> Tuple[Union[float, None], bool]:
def timedFloat(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, allowNegative: bool = True, pollRate: float = 0) -> Tuple[Union[float, None], bool]:
"""Ask the user to enter a floating-point value.

Args:
prompt (str, optional): The prompt to be displayed to the user. Defaults to "".
timeout (int, optional): How many seconds to wait for input. Defaults to 5, use -1 to wait forever.
resetOnInput (bool, optional): Reset the timeout-timer any time user presses a key. Defaults to True.
allowNegative (bool, optional): Whether to allow the user to enter a negative value or not.
pollRate (float, optional): How long to sleep between polls. Defaults to 0, use 0 to disable.

Returns:
Tuple[Union[float, None], bool]: The value entered by the user and whether the input timed out or not.
"""
userInput, timedOut = __timedInput(
prompt, timeout, resetOnInput, allowCharacters="-" if(allowNegative) else "", inputType="float")
prompt, timeout, resetOnInput, allowCharacters="-" if(allowNegative) else "", inputType="float", pollRate = pollRate)
try:
return float(userInput), timedOut
except:
return None, timedOut


def __timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, maxLength: int = 0, allowCharacters: str = "", endCharacters: str = "\x1b\n\r", inputType: str = "text") -> Tuple[str, bool]:
def __timedInput(prompt: str = "", timeout: int = 5, resetOnInput: bool = True, maxLength: int = 0, allowCharacters: str = "", endCharacters: str = "\x1b\n\r", inputType: str = "text", pollRate: float = 0) -> Tuple[str, bool]:
def checkStdin():
if(sys.platform == "win32"):
return msvcrt.kbhit()
Expand Down Expand Up @@ -150,6 +153,8 @@ def readStdin():
print("\x1b[1D\x1b[0K", end='', flush=True)
if(resetOnInput and timeout > -1):
timeStart = time.time()
if(pollRate != 0):
time.sleep(pollRate)
print("")
__setStdoutSettings(__savedConsoleSettings)
return userInput, timedOut
Expand Down