Plugin - tmuxp.plugin

Plugin system for tmuxp.

tmuxp.plugin.TMUX_MIN_VERSION = '3.2'
data
data
tmuxp.plugin.TMUX_MIN_VERSION = '3.2'

Minimum version of tmux required to run tmuxp

tmuxp.plugin.TMUX_MAX_VERSION = None
data
data
tmuxp.plugin.TMUX_MAX_VERSION = None

Most recent version of tmux supported

tmuxp.plugin.LIBTMUX_MIN_VERSION = '0.8.3'
data
data
tmuxp.plugin.LIBTMUX_MIN_VERSION = '0.8.3'

Minimum version of libtmux required to run libtmux

tmuxp.plugin.LIBTMUX_MAX_VERSION = None
data
data
tmuxp.plugin.LIBTMUX_MAX_VERSION = None

Most recent version of libtmux supported

tmuxp.plugin.TMUXP_MIN_VERSION = '1.6.0'
data
data
tmuxp.plugin.TMUXP_MIN_VERSION = '1.6.0'

Minimum version of tmuxp required to use plugins

tmuxp.plugin.TMUXP_MAX_VERSION = None
data
data
tmuxp.plugin.TMUXP_MAX_VERSION = None

Most recent version of tmuxp

class tmuxp.plugin.Config
class[source]
class[source]
class tmuxp.plugin.Config

Bases: TypedDict

tmuxp plugin configuration mapping.

plugin_name: str
attribute
attribute
plugin_name: str
tmux_min_version: str
attribute
attribute
tmux_min_version: str
tmux_max_version: str | None
attribute
attribute
tmux_max_version: str | None
tmux_version_incompatible: list[str] | None
attribute
attribute
tmux_version_incompatible: list[str] | None
libtmux_min_version: str
attribute
attribute
libtmux_min_version: str
libtmux_max_version: str | None
attribute
attribute
libtmux_max_version: str | None
libtmux_version_incompatible: list[str] | None
attribute
attribute
libtmux_version_incompatible: list[str] | None
tmuxp_min_version: str
attribute
attribute
tmuxp_min_version: str
tmuxp_max_version: str | None
attribute
attribute
tmuxp_max_version: str | None
tmuxp_version_incompatible: list[str] | None
attribute
attribute
tmuxp_version_incompatible: list[str] | None
tmuxp.plugin.validate_plugin_config(config)
function[source]
function[source]
tmuxp.plugin.validate_plugin_config(config)

Return True if tmuxp plugin configuration valid, also upcasts.

Parameters:

config (PluginConfigSchema)

Return type:

TypeGuard[Config]

tmuxp.plugin.setup_plugin_config(config, default_config=DEFAULT_CONFIG)
function[source]
function[source]
tmuxp.plugin.setup_plugin_config(config, default_config=DEFAULT_CONFIG)

Initialize tmuxp plugin configuration.

Parameters:
Return type:

Config

class tmuxp.plugin.TmuxpPlugin
class[source]
class[source]
class tmuxp.plugin.TmuxpPlugin

Bases: object

Base class for a tmuxp plugin.

__init__(**kwargs)
method[source]
method[source]
__init__(**kwargs)

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[source]
method[source]
_version_check()

Check all dependency versions for compatibility.

Return type:

None

_pass_version_check(version, vmin, vmax, incompatible)
method[source]
method[source]
_pass_version_check(version, vmin, vmax, incompatible)

Provide affirmative if version compatibility is correct.

Parameters:
Return type:

bool

before_workspace_builder(session)
method[source]
method[source]
before_workspace_builder(session)

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[source]
method[source]
on_window_create(window)

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[source]
method[source]
after_window_finished(window)

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[source]
method[source]
before_script(session)

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[source]
method[source]
reattach(session)

Provide a session hook before reattaching to the session.

Parameters:

session (libtmux.Session) – session to hook into

Return type:

None