allow for configuration of what raises a Interrupt

README.rst

@@ -95,6 +95,17 @@ This submodule contains a list of available keys to compare against. The constan
 fully portable. If a key is listed here for your platform, :code:`readkey()` can read it, and you can compare against it.
 
 
+:code:`config` module
+---------------------
+
+This submodule contains configurations for :code:`readchar`. It holds Constants that are used in other parts of the code. You can override/change these
+to modify its behaviour. Here is a description of the existing configs:
+
+:code:`INTERRUPT_KEYS`
+  | List of keys that will result in :code:`readkey()` raising a :code:`KeyboardInterrupt`. You can modify or add to it.
+  | *Default:* :code:`[key.CTRL_C]`
+
+
 OS Support
 ==========
 

readchar/__init__.py

@@ -1,10 +1,12 @@
 """Library to easily read single chars and key strokes"""
 
 __version__ = "4.0.1-dev0"
-__all__ = ["readchar", "readkey", "key"]
+__all__ = ["readchar", "readkey", "key", "config"]
 
 from sys import platform
 
+from . import config
+
 
 if platform.startswith(("linux", "darwin", "freebsd")):
     from . import _posix_key as key

readchar/_posix_read.py

@@ -1,6 +1,8 @@
 import sys
 import termios
 
+from .config import INTERRUPT_KEYS
+
 
 # Initially taken from:
 # http://code.activestate.com/recipes/134892/
@@ -31,7 +33,7 @@ def readkey() -> str:
 
     c1 = readchar()
 
-    if c1 == "\x03":
+    if c1 in INTERRUPT_KEYS:
         raise KeyboardInterrupt
 
     if c1 != "\x1B":

readchar/_win_read.py

@@ -1,5 +1,7 @@
 import msvcrt
 
+from .config import INTERRUPT_KEYS
+
 
 def readchar() -> str:
     """Reads a single character from the input stream.
@@ -15,7 +17,7 @@ def readkey() -> str:
 
     ch = readchar()
 
-    if ch == "\x03":
+    if ch in INTERRUPT_KEYS:
         raise KeyboardInterrupt
 
     # if it is a normal character:

readchar/config.py

@@ -0,0 +1,6 @@
+from typing import List
+
+from . import _base_key as key
+
+
+INTERRUPT_KEYS: List[str] = [key.CTRL_C]