Skip to content

Commit ce5bb27

Browse files
tonytony
committed
Query/Filter APIs(fix): Correct deprecation versions to match MIGRATION
why: The DeprecatedError version parameter was 0.16.0 for all query/filter APIs, but per MIGRATION docs, only get_by_id() was deprecated in 0.16.0. The following were deprecated in 0.17.0: - list_*(), _list_*(), where(), find_where(), children - Dict-style access (get(), __getitem__()) what: - Keep get_by_id() at 0.16.0 (Server, Session, Window) - Update where(), find_where() to 0.17.0 (Server, Session, Window) - Update list_*, _list_*, children, _sessions/_windows/_panes to 0.17.0 - Update get(), __getitem__() to 0.17.0 (Session, Window, Pane)
1 parent bd1d938 commit ce5bb27

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
@@ -927,7 +927,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
927927
raise exc.DeprecatedError(
928928
deprecated="Pane.get()",
929929
replacement="direct attribute access (e.g., pane.pane_id)",
930-
version="0.16.0",
930+
version="0.17.0",
931931
)
932932

933933
def __getitem__(self, key: str) -> t.Any:
@@ -942,7 +942,7 @@ def __getitem__(self, key: str) -> t.Any:
942942
raise exc.DeprecatedError(
943943
deprecated="Pane[key] lookup",
944944
replacement="direct attribute access (e.g., pane.pane_id)",
945-
version="0.16.0",
945+
version="0.17.0",
946946
)
947947

948948
def resize_pane(

‎src/libtmux/server.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Session]:
760760
raise exc.DeprecatedError(
761761
deprecated="Server.where()",
762762
replacement="Server.sessions.filter()",
763-
version="0.16.0",
763+
version="0.17.0",
764764
)
765765

766766
def find_where(self, kwargs: dict[str, t.Any]) -> Session | None:
@@ -774,7 +774,7 @@ def find_where(self, kwargs: dict[str, t.Any]) -> Session | None:
774774
raise exc.DeprecatedError(
775775
deprecated="Server.find_where()",
776776
replacement="Server.sessions.get(default=None, **kwargs)",
777-
version="0.16.0",
777+
version="0.17.0",
778778
)
779779

780780
def _list_windows(self) -> list[WindowDict]:
@@ -793,7 +793,7 @@ def _list_windows(self) -> list[WindowDict]:
793793
raise exc.DeprecatedError(
794794
deprecated="Server._list_windows()",
795795
replacement="Server.windows property",
796-
version="0.16.0",
796+
version="0.17.0",
797797
)
798798

799799
def _update_windows(self) -> Server:
@@ -807,7 +807,7 @@ def _update_windows(self) -> Server:
807807
raise exc.DeprecatedError(
808808
deprecated="Server._update_windows()",
809809
replacement="Server.windows property",
810-
version="0.16.0",
810+
version="0.17.0",
811811
)
812812

813813
@property
@@ -822,7 +822,7 @@ def _sessions(self) -> list[SessionDict]:
822822
raise exc.DeprecatedError(
823823
deprecated="Server._sessions",
824824
replacement="Server.sessions property",
825-
version="0.16.0",
825+
version="0.17.0",
826826
)
827827

828828
def _list_sessions(self) -> list[SessionDict]:
@@ -835,7 +835,7 @@ def _list_sessions(self) -> list[SessionDict]:
835835
raise exc.DeprecatedError(
836836
deprecated="Server._list_sessions()",
837837
replacement="Server.sessions property",
838-
version="0.16.0",
838+
version="0.17.0",
839839
)
840840

841841
def list_sessions(self) -> list[Session]:
@@ -852,7 +852,7 @@ def list_sessions(self) -> list[Session]:
852852
raise exc.DeprecatedError(
853853
deprecated="Server.list_sessions()",
854854
replacement="Server.sessions property",
855-
version="0.16.0",
855+
version="0.17.0",
856856
)
857857

858858
@property
@@ -867,5 +867,5 @@ def children(self) -> QueryList[Session]:
867867
raise exc.DeprecatedError(
868868
deprecated="Server.children",
869869
replacement="Server.sessions property",
870-
version="0.16.0",
870+
version="0.17.0",
871871
)

‎src/libtmux/session.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -712,7 +712,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
712712
raise exc.DeprecatedError(
713713
deprecated="Session.get()",
714714
replacement="direct attribute access (e.g., session.session_name)",
715-
version="0.16.0",
715+
version="0.17.0",
716716
)
717717

718718
def __getitem__(self, key: str) -> t.Any:
@@ -727,7 +727,7 @@ def __getitem__(self, key: str) -> t.Any:
727727
raise exc.DeprecatedError(
728728
deprecated="Session[key] lookup",
729729
replacement="direct attribute access (e.g., session.session_name)",
730-
version="0.16.0",
730+
version="0.17.0",
731731
)
732732

733733
def get_by_id(self, session_id: str) -> Window | None:
@@ -755,7 +755,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Window]:
755755
raise exc.DeprecatedError(
756756
deprecated="Session.where()",
757757
replacement="Session.windows.filter()",
758-
version="0.16.0",
758+
version="0.17.0",
759759
)
760760

761761
def find_where(self, kwargs: dict[str, t.Any]) -> Window | None:
@@ -769,7 +769,7 @@ def find_where(self, kwargs: dict[str, t.Any]) -> Window | None:
769769
raise exc.DeprecatedError(
770770
deprecated="Session.find_where()",
771771
replacement="Session.windows.get(default=None, **kwargs)",
772-
version="0.16.0",
772+
version="0.17.0",
773773
)
774774

775775
def _list_windows(self) -> list[WindowDict]:
@@ -783,7 +783,7 @@ def _list_windows(self) -> list[WindowDict]:
783783
raise exc.DeprecatedError(
784784
deprecated="Session._list_windows()",
785785
replacement="Session.windows property",
786-
version="0.16.0",
786+
version="0.17.0",
787787
)
788788

789789
@property
@@ -798,7 +798,7 @@ def _windows(self) -> list[WindowDict]:
798798
raise exc.DeprecatedError(
799799
deprecated="Session._windows",
800800
replacement="Session.windows property",
801-
version="0.16.0",
801+
version="0.17.0",
802802
)
803803

804804
def list_windows(self) -> list[Window]:
@@ -812,7 +812,7 @@ def list_windows(self) -> list[Window]:
812812
raise exc.DeprecatedError(
813813
deprecated="Session.list_windows()",
814814
replacement="Session.windows property",
815-
version="0.16.0",
815+
version="0.17.0",
816816
)
817817

818818
@property
@@ -827,5 +827,5 @@ def children(self) -> QueryList[Window]:
827827
raise exc.DeprecatedError(
828828
deprecated="Session.children",
829829
replacement="Session.windows property",
830-
version="0.16.0",
830+
version="0.17.0",
831831
)

‎src/libtmux/window.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ def get(self, key: str, default: t.Any | None = None) -> t.Any:
910910
raise exc.DeprecatedError(
911911
deprecated="Window.get()",
912912
replacement="direct attribute access (e.g., window.window_name)",
913-
version="0.16.0",
913+
version="0.17.0",
914914
)
915915

916916
def __getitem__(self, key: str) -> t.Any:
@@ -925,7 +925,7 @@ def __getitem__(self, key: str) -> t.Any:
925925
raise exc.DeprecatedError(
926926
deprecated="Window[key] lookup",
927927
replacement="direct attribute access (e.g., window.window_name)",
928-
version="0.16.0",
928+
version="0.17.0",
929929
)
930930

931931
def get_by_id(self, pane_id: str) -> Pane | None:
@@ -953,7 +953,7 @@ def where(self, kwargs: dict[str, t.Any]) -> list[Pane]:
953953
raise exc.DeprecatedError(
954954
deprecated="Window.where()",
955955
replacement="Window.panes.filter()",
956-
version="0.16.0",
956+
version="0.17.0",
957957
)
958958

959959
def find_where(self, kwargs: dict[str, t.Any]) -> Pane | None:
@@ -967,7 +967,7 @@ def find_where(self, kwargs: dict[str, t.Any]) -> Pane | None:
967967
raise exc.DeprecatedError(
968968
deprecated="Window.find_where()",
969969
replacement="Window.panes.get(default=None, **kwargs)",
970-
version="0.16.0",
970+
version="0.17.0",
971971
)
972972

973973
def _list_panes(self) -> list[PaneDict]:
@@ -981,7 +981,7 @@ def _list_panes(self) -> list[PaneDict]:
981981
raise exc.DeprecatedError(
982982
deprecated="Window._list_panes()",
983983
replacement="Window.panes property",
984-
version="0.16.0",
984+
version="0.17.0",
985985
)
986986

987987
@property
@@ -996,7 +996,7 @@ def _panes(self) -> list[PaneDict]:
996996
raise exc.DeprecatedError(
997997
deprecated="Window._panes",
998998
replacement="Window.panes property",
999-
version="0.16.0",
999+
version="0.17.0",
10001000
)
10011001

10021002
def list_panes(self) -> list[Pane]:
@@ -1010,7 +1010,7 @@ def list_panes(self) -> list[Pane]:
10101010
raise exc.DeprecatedError(
10111011
deprecated="Window.list_panes()",
10121012
replacement="Window.panes property",
1013-
version="0.16.0",
1013+
version="0.17.0",
10141014
)
10151015

10161016
@property
@@ -1025,5 +1025,5 @@ def children(self) -> QueryList[Pane]:
10251025
raise exc.DeprecatedError(
10261026
deprecated="Window.children",
10271027
replacement="Window.panes property",
1028-
version="0.16.0",
1028+
version="0.17.0",
10291029
)

0 commit comments

Comments
 (0)