Utilities - tmuxp.util

Utility and helper methods for tmuxp.

tmuxp.util.run_before_script(script_file, cwd=None, on_line=None)

function

function

tmuxp.util.run_before_script(script_file, cwd=None, on_line=None)

Execute shell script, streaming output to callback or terminal (if TTY).

Output is buffered and optionally forwarded via the on_line callback.

Parameters:

• script_file (str | Path)

• cwd (Path | None)

• on_line (Callable[[str], None] | None)

Return type:

int

tmuxp.util.oh_my_zsh_auto_title()

function

function

tmuxp.util.oh_my_zsh_auto_title()

Give warning and offer to fix DISABLE_AUTO_TITLE.

See: https://github.com/robbyrussell/oh-my-zsh/pull/257

Return type:

None

tmuxp.util.get_current_pane(server)

function

function

tmuxp.util.get_current_pane(server)

Return Pane if one found in env.

Parameters:

server (Server)

Return type:

Pane | None

tmuxp.util.get_session(server, session_name=None, current_pane=None)

function

function

tmuxp.util.get_session(server, session_name=None, current_pane=None)

Get tmux session for server by session name, respects current pane, if passed.

Parameters:

• server (Server)

• session_name (str | None)

• current_pane (Pane | None)

Return type:

Session

tmuxp.util.get_window(session, window_name=None, current_pane=None)

function

function

tmuxp.util.get_window(session, window_name=None, current_pane=None)

Get tmux window for server by window name, respects current pane, if passed.

Parameters:

• session (Session)

• window_name (str | None)

• current_pane (Pane | None)

Return type:

Window

tmuxp.util.get_pane(window, current_pane=None)

function

function

tmuxp.util.get_pane(window, current_pane=None)

Get tmux pane for server by pane name, respects current pane, if passed.

Parameters:

• window (Window)

• current_pane (Pane | None)

Return type:

Pane