Preexec hook for REPL
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando la ruta de ejecución de Python REPL y el ejemplo de integración con el shell en python_files/pythonrc.py de la extensión de Python de VS Code enlazada. Lee los PRs enlazados gh-144724 y gh-157241 para entender el trabajo existente y las decisiones tomadas. Se considera completado cuando haya disponible un hook de preejecución documentado para las integraciones de REPL y su comportamiento esté cubierto por las pruebas relevantes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- cli
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100