Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

method libtmux stable

OptionsMixin._show_options

Return a dict of options for the target.

Source and package
Qualified name
libtmux.options.OptionsMixin._show_options
Module
libtmux.options
Declared in
OptionsMixin
Package
libtmux
Source
src/libtmux/options.py
_show_options ( self, g: bool | None = False, global_: bool | None = False, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, include_hooks: bool | None = None, include_inherited: bool | None = None, quiet: bool | None = None, ) → ExplodedComplexUntypedOptionsDict

Examples#

>>> import typing as t
>>> from libtmux.common import tmux_cmd
>>> from libtmux.constants import OptionScope
>>> class MyServer(OptionsMixin):
... socket_name = server.socket_name
... def cmd(self, cmd: str, *args: object):
... cmd_args: t.List[t.Union[str, int]] = [cmd]
... if self.socket_name:
... cmd_args.insert(0, f"-L{self.socket_name}")
... cmd_args.insert(0, "-f/dev/null")
... return tmux_cmd(*cmd_args, *args)
...
... default_option_scope = OptionScope.Server
>>> MyServer()._show_options()
{...}
Parameters

tmux catalog Options

Esc

Type to search.

Reference preview Open reference