Sessions

class libtmux.Session[source]

Bases: Obj, EnvironmentMixin

tmux(1) Session [session_manual].

Holds Window objects.

Parameters:

server (Server)

Examples

>>> session
Session($1 ...)

>>> session.windows
[Window(@1 ...:..., Session($1 ...)]

>>> session.active_window
Window(@1 ...:..., Session($1 ...))

>>> session.active_pane
Pane(%1 Window(@1 ...:..., Session($1 ...)))

References

[session_manual]
tmux session. openbsd manpage for TMUX(1).

“When tmux is started it creates a new session with a single window and displays it on screen…”

“A session is a single collection of pseudo terminals under the management of tmux. Each session has one or more windows linked to it.”

https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.

refresh()[source]

Refresh session attributes from tmux.

Return type:

None

classmethod from_session_id(server, session_id)[source]

Create Session from existing session_id.

Return type:

Session

Parameters:
property windows: QueryList[Window]

Windows contained by session.

Can be accessed via .windows.get() and .windows.filter()

property panes: QueryList[Pane]

Panes contained by session’s windows.

Can be accessed via .panes.get() and .panes.filter()

cmd(cmd, *args, target=None)[source]

Execute tmux subcommand within session context.

Automatically binds target by adding -t for object’s session ID to the command. Pass target to keyword arguments to override.

Return type:

tmux_cmd

Parameters:

Examples

>>> session.cmd('new-window', '-P').stdout[0]
'libtmux...:....0'

From raw output to an enriched Window object:

>>> Window.from_window_id(window_id=session.cmd(
... 'new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
Window(@... ...:..., Session($1 libtmux_...))
Parameters:

  • target (str, optional) – Optional custom target override. By default, the target is the session ID.

  • cmd (str)

  • args (Any)

Return type:

server.cmd()

Notes

Changed in version 0.34: Passing target by -t is ignored. Use target keyword argument instead.

Changed in version 0.8: Renamed from .tmux to .cmd.

set_option(option, value, global_=False)[source]

Set option $ tmux set-option <option> <value>.

Return type:

Session

Parameters:

  • option (str) – the window option. such as ‘default-shell’.

  • value (str, int, or bool) – True/False will turn in ‘on’ and ‘off’. You can also enter ‘on’ or ‘off’ directly.

  • _global (bool, optional) – check for option globally across all servers (-g)

  • global_ (bool)

Raises:

Notes

show_options(global_=False)[source]

Return dict of options for the session.

Return type:

dict[str, Union[str, int]]

Parameters:

  • _global (bool, optional) – Pass -g flag for global variable (server-wide)

  • global_ (bool | None)

Return type:

dict

Notes

Uses _global for keyword name instead of global to avoid colliding with reserved keyword.

show_option(option, global_=False)[source]

Return option value for the target session.

Return type:

Union[str, int, bool, None]

Parameters:

  • option (str) – option name

  • _global (bool, optional) – use global option scope, same as -g

  • global_ (bool)

Return type:

str, int, or bool

Raises:

Notes

Uses _global for keyword name instead of global to avoid colliding with reserved keyword.

Test and return True/False for on/off string.

select_window(target_window)[source]

Select window and return the selected window.

Return type:

Window

Parameters:

  • window (str) – target_window can also be ‘last-window’ (-l), ‘next-window’ (-n), or ‘previous-window’ (-p)

  • target_window (str | int)

Return type:

Window

Notes

property active_pane: Pane | None

Return the active Pane object.

property active_window: Window

Return the active Window object.

attach(exit_=None, flags_=None)[source]

Return $ tmux attach-session aka alias: $ tmux attach.

Return type:

Session

Parameters:

Examples

>>> session = server.new_session()

>>> session not in server.attached_sessions
True
kill(all_except=None, clear=None)[source]

Kill Session, closes linked windows and detach all clients.

$ tmux kill-session.

Return type:

None

Parameters:

  • all_except (bool, optional) – Kill all sessions in server except this one.

  • clear (bool, optional) – Clear alerts (bell, activity, or silence) in all windows.

Examples

Kill a session:

>>> session_1 = server.new_session()

>>> session_1 in server.sessions
True

>>> session_1.kill()

>>> session_1 not in server.sessions
True

Kill all sessions except the current one:

>>> one_session_to_rule_them_all = server.new_session()

>>> other_sessions = server.new_session(
...     ), server.new_session()

>>> all([w in server.sessions for w in other_sessions])
True

>>> one_session_to_rule_them_all.kill(all_except=True)

>>> all([w not in server.sessions for w in other_sessions])
True

>>> one_session_to_rule_them_all in server.sessions
True
switch_client()[source]

Switch client to session.

Return type:

Session

Raises:

exc.LibTmuxException –

rename_session(new_name)[source]

Rename session and return new Session object.

Return type:

Session

Parameters:

new_name (str) – new session name

Raises:

exc.BadSessionName –

new_window(window_name=None, *, start_directory=None, attach=False, window_index='', window_shell=None, environment=None, direction=None, target_window=None)[source]

Create new window, returns new Window.

By default, this will make the window active. For the new window to be created and not set to current, pass in attach=False.

Return type:

Window

Parameters:

  • window_name (str, optional)

  • start_directory (str, optional) – working directory in which the new window is created.

  • attach (bool, optional) – make new window the current window after creating it, default True.

  • window_index (str) – create the new window at the given index position. Default is empty string which will create the window in the next available position.

  • window_shell (str, optional) –

    execute a command on starting the window. The window will close when the command exits.

    Note

    When this command exits the window will close. This feature is useful for long-running processes where the closing of the window upon completion is desired.

  • direction (WindowDirection, optional) – Insert window before or after target window (tmux 3.2+).

  • target_window (str, optional) – Used by Window.new_window() to specify the target window.

  • versionchanged: (..) – 0.28.0: attach default changed from True to False.

  • environment (dict[str, str] | None)

See also

Window.new_window()

Examples

>>> window_initial = session.new_window(window_name='Example')
>>> window_initial
Window(@... 2:Example, Session($1 libtmux_...))
>>> window_initial.window_index
'2'

>>> window_before = session.new_window(
... window_name='Window before', direction=WindowDirection.Before)
>>> window_initial.refresh()
>>> window_before
Window(@... 1:Window before, Session($1 libtmux_...))
>>> window_initial
Window(@... 3:Example, Session($1 libtmux_...))

>>> window_after = session.new_window(
... window_name='Window after', direction=WindowDirection.After)
>>> window_initial.refresh()
>>> window_after.refresh()
>>> window_after
Window(@... 3:Window after, Session($1 libtmux_...))
>>> window_initial
Window(@... 4:Example, Session($1 libtmux_...))
>>> window_before
Window(@... 1:Window before, Session($1 libtmux_...))
Returns:

The newly created window.

Return type:

Window

Parameters:

  • window_name (str | None)

  • start_directory (None)

  • attach (bool)

  • window_index (str)

  • window_shell (str | None)

  • environment (dict[str, str] | None)

  • direction (WindowDirection | None)

  • target_window (str | None)

kill_window(target_window=None)[source]

Close a tmux window, and all panes inside it, $ tmux kill-window.

Kill the current window or the window at target-window. removing it from any sessions to which it is linked.

Return type:

None

Parameters:

target_window (str, optional) – window to kill

property id: str | None

Alias of Session.session_id.

>>> session.id
'$1'

>>> session.id == session.session_id
True
property name: str | None

Alias of Session.session_name.

>>> session.name
'libtmux_...'

>>> session.name == session.session_name
True
property attached_pane: Pane | None

Return the active Pane object.

Notes

Deprecated since version 0.31: Deprecated in favor of active_pane().

property attached_window: Window

Return the active Window object.

Notes

Deprecated since version 0.31: Deprecated in favor of active_window().

attach_session()[source]

Return $ tmux attach-session aka alias: $ tmux attach.

Return type:

Session

Notes

Deprecated since version 0.30: Deprecated in favor of attach().

kill_session()[source]

Destroy session.

Return type:

None

Notes

Deprecated since version 0.30: Deprecated in favor of kill().

get(key, default=None)[source]

Return key-based lookup. Deprecated by attributes. :rtype: Any

Deprecated since version 0.16: Deprecated by attribute lookup.e.g. session['session_name'] is now accessed via session.session_name.

Parameters:

  • key (str)

  • default (Any | None)

Return type:

Any

get_by_id(session_id)[source]

Return window by id. Deprecated in favor of windows.get(). :rtype: Optional[Window]

Deprecated since version 0.16: Deprecated by windows.get().

Parameters:

session_id (str)

Return type:

Window | None

where(kwargs)[source]

Filter through windows, return list of Window. :rtype: list[Window]

Deprecated since version 0.16: Deprecated by windows.filter().

Parameters:

kwargs (dict[str, Any])

Return type:

list[Window]

find_where(kwargs)[source]

Filter through windows, return first Window. :rtype: Optional[Window]

Deprecated since version 0.16: Slated to be removed in favor of windows.get().

Parameters:

kwargs (dict[str, Any])

Return type:

Window | None

_list_windows()[source]

Return list of windows (deprecated in favor of windows). :rtype: list[dict[str, Any]]

Deprecated since version 0.16: Slated to be removed in favor of windows.

Return type:

list[dict[str, Any]]

property _windows: list[dict[str, Any]]

Property / alias to return Session._list_windows().

Deprecated since version 0.16: Slated to be removed in favor of windows.

list_windows()[source]

Return a list of Window from the tmux(1) session. :rtype: list[Window]

Deprecated since version 0.16: Slated to be removed in favor of windows.

Return type:

list[Window]

property children: QueryList[Window]

Was used by TmuxRelationalObject (but that’s longer used in this class).

Deprecated since version 0.16: Slated to be removed in favor of windows.

__init__(server, active_window_index=None, alternate_saved_x=None, alternate_saved_y=None, buffer_name=None, buffer_sample=None, buffer_size=None, client_cell_height=None, client_cell_width=None, client_discarded=None, client_flags=None, client_height=None, client_key_table=None, client_name=None, client_pid=None, client_termname=None, client_tty=None, client_uid=None, client_user=None, client_width=None, client_written=None, command_list_alias=None, command_list_name=None, command_list_usage=None, config_files=None, copy_cursor_line=None, copy_cursor_word=None, copy_cursor_x=None, copy_cursor_y=None, current_file=None, cursor_character=None, cursor_flag=None, cursor_x=None, cursor_y=None, history_bytes=None, history_limit=None, history_size=None, insert_flag=None, keypad_cursor_flag=None, keypad_flag=None, last_window_index=None, line=None, mouse_all_flag=None, mouse_any_flag=None, mouse_button_flag=None, mouse_sgr_flag=None, mouse_standard_flag=None, next_session_id=None, origin_flag=None, pane_active=None, pane_at_bottom=None, pane_at_left=None, pane_at_right=None, pane_at_top=None, pane_bg=None, pane_bottom=None, pane_current_command=None, pane_current_path=None, pane_dead_signal=None, pane_dead_status=None, pane_dead_time=None, pane_fg=None, pane_height=None, pane_id=None, pane_index=None, pane_left=None, pane_pid=None, pane_right=None, pane_search_string=None, pane_start_command=None, pane_start_path=None, pane_tabs=None, pane_top=None, pane_tty=None, pane_width=None, pid=None, scroll_position=None, scroll_region_lower=None, scroll_region_upper=None, search_match=None, selection_end_x=None, selection_end_y=None, selection_start_x=None, selection_start_y=None, session_activity=None, session_alerts=None, session_attached=None, session_attached_list=None, session_created=None, session_group=None, session_group_attached=None, session_group_list=None, session_group_size=None, session_id=None, session_last_attached=None, session_name=None, session_path=None, session_stack=None, session_windows=None, socket_path=None, start_time=None, uid=None, user=None, version=None, window_active=None, window_active_clients=None, window_active_sessions=None, window_activity=None, window_cell_height=None, window_cell_width=None, window_height=None, window_id=None, window_index=None, window_layout=None, window_linked=None, window_linked_sessions=None, window_linked_sessions_list=None, window_marked_flag=None, window_name=None, window_offset_x=None, window_offset_y=None, window_panes=None, window_raw_flags=None, window_stack_index=None, window_width=None, wrap_flag=None)[source]
Parameters:

  • server (Server)

  • active_window_index (str | None)

  • alternate_saved_x (str | None)

  • alternate_saved_y (str | None)

  • buffer_name (str | None)

  • buffer_sample (str | None)

  • buffer_size (str | None)

  • client_cell_height (str | None)

  • client_cell_width (str | None)

  • client_discarded (str | None)

  • client_flags (str | None)

  • client_height (str | None)

  • client_key_table (str | None)

  • client_name (str | None)

  • client_pid (str | None)

  • client_termname (str | None)

  • client_tty (str | None)

  • client_uid (str | None)

  • client_user (str | None)

  • client_width (str | None)

  • client_written (str | None)

  • command_list_alias (str | None)

  • command_list_name (str | None)

  • command_list_usage (str | None)

  • config_files (str | None)

  • copy_cursor_line (str | None)

  • copy_cursor_word (str | None)

  • copy_cursor_x (str | None)

  • copy_cursor_y (str | None)

  • current_file (str | None)

  • cursor_character (str | None)

  • cursor_flag (str | None)

  • cursor_x (str | None)

  • cursor_y (str | None)

  • history_bytes (str | None)

  • history_limit (str | None)

  • history_size (str | None)

  • insert_flag (str | None)

  • keypad_cursor_flag (str | None)

  • keypad_flag (str | None)

  • last_window_index (str | None)

  • line (str | None)

  • mouse_all_flag (str | None)

  • mouse_any_flag (str | None)

  • mouse_button_flag (str | None)

  • mouse_sgr_flag (str | None)

  • mouse_standard_flag (str | None)

  • next_session_id (str | None)

  • origin_flag (str | None)

  • pane_active (str | None)

  • pane_at_bottom (str | None)

  • pane_at_left (str | None)

  • pane_at_right (str | None)

  • pane_at_top (str | None)

  • pane_bg (str | None)

  • pane_bottom (str | None)

  • pane_current_command (str | None)

  • pane_current_path (str | None)

  • pane_dead_signal (str | None)

  • pane_dead_status (str | None)

  • pane_dead_time (str | None)

  • pane_fg (str | None)

  • pane_height (str | None)

  • pane_id (str | None)

  • pane_index (str | None)

  • pane_left (str | None)

  • pane_pid (str | None)

  • pane_right (str | None)

  • pane_search_string (str | None)

  • pane_start_command (str | None)

  • pane_start_path (str | None)

  • pane_tabs (str | None)

  • pane_top (str | None)

  • pane_tty (str | None)

  • pane_width (str | None)

  • pid (str | None)

  • scroll_position (str | None)

  • scroll_region_lower (str | None)

  • scroll_region_upper (str | None)

  • search_match (str | None)

  • selection_end_x (str | None)

  • selection_end_y (str | None)

  • selection_start_x (str | None)

  • selection_start_y (str | None)

  • session_activity (str | None)

  • session_alerts (str | None)

  • session_attached (str | None)

  • session_attached_list (str | None)

  • session_created (str | None)

  • session_group (str | None)

  • session_group_attached (str | None)

  • session_group_list (str | None)

  • session_group_size (str | None)

  • session_id (str | None)

  • session_last_attached (str | None)

  • session_name (str | None)

  • session_path (str | None)

  • session_stack (str | None)

  • session_windows (str | None)

  • socket_path (str | None)

  • start_time (str | None)

  • uid (str | None)

  • user (str | None)

  • version (str | None)

  • window_active (str | None)

  • window_active_clients (str | None)

  • window_active_sessions (str | None)

  • window_activity (str | None)

  • window_cell_height (str | None)

  • window_cell_width (str | None)

  • window_height (str | None)

  • window_id (str | None)

  • window_index (str | None)

  • window_layout (str | None)

  • window_linked (str | None)

  • window_linked_sessions (str | None)

  • window_linked_sessions_list (str | None)

  • window_marked_flag (str | None)

  • window_name (str | None)

  • window_offset_x (str | None)

  • window_offset_y (str | None)

  • window_panes (str | None)

  • window_raw_flags (str | None)

  • window_stack_index (str | None)

  • window_width (str | None)

  • wrap_flag (str | None)

Return type:

None

getenv(name)[source]

Show environment variable $ tmux show-environment -t [session] <name>.

Return the value of a specific variable if the name is specified. :rtype: Union[str, bool, None]

Added in version 0.13.

Parameters:

name (str) – the environment variable name. such as ‘PATH’.

Returns:

Value of environment variable

Return type:

str

remove_environment(name)[source]

Remove environment variable $ tmux set-environment -r <name>.

Return type:

None

Parameters:

name (str) – the environment variable name. such as ‘PATH’.

set_environment(name, value)[source]

Set environment $ tmux set-environment <name> <value>.

Return type:

None

Parameters:

  • name (str) – the environment variable name. such as ‘PATH’.

  • option (str) – environment value.

  • value (str)

show_environment()[source]

Show environment $ tmux show-environment -t [session].

Return dict of environment variables for the session. :rtype: dict[str, Union[bool, str]]

Changed in version 0.13: Removed per-item lookups. Use libtmux.common.EnvironmentMixin.getenv().

Returns:

environmental variables in dict, if no name, or str if name entered.

Return type:

dict

unset_environment(name)[source]

Unset environment variable $ tmux set-environment -u <name>.

Return type:

None

Parameters:

name (str) – the environment variable name. such as ‘PATH’.