cmd.Cmd completion fails in some cases, must allow the definition of readline completion delimiters
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Bug report
Bug description:
cmd.Cmd does not allow the definition of readline completion delimiters, therefore, complete_*() methods will fail with completion options containing dashes (or other characters in readline's default list of delimiters).
Defining a Cmd.completer_delims (by default None) and then calling readline.set_completer_delims(self.completer_delims) (if Cmd.completer_delims is not None) after importing readline will do the trick.
CPython versions tested on:
3.12
Operating systems tested on:
Linux
Contributor guide
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
Start at cmd.Cmd's completion path and its readline integration, focusing on how completion delimiters are currently selected. Confirm the configurable delimiter behavior with a regression test for completion options containing dashes; done when those options complete successfully while the default delimiter behavior remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100