Skip to content

Commit b4cc75a

Browse files
tonytony
committed
docs(docstrings): Correct deprecated directive versions 0.16 → 0.17
why: Docstrings showed ".. deprecated:: 0.16" but DeprecatedError used version="0.17.0", creating inconsistency. what: - Update server.py: 8 docstrings (where, find_where, _list_windows, etc.) - Update session.py: 8 docstrings (get, __getitem__, where, etc.) - Update window.py: 8 docstrings (get, __getitem__, where, etc.) - Update pane.py: 2 docstrings (get, __getitem__) - Preserve get_by_id() at 0.16 (correctly deprecated in v0.16.0) Only get_by_id() was deprecated in 0.16.0; all other query/filter APIs were deprecated in 0.17.0.
1 parent 2984278 commit b4cc75a

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

‎src/libtmux/pane.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -918,7 +918,7 @@ def split_window(
918918
def get(self, key: str, default: t.Any | None = None) -> t.Any:
919919
"""Return key-based lookup. Deprecated by attributes.
920920
921-
.. deprecated:: 0.16
921+
.. deprecated:: 0.17
922922
923923
Deprecated by attribute lookup, e.g. ``pane['window_name']`` is now
924924
accessed via ``pane.window_name``.
@@ -933,7 +933,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
933933
def __getitem__(self, key: str) -> t.Any:
934934
"""Return item lookup by key. Deprecated in favor of attributes.
935935
936-
.. deprecated:: 0.16
936+
.. deprecated:: 0.17
937937
938938
Deprecated in favor of attributes. e.g. ``pane['window_name']`` is now
939939
accessed via ``pane.window_name``.

‎src/libtmux/server.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@ def get_by_id(self, session_id: str) -> Session | None:
752752
def where(self, kwargs: dict[str, t.Any]) -> list[Session]:
753753
"""Filter through sessions, return list of :class:`Session`.
754754
755-
.. deprecated:: 0.16
755+
.. deprecated:: 0.17
756756
757757
Deprecated by :meth:`.session.filter()`.
758758
@@ -766,7 +766,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Session]:
766766
def find_where(self, kwargs: dict[str, t.Any]) -> Session | None:
767767
"""Filter through sessions, return first :class:`Session`.
768768
769-
.. deprecated:: 0.16
769+
.. deprecated:: 0.17
770770
771771
Slated to be removed in favor of :meth:`.sessions.get()`.
772772
@@ -785,7 +785,7 @@ def _list_windows(self) -> list[WindowDict]:
785785
The :py:obj:`list` is derived from ``stdout`` in
786786
:class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
787787
788-
.. deprecated:: 0.16
788+
.. deprecated:: 0.17
789789
790790
Slated to be removed in favor of :attr:`.windows`.
791791
@@ -799,7 +799,7 @@ def _list_windows(self) -> list[WindowDict]:
799799
def _update_windows(self) -> Server:
800800
"""Update internal window data and return ``self`` for chainability.
801801
802-
.. deprecated:: 0.16
802+
.. deprecated:: 0.17
803803
804804
Deprecated in favor of :attr:`.windows` and returning ``self``.
805805
@@ -814,7 +814,7 @@ def _update_windows(self) -> Server:
814814
def _sessions(self) -> list[SessionDict]:
815815
"""Property / alias to return :meth:`~._list_sessions`.
816816
817-
.. deprecated:: 0.16
817+
.. deprecated:: 0.17
818818
819819
Slated to be removed in favor of :attr:`.sessions`.
820820
@@ -828,7 +828,7 @@ def _sessions(self) -> list[SessionDict]:
828828
def _list_sessions(self) -> list[SessionDict]:
829829
"""Return list of session object dictionaries.
830830
831-
.. deprecated:: 0.16
831+
.. deprecated:: 0.17
832832
833833
Slated to be removed in favor of :attr:`.sessions`.
834834
"""
@@ -841,7 +841,7 @@ def _list_sessions(self) -> list[SessionDict]:
841841
def list_sessions(self) -> list[Session]:
842842
"""Return list of :class:`Session` from the ``tmux(1)`` session.
843843
844-
.. deprecated:: 0.16
844+
.. deprecated:: 0.17
845845
846846
Slated to be removed in favor of :attr:`.sessions`.
847847
@@ -859,7 +859,7 @@ def list_sessions(self) -> list[Session]:
859859
def children(self) -> QueryList[Session]:
860860
"""Was used by TmuxRelationalObject (but that's longer used in this class).
861861
862-
.. deprecated:: 0.16
862+
.. deprecated:: 0.17
863863
864864
Slated to be removed in favor of :attr:`.sessions`.
865865

‎src/libtmux/session.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ def kill_session(self) -> None:
703703
def get(self, key: str, default: t.Any | None = None) -> t.Any:
704704
"""Return key-based lookup. Deprecated by attributes.
705705
706-
.. deprecated:: 0.16
706+
.. deprecated:: 0.17
707707
708708
Deprecated by attribute lookup.e.g. ``session['session_name']`` is now
709709
accessed via ``session.session_name``.
@@ -718,7 +718,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
718718
def __getitem__(self, key: str) -> t.Any:
719719
"""Return item lookup by key. Deprecated in favor of attributes.
720720
721-
.. deprecated:: 0.16
721+
.. deprecated:: 0.17
722722
723723
Deprecated in favor of attributes. e.g. ``session['session_name']`` is now
724724
accessed via ``session.session_name``.
@@ -747,7 +747,7 @@ def get_by_id(self, session_id: str) -> Window | None:
747747
def where(self, kwargs: dict[str, t.Any]) -> list[Window]:
748748
"""Filter through windows, return list of :class:`Window`.
749749
750-
.. deprecated:: 0.16
750+
.. deprecated:: 0.17
751751
752752
Deprecated by :meth:`.windows.filter()`.
753753
@@ -761,7 +761,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Window]:
761761
def find_where(self, kwargs: dict[str, t.Any]) -> Window | None:
762762
"""Filter through windows, return first :class:`Window`.
763763
764-
.. deprecated:: 0.16
764+
.. deprecated:: 0.17
765765
766766
Slated to be removed in favor of :meth:`.windows.get()`.
767767
@@ -775,7 +775,7 @@ def find_where(self, kwargs: dict[str, t.Any]) -> Window | None:
775775
def _list_windows(self) -> list[WindowDict]:
776776
"""Return list of windows (deprecated in favor of :attr:`.windows`).
777777
778-
.. deprecated:: 0.16
778+
.. deprecated:: 0.17
779779
780780
Slated to be removed in favor of :attr:`.windows`.
781781
@@ -790,7 +790,7 @@ def _list_windows(self) -> list[WindowDict]:
790790
def _windows(self) -> list[WindowDict]:
791791
"""Property / alias to return :meth:`Session._list_windows`.
792792
793-
.. deprecated:: 0.16
793+
.. deprecated:: 0.17
794794
795795
Slated to be removed in favor of :attr:`.windows`.
796796
@@ -804,7 +804,7 @@ def _windows(self) -> list[WindowDict]:
804804
def list_windows(self) -> list[Window]:
805805
"""Return a list of :class:`Window` from the ``tmux(1)`` session.
806806
807-
.. deprecated:: 0.16
807+
.. deprecated:: 0.17
808808
809809
Slated to be removed in favor of :attr:`.windows`.
810810
@@ -819,7 +819,7 @@ def list_windows(self) -> list[Window]:
819819
def children(self) -> QueryList[Window]:
820820
"""Was used by TmuxRelationalObject (but that's longer used in this class).
821821
822-
.. deprecated:: 0.16
822+
.. deprecated:: 0.17
823823
824824
Slated to be removed in favor of :attr:`.windows`.
825825

‎src/libtmux/window.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -901,7 +901,7 @@ def show_window_option(
901901
def get(self, key: str, default: t.Any | None = None) -> t.Any:
902902
"""Return key-based lookup. Deprecated by attributes.
903903
904-
.. deprecated:: 0.16
904+
.. deprecated:: 0.17
905905
906906
Deprecated by attribute lookup.e.g. ``window['window_name']`` is now
907907
accessed via ``window.window_name``.
@@ -916,7 +916,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
916916
def __getitem__(self, key: str) -> t.Any:
917917
"""Return item lookup by key. Deprecated in favor of attributes.
918918
919-
.. deprecated:: 0.16
919+
.. deprecated:: 0.17
920920
921921
Deprecated in favor of attributes. e.g. ``window['window_name']`` is now
922922
accessed via ``window.window_name``.
@@ -945,7 +945,7 @@ def get_by_id(self, pane_id: str) -> Pane | None:
945945
def where(self, kwargs: dict[str, t.Any]) -> list[Pane]:
946946
"""Filter through panes, return list of :class:`Pane`.
947947
948-
.. deprecated:: 0.16
948+
.. deprecated:: 0.17
949949
950950
Deprecated by :meth:`.panes.filter()`.
951951
@@ -959,7 +959,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Pane]:
959959
def find_where(self, kwargs: dict[str, t.Any]) -> Pane | None:
960960
"""Filter through panes, return first :class:`Pane`.
961961
962-
.. deprecated:: 0.16
962+
.. deprecated:: 0.17
963963
964964
Slated to be removed in favor of :meth:`.panes.get()`.
965965
@@ -973,7 +973,7 @@ def find_where(self, kwargs: dict[str, t.Any]) -> Pane | None:
973973
def _list_panes(self) -> list[PaneDict]:
974974
"""Return list of panes (deprecated in favor of :meth:`.panes`).
975975
976-
.. deprecated:: 0.16
976+
.. deprecated:: 0.17
977977
978978
Slated to be removed in favor of :attr:`.panes`.
979979
@@ -988,7 +988,7 @@ def _list_panes(self) -> list[PaneDict]:
988988
def _panes(self) -> list[PaneDict]:
989989
"""Property / alias to return :meth:`~._list_panes`.
990990
991-
.. deprecated:: 0.16
991+
.. deprecated:: 0.17
992992
993993
Slated to be removed in favor of :attr:`.panes`.
994994
@@ -1002,7 +1002,7 @@ def _panes(self) -> list[PaneDict]:
10021002
def list_panes(self) -> list[Pane]:
10031003
"""Return list of :class:`Pane` for the window.
10041004
1005-
.. deprecated:: 0.16
1005+
.. deprecated:: 0.17
10061006
10071007
Slated to be removed in favor of :attr:`.panes`.
10081008
@@ -1017,7 +1017,7 @@ def list_panes(self) -> list[Pane]:
10171017
def children(self) -> QueryList[Pane]:
10181018
"""Was used by TmuxRelationalObject (but that's longer used in this class).
10191019
1020-
.. deprecated:: 0.16
1020+
.. deprecated:: 0.17
10211021
10221022
Slated to be removed in favor of :attr:`.panes`.
10231023

0 commit comments

Comments
 (0)