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

libtmux.options.OptionsMixin._show_options_raw

Python
  • Python
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
libtmux.options
Declared in
OptionsMixin
Package
libtmux
Source
src/libtmux/options.py
_show_options_raw ( 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 , values_only : bool | None = None ) → tmux_cmd
method [source]
method [source]
_show_options_raw

Return a dict of options for the target.

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_raw()
<libtmux.common.tmux_cmd object at ...>
>>> MyServer()._show_options_raw().stdout
[...]
Parameters
  • g ( bool | None ) – Use global_ instead. deprecated 0.50.0

  • quiet ( bool | None ) – Suppress errors silently (-q flag). added 0.56

  • values_only ( bool | None ) – Return only option values without names (-v flag). added 0.56

0 declared, 0 inherited

Esc

Type to search.