Preexec hook for REPL
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
Proposal:
Background
In VS Code we override PS1 to enable shell integration, this currently gives VS Code understanding of where the commands are and what they are. This provides a few features:
Command decorations with visualization of exit/error status:
Command navigation (cmd/ctrl+up/down):
Run recent (ctrl+alt+r):
To give an example of what's possible with shell integration, here's our experimental VS Code-native PowerShell intellisense:
And multi-line sticky scroll:
Request
Something we needed to work around for Python was the lack of a pre-execution hook, we would normally print \x1b[633;C\a at the end of a command just before it's run such that VS Code knows where that marker is. Currently we have to stick that at the start of the command input though which can degrade the experience, especially when VS Code attempts to figure out that command has been run manually.
To visualization of the problem, see the A, B, C, D markers in our python REPL:
Compare this to PowerShell which positions them correctly:
Shell integration script included in VS Code's python extension: https://github.com/microsoft/vscode-python/blob/main/python_files/pythonrc.py
I'm not a Python dev so I'm not sure what such an API would look like, but we essentially need a hook to run arbitrary code immediately before the REPL runs the command, something like this:
class MyPreexec:
def __str__(self):
return "preexec"
sys.preexec = MyPreexec()
cc @anthonykim1 @brettcannon
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Linked PRs
- gh-144724
- gh-157241
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 by reviewing the Python REPL execution path and the shell integration example in python_files/pythonrc.py from the linked VS Code Python extension. Read linked PRs gh-144724 and gh-157241 to understand existing work and decisions. Done means a documented pre-execution hook is available to REPL integrations and its behavior is covered by relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100