Exceptions#

libtmux exceptions.

libtmux.exc#

exception libtmux.exc.LibTmuxException[source]#

Base Exception for libtmux Errors.

exception libtmux.exc.TmuxSessionExists[source]#

Session does not exist in the server.

exception libtmux.exc.TmuxCommandNotFound[source]#

Application binary for tmux not found.

exception libtmux.exc.TmuxObjectDoesNotExist[source]#

The query returned multiple objects when only one was expected.

__init__(obj_key=None, obj_id=None, list_cmd=None, list_extra_args=None, *args)[source]#
Parameters:
  • obj_key (str | None) –

  • obj_id (str | None) –

  • list_cmd (str | None) –

  • list_extra_args (t.Optional[ListExtraArgs]) –

  • args (object) –

Return type:

None

exception libtmux.exc.VersionTooLow[source]#

Raised if tmux below the minimum version to use libtmux.

exception libtmux.exc.BadSessionName[source]#

Disallowed session name for tmux (empty, contains periods or colons).

__init__(reason, session_name=None, *args)[source]#
Parameters:
  • reason (str) –

  • session_name (str | None) –

  • args (object) –

Return type:

None

exception libtmux.exc.OptionError[source]#

Root error for any error involving invalid, ambiguous or bad options.

exception libtmux.exc.UnknownOption[source]#

Option unknown to tmux show-option(s) or show-window-option(s).

exception libtmux.exc.UnknownColorOption[source]#

Unknown color option.

__init__(*args)[source]#
Parameters:

args (object) –

Return type:

None

exception libtmux.exc.InvalidOption[source]#

Option invalid to tmux, introduced in tmux v2.4.

exception libtmux.exc.AmbiguousOption[source]#

Option that could potentially match more than one.

exception libtmux.exc.WaitTimeout[source]#

Function timed out without meeting condition.

exception libtmux.exc.VariableUnpackingError[source]#

Error unpacking variable.

__init__(variable=None, *args)[source]#
Parameters:
  • variable (Any | None) –

  • args (object) –

Return type:

None

exception libtmux.exc.PaneError[source]#

Any type of pane related error.

exception libtmux.exc.PaneNotFound[source]#

Pane not found.

__init__(pane_id=None, *args)[source]#
Parameters:
Return type:

None

exception libtmux.exc.WindowError[source]#

Any type of window related error.

exception libtmux.exc.MultipleActiveWindows[source]#

Multiple active windows.

__init__(count, *args)[source]#
Parameters:
Return type:

None

exception libtmux.exc.NoActiveWindow[source]#

No active window found.

__init__(*args)[source]#
Parameters:

args (object) –

Return type:

None

exception libtmux.exc.NoWindowsExist[source]#

No windows exist for object.

__init__(*args)[source]#
Parameters:

args (object) –

Return type:

None

exception libtmux.exc.AdjustmentDirectionRequiresAdjustment[source]#

If adjustment_direction is set, adjustment must be set.

__init__()[source]#
Return type:

None

exception libtmux.exc.WindowAdjustmentDirectionRequiresAdjustment[source]#

ValueError for libtmux.Window.resize_window().

exception libtmux.exc.PaneAdjustmentDirectionRequiresAdjustment[source]#

ValueError for libtmux.Pane.resize_pane().

exception libtmux.exc.RequiresDigitOrPercentage[source]#

Requires digit (int or str digit) or a percentage.

__init__()[source]#
Return type:

None