Skip to content

Commit dfaa717

Browse files
committed
feat: Rename Session.attached_pane -> Session.active_pane
Deprecate Session.attached_pane
1 parent 84f4afb commit dfaa717

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

src/libtmux/session.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,9 +353,9 @@ def select_window(self, target_window: t.Union[str, int]) -> "Window":
353353
# Computed properties
354354
#
355355
@property
356-
def attached_pane(self) -> t.Optional["Pane"]:
356+
def active_pane(self) -> t.Optional["Pane"]:
357357
"""Return active :class:`Pane` object."""
358-
return self.active_window.attached_pane
358+
return self.active_window.active_pane
359359

360360
@property
361361
def active_window(self) -> "Window":
@@ -673,6 +673,23 @@ def name(self) -> t.Optional[str]:
673673
#
674674
# Legacy: Redundant stuff we want to remove
675675
#
676+
@property
677+
def attached_pane(self) -> t.Optional["Pane"]:
678+
"""Return active :class:`Pane` object.
679+
680+
Notes
681+
-----
682+
.. deprecated:: 0.31
683+
684+
Deprecated in favor of :meth:`.active_pane`.
685+
"""
686+
warnings.warn(
687+
"Session.attached_pane() is deprecated in favor of Session.active_pane()",
688+
category=DeprecationWarning,
689+
stacklevel=2,
690+
)
691+
return self.active_window.active_pane
692+
676693
@property
677694
def attached_window(self) -> "Window":
678695
"""Return active :class:`Window` object.

0 commit comments

Comments
 (0)