Exceptions - tmuxp.exc

Exceptions for tmuxp.

exception tmuxp.exc.TmuxpException

exception

exception

exception tmuxp.exc.TmuxpException

Bases: Exception

Base Exception for Tmuxp Errors.

exception tmuxp.exc.WorkspaceError

exception

exception

exception tmuxp.exc.WorkspaceError

Bases: TmuxpException

Error parsing tmuxp workspace data.

exception tmuxp.exc.SessionNotFound

exception

exception

exception tmuxp.exc.SessionNotFound

Bases: TmuxpException

tmux session not found.

__init__(session_target=None, *args, **kwargs)

method

method

__init__(session_target=None, *args, **kwargs)

Parameters:

• session_target (str | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.WindowNotFound

exception

exception

exception tmuxp.exc.WindowNotFound

Bases: TmuxpException

tmux window not found.

__init__(window_target=None, *args, **kwargs)

method

method

__init__(window_target=None, *args, **kwargs)

Parameters:

• window_target (str | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.PaneNotFound

exception

exception

exception tmuxp.exc.PaneNotFound

Bases: TmuxpException

tmux pane not found.

__init__(pane_target=None, *args, **kwargs)

method

method

__init__(pane_target=None, *args, **kwargs)

Parameters:

• pane_target (str | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.EmptyWorkspaceException

exception

exception

exception tmuxp.exc.EmptyWorkspaceException

Bases: WorkspaceError

Workspace file is empty.

__init__(*args, **kwargs)

method

method

__init__(*args, **kwargs)

Parameters:

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.SessionMissingWorkspaceException

exception

exception

exception tmuxp.exc.SessionMissingWorkspaceException

Bases: WorkspaceError, ObjectDoesNotExist

Session missing while loading tmuxp workspace.

__init__(*args, **kwargs)

method

method

__init__(*args, **kwargs)

Parameters:

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.ActiveSessionMissingWorkspaceException

exception

exception

exception tmuxp.exc.ActiveSessionMissingWorkspaceException

Bases: WorkspaceError

Active session cannot be found while loading tmuxp workspace.

__init__(*args, **kwargs)

method

method

__init__(*args, **kwargs)

Parameters:

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.WorkspaceBuilderError

exception

exception

exception tmuxp.exc.WorkspaceBuilderError

Bases: WorkspaceError

Base error for resolving and validating a workspace builder.

exception tmuxp.exc.WorkspaceBuilderNotFound

exception

exception

exception tmuxp.exc.WorkspaceBuilderNotFound

Bases: WorkspaceBuilderError

Configured workspace_builder could not be resolved.

>>> print(WorkspaceBuilderNotFound("nope"))
Workspace builder 'nope' could not be found....

__init__(target, available=None, *args, **kwargs)

method

method

__init__(target, available=None, *args, **kwargs)

Parameters:

• target (str)

• available (list[str] | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.WorkspaceBuilderImportError

exception

exception

exception tmuxp.exc.WorkspaceBuilderImportError

Bases: WorkspaceBuilderError

Configured workspace_builder failed to import.

>>> print(WorkspaceBuilderImportError("pkg:B"))
Could not import workspace builder 'pkg:B'....

__init__(target, reason=None, paths=None, *args, **kwargs)

method

method

__init__(target, reason=None, paths=None, *args, **kwargs)

Parameters:

• target (str)

• reason (str | None)

• paths (list[str] | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.InvalidWorkspaceBuilder

exception

exception

exception tmuxp.exc.InvalidWorkspaceBuilder

Bases: WorkspaceBuilderError

Resolved workspace_builder object is not a usable builder.

>>> print(InvalidWorkspaceBuilder("pkg:B"))
'pkg:B' is not a valid workspace builder.

__init__(target, reason=None, *args, **kwargs)

method

method

__init__(target, reason=None, *args, **kwargs)

Parameters:

• target (str)

• reason (str | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.WorkspaceBuilderPathError

exception

exception

exception tmuxp.exc.WorkspaceBuilderPathError

Bases: WorkspaceBuilderError

A workspace_builder_paths entry is not a usable directory.

>>> print(WorkspaceBuilderPathError("/x"))
workspace_builder_paths entry is invalid: /x....

__init__(path, reason=None, *args, **kwargs)

method

method

__init__(path, reason=None, *args, **kwargs)

Parameters:

• path (str)

• reason (str | None)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.InvalidWorkspaceBuilderOption

exception

exception

exception tmuxp.exc.InvalidWorkspaceBuilderOption

Bases: WorkspaceBuilderError

A workspace_builder_options value is invalid.

>>> print(InvalidWorkspaceBuilderOption("bad"))
Invalid workspace_builder_options: bad

__init__(reason, *args, **kwargs)

method

method

__init__(reason, *args, **kwargs)

Parameters:

• reason (str)

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.TmuxpPluginException

exception

exception

exception tmuxp.exc.TmuxpPluginException

Bases: TmuxpException

Base Exception for Tmuxp Errors.

exception tmuxp.exc.BeforeLoadScriptNotExists

exception

exception

exception tmuxp.exc.BeforeLoadScriptNotExists

Bases: OSError

Raises if shell script could not be found.

__init__(*args, **kwargs)

method

method

__init__(*args, **kwargs)

Parameters:

• args (object)

• kwargs (object)

Return type:

None

exception tmuxp.exc.BeforeLoadScriptError

exception

exception

exception tmuxp.exc.BeforeLoadScriptError

Bases: Exception

Shell script execution error.

Replaces subprocess.CalledProcessError for tmuxp.util.run_before_script().

__init__(returncode, cmd, output=None)

method

method

__init__(returncode, cmd, output=None)

Parameters:

• returncode (int)

• cmd (str)

• output (str | None)

Return type:

None