chore(Window): Window.split_window() -> Window.split()

Author: tony

README.md

@@ -182,7 +182,7 @@ Grab remaining tmux window:
 
 ```python
 >>> window = session.active_window
->>> window.split_window(attach=False)
+>>> window.split(attach=False)
 Pane(%2 Window(@1 1:... Session($1 ...)))
 ```
 
@@ -196,14 +196,14 @@ Window(@1 1:libtmuxower, Session($1 ...))
 Split window (create a new pane):
 
 ```python
->>> pane = window.split_window()
->>> pane = window.split_window(attach=False)
+>>> pane = window.split()
+>>> pane = window.split(attach=False)
 >>> pane.select()
 Pane(%3 Window(@1 1:..., Session($1 ...)))
 >>> window = session.new_window(attach=False, window_name="test")
 >>> window
 Window(@2 2:test, Session($1 ...))
->>> pane = window.split_window(attach=False)
+>>> pane = window.split(attach=False)
 >>> pane
 Pane(%5 Window(@2 2:test, Session($1 ...)))
 ```

docs/quickstart.md

@@ -149,7 +149,7 @@ Create a pane from a window:
 '%2'
 ```
 
-Raw output directly to a {class}`Pane` (in practice, you'd use {meth}`Window.split_window()`):
+Raw output directly to a {class}`Pane` (in practice, you'd use {meth}`Window.split()`):
 
 ```python
 >>> Pane.from_pane_id(pane_id=window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server)
@@ -312,10 +312,10 @@ to grab our current window.
 
 `window` now has access to all of the objects inside of {class}`Window`.
 
-Let's create a pane, {meth}`Window.split_window`:
+Let's create a pane, {meth}`Window.split`:
 
 ```python
->>> window.split_window(attach=False)
+>>> window.split(attach=False)
 Pane(%2 Window(@1 ...:..., Session($1 ...)))
 ```
 
@@ -341,15 +341,15 @@ You have two ways you can move your cursor to new sessions, windows and panes.
 For one, arguments such as `attach=False` can be omittted.
 
 ```python
->>> pane = window.split_window()
+>>> pane = window.split()
 ```
 
 This gives you the {class}`Pane` along with moving the cursor to a new window. You
 can also use the `.select_*` available on the object, in this case the pane has
 {meth}`Pane.select()`.
 
 ```python
->>> pane = window.split_window(attach=False)
+>>> pane = window.split(attach=False)
 ```
 
 ```python
@@ -371,7 +371,7 @@ As long as you have the object, or are iterating through a list of them, you can
 
 ```python
 >>> window = session.new_window(attach=False, window_name="test")
->>> pane = window.split_window(attach=False)
+>>> pane = window.split(attach=False)
 >>> pane.send_keys('echo hey', enter=False)
 ```
 

tests/test_dataclasses.py

@@ -41,8 +41,8 @@ def test_pane(
     assert __session is not None
 
     __window = __session.active_window
-    __window.split_window()
-    __pane = __window.split_window()
+    __window.split()
+    __pane = __window.split()
     __window.select_layout("main-vertical")
 
     assert __pane is not None
@@ -125,12 +125,12 @@ def test_pane(
     #
 
     # Window-level
-    new_pane = window.split_window()
+    new_pane = window.split()
     assert new_pane.pane_id != pane.pane_id
     assert new_pane.window_id == window.window_id
 
     # Pane-level
-    new_pane_2 = new_pane.split_window()
+    new_pane_2 = new_pane.split()
     assert new_pane_2.pane_id != new_pane.pane_id
     assert new_pane_2.window_id == new_pane.window_id
 

tests/test_pane.py

@@ -28,7 +28,7 @@ def test_send_keys(session: Session) -> None:
 def test_set_height(session: Session) -> None:
     """Verify Pane.set_height()."""
     window = session.new_window(window_name="test_set_height")
-    window.split_window()
+    window.split()
     pane1 = window.active_pane
     assert pane1 is not None
     pane1_height = pane1.pane_height
@@ -42,7 +42,7 @@ def test_set_height(session: Session) -> None:
 def test_set_width(session: Session) -> None:
     """Verify Pane.set_width()."""
     window = session.new_window(window_name="test_set_width")
-    window.split_window()
+    window.split()
 
     window.select_layout("main-vertical")
     pane1 = window.active_pane
@@ -144,8 +144,8 @@ def test_resize_pane(
     session.cmd("detach-client", "-s")
 
     window = session.active_window
-    pane = window.split_window(attach=False)
-    window.split_window(vertical=True, attach=False)
+    pane = window.split(attach=False)
+    window.split(vertical=True, attach=False)
 
     assert pane is not None
 

tests/test_tmuxobject.py

@@ -99,7 +99,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.active_window
-    window.split_window()  # create second pane
+    window.split()  # create second pane
 
     for session in server.sessions:
         session_id = session.session_id
@@ -156,7 +156,7 @@ def test_filter(server: Server) -> None:
     sess = server.new_session("test")
     window = sess.active_window
 
-    window.split_window()  # create second pane
+    window.split()  # create second pane
 
     for session in server.sessions:
         session_id = session.session_id

tests/test_window.py

@@ -72,7 +72,7 @@ def test_fresh_window_data(session: Session) -> None:
     window = session.active_window
     assert isinstance(window, Window)
     assert len(session.active_window.panes) == 1
-    window.split_window()
+    window.split()
 
     active_window = session.active_window
     assert active_window is not None
@@ -104,12 +104,12 @@ def test_newest_pane_data(session: Session) -> None:
     window = session.new_window(window_name="test", attach=True)
     assert isinstance(window, Window)
     assert len(window.panes) == 1
-    window.split_window(attach=True)
+    window.split(attach=True)
 
     assert len(window.panes) == 2
-    # note: the below used to accept -h, removing because split_window now
+    # note: the below used to accept -h, removing because split now
     # has attach as its only argument now
-    window.split_window(attach=True)
+    window.split(attach=True)
     assert len(window.panes) == 3
 
 
@@ -119,11 +119,11 @@ def test_active_pane(session: Session) -> None:
     assert isinstance(window.active_pane, Pane)
 
 
-def test_split_window(session: Session) -> None:
-    """Window.split_window() splits window, returns new Pane, vertical."""
+def test_split(session: Session) -> None:
+    """Window.split() splits window, returns new Pane, vertical."""
     window_name = "test split window"
     window = session.new_window(window_name=window_name, attach=True)
-    pane = window.split_window()
+    pane = window.split()
     assert len(window.panes) == 2
     assert isinstance(pane, Pane)
 
@@ -134,12 +134,12 @@ def test_split_window(session: Session) -> None:
     assert float(first_pane.pane_height) <= ((float(window.window_width) + 1) / 2)
 
 
-def test_split_window_shell(session: Session) -> None:
-    """Window.split_window() splits window, returns new Pane, vertical."""
+def test_split_shell(session: Session) -> None:
+    """Window.split() splits window, returns new Pane, vertical."""
     window_name = "test split window"
     cmd = "sleep 1m"
     window = session.new_window(window_name=window_name, attach=True)
-    pane = window.split_window(shell=cmd)
+    pane = window.split(shell=cmd)
     assert len(window.panes) == 2
     assert isinstance(pane, Pane)
 
@@ -156,11 +156,11 @@ def test_split_window_shell(session: Session) -> None:
         assert pane.pane_start_command == cmd
 
 
-def test_split_window_horizontal(session: Session) -> None:
-    """Window.split_window() splits window, returns new Pane, horizontal."""
+def test_split_horizontal(session: Session) -> None:
+    """Window.split() splits window, returns new Pane, horizontal."""
     window_name = "test split window"
     window = session.new_window(window_name=window_name, attach=True)
-    pane = window.split_window(vertical=False)
+    pane = window.split(vertical=False)
     assert len(window.panes) == 2
     assert isinstance(pane, Pane)
 
@@ -189,22 +189,22 @@ def test_split_percentage(session: Session) -> None:
         assert pane.pane_height == str(int(window_height_before * 0.1))
 
 
-def test_split_window_size(session: Session) -> None:
-    """Window.split_window() respects size."""
+def test_split_size(session: Session) -> None:
+    """Window.split() respects size."""
     window = session.new_window(window_name="split window size")
     window.resize(height=100, width=100)
 
     if has_gte_version("3.1"):
-        pane = window.split_window(size=10)
+        pane = window.split(size=10)
         assert pane.pane_height == "10"
 
-        pane = window.split_window(vertical=False, size=10)
+        pane = window.split(vertical=False, size=10)
         assert pane.pane_width == "10"
 
-        pane = window.split_window(size="10%")
+        pane = window.split(size="10%")
         assert pane.pane_height == "8"
 
-        pane = window.split_window(vertical=False, size="10%")
+        pane = window.split(vertical=False, size="10%")
         assert pane.pane_width == "8"
     else:
         window_height_before = (
@@ -213,10 +213,10 @@ def test_split_window_size(session: Session) -> None:
         window_width_before = (
             int(window.window_width) if isinstance(window.window_width, str) else 0
         )
-        pane = window.split_window(size="10%")
+        pane = window.split(size="10%")
         assert pane.pane_height == str(int(window_height_before * 0.1))
 
-        pane = window.split_window(vertical=False, size="10%")
+        pane = window.split(vertical=False, size="10%")
         assert pane.pane_width == str(int(window_width_before * 0.1))
 
 
@@ -405,16 +405,16 @@ def test_empty_window_name(session: Session) -> None:
         {"ENV_VAR_1": "pane_1", "ENV_VAR_2": "pane_2"},
     ],
 )
-def test_split_window_with_environment(
+def test_split_with_environment(
     session: Session,
     environment: t.Dict[str, str],
 ) -> None:
     """Verify splitting window with environment variables."""
     env = shutil.which("env")
     assert env is not None, "Cannot find usable `env` in Path."
 
-    window = session.new_window(window_name="split_window_with_environment")
-    pane = window.split_window(
+    window = session.new_window(window_name="split_with_environment")
+    pane = window.split(
         shell=f"{env} PS1='$ ' sh",
         environment=environment,
     )
@@ -430,16 +430,16 @@ def test_split_window_with_environment(
     has_gte_version("3.0"),
     reason="3.0 has the -e flag on split-window",
 )
-def test_split_window_with_environment_logs_warning_for_old_tmux(
+def test_split_with_environment_logs_warning_for_old_tmux(
     session: Session,
     caplog: pytest.LogCaptureFixture,
 ) -> None:
     """Verify splitting window with environment variables warns if tmux too old."""
     env = shutil.which("env")
     assert env is not None, "Cannot find usable `env` in Path."
 
-    window = session.new_window(window_name="split_window_with_environment")
-    window.split_window(
+    window = session.new_window(window_name="split_with_environment")
+    window.split(
         shell=f"{env} PS1='$ ' sh",
         environment={"ENV_VAR": "pane"},
     )