prompt-toolkit / prompt-toolkit/python-prompt-toolkit

Correctly raise ValueError on unknown binding in KeyBindings.remove()

Open
#2,042 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

When trying to remove from KeyBindings by Keys, an undocumented UnboundLocalError exception is raised instead of the documented ValueError.

To repro can add something like the following to test_remove_bindings:

        h3 = handlers.controla

        ...

        # Test passing unbound key sequence to the remove() function
        with pytest.raises(ValueError):
            bindings.remove(h3)
        with pytest.raises(ValueError):
            bindings.remove(Keys.ControlA)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at KeyBindings.remove() and the existing test_remove_bindings test. Reproduce removal of an unbound handler and Keys value there, then verify the documented ValueError is raised for both cases. Done when the regression coverage passes and the prior UnboundLocalError no longer occurs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.