Skip to content

Automation patterns: wait for tmux instead of guessing #734

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

Open
tony wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Automation patterns: wait for tmux instead of guessing #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
173c8d3
Docs(topics[automation]): Wait for tmux, don't guess
tony Jul 31, 2026
8d35933
docs(CHANGES): Automation patterns waits for tmux
tony Aug 1, 2026
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
14 changes: 14 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@ _Notes on the upcoming release will go here._

### Documentation

#### Automation patterns waits for tmux instead of guessing (#734)

The examples on {ref}`automation-patterns` waited for a command to finish by
sleeping a fixed amount and then reading the pane. A sleep long enough to be
safe is dead time on every run, and one short enough to feel quick reports
failure on a busy machine.

They now have the command signal a channel when it finishes and block on that
with {meth}`Server.wait_for() <libtmux.Server.wait_for>`, which returns the
moment the command is done. Checks compare whole captured lines rather than
searching the joined capture, because {meth}`~libtmux.Pane.capture_pane`
returns the command tmux echoed onto the pane -- a substring search matches
that echo and is already true before the shell has run.

#### Cleaner `from_env` examples (#719)

The rendered examples for {meth}`Pane.from_env() <libtmux.Pane.from_env>` and
Expand Down
Loading
Loading