Exceptions

libtmux exceptions.

libtmux.exc

exception libtmux.exc.LibTmuxException
exception[source]
exception[source]
exception libtmux.exc.LibTmuxException

Bases: Exception

Base Exception for libtmux Errors.

exception libtmux.exc.DeprecatedError
exception[source]
exception[source]
exception libtmux.exc.DeprecatedError

Bases: LibTmuxException

Raised when a deprecated function, method, or parameter is used.

This exception provides clear guidance on what to use instead.

Parameters:

  • deprecated (str) – The name of the deprecated API (e.g., “Pane.resize_pane()”)

  • replacement (str) – The recommended replacement API to use instead

  • version (str) – The version when the API was deprecated (e.g., “0.28.0”)

__init__(*, deprecated, replacement, version)
method[source]
method[source]
__init__(*, deprecated, replacement, version)
Parameters:

  • deprecated (str)

  • replacement (str)

  • version (str)

Return type:

None

exception libtmux.exc.TmuxSessionExists
exception[source]
exception[source]
exception libtmux.exc.TmuxSessionExists

Bases: LibTmuxException

Session does not exist in the server.

exception libtmux.exc.TmuxCommandNotFound
exception[source]
exception[source]
exception libtmux.exc.TmuxCommandNotFound

Bases: LibTmuxException

Application binary for tmux not found.

exception libtmux.exc.TmuxObjectDoesNotExist
exception[source]
exception[source]
exception libtmux.exc.TmuxObjectDoesNotExist

Bases: ObjectDoesNotExist

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)
method[source]
method[source]
__init__(obj_key=None, obj_id=None, list_cmd=None, list_extra_args=None, *args)
Parameters:
Return type:

None

exception libtmux.exc.VersionTooLow
exception[source]
exception[source]
exception libtmux.exc.VersionTooLow

Bases: LibTmuxException

Raised if tmux below the minimum version to use libtmux.

exception libtmux.exc.BadSessionName
exception[source]
exception[source]
exception libtmux.exc.BadSessionName

Bases: LibTmuxException

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

__init__(reason, session_name=None, *args)
method[source]
method[source]
__init__(reason, session_name=None, *args)
Parameters:
Return type:

None

exception libtmux.exc.OptionError
exception[source]
exception[source]
exception libtmux.exc.OptionError

Bases: LibTmuxException

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

exception libtmux.exc.UnknownOption
exception[source]
exception[source]
exception libtmux.exc.UnknownOption

Bases: OptionError

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

exception libtmux.exc.UnknownColorOption
exception[source]
exception[source]
exception libtmux.exc.UnknownColorOption

Bases: UnknownOption

Unknown color option.

__init__(*args)
method[source]
method[source]
__init__(*args)
Parameters:

args (object)

Return type:

None

exception libtmux.exc.InvalidOption
exception[source]
exception[source]
exception libtmux.exc.InvalidOption

Bases: OptionError

Option invalid to tmux.

exception libtmux.exc.AmbiguousOption
exception[source]
exception[source]
exception libtmux.exc.AmbiguousOption

Bases: OptionError

Option that could potentially match more than one.

exception libtmux.exc.WaitTimeout
exception[source]
exception[source]
exception libtmux.exc.WaitTimeout

Bases: LibTmuxException

Function timed out without meeting condition.

exception libtmux.exc.VariableUnpackingError
exception[source]
exception[source]
exception libtmux.exc.VariableUnpackingError

Bases: LibTmuxException

Error unpacking variable.

__init__(variable=None, *args)
method[source]
method[source]
__init__(variable=None, *args)
Parameters:
Return type:

None

exception libtmux.exc.PaneError
exception[source]
exception[source]
exception libtmux.exc.PaneError

Bases: LibTmuxException

Any type of pane related error.

exception libtmux.exc.PaneNotFound
exception[source]
exception[source]
exception libtmux.exc.PaneNotFound

Bases: PaneError

Pane not found.

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

None

exception libtmux.exc.WindowError
exception[source]
exception[source]
exception libtmux.exc.WindowError

Bases: LibTmuxException

Any type of window related error.

exception libtmux.exc.MultipleActiveWindows
exception[source]
exception[source]
exception libtmux.exc.MultipleActiveWindows

Bases: WindowError

Multiple active windows.

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

None

exception libtmux.exc.NoActiveWindow
exception[source]
exception[source]
exception libtmux.exc.NoActiveWindow

Bases: WindowError

No active window found.

__init__(*args)
method[source]
method[source]
__init__(*args)
Parameters:

args (object)

Return type:

None

exception libtmux.exc.NoWindowsExist
exception[source]
exception[source]
exception libtmux.exc.NoWindowsExist

Bases: WindowError

No windows exist for object.

__init__(*args)
method[source]
method[source]
__init__(*args)
Parameters:

args (object)

Return type:

None

exception libtmux.exc.AdjustmentDirectionRequiresAdjustment
exception[source]
exception[source]
exception libtmux.exc.AdjustmentDirectionRequiresAdjustment

Bases: LibTmuxException, ValueError

If adjustment_direction is set, adjustment must be set.

__init__()
method[source]
method[source]
__init__()
Return type:

None

exception libtmux.exc.WindowAdjustmentDirectionRequiresAdjustment
exception[source]
exception[source]
exception libtmux.exc.WindowAdjustmentDirectionRequiresAdjustment

Bases: WindowError, AdjustmentDirectionRequiresAdjustment

ValueError for libtmux.Window.resize_window().

exception libtmux.exc.PaneAdjustmentDirectionRequiresAdjustment
exception[source]
exception[source]
exception libtmux.exc.PaneAdjustmentDirectionRequiresAdjustment

Bases: WindowError, AdjustmentDirectionRequiresAdjustment

ValueError for libtmux.Pane.resize_pane().

exception libtmux.exc.RequiresDigitOrPercentage
exception[source]
exception[source]
exception libtmux.exc.RequiresDigitOrPercentage

Bases: LibTmuxException, ValueError

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

__init__()
method[source]
method[source]
__init__()
Return type:

None