cardinal_pythonlib.getch

Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).

This file is part of cardinal_pythonlib.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Offers the getch() and kbhit() functions, and other terminal-related stuff.

In this module, getch() and kbhit() are mapped to their OS-specific versions.

cardinal_pythonlib.getch.getch() → str: Under UNIX, gets a single character from standard input. Does not echo to the screen. Note that the terminal will have been pre-configured, below.

cardinal_pythonlib.getch.kbhit() → bool: Under UNIX: is a keystroke available?

cardinal_pythonlib.getch.set_curses_term() → None[source]: Under UNIX: switch to an unbuffered, curses-style terminal. (Compare set_normal_term().)

cardinal_pythonlib.getch.set_normal_term() → None[source]: Under UNIX: switch to a normal terminal. (Compare set_curses_term().)