v4.0.0 development

[Cube707]

This is a continuation of #71. I just felt that it was justified to create a new clean issue.

Motivation

As the current Version 3.0.5 has some big issues and the windows support has always been lacking, I took the time to restructure the complete library.

Changes

The following changes have been made:

Breaking changes

• the readkey() function now raises a KeyboardInterupt when CTRL+C is pressed. (but readchar() can still be used to capture it). This is more inline with the python philosophy (IMHO) and prevents developers from accidentally trapping their users with no option to stop the programm.

fixes

• windows now returns strings instead of bytestrings, same as on linux
• windows now supports most special characters
• swaped LF and CR, as per Swap linefeed & carriage return keycodes #69
• windows actually returns CR on ENTER, so the ENTER variable now points to the appropriate existing variable
• __all__ should return a list of strings
• f5-f12 had wrong codes on linux
• code coverage is much better now:
• workflows: code coverage is now measued during the testing workflow and uploaded to coveralls.io

removed

• removed python 2.7, 3.4, 3.5 and pypy support

changed

• support for NON-BLOCKING behavior this is now removed as it has problems with the terminalsettings as pointed out in Keypresses outside of readchar_linux() are dropped #73 and discussed in feature request - non-blocking / timeout #62
• general cleanup of config and setup files
• bump precommit-hook versions
• simplyfied .yamellinter.yml
• since yamllint v1.27.0 there is a new option new-lines: type: platform that allows for platform independent linting. Added this.
• reworked the github actions
• workflows: updated the used github actions to actions/checkout@v3 and actions/setup-python@v4

added

• extensive testing for both windows and linux
• automated workflow that runs the test on both platforms
• more keycodes for windows
• add end-of-line-fixer to pre-commit
• Add LICENSE file to repo and sdist #44
• mac OS and FreeBSD run the linux behavior (note in the README that they are not supported but should work)
• SHIFT+TAB support on Linux

related

closes #80
resolves #78, resolves #46
closes #75
closes #66
closes #56, resolves #42
closes #44
fixes #37
closes #9, resolves #8

closes magmax/python-inquirer#156
fixes magmax/python-inquirer#155
fixes magmax/python-inquirer#117
closes magmax/python-inquirer#113

closes Kamik423/cutie#26
closes Kamik423/cutie#23

[C0D3D3V]

Did you try to use the PyCharm terminal for example to debug the input test script? I got one report that the inputs do not work on windows using PyCharm. I myself did not test it, and I think there is also an issue open for the old version, so it is not very important that this works.

[Cube707]

@C0D3D3V

No I only tested in Windows CMD terminal and Debian bash so far. Both while using VS code. I have never used PyCharm. But you right, there is already an issue: #51

[qianyun210603]

(Edited shorter to keep this thread manageable, detailed discussion in https://github.com/Cube707/python-readchar/pull/5)

[Cube707]

@qianyun210603 please see https://github.com/Cube707/python-readchar/pull/5

Would you also be so kind and edit your comment shorter to keep this thread manageable and more on-topic. Its already big enough with all the commits and linked issues...