Skip to content

Commit 50a4360

Browse files
committed
Window: Add show_option(), deprecate show_window_option()
1 parent 4e9bebf commit 50a4360

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

src/libtmux/window.py

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ def set_option(
347347
self,
348348
option: str,
349349
value: t.Union[int, str],
350-
format: t.Optional[bool] = None,
350+
_format: t.Optional[bool] = None,
351351
unset: t.Optional[bool] = None,
352352
unset_panes: t.Optional[bool] = None,
353353
prevent_overwrite: t.Optional[bool] = None,
@@ -386,8 +386,8 @@ def set_option(
386386
assert isinstance(unset_panes, bool)
387387
flags.append("-U")
388388

389-
if format is not None and format:
390-
assert isinstance(format, bool)
389+
if _format is not None and _format:
390+
assert isinstance(_format, bool)
391391
flags.append("-F")
392392

393393
if prevent_overwrite is not None and prevent_overwrite:
@@ -420,11 +420,18 @@ def set_option(
420420
return self
421421

422422
def show_window_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict":
423-
"""Return dict of options for window.
423+
"""Show options for tmux window. Deprecated by :meth:`Window.show_options()`.
424424
425-
.. versionchanged:: 0.13.0
425+
.. deprecated:: 0.26
426+
427+
Deprecated by :meth:`Window.show_options()`.
428+
429+
"""
430+
warnings.warn("Window.show_window_options() is deprecated", stacklevel=2)
431+
return self.show_options(g=g)
426432

427-
``option`` removed, use show_window_option to return an individual option.
433+
def show_options(self, g: t.Optional[bool] = False) -> "WindowOptionDict":
434+
"""Return a dict of options for the window.
428435
429436
Parameters
430437
----------
@@ -463,6 +470,19 @@ def show_window_option(
463470
self,
464471
option: str,
465472
g: bool = False,
473+
) -> t.Optional[t.Union[str, int]]:
474+
"""Return option for target window. Deprecated by :meth:`Window.show_option()`.
475+
476+
.. deprecated:: 0.26
477+
478+
Deprecated by :meth:`Window.show_option()`.
479+
480+
"""
481+
warnings.warn("Window.show_window_option() is deprecated", stacklevel=2)
482+
return self.show_option(option=option, g=g)
483+
484+
def show_option(
485+
self, option: str, g: bool = False
466486
) -> t.Optional[t.Union[str, int]]:
467487
"""Return option value for the target window.
468488

0 commit comments

Comments
 (0)