refactor(Session.active_window): Use renamed method

tony · tony · commit 9c67ae66f356 · 2024-02-17T06:52:18.000-06:00
diff --git a/README.md b/README.md
@@ -173,14 +173,14 @@ Window(@... 2:ha in the bg, Session($1 ...))
 Close window:
 
 ```python
->>> w = session.attached_window
+>>> w = session.active_window
 >>> w.kill()
 ```
 
 Grab remaining tmux window:
 
 ```python
->>> window = session.attached_window
+>>> window = session.active_window
 >>> window.split_window(attach=False)
 Pane(%2 Window(@1 1:... Session($1 ...)))
 ```
diff --git a/conftest.py b/conftest.py
@@ -41,7 +41,7 @@ def add_doctest_fixtures(
         doctest_namespace["server"] = request.getfixturevalue("server")
         session: "Session" = request.getfixturevalue("session")
         doctest_namespace["session"] = session
-        doctest_namespace["window"] = session.attached_window
+        doctest_namespace["window"] = session.active_window
         doctest_namespace["pane"] = session.attached_pane
         doctest_namespace["request"] = request
 
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -302,11 +302,11 @@ through active {class}`Window`'s.
 
 ## Manipulating windows
 
-Now that we know how to create windows, let's use one. Let's use {meth}`Session.attached_window()`
+Now that we know how to create windows, let's use one. Let's use {meth}`Session.active_window()`
 to grab our current window.
 
 ```python
->>> window = session.attached_window
+>>> window = session.active_window
 ```
 
 `window` now has access to all of the objects inside of {class}`Window`.
@@ -320,7 +320,7 @@ Pane(%2 Window(@1 ...:..., Session($1 ...)))
 
 Powered up. Let's have a break down:
 
-1. `window = session.attached_window()` gave us the {class}`Window` of the current attached to window.
+1. `window = session.active_window()` gave us the {class}`Window` of the current attached to window.
 2. `attach=False` assures the cursor didn't switch to the newly created pane.
 3. Returned the created {class}`Pane`.
 
diff --git a/docs/reference/properties.md b/docs/reference/properties.md
@@ -75,7 +75,7 @@ from libtmux.neo import Obj
 The same concepts apply for {class}`~libtmux.Window`:
 
 ```python
->>> window = session.attached_window
+>>> window = session.active_window
 
 >>> window
 Window(@1 ...:..., Session($1 ...))
diff --git a/docs/topics/traversal.md b/docs/topics/traversal.md
@@ -71,7 +71,7 @@ Window(@1 ...:..., Session($1 ...))
 Grab the currently focused window from session:
 
 ```python
->>> session.attached_window
+>>> session.active_window
 Window(@1 ...:..., Session($1 ...))
 ```
 
diff --git a/src/libtmux/server.py b/src/libtmux/server.py
@@ -68,7 +68,7 @@ class Server(EnvironmentMixin):
     >>> server.sessions[0].windows
     [Window(@1 1:..., Session($1 ...)]
 
-    >>> server.sessions[0].attached_window
+    >>> server.sessions[0].active_window
     Window(@1 1:..., Session($1 ...))
 
     >>> server.sessions[0].attached_pane
diff --git a/src/libtmux/session.py b/src/libtmux/session.py
@@ -52,7 +52,7 @@ class Session(Obj, EnvironmentMixin):
     >>> session.windows
     [Window(@1 ...:..., Session($1 ...)]
 
-    >>> session.attached_window
+    >>> session.active_window
     Window(@1 ...:..., Session($1 ...)
 
     >>> session.attached_pane
@@ -347,7 +347,7 @@ def select_window(self, target_window: t.Union[str, int]) -> "Window":
         if proc.stderr:
             raise exc.LibTmuxException(proc.stderr)
 
-        return self.attached_window
+        return self.active_window
 
     #
     # Computed properties
@@ -631,7 +631,7 @@ def kill_window(self, target_window: t.Optional[str] = None) -> None:
     @property
     def attached_pane(self) -> t.Optional["Pane"]:
         """Return active :class:`Pane` object."""
-        return self.attached_window.attached_pane
+        return self.active_window.attached_pane
 
     #
     # Dunder
diff --git a/src/libtmux/test.py b/src/libtmux/test.py
@@ -85,7 +85,7 @@ def retry_until(
     Examples
     --------
     >>> def fn():
-    ...     p = session.attached_window.attached_pane
+    ...     p = session.active_window.attached_pane
     ...     return p.pane_current_path is not None
 
     >>> retry_until(fn)
diff --git a/src/libtmux/window.py b/src/libtmux/window.py
@@ -61,10 +61,10 @@ class Window(Obj):
     >>> window.session
     Session(...)
 
-    >>> window.window_id == session.attached_window.window_id
+    >>> window.window_id == session.active_window.window_id
     True
 
-    >>> window == session.attached_window
+    >>> window == session.active_window
     True
 
     >>> window in session.windows
@@ -577,7 +577,7 @@ def rename_window(self, new_name: str) -> "Window":
 
         Examples
         --------
-        >>> window = session.attached_window
+        >>> window = session.active_window
 
         >>> window.rename_window('My project')
         Window(@1 1:My project, Session($1 ...))
@@ -701,7 +701,7 @@ def select(self) -> "Window":
 
         Examples
         --------
-        >>> window = session.attached_window
+        >>> window = session.active_window
         >>> new_window = session.new_window()
         >>> session.refresh()
         >>> active_windows = [w for w in session.windows if w.window_active == '1']
diff --git a/tests/test_dataclasses.py b/tests/test_dataclasses.py
@@ -39,7 +39,7 @@ def test_pane(
 
     assert __session is not None
 
-    __window = __session.attached_window
+    __window = __session.active_window
     __window.split_window()
     __pane = __window.split_window()
     __window.select_layout("main-vertical")
diff --git a/tests/test_pane.py b/tests/test_pane.py
@@ -13,7 +13,7 @@
 
 def test_send_keys(session: Session) -> None:
     """Verify Pane.send_keys()."""
-    pane = session.attached_window.attached_pane
+    pane = session.active_window.attached_pane
     assert pane is not None
     pane.send_keys("c-c", literal=True)
 
@@ -66,7 +66,7 @@ def test_capture_pane(session: Session) -> None:
         window_name="capture_pane",
         window_shell=f"{env} PS1='$ ' sh",
     )
-    pane = session.attached_window.attached_pane
+    pane = session.active_window.attached_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.attached_window.attached_pane
+    pane = session.active_window.attached_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.attached_window.attached_pane
+    pane = session.active_window.attached_pane
     assert pane is not None
     pane_contents = "\n".join(pane.capture_pane())
     assert pane_contents == "$"
@@ -142,7 +142,7 @@ def test_resize_pane(
     """Verify resizing window."""
     session.cmd("detach-client", "-s")
 
-    window = session.attached_window
+    window = session.active_window
     pane = window.split_window(attach=False)
     window.split_window(vertical=True, attach=False)
 
diff --git a/tests/test_session.py b/tests/test_session.py
@@ -31,7 +31,7 @@ def test_select_window(session: Session) -> None:
     """Session.select_window moves window."""
     # get the current window_base_index, since different user tmux config
     # may start at 0 or 1, or whatever they want.
-    window_idx = session.attached_window.window_index
+    window_idx = session.active_window.window_index
     assert window_idx is not None
     window_base_index = int(window_idx)
 
@@ -42,22 +42,22 @@ def test_select_window(session: Session) -> None:
 
     assert len(session.windows) == window_count
 
-    # tmux selects a window, moves to it, shows it as attached_window
+    # tmux selects a window, moves to it, shows it as active_window
     selected_window1 = session.select_window(window_base_index)
     assert isinstance(selected_window1, Window)
-    attached_window1 = session.attached_window
+    active_window1 = session.active_window
 
-    assert selected_window1 == attached_window1
-    assert selected_window1.__dict__ == attached_window1.__dict__
+    assert selected_window1 == active_window1
+    assert selected_window1.__dict__ == active_window1.__dict__
 
     # again: tmux selects a window, moves to it, shows it as
-    # attached_window
+    # active_window
     selected_window2 = session.select_window(window_base_index + 1)
     assert isinstance(selected_window2, Window)
-    attached_window2 = session.attached_window
+    active_window2 = session.active_window
 
-    assert selected_window2 == attached_window2
-    assert selected_window2.__dict__ == attached_window2.__dict__
+    assert selected_window2 == active_window2
+    assert selected_window2.__dict__ == active_window2.__dict__
 
     # assure these windows were really different
     assert selected_window1 != selected_window2
@@ -69,16 +69,16 @@ def test_select_window_returns_Window(session: Session) -> None:
     window_count = len(session.windows)
     assert len(session.windows) == window_count
 
-    window_idx = session.attached_window.window_index
+    window_idx = session.active_window.window_index
     assert window_idx is not None
     window_base_index = int(window_idx)
     window = session.select_window(window_base_index)
     assert isinstance(window, Window)
 
 
-def test_attached_window(session: Session) -> None:
-    """Session.attached_window returns Window."""
-    assert isinstance(session.attached_window, Window)
+def test_active_window(session: Session) -> None:
+    """Session.active_window returns Window."""
+    assert isinstance(session.active_window, Window)
 
 
 def test_attached_pane(session: Session) -> None:
diff --git a/tests/test_tmuxobject.py b/tests/test_tmuxobject.py
@@ -97,7 +97,7 @@ def test_find_where_multiple_infos(server: Server, session: Session) -> None:
 
 def test_where(server: Server, session: Session) -> None:
     """Test self.where() returns matching objects."""
-    window = session.attached_window
+    window = session.active_window
     window.split_window()  # create second pane
 
     for session in server.sessions:
@@ -153,7 +153,7 @@ def test_where(server: Server, session: Session) -> None:
 def test_filter(server: Server) -> None:
     """Test self.filter() retrieves child object."""
     sess = server.new_session("test")
-    window = sess.attached_window
+    window = sess.active_window
 
     window.split_window()  # create second pane
 
diff --git a/tests/test_window.py b/tests/test_window.py
