refactor({Window,Session}.active_pane): Use renamed method

Author: tony

conftest.py

@@ -42,7 +42,7 @@ def add_doctest_fixtures(
         session: "Session" = request.getfixturevalue("session")
         doctest_namespace["session"] = session
         doctest_namespace["window"] = session.active_window
-        doctest_namespace["pane"] = session.attached_pane
+        doctest_namespace["pane"] = session.active_pane
         doctest_namespace["request"] = request
 
 

docs/reference/properties.md

@@ -109,7 +109,7 @@ Use attribute access for details not accessible via properties:
 Get the {class}`~libtmux.Pane`:
 
 ```python
->>> pane = window.attached_pane
+>>> pane = window.active_pane
 
 >>> pane
 Pane(%1 Window(@1 ...:..., Session($1 libtmux_...)))

docs/topics/traversal.md

@@ -78,20 +78,20 @@ Window(@1 ...:..., Session($1 ...))
 Grab the currently focused {class}`Pane` from session:
 
 ```python
->>> session.attached_pane
+>>> session.active_pane
 Pane(%1 Window(@1 ...:..., Session($1 ...)))
 ```
 
 Assign the attached {class}`~libtmux.Pane` to `p`:
 
 ```python
->>> p = session.attached_pane
+>>> p = session.active_pane
 ```
 
 Access the window/server of a pane:
 
 ```python
->>> p = session.attached_pane
+>>> p = session.active_pane
 >>> p.window
 Window(@1 ...:..., Session($1 ...))
 

src/libtmux/pane.py

@@ -423,7 +423,7 @@ def select(self) -> "Pane":
 
         Examples
         --------
-        >>> pane = window.attached_pane
+        >>> pane = window.active_pane
         >>> new_pane = window.split_window()
         >>> pane.refresh()
         >>> active_panes = [p for p in window.panes if p.pane_active == '1']

src/libtmux/server.py

@@ -71,7 +71,7 @@ class Server(EnvironmentMixin):
     >>> server.sessions[0].active_window
     Window(@1 1:..., Session($1 ...))
 
-    >>> server.sessions[0].attached_pane
+    >>> server.sessions[0].active_pane
     Pane(%1 Window(@1 1:..., Session($1 ...)))
 
     References

src/libtmux/session.py

@@ -55,7 +55,7 @@ class Session(Obj, EnvironmentMixin):
     >>> session.active_window
     Window(@1 ...:..., Session($1 ...)
 
-    >>> session.attached_pane
+    >>> session.active_pane
     Pane(%1 Window(@1 ...:..., Session($1 ...)))
 
     References

src/libtmux/test.py

@@ -85,7 +85,7 @@ def retry_until(
     Examples
     --------
     >>> def fn():
-    ...     p = session.active_window.attached_pane
+    ...     p = session.active_window.active_pane
     ...     return p.pane_current_path is not None
 
     >>> retry_until(fn)

src/libtmux/window.py

@@ -53,7 +53,7 @@ class Window(Obj):
     >>> window.panes
     [Pane(...)]
 
-    >>> window.attached_pane
+    >>> window.active_pane
     Pane(...)
 
     Relations moving up:
@@ -179,7 +179,7 @@ def select_pane(self, target_pane: t.Union[str, int]) -> t.Optional["Pane"]:
         if proc.stderr:
             raise exc.LibTmuxException(proc.stderr)
 
-        return self.attached_pane
+        return self.active_pane
 
     def split_window(
         self,

tests/test_pane.py

@@ -13,7 +13,7 @@
 
 def test_send_keys(session: Session) -> None:
     """Verify Pane.send_keys()."""
-    pane = session.active_window.attached_pane
+    pane = session.active_window.active_pane
     assert pane is not None
     pane.send_keys("c-c", literal=True)
 
@@ -28,7 +28,7 @@ def test_set_height(session: Session) -> None:
     """Verify Pane.set_height()."""
     window = session.new_window(window_name="test_set_height")
     window.split_window()
-    pane1 = window.attached_pane
+    pane1 = window.active_pane
     assert pane1 is not None
     pane1_height = pane1.pane_height
 
@@ -44,7 +44,7 @@ def test_set_width(session: Session) -> None:
     window.split_window()
 
     window.select_layout("main-vertical")
-    pane1 = window.attached_pane
+    pane1 = window.active_pane
     assert pane1 is not None
     pane1_width = pane1.pane_width
 
@@ -66,7 +66,7 @@ def test_capture_pane(session: Session) -> None:
         window_name="capture_pane",
         window_shell=f"{env} PS1='$ ' sh",
     )
-    pane = session.active_window.attached_pane
+    pane = session.active_window.active_pane
     assert pane is not None
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"
@@ -91,7 +91,7 @@ def test_capture_pane_start(session: Session) -> None:
         window_name="capture_pane_start",
         window_shell=f"{env} PS1='$ ' sh",
     )
-    pane = session.active_window.attached_pane
+    pane = session.active_window.active_pane
     assert pane is not None
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"
@@ -119,7 +119,7 @@ def test_capture_pane_end(session: Session) -> None:
         window_name="capture_pane_end",
         window_shell=f"{env} PS1='$ ' sh",
     )
-    pane = session.active_window.attached_pane
+    pane = session.active_window.active_pane
     assert pane is not None
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"

tests/test_session.py

@@ -81,9 +81,9 @@ def test_active_window(session: Session) -> None:
     assert isinstance(session.active_window, Window)
 
 
-def test_attached_pane(session: Session) -> None:
-    """Session.attached_pane returns Pane."""
-    assert isinstance(session.attached_pane, Pane)
+def test_active_pane(session: Session) -> None:
+    """Session.active_pane returns Pane."""
+    assert isinstance(session.active_pane, Pane)
 
 
 def test_session_rename(session: Session) -> None:
@@ -297,7 +297,7 @@ def test_new_window_with_environment(
         window_shell=f"{env} PS1='$ ' sh",
         environment=environment,
     )
-    pane = window.attached_pane
+    pane = window.active_pane
     assert pane is not None
     for k, v in environment.items():
         pane.send_keys(f"echo ${k}")

tests/test_window.py

@@ -77,14 +77,14 @@ def test_fresh_window_data(session: Session) -> None:
     assert active_window is not None
     active_window.select_pane(pane_base_index)
 
-    attached_pane = session.attached_pane
-    assert attached_pane is not None
-    attached_pane.send_keys("cd /srv/www/flaskr")
+    active_pane = session.active_pane
+    assert active_pane is not None
+    active_pane.send_keys("cd /srv/www/flaskr")
 
     active_window.select_pane(pane_base_index + 1)
-    attached_pane = session.attached_pane
-    assert attached_pane is not None
-    attached_pane.send_keys("source .venv/bin/activate")
+    active_pane = session.active_pane
+    assert active_pane is not None
+    active_pane.send_keys("source .venv/bin/activate")
     session.new_window(window_name="second")
     current_windows += 1
     assert current_windows == len(session.windows)
@@ -112,10 +112,10 @@ def test_newest_pane_data(session: Session) -> None:
     assert len(window.panes) == 3
 
 
-def test_attached_pane(session: Session) -> None:
+def test_active_pane(session: Session) -> None:
     """Window.active_window returns active Pane."""
     window = session.active_window  # current window
-    assert isinstance(window.attached_pane, Pane)
+    assert isinstance(window.active_pane, Pane)
 
 
 def test_split_window(session: Session) -> None: