@@ -594,37 +594,75 @@ def name(self) -> t.Optional[str]:
594
594
# Legacy: Redundant stuff we want to remove
595
595
#
596
596
def get (self , key : str , default : t .Optional [t .Any ] = None ) -> t .Any :
597
- """.. deprecated:: 0.16."""
597
+ """Return key-based lookup. Deprecated by attributes.
598
+
599
+ .. deprecated:: 0.16.
600
+
601
+ Deprecated by attribute lookup.e.g. ``session['session_name']`` is now
602
+ accessed via ``session.session_name``.
603
+
604
+ """
598
605
warnings .warn ("Session.get() is deprecated" , stacklevel = 2 )
599
606
return getattr (self , key , default )
600
607
601
608
def __getitem__ (self , key : str ) -> t .Any :
602
- """.. deprecated:: 0.16."""
609
+ """Return item lookup by key. Deprecated in favor of attributes.
610
+
611
+ .. deprecated:: 0.16
612
+
613
+ Deprecated in favor of attributes. e.g. ``session['session_name']`` is now
614
+ accessed via ``session.session_name``.
615
+
616
+ """
603
617
warnings .warn (
604
618
f"Item lookups, e.g. session['{ key } '] is deprecated" , stacklevel = 2
605
619
)
606
620
return getattr (self , key )
607
621
608
622
def get_by_id (self , id : str ) -> t .Optional [Window ]:
609
- """.. deprecated:: 0.16."""
623
+ """Return window by id. Deprecated in favor of :meth:`.windows.get()`.
624
+
625
+ .. deprecated:: 0.16.
626
+
627
+ Deprecated by :meth:`.windows.get()`.
628
+
629
+ """
610
630
warnings .warn ("Session.get_by_id() is deprecated" , stacklevel = 2 )
611
631
return self .windows .get (window_id = id , default = None )
612
632
613
633
def where (self , kwargs : t .Dict [str , t .Any ]) -> t .List [Window ]:
614
- """.. deprecated:: 0.16."""
634
+ """Filter through window, return list of :class:`Window`.
635
+
636
+ .. deprecated:: 0.16
637
+
638
+ Deprecated by :meth:`.windows.filter()`.
639
+
640
+ """
615
641
warnings .warn ("Session.where() is deprecated" , stacklevel = 2 )
616
642
try :
617
643
return self .windows .filter (** kwargs )
618
644
except IndexError :
619
645
return []
620
646
621
647
def find_where (self , kwargs : t .Dict [str , t .Any ]) -> t .Optional [Window ]:
622
- """.. deprecated:: 0.16."""
648
+ """Filter through windows, return first :class:`Window`.
649
+
650
+ .. deprecated:: 0.16.
651
+
652
+ Slated to be removed in favor of :meth:`.windows.get()`.
653
+
654
+ """
623
655
warnings .warn ("Session.find_where() is deprecated" , stacklevel = 2 )
624
656
return self .windows .get (default = None , ** kwargs )
625
657
626
658
def _list_windows (self ) -> t .List ["WindowDict" ]:
627
- """.. deprecated:: 0.16."""
659
+ """Return list of windows (deprecated in favor of :meth:`.windows`).
660
+
661
+ .. deprecated:: 0.16.
662
+
663
+ Slated to be removed in favor of :meth:`.windows`.
664
+
665
+ """
628
666
warnings .warn ("Session._list_windows() is deprecated" , stacklevel = 2 )
629
667
return [w .__dict__ for w in self .windows ]
630
668
@@ -633,6 +671,9 @@ def _windows(self) -> t.List["WindowDict"]:
633
671
"""Property / alias to return :meth:`Session._list_windows`.
634
672
635
673
.. deprecated:: 0.16
674
+
675
+ Slated to be removed in favor of :meth:`.windows`.
676
+
636
677
"""
637
678
warnings .warn ("Session._windows is deprecated" , stacklevel = 2 )
638
679
return self ._list_windows ()
@@ -641,6 +682,9 @@ def list_windows(self) -> t.List["Window"]:
641
682
"""Return a list of :class:`Window` from the ``tmux(1)`` session.
642
683
643
684
.. deprecated:: 0.16
685
+
686
+ Slated to be removed in favor of :meth:`.windows`.
687
+
644
688
"""
645
689
warnings .warn ("Session.list_windows() is deprecated" , stacklevel = 2 )
646
690
return self .windows
@@ -650,6 +694,9 @@ def children(self) -> QueryList["Window"]: # type:ignore
650
694
"""Was used by TmuxRelationalObject (but that's longer used in this class).
651
695
652
696
.. deprecated:: 0.16
697
+
698
+ Slated to be removed in favor of :meth:`.windows`.
699
+
653
700
"""
654
701
warnings .warn ("Session.children is deprecated" , stacklevel = 2 )
655
702
return self .windows
0 commit comments