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.

Python API

method libtmux stable

Pane._show_option_raw

Return raw option output for target.

Source and package
Qualified name
libtmux.Pane._show_option_raw
Module
libtmux
Declared in
Pane
Package
libtmux
Source
src/libtmux/options.py
_show_option_raw ( self, option: str, global_: bool = False, g: bool = False, scope: OptionScope | _DefaultOptionScope | None = DEFAULT_OPTION_SCOPE, ignore_errors: bool | None = None, include_hooks: bool | None = None, include_inherited: bool | None = None, ) → tmux_cmd

Inherited from libtmux.options.OptionsMixin

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().cmd('new-session', '-d')
<libtmux.common.tmux_cmd object at ...>
>>> MyServer()._show_option_raw('exit-unattached', global_=True)
<libtmux.common.tmux_cmd object at ...>
>>> MyServer()._show_option_raw('exit-unattached', global_=True).stdout
['exit-unattached off']
>>> isinstance(MyServer()._show_option_raw('exit-unattached', global_=True).stdout, list)
True
>>> isinstance(MyServer()._show_option_raw('exit-unattached', global_=True).stdout[0], str)
True
Esc

Type to search.

Reference preview Open reference