Sessions#

Exist inside Servers
Contain Windows (which contain Panes)
Identified by $, e.g. $313

class libtmux.Session(server, session_id, **kwargs)[source]#

Bases: TmuxMappingObject, TmuxRelationalObject[Window, WindowDict], EnvironmentMixin

Holds Window objects.

Parameters:: server (Server) –

Examples

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

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

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

>>> session.attached_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.

child_id_attribute: str = 'window_id'#: Unique child ID key for TmuxRelationalObject

formatter_prefix: str = 'session_'#: Namespace used for TmuxMappingObject

server: Server#: libtmux.server.Server session is linked to

cmd(*args, **kwargs)[source]#

Return server.cmd().

Return type:: server.cmd

Notes

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

Return type:: tmux_cmd

attach_session()[source]#

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

Return type:: None

kill_session()[source]#

$ tmux kill-session.

Return type:: None

switch_client()[source]#

Switch client to this session.

Raises:: exc.LibTmuxException –
Return type:: None

rename_session(new_name)[source]#

Rename session and return new Session object.

Parameters:: new_name (str) – new session name
Return type:: Session
Raises:: exc.BadSessionName –
Return type:: Session

new_window(window_name=None, start_directory=None, attach=True, window_index='', window_shell=None, environment=None)[source]#

Return Window from $ tmux 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.

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.
environment (dict, optional) – Environmental variables for new window. tmux 3.0+ only. Passthrough to -e.

Return type:

Window

Return type:

Window

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.

Parameters:: target_window (str, optional) – window to kill
Return type:: None

property _windows: List[Dict[str, Any]]#

Property / alias to return Session._list_windows().

Return type:: List[Dict[str, Any]]

list_windows()[source]#

Return a list of Window from the tmux(1) session.

Return type:: Window
Return type:: List[Window]

property windows: List[Window]#

Property / alias to return Session.list_windows().

Return type:: List[Window]

property children: List[Window]#

Alias windows for TmuxRelationalObject

Return type:: List[Window]

property attached_window: Window#

Return active Window object.

Return type:: Window
Return type:: Window

select_window(target_window)[source]#

Return Window selected via $ tmux select-window.

Parameters:: window (str) – target_window also ‘last-window’ (-l), ‘next-window’ (-n), or ‘previous-window’ (-p)
Return type:: Window

Notes

Return type:: Window

property attached_pane: Optional[Pane]#

Return active Pane object.

Return type:: Optional[Pane]

find_where(attrs)[source]#

Return object on first match.

Changed in version 0.4: Renamed from .findWhere to .find_where.

Return type:: Union[Pane, Window, Session, None]

get(k[, d]) → D[k] if k in D, else d. d defaults to None.[source]#

get_by_id(id)[source]#

Return object based on child_id_attribute.

Parameters:: val (str) –
Return type:: object
Return type:: Optional[TypeVar(O, Pane, Window, Session)]

getenv(name)[source]#

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

Return the value of a specific variable if the name is specified.

New in version 0.13.

Parameters:: name (str) – the environment variable name. such as ‘PATH’.
Returns:: Value of environment variable
Return type:: str
Return type:: Union[str, bool, None]

items() → a set-like object providing a view on D's items[source]#

keys()[source]#

Return list of keys.

Return type:: KeysView[str]

remove_environment(name)[source]#

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

Parameters:: name (str) – the environment variable name. such as ‘PATH’.
Return type:: None

set_environment(name, value)[source]#

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

Parameters:

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

Return type:

None

set_option(option, value, _global=False)[source]#

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

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)

Raises:

exc.OptionError –
exc.InvalidOption –

Notes

Return type:: None

show_environment()[source]#

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

Return dict of environment variables for the session.

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
Return type:: Dict[str, Union[bool, str]]

unset_environment(name)[source]#

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

Parameters:: name (str) – the environment variable name. such as ‘PATH’.
Return type:: None

values() → an object providing a view on D's values[source]#

where(attrs, first=False)[source]#

Return objects matching child objects properties.

Parameters:: attrs (dict) – tmux properties to match values of
Return type:: list of objects, or one object if first=True
Return type:: Union[List[TypeVar(O, Pane, Window, Session)], TypeVar(O, Pane, Window, Session)]

show_options(_global=False)[source]#

Return a dict of options for the window.

For familiarity with tmux, the option option param forwards to pick a single option, forwarding to Session.show_option().

Parameters:: _global (bool, optional) – Pass -g flag for global variable (server-wide)
Return type:: dict

Notes

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

Return type:: Dict[str, Union[str, int]]

show_option(option, _global=False)[source]#

Return a list of options for the window.

Parameters:

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

Return type:

str, int, or bool

Raises:

exc.OptionError –
exc.InvalidOption –

Notes

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

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

Return type:: Union[str, int, bool, None]