Plugin - tmuxp.plugin

Plugin system for tmuxp.

tmuxp.plugin.TMUX_MIN_VERSION = '3.2'

data

Minimum version of tmux required to run tmuxp

tmuxp.plugin.TMUX_MAX_VERSION = None

data

Most recent version of tmux supported

tmuxp.plugin.LIBTMUX_MIN_VERSION = '0.8.3'

data

Minimum version of libtmux required to run libtmux

tmuxp.plugin.LIBTMUX_MAX_VERSION = None

data

Most recent version of libtmux supported

tmuxp.plugin.TMUXP_MIN_VERSION = '1.6.0'

data

Minimum version of tmuxp required to use plugins

tmuxp.plugin.TMUXP_MAX_VERSION = None

data

Most recent version of tmuxp

class tmuxp.plugin.Config

class

Bases: TypedDict

tmuxp plugin configuration mapping.

plugin_name: str

attribute

tmux_min_version: str

attribute

tmux_max_version: str | None

attribute

tmux_version_incompatible: list[str] | None

attribute

libtmux_min_version: str

attribute

libtmux_max_version: str | None

attribute

libtmux_version_incompatible: list[str] | None

attribute

tmuxp_min_version: str

attribute

tmuxp_max_version: str | None

attribute

tmuxp_version_incompatible: list[str] | None

attribute

tmuxp.plugin.validate_plugin_config(config)

function

Return True if tmuxp plugin configuration valid, also upcasts.

Parameters:

config (PluginConfigSchema)

Return type:

TypeGuard[Config]

tmuxp.plugin.setup_plugin_config(config, default_config={'libtmux_max_version': None, 'libtmux_min_version': '0.8.3', 'libtmux_version_incompatible': None, 'plugin_name': 'tmuxp-plugin', 'tmux_max_version': None, 'tmux_min_version': '3.2', 'tmux_version_incompatible': None, 'tmuxp_max_version': None, 'tmuxp_min_version': '1.6.0', 'tmuxp_version_incompatible': None})

function

Initialize tmuxp plugin configuration.

Parameters:

• config (PluginConfigSchema)

• default_config (Config)

Return type:

Config

class tmuxp.plugin.TmuxpPlugin

class

Bases: object

Base class for a tmuxp plugin.

__init__(**kwargs)

method

Initialize plugin.

The default version values are set to the versions that the plugin system requires.

Parameters:

• plugin_name (str) – Name of the child plugin. Used in error message plugin fails to load

• tmux_min_version (str) – Min version of tmux that the plugin supports

• tmux_max_version (str) – Min version of tmux that the plugin supports

• tmux_version_incompatible (list) – Versions of tmux that are incompatible with the plugin

• libtmux_min_version (str) – Min version of libtmux that the plugin supports

• libtmux_max_version (str) – Max version of libtmux that the plugin supports

• libtmux_version_incompatible (list) – Versions of libtmux that are incompatible with the plugin

• tmuxp_min_version (str) – Min version of tmuxp that the plugin supports

• tmuxp_max_version (str) – Max version of tmuxp that the plugin supports

• tmuxp_version_incompatible (list) – Versions of tmuxp that are incompatible with the plugin

• kwargs (Unpack[PluginConfigSchema])

Return type:

None

_version_check()

method

Check all dependency versions for compatibility.

Return type:

None

_pass_version_check(version, vmin, vmax, incompatible)

method

Provide affirmative if version compatibility is correct.

Parameters:

• version (str | LegacyVersion)

• vmin (str)

• vmax (str | None)

• incompatible (list[Any | str])

Return type:

bool

before_workspace_builder(session)

method

Provide a session hook previous to creating the workspace.

This runs after the session has been created but before any of the windows/panes/commands are entered.

Parameters:

session (libtmux.Session) – session to hook into

Return type:

None

on_window_create(window)

method

Provide a window hook previous to doing anything with a window.

This runs runs before anything is created in the windows, like panes.

Parameters:

window (libtmux.Window) – window to hook into

Return type:

None

after_window_finished(window)

method

Provide a window hook after creating the window.

This runs after everything has been created in the window, including the panes and all of the commands for the panes. It also runs after the options_after has been applied to the window.

Parameters:

window (libtmux.Window) – window to hook into

Return type:

None

before_script(session)

method

Provide a session hook after the workspace has been built.

This runs after the workspace has been loaded with tmuxp load. It augments instead of replaces the before_script section of the workspace data.

This hook provides access to the LibTmux.session object for any behavior that would be used in the before_script section of the workspace file that needs access directly to the session object. This runs after the workspace has been loaded with tmuxp load.

The hook augments, rather than replaces, the before_script section of the workspace. While it is possible to do all of the before_script workspace in this function, if a shell script is currently being used for the workspace, it would be cleaner to continue using the script in the before_section.

If changes to the session need to be made prior to anything being built, please use before_workspace_builder instead.

Parameters:

session (libtmux.Session) – session to hook into

Return type:

None

reattach(session)

method

Provide a session hook before reattaching to the session.

Parameters:

session (libtmux.Session) – session to hook into

Return type:

None