prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Undocumented backwards incompatibility in version 3.0.29
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Hello, I found that the most recent version 3.0.29 of prompt_toolkit probably introduces some breaking changes, which are not recorded in release notes.
- Add required parameter
vt100_inputin functionprompt_toolkit.contrib.telnet.server.TelnetConnection.__init__. - Add required parameter
_pipein functionprompt_toolkit.input.posix_pipe.PosixPipeInput.__init__. - Rename optional parameter
textto_textin functionprompt_toolkit.input.posix_pipe.PosixPipeInput.__init__. is_windowsis not accessible from following modules:prompt_toolkit.application.application.is_windowsprompt_toolkit.eventloop.inputhook.is_windowsprompt_toolkit.input.defaults.is_windowsprompt_toolkit.key_binding.bindings.mouse.is_windowsprompt_toolkit.output.defaults.is_windows
To make it easier to understand the impact of the breaking changes, I write a short code snippet that reproduces the breaking changes.
The following code runs well in 3.0.28 but gets crashed in 3.0.29.
# Change 1
TelnetConnection(conn, addr, interact, server, encoding, style)
# missing 1 required positional argument: 'vt100_input'
# Change 2 and 3
PosixPipeInput(text="text")
# missing 1 required positional argument: '_pipe' and got an unexpected keyword argument 'text'
# Change 4
from prompt_toolkit.application.application import is_windows
# AttributeError: module 'prompt_toolkit.application.application' has no attribute 'is_windows'
Maybe recording these changes in release notes helps to avoid user confusion during updating this version?
Kind regrads,
@eXceediDeaL
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the release notes for version 3.0.29 and compare them with the four incompatibilities listed in the issue, including the affected constructors and is_windows imports. Document each breaking change with the supplied reproduction examples, so users upgrading from 3.0.28 can identify the required adjustments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100