Refactor _pyrepl refresh invalidation state

Make buffer, layout, prompt, overlay, and full redraw causes explicit in Reader.
The invalidation matrix is still cursed, but at least now it is visible.

Author: pablogsal

Lib/_pyrepl/commands.py

@@ -75,7 +75,7 @@ def kill_range(self, start: int, end: int) -> None:
         else:
             r.kill_ring.append(text)
         r.pos = start
-        r.dirty = True
+        r.invalidate_buffer(start)
 
 
 class YankCommand(Command):
@@ -126,27 +126,27 @@ def do(self) -> None:
                     r.arg = 10 * r.arg - d
                 else:
                     r.arg = 10 * r.arg + d
-        r.dirty = True
+        r.invalidate_prompt()
 
 
 class clear_screen(Command):
     def do(self) -> None:
         r = self.reader
         trace("command.clear_screen")
         r.console.clear()
-        r.dirty = True
+        r.invalidate_full()
 
 
 class refresh(Command):
     def do(self) -> None:
         trace("command.refresh")
-        self.reader.dirty = True
+        self.reader.invalidate_full()
 
 
 class repaint(Command):
     def do(self) -> None:
         trace("command.repaint")
-        self.reader.dirty = True
+        self.reader.invalidate_full()
         self.reader.console.repaint()
 
 
@@ -212,9 +212,10 @@ def do(self) -> None:
         repl = len(r.kill_ring[-1])
         r.kill_ring.insert(0, r.kill_ring.pop())
         t = r.kill_ring[-1]
+        start = r.pos - repl
         b[r.pos - repl : r.pos] = t
         r.pos = r.pos - repl + len(t)
-        r.dirty = True
+        r.invalidate_buffer(start)
 
 
 class interrupt(FinishCommand):
@@ -246,7 +247,7 @@ def do(self) -> None:
         r.console.prepare()
         r.pos = p
         # r.posxy = 0, 0  # XXX this is invalid
-        r.dirty = True
+        r.invalidate_full()
         trace("command.suspend sync_rendered_screen")
         r.console.sync_rendered_screen(RenderedScreen.empty(), r.console.posxy)
 
@@ -374,14 +375,15 @@ class self_insert(EditCommand):
     def do(self) -> None:
         r = self.reader
         text = self.event * r.get_arg()
+        start = r.pos
         r.insert(text)
         if r.paste_mode:
             data = ""
             ev = r.console.getpending()
             data += ev.data
             if data:
                 r.insert(data)
-                r.last_refresh_cache.invalidated = True
+                r.invalidate_buffer(start)
 
 
 class insert_nl(EditCommand):
@@ -405,20 +407,23 @@ def do(self) -> None:
             del b[s]
             b.insert(t, c)
             r.pos = t
-            r.dirty = True
+            r.invalidate_buffer(s)
 
 
 class backspace(EditCommand):
     def do(self) -> None:
         r = self.reader
         b = r.buffer
+        changed_from: int | None = None
         for i in range(r.get_arg()):
             if r.pos > 0:
                 r.pos -= 1
                 del b[r.pos]
-                r.dirty = True
+                changed_from = r.pos if changed_from is None else min(changed_from, r.pos)
             else:
                 self.reader.error("can't backspace at start")
+        if changed_from is not None:
+            r.invalidate_buffer(changed_from)
 
 
 class delete(EditCommand):
@@ -436,12 +441,15 @@ def do(self) -> None:
                 r.console.finish()
                 raise EOFError
 
+        changed_from: int | None = None
         for i in range(r.get_arg()):
             if r.pos != len(b):
                 del b[r.pos]
-                r.dirty = True
+                changed_from = r.pos if changed_from is None else min(changed_from, r.pos)
             else:
                 self.reader.error("end of buffer")
+        if changed_from is not None:
+            r.invalidate_buffer(changed_from)
 
 
 class accept(FinishCommand):
@@ -493,7 +501,7 @@ def do(self) -> None:
 class paste_mode(Command):
     def do(self) -> None:
         self.reader.paste_mode = not self.reader.paste_mode
-        self.reader.dirty = True
+        self.reader.invalidate_prompt()
 
 
 class perform_bracketed_paste(Command):
@@ -510,4 +518,3 @@ def do(self) -> None:
             s=time.time() - start,
         )
         self.reader.insert(data.replace(done, ""))
-        self.reader.last_refresh_cache.invalidated = True

Lib/_pyrepl/completing_reader.py

@@ -193,7 +193,7 @@ def do(self) -> None:
             completion = stripcolor(completions[0])
             if completions_unchangable and len(completion) == len(stem):
                 r.msg = "[ sole completion ]"
-                r.dirty = True
+                r.invalidate_message()
             r.insert(completion[len(stem):])
         else:
             clean_completions = [stripcolor(word) for word in completions]
@@ -206,15 +206,15 @@ def do(self) -> None:
                 r.cmpltn_menu, r.cmpltn_menu_end = build_menu(
                     r.console, completions, r.cmpltn_menu_end,
                     r.use_brackets, r.sort_in_column)
-                r.dirty = True
+                r.invalidate_overlay()
             elif not r.cmpltn_menu_visible:
                 r.cmpltn_message_visible = True
                 if stem + p in clean_completions:
                     r.msg = "[ complete but not unique ]"
-                    r.dirty = True
+                    r.invalidate_message()
                 else:
                     r.msg = "[ not unique ]"
-                    r.dirty = True
+                    r.invalidate_message()
 
         if r.cmpltn_action:
             if r.msg and r.cmpltn_message_visible:
@@ -244,6 +244,7 @@ def do(self) -> None:
                     r.cmpltn_menu, r.cmpltn_menu_end = build_menu(
                         r.console, completions, 0,
                         r.use_brackets, r.sort_in_column)
+                    r.invalidate_overlay()
                 else:
                     r.cmpltn_reset()
 
@@ -297,6 +298,8 @@ def finish(self) -> None:
         self.cmpltn_reset()
 
     def cmpltn_reset(self) -> None:
+        if getattr(self, "cmpltn_menu_visible", False):
+            self.invalidate_overlay()
         self.cmpltn_menu = []
         self.cmpltn_menu_visible = False
         self.cmpltn_message_visible = False

Lib/_pyrepl/historical_reader.py

@@ -90,7 +90,7 @@ def do(self) -> None:
             if r.get_unicode() != r.history[r.historyi]:
                 r.buffer = list(r.history[r.historyi])
                 r.pos = len(r.buffer)
-                r.dirty = True
+                r.invalidate_buffer(0)
 
 
 class first_history(commands.Command):
@@ -130,10 +130,11 @@ def do(self) -> None:
             o = len(r.yank_arg_yanked)
         else:
             o = 0
+        start = r.pos - o
         b[r.pos - o : r.pos] = list(w)
         r.yank_arg_yanked = w
         r.pos += len(w) - o
-        r.dirty = True
+        r.invalidate_buffer(start)
 
 
 class forward_history_isearch(commands.Command):
@@ -142,15 +143,15 @@ def do(self) -> None:
         r.isearch_direction = ISEARCH_DIRECTION_FORWARDS
         r.isearch_start = r.historyi, r.pos
         r.isearch_term = ""
-        r.dirty = True
+        r.invalidate_prompt()
         r.push_input_trans(r.isearch_trans)
 
 
 class reverse_history_isearch(commands.Command):
     def do(self) -> None:
         r = self.reader
         r.isearch_direction = ISEARCH_DIRECTION_BACKWARDS
-        r.dirty = True
+        r.invalidate_prompt()
         r.isearch_term = ""
         r.push_input_trans(r.isearch_trans)
         r.isearch_start = r.historyi, r.pos
@@ -163,15 +164,15 @@ def do(self) -> None:
         r.pop_input_trans()
         r.select_item(r.isearch_start[0])
         r.pos = r.isearch_start[1]
-        r.dirty = True
+        r.invalidate_prompt()
 
 
 class isearch_add_character(commands.Command):
     def do(self) -> None:
         r = self.reader
         b = r.buffer
         r.isearch_term += self.event[-1]
-        r.dirty = True
+        r.invalidate_prompt()
         p = r.pos + len(r.isearch_term) - 1
         if b[p : p + 1] != [r.isearch_term[-1]]:
             r.isearch_next()
@@ -182,7 +183,7 @@ def do(self) -> None:
         r = self.reader
         if len(r.isearch_term) > 0:
             r.isearch_term = r.isearch_term[:-1]
-            r.dirty = True
+            r.invalidate_prompt()
         else:
             r.error("nothing to rubout")
 
@@ -207,7 +208,7 @@ def do(self) -> None:
         r.isearch_direction = ISEARCH_DIRECTION_NONE
         r.console.forgetinput()
         r.pop_input_trans()
-        r.dirty = True
+        r.invalidate_prompt()
 
 
 @dataclass
@@ -278,8 +279,7 @@ def select_item(self, i: int) -> None:
         self.buffer = list(buf)
         self.historyi = i
         self.pos = len(self.buffer)
-        self.dirty = True
-        self.last_refresh_cache.invalidated = True
+        self.invalidate_buffer(0)
 
     def get_item(self, i: int) -> str:
         if i != len(self.history):
@@ -357,7 +357,7 @@ def search_next(self, *, forwards: bool) -> None:
                 if forwards and not match_prefix:
                     self.pos = 0
                     self.buffer = []
-                    self.dirty = True
+                    self.invalidate_buffer(0)
                 else:
                     self.error("not found")
                 return