Servers#

  • Identified by socket path and socket name

  • May have >1 servers running of tmux at the same time.

  • Contain Sessions (which contain Windows, which contain Panes)

tmux initializes a server on automatically on first running (e.g. executing tmux)

class libtmux.Server(socket_name=None, socket_path=None, config_file=None, colors=None, **kwargs)[source]#

Bases: TmuxRelationalObject[Session, SessionDict], EnvironmentMixin

The tmux(1) Server [server_manual].

When instantiated stores information on live, running tmux server.

Parameters:
  • socket_name (str, optional) –

  • socket_path (str, optional) –

  • config_file (str, optional) –

  • colors (str, optional) –

Examples

>>> server
<libtmux.server.Server object at ...>
>>> server.sessions
[Session($1 ...)]
>>> server.sessions[0].windows
[Window(@1 1:..., Session($1 ...)]
>>> server.sessions[0].attached_window
Window(@1 1:..., Session($1 ...)
>>> server.sessions[0].attached_pane
Pane(%1 Window(@1 1:..., Session($1 ...)))

References

[server_manual]
CLIENTS AND SESSIONS. openbsd manpage for TMUX(1)

“The tmux server manages clients, sessions, windows and panes. Clients are attached to sessions to interact with them, either when they are created with the new-session command, or later with the attach-session command. Each session has one or more windows linked into it. Windows may be linked to multiple sessions and are made up of one or more panes, each of which contains a pseudo terminal.”

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

child_id_attribute: str = 'session_id'#

Unique child ID used by TmuxRelationalObject

formatter_prefix = 'server_'#

Namespace used for TmuxMappingObject

socket_name = None#

Passthrough to [-L socket-name]

socket_path = None#

Passthrough to [-S socket-path]

config_file = None#

Passthrough to [-f file]

colors = None#

-2 or -8

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

Execute tmux command and return output.

Return type:

common.tmux_cmd

Notes

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

Return type:

tmux_cmd

_list_sessions()[source]#

Return list of sessions in dict form.

Retrieved from $ tmux(1) list-sessions stdout.

The list is derived from stdout in common.tmux_cmd which wraps subprocess.Popen.

Return type:

list of dict

Return type:

List[Dict[str, Any]]

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

Property / alias to return _list_sessions().

Return type:

List[Dict[str, Any]]

list_sessions()[source]#

Return list of Session from the tmux(1) session.

Return type:

list of Session

Return type:

List[Session]

property sessions: List[Session]#

Property / alias to return list_sessions().

Return type:

List[Session]

property children: List[Session]#

Alias sessions for TmuxRelationalObject

Return type:

List[Session]

_list_windows()[source]#

Return list of windows in dict form.

Retrieved from $ tmux(1) list-windows stdout.

The list is derived from stdout in common.tmux_cmd which wraps subprocess.Popen.

Return type:

list of dict

Return type:

List[Dict[str, Any]]

_update_windows()[source]#

Update internal window data and return self for chainability.

Return type:

Server

Return type:

Server

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_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]

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

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

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)]

_list_panes()[source]#

Return list of panes in dict form.

Retrieved from $ tmux(1) list-panes stdout.

The list is derived from stdout in util.tmux_cmd which wraps subprocess.Popen.

Return type:

list

Return type:

List[Dict[str, Any]]

_update_panes()[source]#

Update internal pane data and return self for chainability.

Return type:

Server

Return type:

Server

property attached_sessions: Optional[List[Session]]#

Return active Session objects.

Return type:

list of Session

Return type:

Optional[List[Session]]

has_session(target_session, exact=True)[source]#

Return True if session exists. $ tmux has-session.

Parameters:
  • target_session (str) – session name

  • exact (bool) – match the session name exactly. tmux uses fnmatch by default. Internally prepends = to the session in $ tmux has-session. tmux 2.1 and up only.

Raises:

exc.BadSessionName

Return type:

bool

Return type:

bool

kill_server()[source]#

$ tmux kill-server.

Return type:

None

kill_session(target_session)[source]#

Kill the tmux session with $ tmux kill-session, return self.

Parameters:

target_session (str, optional) – target_session: str. note this accepts fnmatch(3). ‘asdf’ will kill ‘asdfasd’.

Return type:

Server

Raises:

exc.BadSessionName

Return type:

Server

switch_client(target_session)[source]#

$ tmux switch-client.

Parameters:

target_session (str) – name of the session. fnmatch(3) works.

Raises:

exc.BadSessionName

Return type:

None

attach_session(target_session=None)[source]#

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

Parameters:

target_session (str) – name of the session. fnmatch(3) works.

Raises:

exc.BadSessionName

Return type:

None

new_session(session_name=None, kill_session=False, attach=False, start_directory=None, window_name=None, window_command=None, *args, **kwargs)[source]#

Return Session from $ tmux new-session.

Uses -P flag to print session info, -F for return formatting returns new Session object.

$ tmux new-session -d will create the session in the background $ tmux new-session -Ad will move to the session name if it already exists. todo: make an option to handle this.

Parameters:
  • session_name (str, optional) –

    $ tmux new-session -s <session_name>
    

  • attach (bool, optional) –

    create session in the foreground. attach=False is equivalent to:

    $ tmux new-session -d
    

  • kill_session (bool, optional) – Kill current session if $ tmux has-session. Useful for testing workspaces.

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

  • window_name (str, optional) –

    $ tmux new-session -n <window_name>
    

  • window_command (str) – execute a command on starting the session. 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.

Return type:

Session

Raises:

exc.BadSessionName

Examples

Sessions can be created without a session name (0.14.2+):

>>> server.new_session()
Session($2 2)

Creating them in succession will enumerate IDs (via tmux):

>>> server.new_session()
Session($3 3)

With a session_name:

>>> server.new_session(session_name='my session')
Session($4 my session)
Return type:

Session