Skip to content

Commit 69114e4

Browse files
committed
Window: Add show_option(), deprecate show_window_option()
1 parent 1bb4800 commit 69114e4

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

src/libtmux/window.py

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -462,12 +462,8 @@ def set_option(
462462

463463
return self
464464

465-
def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
466-
"""Return dict of options for window.
467-
468-
.. versionchanged:: 0.13.0
469-
470-
``option`` removed, use show_window_option to return an individual option.
465+
def show_options(self, g: bool | None = False) -> WindowOptionDict:
466+
"""Return a dict of options for the window.
471467
472468
Parameters
473469
----------
@@ -502,7 +498,7 @@ def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
502498

503499
return window_options
504500

505-
def show_window_option(
501+
def show_option(
506502
self,
507503
option: str,
508504
g: bool = False,
@@ -982,6 +978,40 @@ def set_window_option(
982978
)
983979
return self.set_option(option=option, value=value)
984980

981+
def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
982+
"""Show options for tmux window. Deprecated by :meth:`Window.show_options()`.
983+
984+
.. deprecated:: 0.26
985+
986+
Deprecated by :meth:`Window.show_options()`.
987+
988+
"""
989+
warnings.warn(
990+
"Window.show_window_options() is deprecated",
991+
category=DeprecationWarning,
992+
stacklevel=2,
993+
)
994+
return self.show_options(g=g)
995+
996+
def show_window_option(
997+
self,
998+
option: str,
999+
g: bool = False,
1000+
) -> str | int | None:
1001+
"""Return option for target window. Deprecated by :meth:`Window.show_option()`.
1002+
1003+
.. deprecated:: 0.26
1004+
1005+
Deprecated by :meth:`Window.show_option()`.
1006+
1007+
"""
1008+
warnings.warn(
1009+
"Window.show_window_option() is deprecated",
1010+
category=DeprecationWarning,
1011+
stacklevel=2,
1012+
)
1013+
return self.show_option(option=option, g=g)
1014+
9851015
def get(self, key: str, default: t.Any | None = None) -> t.Any:
9861016
"""Return key-based lookup. Deprecated by attributes.
9871017

0 commit comments

Comments
 (0)