fix: implement CSI S/T (scroll up/down) to fix ghost content in screenshots

pyte 0.8.2 does not handle CSI S (SU — Scroll Up) or CSI T (SD —
Scroll Down). When TERM=xterm-256color, tmux sends CSI n S for bulk
scrolling instead of DECSTBM+index. pyte silently ignored these
sequences, leaving old content in the screen buffer — visible as
ghost content in SVG screenshots.

Fix: monkeypatch pyte's CSI dispatch tables to map S→scroll_up and
T→scroll_down, and implement both methods on AltScreen with proper
scroll-region (DECSTBM) support.

Adds 6 tests for SU/SD functionality.
This commit is contained in:
GitHub Copilot
2026-02-06 21:21:57 +00:00
parent c98cee4cd6
commit 207eddc922
3 changed files with 155 additions and 0 deletions
+18
View File
@@ -55,6 +55,24 @@ Frame N+1 (broken): EL2+CUU1 × 6 (clears rows 30→24) + redraw 6 lines ✗
## Fix
### Primary fix: CSI S (Scroll Up) and CSI T (Scroll Down) support
The root cause is that **pyte does not implement `CSI S` (SU — Scroll Up) or `CSI T` (SD — Scroll Down)**. When `TERM=xterm-256color` is set, tmux uses `CSI n S` to scroll content up in the outer terminal instead of the DECSTBM + index approach used with simpler TERM types. Without SU support, pyte silently ignores these scroll commands, leaving old content in place.
The fix monkeypatches pyte's `ByteStream.csi` and `Stream.csi` dispatch tables to map `"S"``scroll_up` and `"T"``scroll_down`, and adds the corresponding methods to `AltScreen`.
```python
# In alt_screen.py — patch pyte's CSI dispatch
pyte.ByteStream.csi["S"] = "scroll_up"
pyte.ByteStream.csi["T"] = "scroll_down"
# AltScreen implements scroll_up() and scroll_down()
# which shift buffer lines within the scroll region,
# matching real terminal behaviour.
```
### Secondary fix: expand_clear_sequences (best-effort)
`AltScreen.expand_clear_sequences()` in `alt_screen.py` pre-processes incoming terminal data before it reaches pyte. It detects runs of 3+ `EL2+CUU1` pairs and, if the run doesn't reach row 0, extends it with additional pairs so the erase covers all lines from the cursor position up to the top of the screen.
```python