Windows#

Exist inside Sessions
Contain Panes
Identified by @, e.g. @313

class libtmux.Window(session, window_id, **kwargs)[source]#

Bases: TmuxMappingObject, TmuxRelationalObject[Pane, PaneDict]

Holds Pane objects.

Parameters:: session (Session) –

Examples

>>> window = session.new_window('My project')

>>> window
Window(@2 2:My project, Session($... ...))

Windows have panes:

>>> window.panes
[Pane(...)]

>>> window.attached_pane
Pane(...)

Relations moving up:

>>> window.session
Session(...)

>>> window == session.attached_window
True

>>> window in session.windows
True

References

[window_manual]

tmux window. openbsd manpage for TMUX(1).: “Each session has one or more windows linked to it. A window occupies the entire screen and may be split into rectangular panes…”

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

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

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

session: Session#: libtmux.Session window is linked to

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

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

Return Server.cmd() defaulting target_window as target.

Send command to tmux with window_id as target-window.

Specifying ('-t', 'custom-target') or ('-tcustom_target') in args will override using the object’s window_id as target.

Return type:: Server.cmd

Notes

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

Return type:: tmux_cmd

select_layout(layout=None)[source]#

Wrapper for $ tmux select-layout <layout>.

Parameters:

layout (str, optional) –

string of the layout, ‘even-horizontal’, ‘tiled’, etc. Entering None (leaving this blank) is same as select-layout with no layout. In recent tmux versions, it picks the most recently set layout.

’even-horizontal’: Panes are spread out evenly from left to right across the window.
’even-vertical’: Panes are spread evenly from top to bottom.
’main-horizontal’: A large (main) pane is shown at the top of the window and the remaining panes are spread from left to right in the leftover space at the bottom.
’main-vertical’: Similar to main-horizontal but the large pane is placed on the left and the others spread from top to bottom along the right.
’tiled’: Panes are spread out as evenly as possible over the window in both rows and columns.
’custom’: custom dimensions (see tmux(1) manpages).

Return type:

None

set_window_option(option, value)[source]#

Wrapper for $ tmux set-window-option <option> <value>.

Parameters:

option (str) – option to set, e.g. ‘aggressive-resize’
value (str) – window option value. True/False will turn in ‘on’ and ‘off’, also accepts string of ‘on’ or ‘off’ directly.

Raises:

exc.OptionError –
exc.InvalidOption –

Return type:

None

show_window_options(g=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 Window.show_window_option().

Changed in version 0.13.0: option removed, use show_window_option to return an individual option.

Parameters:: g (str, optional) – Pass -g flag for global variable, default False.
Return type:: dict
Return type:: Dict[str, Any]

show_window_option(option, g=False)[source]#

Return a list of options for the window.

todo: test and return True/False for on/off string

Parameters:

option (str) –
g (bool, optional) – Pass -g flag, global. Default False.

Return type:

str, int

Raises:

exc.OptionError –
exc.InvalidOption –

Return type:

Union[str, int, None]

rename_window(new_name)[source]#

Return Window object $ tmux rename-window <new_name>.

Parameters:: new_name (str) – name of the window

Examples

>>> window = session.attached_window

>>> window.rename_window('My project')
Window(@1 1:My project, Session($1 ...))

>>> window.rename_window('New name')
Window(@1 1:New name, Session($1 ...))

Return type:: Window

kill_window()[source]#

Kill the current Window object. $ tmux kill-window.

Return type:: None

move_window(destination='', session=None)[source]#

Move the current Window object $ tmux move-window.

Parameters:

destination (str, optional) – the target window or index to move the window to, default: empty string
session (str, optional) – the target session or index to move the window to, default: current session.

Return type:

None

select_window()[source]#

Select window. Return self.

To select a window object asynchrously. If a window object exists and is no longer longer the current window, w.select_window() will make w the current window.

Return type:: Window
Return type:: Window

select_pane(target_pane)[source]#

Return selected Pane through $ tmux select-pane.

Parameters:: target_pane (str) – ‘target_pane’, ‘-U’ ,’-D’, ‘-L’, ‘-R’, or ‘-l’.
Return type:: Pane
Return type:: Optional[Pane]

last_pane()[source]#

Return last pane.

Return type:: Optional[Pane]

split_window(target=None, start_directory=None, attach=True, vertical=True, shell=None, percent=None)[source]#

Split window and return the created Pane.

Used for splitting window and holding in a python object.

Parameters:

attach (bool, optional) – make new window the current window after creating it, default True.
start_directory (str, optional) – specifies the working directory in which the new window is created.
target (str) – target_pane to split.
vertical (str) – split vertically
shell (str, optional) –
execute a command on splitting the window. The pane will close when the command exits.

NOTE: When this command exits the pane will close. This feature is useful for long-running processes where the closing of the window upon completion is desired.
percent (int, optional) – percentage to occupy with respect to current window

Return type:

Pane

Notes

tmux(1) will move window to the new pane if the split-window target is off screen. tmux handles the -d the same way as new-window and attach in Session.new_window.

By default, this will make the window the pane is created in active. To remain on the same window and split the pane in another target window, pass in attach=False.

Return type:: Pane

property attached_pane: Optional[Pane]#

Return the attached Pane.

Return type:: Pane
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)]

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

keys()[source]#

Return list of keys.

Return type:: KeysView[str]

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

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

Property / alias to return _list_panes().

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

list_panes()[source]#

Return list of Pane for the window.

Return type:: list of Pane
Return type:: List[Pane]

property panes: List[Pane]#

Property / alias to return list_panes().

Return type:: List[Pane]

property children: List[Pane]#

Alias panes for TmuxRelationalObject

Return type:: List[Pane]