Skip to content

Commit 86661d0

Browse files
committed
Window: Add show_option(), deprecate show_window_option()
1 parent 4bdb97f commit 86661d0

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

src/libtmux/window.py

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -420,12 +420,18 @@ def set_option(
420420
return self
421421

422422
def show_window_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict":
423-
"""
424-
Return a dict of options for the window.
423+
"""Show option for tmux window. Deprecated by :meth:`Window.show_options()`.
424+
425+
.. deprecated:: 0.26
425426
426-
.. versionchanged:: 0.13.0
427+
Deprecated by :meth:`Window.show_options()`.
427428
428-
``option`` removed, use show_window_option to return an individual option.
429+
"""
430+
warnings.warn("Window.show_window_options() is deprecated", stacklevel=2)
431+
return self.show_options(g=g)
432+
433+
def show_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict":
434+
"""Return a dict of options for the window.
429435
430436
Parameters
431437
----------
@@ -460,8 +466,20 @@ def show_window_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict"
460466
def show_window_option(
461467
self, option: str, g: bool = False
462468
) -> t.Optional[t.Union[str, int]]:
469+
"""Return option for target window. Deprecated by :meth:`Window.show_option()`.
470+
471+
.. deprecated:: 0.26
472+
473+
Deprecated by :meth:`Window.show_option()`.
474+
463475
"""
464-
Return option value for the target window.
476+
warnings.warn("Window.show_window_option() is deprecated", stacklevel=2)
477+
return self.show_option(option=option, g=g)
478+
479+
def show_option(
480+
self, option: str, g: bool = False
481+
) -> t.Optional[t.Union[str, int]]:
482+
"""Return option value for the target window.
465483
466484
todo: test and return True/False for on/off string
467485

0 commit comments

Comments
 (0)