Skip to content

Commit fd42329

Browse files
committed
Window: Add show_option(), deprecate show_window_option()
1 parent 31de209 commit fd42329

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
@@ -511,12 +511,8 @@ def set_option(
511511

512512
return self
513513

514-
def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
515-
"""Return dict of options for window.
516-
517-
.. versionchanged:: 0.13.0
518-
519-
``option`` removed, use show_window_option to return an individual option.
514+
def show_options(self, g: bool | None = False) -> WindowOptionDict:
515+
"""Return a dict of options for the window.
520516
521517
Parameters
522518
----------
@@ -551,7 +547,7 @@ def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
551547

552548
return window_options
553549

554-
def show_window_option(
550+
def show_option(
555551
self,
556552
option: str,
557553
g: bool = False,
@@ -1031,6 +1027,40 @@ def set_window_option(
10311027
)
10321028
return self.set_option(option=option, value=value)
10331029

1030+
def show_window_options(self, g: bool | None = False) -> WindowOptionDict:
1031+
"""Show options for tmux window. Deprecated by :meth:`Window.show_options()`.
1032+
1033+
.. deprecated:: 0.26
1034+
1035+
Deprecated by :meth:`Window.show_options()`.
1036+
1037+
"""
1038+
warnings.warn(
1039+
"Window.show_window_options() is deprecated",
1040+
category=DeprecationWarning,
1041+
stacklevel=2,
1042+
)
1043+
return self.show_options(g=g)
1044+
1045+
def show_window_option(
1046+
self,
1047+
option: str,
1048+
g: bool = False,
1049+
) -> str | int | None:
1050+
"""Return option for target window. Deprecated by :meth:`Window.show_option()`.
1051+
1052+
.. deprecated:: 0.26
1053+
1054+
Deprecated by :meth:`Window.show_option()`.
1055+
1056+
"""
1057+
warnings.warn(
1058+
"Window.show_window_option() is deprecated",
1059+
category=DeprecationWarning,
1060+
stacklevel=2,
1061+
)
1062+
return self.show_option(option=option, g=g)
1063+
10341064
def get(self, key: str, default: t.Any | None = None) -> t.Any:
10351065
"""Return key-based lookup. Deprecated by attributes.
10361066

0 commit comments

Comments
 (0)