Support new Textual footer

news/597.bugfix.rst

@@ -1 +1 @@
-Fix dynamic toggling between descriptions like "Pause" vs "Unpause" or "Show" vs "Hide" in the footer of the live-mode TUI and tree reporter. This was broken by changes introduced in Textual 0.61.
+Fix dynamic toggling between descriptions like "Pause" vs "Unpause" or "Show" vs "Hide" in the footer of the live-mode TUI and tree reporter. This was broken by changes introduced in Textual 0.61 (and again by Textual 0.63).

src/memray/reporters/_textual_hacks.py

@@ -1,11 +1,14 @@
 import dataclasses
+from typing import Any
 from typing import Dict
 from typing import Tuple
 from typing import Union
 
 from textual import binding
+from textual.app import App
 from textual.binding import Binding
 from textual.dom import DOMNode
+from textual.widgets import Footer
 
 # In Textual 0.61, `App.namespace_bindings` was removed in favor of
 # `Screen.active_bindings`. The two have a slightly different interface:
@@ -24,3 +27,14 @@ def update_key_description(bindings: Bindings, key: str, description: str) -> No
         bindings[key] = val[:1] + (binding,) + val[2:]  # type: ignore
     else:
         bindings[key] = val._replace(binding=binding)  # type: ignore
+
+
+def redraw_footer(app: App[Any]) -> None:
+    footer = app.query_one(Footer)
+    if hasattr(footer, "recompose"):
+        # Added in Textual v0.53
+        footer.refresh(recompose=True)
+    else:  # pragma: no cover
+        # Hack: trick the Footer into redrawing itself
+        footer.highlight_key = "q"  # type: ignore[attr-defined]
+        footer.highlight_key = None  # type: ignore[attr-defined]

src/memray/reporters/tree.py

@@ -38,6 +38,7 @@
 from memray import AllocationRecord
 from memray._memray import size_fmt
 from memray.reporters._textual_hacks import Bindings
+from memray.reporters._textual_hacks import redraw_footer
 from memray.reporters._textual_hacks import update_key_description
 from memray.reporters.frame_tools import is_cpython_internal
 from memray.reporters.frame_tools import is_frame_from_import_system
@@ -367,7 +368,7 @@ def action_toggle_import_system(self) -> None:
         else:
             self.import_system_filter = None
 
-        self.redraw_footer()
+        redraw_footer(self.app)
         self.repopulate_tree(self.query_one(FrameTree))
 
     def action_toggle_uninteresting(self) -> None:
@@ -376,14 +377,9 @@ def action_toggle_uninteresting(self) -> None:
         else:
             self.uninteresting_filter = None
 
-        self.redraw_footer()
+        redraw_footer(self.app)
         self.repopulate_tree(self.query_one(FrameTree))
 
-    def redraw_footer(self) -> None:
-        # Hack: trick the Footer into redrawing itself
-        self.app.query_one(Footer).highlight_key = "q"
-        self.app.query_one(Footer).highlight_key = None
-
     def rewrite_bindings(self, bindings: Bindings) -> None:
         if self.import_system_filter is not None:
             update_key_description(bindings, "i", "Show import system")

src/memray/reporters/tui.py

@@ -48,6 +48,7 @@
 from memray import SocketReader
 from memray._memray import size_fmt
 from memray.reporters._textual_hacks import Bindings
+from memray.reporters._textual_hacks import redraw_footer
 from memray.reporters._textual_hacks import update_key_description
 
 MAX_MEMORY_RATIO = 0.95
@@ -535,8 +536,8 @@ class TUI(Screen[None]):
     thread_idx = reactive(0)
     threads = reactive(_DUMMY_THREAD_LIST, always_update=True)
     snapshot = reactive(_EMPTY_SNAPSHOT)
-    paused = reactive(False)
-    disconnected = reactive(False)
+    paused = reactive(False, init=False)
+    disconnected = reactive(False, init=False)
 
     def __init__(self, pid: Optional[int], cmd_line: Optional[str], native: bool):
         self.pid = pid
@@ -566,7 +567,7 @@ def action_toggle_pause(self) -> None:
         """Toggle pause on keypress"""
         if self.paused or not self.disconnected:
             self.paused = not self.paused
-            self.redraw_footer()
+            redraw_footer(self.app)
             if not self.paused:
                 self.display_snapshot()
 
@@ -592,7 +593,7 @@ def watch_threads(self, threads: List[int]) -> None:
 
     def watch_disconnected(self) -> None:
         self.update_label()
-        self.redraw_footer()
+        redraw_footer(self.app)
 
     def watch_paused(self) -> None:
         self.update_label()
@@ -664,11 +665,6 @@ def update_sort_key(self, col_number: int) -> None:
         body = self.query_one(AllocationTable)
         body.sort_column_id = col_number
 
-    def redraw_footer(self) -> None:
-        # Hack: trick the Footer into redrawing itself
-        self.app.query_one(Footer).highlight_key = "q"
-        self.app.query_one(Footer).highlight_key = None
-
     def rewrite_bindings(self, bindings: Bindings) -> None:
         if "space" in bindings and bindings["space"][1].description == "Pause":
             if self.paused: