Merge pull request #1039 from Textualize/unmount

unmount event

Author: willmcgugan

CHANGELOG.md

@@ -7,9 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.2.2] - Unreleased
 
+### Fixed
+
+- Fixed issue where scrollbars weren't being unmounted
+
 ### Changed
 
 - DOMQuery now raises InvalidQueryFormat in response to invalid query strings, rather than cryptic CSS error
+- Dropped quit_after, screenshot, and screenshot_title from App.run, which can all be done via auto_pilot
+- Widgets are now closed in reversed DOM order
+
+### Added
+
+- Added Unmount event
+- Added App.run_async method
+- Added App.run_test context manager
+- Added auto_pilot to App.run and App.run_async
+- Added Widget._get_virtual_dom to get scrollbars
+- Added size parameter to run and run_async
 
 ## [0.2.1] - 2022-10-23
 

docs/reference/pilot.md

@@ -0,0 +1 @@
+::: textual.pilot

mkdocs.yml

@@ -107,6 +107,7 @@ nav:
     - "reference/index.md"
     - "reference/message_pump.md"
     - "reference/message.md"
+    - "reference/pilot.md"
     - "reference/query.md"
     - "reference/reactive.md"
     - "reference/screen.md"

src/textual/__init__.py

@@ -51,7 +51,9 @@ def __call__(self, *args: object, **kwargs) -> None:
         try:
             app = active_app.get()
         except LookupError:
-            raise LoggerError("Unable to log without an active app.") from None
+            print_args = (*args, *[f"{key}={value!r}" for key, value in kwargs.items()])
+            print(*print_args)
+            return
         if app.devtools is None or not app.devtools.is_connected:
             return
 

src/textual/_doc.py

@@ -5,6 +5,7 @@
 from typing import Iterable
 
 from textual.app import App
+from textual.pilot import Pilot
 from textual._import_app import import_app
 
 
@@ -18,7 +19,7 @@ def format_svg(source, language, css_class, options, md, attrs, **kwargs) -> str
         path = cmd[0]
 
         _press = attrs.get("press", None)
-        press = [*_press.split(",")] if _press else ["_"]
+        press = [*_press.split(",")] if _press else []
         title = attrs.get("title")
 
         print(f"screenshotting {path!r}")
@@ -28,7 +29,7 @@ def format_svg(source, language, css_class, options, md, attrs, **kwargs) -> str
             rows = int(attrs.get("lines", 24))
             columns = int(attrs.get("columns", 80))
             svg = take_svg_screenshot(
-                None, path, press, title, terminal_size=(rows, columns)
+                None, path, press, title, terminal_size=(columns, rows)
             )
         finally:
             os.chdir(cwd)
@@ -45,9 +46,9 @@ def format_svg(source, language, css_class, options, md, attrs, **kwargs) -> str
 def take_svg_screenshot(
     app: App | None = None,
     app_path: str | None = None,
-    press: Iterable[str] = ("_",),
+    press: Iterable[str] = (),
     title: str | None = None,
-    terminal_size: tuple[int, int] = (24, 80),
+    terminal_size: tuple[int, int] = (80, 24),
 ) -> str:
     """
 
@@ -63,25 +64,29 @@ def take_svg_screenshot(
             the screenshot was taken.
 
     """
-    rows, columns = terminal_size
-
-    os.environ["COLUMNS"] = str(columns)
-    os.environ["LINES"] = str(rows)
 
     if app is None:
+        assert app_path is not None
         app = import_app(app_path)
 
+    assert app is not None
+
     if title is None:
         title = app.title
 
-    app.run(
-        quit_after=5,
-        press=press or ["ctrl+c"],
+    async def auto_pilot(pilot: Pilot) -> None:
+        app = pilot.app
+        await pilot.press(*press)
+        svg = app.export_screenshot(title=title)
+        app.exit(svg)
+
+    svg = app.run(
         headless=True,
-        screenshot=True,
-        screenshot_title=title,
+        auto_pilot=auto_pilot,
+        size=terminal_size,
     )
-    svg = app._screenshot
+    assert svg is not None
+
     return svg