handle_option_error
Raise exception if error in option command found.
Source and package
- Qualified name
-
libtmux.options .handle _option _error - Module
- libtmux.options
- Package
- libtmux
- Source
- src/libtmux/options.py
-
Description#
In tmux 3.0, show-option and show-window-option return invalid option instead of unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
In tmux >2.4, there are 3 different types of option errors:
- unknown option
- invalid option
- ambiguous option
In tmux <2.4, unknown option was the only option.
All errors raised will have the base error of
exc.OptionError. So to catch any option error, useexcept exc.OptionError.Examples#
>>> result = server.cmd(... 'set-option',... 'unknown-option-name',... )>>> bool(isinstance(result.stderr, list) and len(result.stderr))True>>> import pytest>>> from libtmux import exc>>> with pytest.raises(exc.OptionError):... handle_option_error(result.stderr[0])- Parameters
- Raises