I met this bug when I was running a class inherit the python Cmd class (I mean Main().cmdloop()) I think this module was imported by Cmd class for complete the command

Ctrl+C only quits a program after any other key is pressed.

This always takes effect when readline is imported. Here is a little example program.

import readline
readline.parse_and_bind("tab: complete")

def complete(text,state):
    volcab = ['dog','cat','rabbit','bird','slug','snail']
    results = [x for x in volcab if x.startswith(text)] + [None]
    return results[state]


readline.set_completer(complete)

try:
    line = input('prompt> ')
except KeyboardInterrupt:
    from os import system
    system("color")
    print("\n\033[91mKeyboardInterrupt\033[0m")

Press Ctrl+C, you will see that nothing happens until you press a regular key like H. This is on Bindows 10.

It seem that almost all docs in the doc folder are either very outdated or wrong, with very poor formatting. A refresh and update would be helpful, especially in order to better explain various usage scenarios.

Using standard mark down files (*.md) are also preferred to the *.rst files.

The original README.rst is over 9 years old! It is also completely incomprehensible and useless, not telling much what this package is doing, when to use it, or how to use it.

I strongly suggest to clarify the utilization of this package, and how to use it from a practical point of view (I.e. key sequences that actually does something in REPL, for example.) and also from a more abstract and development point of view. (When and why does your package need to use readline?)

• [ ] Also update the README to use the mark down extension: README.md.
• [ ] Add some screenshots (of how it works and what it displays in various scenarios)
• [ ] Answer some basic questions:
  • [ ] What does pyreadline do?
  • [ ] Why is pyreadline needed?
  • [ ] When do I need or want to use pyreadline?
  • [ ] How do I include pyreadline in my own package or dependencies?
  • [ ] When should I not use pyreadline?
  • [ ] What is the relationship between pyreadline and readline?

Other questions?
Please comment!

Here are all the currently open PR's and issues from pyreadline repo.

Please use this list to check off the items that have been fixed here. If you do check it off, and if it's not too much to ask, please comment with the PR that fixed it.

• [ ] [77] UnicodeDecodeError after using sympy's math expressions?
• [ ] [76] Anyone interested in making an unofficial maintained branch of this?
• [ ] [75] Fix for variable assignment issue in keysyms mod
• [ ] [74] Code error in pyreadline/keysyms/init.py
• [ ] [73] python.exe on Windows 10 with Python 3.10 errors after this module is installed
• [ ] [72] Fix Python 3.10 AtributeError
• [ ] [71] input color not working on windows(10)[19042]
• [ ] [70] AttributeError: module 'readline' has no attribute 'redisplay'
• [ ] [69] Remove deprecation warning
• [ ] [68] Fix deprecation warning
• [x] [67] BUG: fix regex to avoid DoS
• [ ] [65] collections deprecation warning (potential incompatibility with Python 3.9)
• [x] [64] Press at the beginning of the line
• [ ] [62] [UnicodeDecodeError] - UnicodeDecodeError: 'gbk' codec can't decode byte 0x80 in position 321: illegal multibyte sequence
• [x] [61] #54 UnicodeDecodeError
• [ ] [60] Open history file with utf-8 encoding, fix #55 on Python 3 too
• [ ] [59] module 'pyreadline' has no attribute 'parse_and_bind'
• [ ] [58] Project status?
• [ ] [57] Open history file with utf-8 encoding, fix #55
• [ ] [56] Fix redisplay() missing & history-files with non-latin chars
• [ ] [55] Reading history file fails with non-latin chars on Windows
• [ ] [54] .python_history file decoding error when it has non-ascii char
• [ ] [53] TypeError: unsupported operand type(s) for *: 'ReadLineTextBuffer' and 'int'
• [ ] [52] AttributeError: module 'pyreadline.console' has no attribute 'Console'
• [ ] [51] Implement readline.redisplay(), fixing #49
• [ ] [50] Fix typo
• [ ] [49] AttributeError: module 'readline' has no attribute 'redisplay'
• [x] [48] Make it possible to use colored completions
• [ ] [46] windows 10(ver 1607) cmd.exe ansi color text not work.
• [ ] [45] No behavior for arbitrary input autocomplete set-up
• [x] [44] switch to setup tools
• [ ] [43] Parse and bind editing mode
• [ ] [42] Uninstall readline hook on exception -- OUTDATED
• [ ] [41] v2.1 changes missing from github
• [ ] [40] pyreadline==2.1 install fails using pip
• [ ] [39] Slow pasting of code into default Python interpreter
• [ ] [38] Python 3.5 support
• [ ] [37] Wrong cursor position when entering Unicode
• [ ] [34] Non incremental search fails on python 3
• [ ] [33] AttributeError: 'module' object has no attribute 'logger'
• [ ] [31] Multi-line input is displayed incorrectly
• [ ] [30] Incorrect encoding of history files
• [ ] [29] vi-mode and swedish characters
• [x] [28] Fixed typo and docstring line length
• [ ] [27] ~~Fix Ctrl-R and Ctrl-S prompt that does not accept space character as par...~~ -- Still Relevant?
• [ ] [26] ~~Change behavior of return key in the interactive search.~~ -- NOT Relevant
• [ ] [24] :o: Isolate kernel32 DLL usage. -- Probably Good Idea!
• [ ] [23] selection commands don't work with ipython/cygwin
• [ ] [22] Current build confuses py2exe; conflict with console module
• [ ] [20] ~~Update eggsetup.py~~ DEPRECATED
• [ ] [19] ~~Update setup.py~~ DEPRECATED
• [ ] [17] :o: Missing readline methods implemented
• [ ] [16] correct name of python dll in case of debug python interpreter
• [ ] [15] Modified rlmain.py to make saving the prompt position an option that is
• [ ] [14] Cannot import pyreadline when username is not ascii
• [ ] [12] Correction to README
• [ ] [8] resurrect ironpython support
• [ ] [5] ironpython support is broken