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