Typings - tmuxp._internal.types

Internal, typing.TYPE_CHECKING guarded typings.

These are _not_ to be imported at runtime as typing_extensions is not bundled with tmuxp. Usage example:

>>> import typing as t

>>> if t.TYPE_CHECKING:
...     from tmuxp._internal.types import PluginConfigSchema
...

class tmuxp._internal.types.PluginConfigSchema

class

class

class tmuxp._internal.types.PluginConfigSchema

Bases: TypedDict

Keyword arguments accepted by tmuxp.plugin.TmuxpPlugin.

Every key is optional. tmuxp.plugin.setup_plugin_config() fills each omitted key from tmuxp.plugin.DEFAULT_CONFIG before the plugin runs its version checks.

plugin_name: NotRequired[str]

attribute

attribute

plugin_name: NotRequired[str]

Name of the plugin, used to identify it in version incompatibility messages.

tmux_min_version: NotRequired[str]

attribute

attribute

tmux_min_version: NotRequired[str]

Oldest tmux version the plugin supports.

tmux_max_version: NotRequired[str]

attribute

attribute

tmux_max_version: NotRequired[str]

Newest tmux version the plugin supports.

tmux_version_incompatible: NotRequired[list[str]]

attribute

attribute

tmux_version_incompatible: NotRequired[list[str]]

Individual tmux versions the plugin rejects even though they fall inside the min / max range.

libtmux_min_version: NotRequired[str]

attribute

attribute

libtmux_min_version: NotRequired[str]

Oldest libtmux version the plugin supports.

libtmux_max_version: NotRequired[str]

attribute

attribute

libtmux_max_version: NotRequired[str]

Newest libtmux version the plugin supports.

libtmux_version_incompatible: NotRequired[list[str]]

attribute

attribute

libtmux_version_incompatible: NotRequired[list[str]]

Individual libtmux versions the plugin rejects even though they fall inside the min / max range.

tmuxp_min_version: NotRequired[str]

attribute

attribute

tmuxp_min_version: NotRequired[str]

Oldest tmuxp version the plugin supports.

tmuxp_max_version: NotRequired[str]

attribute

attribute

tmuxp_max_version: NotRequired[str]

Newest tmuxp version the plugin supports.

tmuxp_version_incompatible: NotRequired[list[str]]

attribute

attribute

tmuxp_version_incompatible: NotRequired[list[str]]

Individual tmuxp versions the plugin rejects even though they fall inside the min / max range.