"""Plugin system for tmuxp.""" from __future__ import annotations import logging import typing as t import libtmux from libtmux._compat import LegacyVersion as Version from libtmux.common import get_version from .__about__ import __version__ from .exc import TmuxpPluginException logger = logging.getLogger(__name__) #: Minimum version of tmux required to run tmuxp TMUX_MIN_VERSION = "3.2" #: Most recent version of tmux supported TMUX_MAX_VERSION = None #: Minimum version of libtmux required to run libtmux LIBTMUX_MIN_VERSION = "0.8.3" #: Most recent version of libtmux supported LIBTMUX_MAX_VERSION = None #: Minimum version of tmuxp required to use plugins TMUXP_MIN_VERSION = "1.6.0" #: Most recent version of tmuxp TMUXP_MAX_VERSION = None if t.TYPE_CHECKING: from typing import TypeGuard from libtmux.session import Session from libtmux.window import Window from typing_extensions import TypedDict, Unpack from ._internal.types import PluginConfigSchema class VersionConstraints(TypedDict): """Version constraints mapping for a tmuxp plugin.""" version: Version | str vmin: str vmax: str | None incompatible: list[t.Any | str] class TmuxpPluginVersionConstraints(TypedDict): """Version constraints for a tmuxp plugin.""" tmux: VersionConstraints tmuxp: VersionConstraints libtmux: VersionConstraints class Config(t.TypedDict): """tmuxp plugin configuration mapping.""" plugin_name: str tmux_min_version: str tmux_max_version: str | None tmux_version_incompatible: list[str] | None libtmux_min_version: str libtmux_max_version: str | None libtmux_version_incompatible: list[str] | None tmuxp_min_version: str tmuxp_max_version: str | None tmuxp_version_incompatible: list[str] | None DEFAULT_CONFIG: Config = { "plugin_name": "tmuxp-plugin", "tmux_min_version": TMUX_MIN_VERSION, "tmux_max_version": TMUX_MAX_VERSION, "tmux_version_incompatible": None, "libtmux_min_version": LIBTMUX_MIN_VERSION, "libtmux_max_version": LIBTMUX_MAX_VERSION, "libtmux_version_incompatible": None, "tmuxp_min_version": TMUXP_MIN_VERSION, "tmuxp_max_version": TMUXP_MAX_VERSION, "tmuxp_version_incompatible": None, } def validate_plugin_config(config: PluginConfigSchema) -> TypeGuard[Config]: """Return True if tmuxp plugin configuration valid, also upcasts.""" return isinstance(config, dict) def setup_plugin_config( config: PluginConfigSchema, default_config: Config = DEFAULT_CONFIG, ) -> Config: """Initialize tmuxp plugin configuration.""" new_config = config.copy() for default_key, default_value in default_config.items(): if default_key not in new_config: new_config[default_key] = default_value # type:ignore assert validate_plugin_config(new_config) return new_config class TmuxpPlugin: """Base class for a tmuxp plugin.""" def __init__(self, **kwargs: Unpack[PluginConfigSchema]) -> None: """ 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 """ config = setup_plugin_config(config=kwargs) self.plugin_name = config["plugin_name"] # Dependency versions self.tmux_version = get_version() self.libtmux_version = libtmux.__about__.__version__ self.tmuxp_version = Version(__version__) self.version_constraints: TmuxpPluginVersionConstraints = { "tmux": { "version": self.tmux_version, "vmin": config["tmux_min_version"], "vmax": config["tmux_max_version"], "incompatible": config["tmux_version_incompatible"] or [], }, "libtmux": { "version": self.libtmux_version, "vmin": config["libtmux_min_version"], "vmax": config["libtmux_max_version"], "incompatible": config["libtmux_version_incompatible"] or [], }, "tmuxp": { "version": self.tmuxp_version, "vmin": config["tmuxp_min_version"], "vmax": config["tmuxp_max_version"], "incompatible": config["tmuxp_version_incompatible"] or [], }, } self._version_check() def _version_check(self) -> None: """Check all dependency versions for compatibility.""" logger.debug("checking version constraints for %s", self.plugin_name) for dep, constraints in self.version_constraints.items(): assert isinstance(constraints, dict) try: assert self._pass_version_check(**constraints) except AssertionError as e: msg = ( "Incompatible {dep} version: {version}\n{plugin_name} " "requirements:\nmin: {vmin} | max: {vmax} | " "incompatible: {incompatible}\n".format( dep=dep, plugin_name=self.plugin_name, **constraints, ) ) raise TmuxpPluginException( msg, ) from e def _pass_version_check( self, version: str | Version, vmin: str, vmax: str | None, incompatible: list[t.Any | str], ) -> bool: """Provide affirmative if version compatibility is correct.""" if vmin and version < Version(vmin): return False if vmax and version > Version(vmax): return False return version not in incompatible def before_workspace_builder(self, session: Session) -> None: """ 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 : :class:`libtmux.Session` session to hook into """ def on_window_create(self, window: Window) -> None: """ 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: :class:`libtmux.Window` window to hook into """ def after_window_finished(self, window: Window) -> None: """ 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: :class:`libtmux.Window` window to hook into """ def before_script(self, session: Session) -> None: """ 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 :meth:`~tmuxp.plugin.TmuxpPlugin.before_workspace_builder` instead. Parameters ---------- session : :class:`libtmux.Session` session to hook into """ def reattach(self, session: Session) -> None: """ Provide a session hook before reattaching to the session. Parameters ---------- session : :class:`libtmux.Session` session to hook into """