@@ -591,6 +591,8 @@ def _list_panes(self) -> t.List[PaneDict]:
591
591
:class:`util.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
592
592
593
593
.. deprecated:: 0.16
594
+
595
+ Deprecated in favor of :attr:`.panes`.
594
596
"""
595
597
warnings .warn ("Server._list_panes() is deprecated" , stacklevel = 2 )
596
598
return [p .__dict__ for p in self .panes ]
@@ -604,26 +606,46 @@ def _update_panes(self) -> "Server":
604
606
:class:`Server`
605
607
606
608
.. deprecated:: 0.16
609
+
610
+ Deprecated in favor of :attr:`.panes` and returning ``self``.
607
611
"""
608
612
warnings .warn ("Server._update_panes() is deprecated" , stacklevel = 2 )
609
613
self ._list_panes ()
610
614
return self
611
615
612
616
def get_by_id (self , id : str ) -> t .Optional [Session ]:
613
- """.. deprecated:: 0.16."""
617
+ """Return session by id. Deprecated in favor of :meth:`.sessions.get()`.
618
+
619
+ .. deprecated:: 0.16.
620
+
621
+ Deprecated by :meth:`.sessions.get()`.
622
+
623
+ """
614
624
warnings .warn ("Server.get_by_id() is deprecated" , stacklevel = 2 )
615
625
return self .sessions .get (session_id = id , default = None )
616
626
617
627
def where (self , kwargs : t .Dict [str , t .Any ]) -> t .List [Session ]:
618
- """.. deprecated:: 0.16."""
628
+ """Filter through sessions, return list of :class:`Session`.
629
+
630
+ .. deprecated:: 0.16
631
+
632
+ Deprecated by :meth:`.session.filter()`.
633
+
634
+ """
619
635
warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
620
636
try :
621
637
return self .sessions .filter (** kwargs )
622
638
except IndexError :
623
639
return []
624
640
625
641
def find_where (self , kwargs : t .Dict [str , t .Any ]) -> t .Optional [Session ]:
626
- """.. deprecated:: 0.16."""
642
+ """Filter through sessions, return first :class:`Session`.
643
+
644
+ .. deprecated:: 0.16.
645
+
646
+ Slated to be removed in favor of :meth:`.sessions.get()`.
647
+
648
+ """
627
649
warnings .warn ("Server.find_where() is deprecated" , stacklevel = 2 )
628
650
return self .sessions .get (default = None , ** kwargs )
629
651
@@ -636,6 +658,9 @@ def _list_windows(self) -> t.List[WindowDict]:
636
658
:class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
637
659
638
660
.. deprecated:: 0.16
661
+
662
+ Slated to be removed in favor of :attr:`.windows`.
663
+
639
664
"""
640
665
warnings .warn ("Server._list_windows() is deprecated" , stacklevel = 2 )
641
666
return [w .__dict__ for w in self .windows ]
@@ -644,6 +669,9 @@ def _update_windows(self) -> "Server":
644
669
"""Update internal window data and return ``self`` for chainability.
645
670
646
671
.. deprecated:: 0.16
672
+
673
+ Deprecated in favor of :attr:`.windows` and returning ``self``.
674
+
647
675
"""
648
676
warnings .warn ("Server._update_windows() is deprecated" , stacklevel = 2 )
649
677
self ._list_windows ()
@@ -654,12 +682,20 @@ def _sessions(self) -> t.List[SessionDict]:
654
682
"""Property / alias to return :meth:`~._list_sessions`.
655
683
656
684
.. deprecated:: 0.16
685
+
686
+ Slated to be removed in favor of :attr:`.sessions`.
687
+
657
688
"""
658
689
warnings .warn ("Server._sessions is deprecated" , stacklevel = 2 )
659
690
return self ._list_sessions ()
660
691
661
692
def _list_sessions (self ) -> t .List ["SessionDict" ]:
662
- """.. deprecated:: 0.16."""
693
+ """Return list of session object dictionaries.
694
+
695
+ .. deprecated:: 0.16
696
+
697
+ Slated to be removed in favor of :attr:`.sessions`.
698
+ """
663
699
warnings .warn ("Server._list_sessions() is deprecated" , stacklevel = 2 )
664
700
return [s .__dict__ for s in self .sessions ]
665
701
@@ -668,6 +704,8 @@ def list_sessions(self) -> t.List[Session]:
668
704
669
705
.. deprecated:: 0.16
670
706
707
+ Slated to be removed in favor of :attr:`.sessions`.
708
+
671
709
Returns
672
710
-------
673
711
list of :class:`Session`
@@ -680,6 +718,9 @@ def children(self) -> QueryList["Session"]: # type:ignore
680
718
"""Was used by TmuxRelationalObject (but that's longer used in this class).
681
719
682
720
.. deprecated:: 0.16
721
+
722
+ Slated to be removed in favor of :meth:`.sessions`.
723
+
683
724
"""
684
725
warnings .warn ("Server.children is deprecated" , stacklevel = 2 )
685
726
return self .sessions
0 commit comments