From 6875d298e24e759af6efe80bf8668105095c9e2f Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 11:55:26 -0500 Subject: [PATCH 01/10] py(deps) Point to git+https://github.com/tmux-python/libtmux.git#improved-options --- pyproject.toml | 3 +++ uv.lock | 10 +++------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 953a65175e..b26e53c689 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -88,6 +88,9 @@ dev-dependencies = [ "types-PyYAML", ] +[tool.uv.sources] +libtmux = { git = "https://github.com/tmux-python/libtmux.git", branch = "improved-options" } + [dependency-groups] docs = [ "aafigure", diff --git a/uv.lock b/uv.lock index 726a78bf9f..7a3a84eb6c 100644 --- a/uv.lock +++ b/uv.lock @@ -364,12 +364,8 @@ wheels = [ [[package]] name = "libtmux" -version = "0.39.0" -source = { registry = "https://pypi.org/simple" } -sdist = { url = "https://files.pythonhosted.org/packages/72/c4/e35564de320c876c6c370b8b9303a31ca2fcd632051aa8ac14a2d4700b68/libtmux-0.39.0.tar.gz", hash = "sha256:59346aeef3c0d6017f3bc5e23248d43cdf50f32b775b9cb5d9ff5e2e5f3059f4", size = 314810 } -wheels = [ - { url = "https://files.pythonhosted.org/packages/82/f8/afdcf3715c7388962c1eef39c7ba415a170f6772808ad83f60f8fdfdc6d0/libtmux-0.39.0-py3-none-any.whl", hash = "sha256:6b6e338be2727f67aa6b7eb67fa134368fa3c3eac5df27565396467692891c1e", size = 56219 }, -] +version = "0.38.1" +source = { git = "https://github.com/tmux-python/libtmux.git?branch=improved-options#5415d2595dde9bea2e6a0526e8522d793b94a1aa" } [[package]] name = "linkify-it-py" @@ -1121,7 +1117,7 @@ testing = [ [package.metadata] requires-dist = [ { name = "colorama", specifier = ">=0.3.9" }, - { name = "libtmux", specifier = "~=0.39.0" }, + { name = "libtmux", git = "https://github.com/tmux-python/libtmux.git?branch=improved-options" }, { name = "pyyaml", specifier = ">=6.0" }, ] From 048076353f012bd7743b5b59c2b15ce2f0714210 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 11:58:06 -0500 Subject: [PATCH 02/10] test(builder): Fixes for libtmux `.show_options` tests/workspace/test_builder.py:233: error: "Session" has no attribute "show_option" [attr-defined] tests/workspace/test_builder.py:237: error: "Session" has no attribute "show_option" [attr-defined] tests/workspace/test_builder.py:252: error: "Session" has no attribute "show_option" [attr-defined] tests/workspace/test_builder.py:255: error: "Session" has no attribute "show_option" [attr-defined] tests/workspace/test_builder.py:278: error: "Session" has no attribute "show_option" [attr-defined] tests/workspace/test_builder.py:281: error: "Session" has no attribute "show_option" [attr-defined] --- tests/workspace/test_builder.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tests/workspace/test_builder.py b/tests/workspace/test_builder.py index 801b462d5a..17f891fc3e 100644 --- a/tests/workspace/test_builder.py +++ b/tests/workspace/test_builder.py @@ -230,11 +230,11 @@ def test_session_options(session: Session) -> None: builder = WorkspaceBuilder(session_config=workspace, server=session.server) builder.build(session=session) - _default_shell = session.show_option("default-shell") + _default_shell = session._show_option("default-shell") assert isinstance(_default_shell, str) assert "/bin/sh" in _default_shell - _default_command = session.show_option("default-command") + _default_command = session._show_option("default-command") assert isinstance(_default_command, str) assert "/bin/sh" in _default_command @@ -249,10 +249,10 @@ def test_global_options(session: Session) -> None: builder = WorkspaceBuilder(session_config=workspace, server=session.server) builder.build(session=session) - _status_position = session.show_option("status-position", _global=True) + _status_position = session._show_option("status-position", _global=True) assert isinstance(_status_position, str) assert "top" in _status_position - assert session.show_option("repeat-time", _global=True) == 493 + assert session._show_option("repeat-time", _global=True) == 493 def test_global_session_env_options( @@ -275,10 +275,10 @@ def test_global_session_env_options( builder = WorkspaceBuilder(session_config=workspace, server=session.server) builder.build(session=session) - _visual_silence = session.show_option("visual-silence", _global=True) + _visual_silence = session._show_option("visual-silence", _global=True) assert isinstance(_visual_silence, str) assert visual_silence in _visual_silence - assert repeat_time == session.show_option("repeat-time") + assert repeat_time == session._show_option("repeat-time") assert main_pane_height == session.active_window.show_window_option( "main-pane-height", ) From 96fb7df671b9ae9ff06de0eb32ad8d0ec148e3d8 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 11:59:41 -0500 Subject: [PATCH 03/10] test(builder): Update for `_show_options` conversions --- tests/workspace/test_builder.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/workspace/test_builder.py b/tests/workspace/test_builder.py index 17f891fc3e..b26fda260d 100644 --- a/tests/workspace/test_builder.py +++ b/tests/workspace/test_builder.py @@ -276,8 +276,8 @@ def test_global_session_env_options( builder.build(session=session) _visual_silence = session._show_option("visual-silence", _global=True) - assert isinstance(_visual_silence, str) - assert visual_silence in _visual_silence + assert isinstance(_visual_silence, bool) + assert _visual_silence is True assert repeat_time == session._show_option("repeat-time") assert main_pane_height == session.active_window.show_window_option( "main-pane-height", @@ -513,7 +513,7 @@ def check_window_name_mismatch() -> bool: assert retry_until(check_window_name_mismatch, 5, interval=0.25) def check_window_name_match() -> bool: - assert w.show_window_option("automatic-rename") == "on" + assert w.show_window_option("automatic-rename") return w.name in { pathlib.Path(os.getenv("SHELL", "bash")).name, portable_command, From 2c0dcd398ede37368b59fc97e7290f70c987a561 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:03:05 -0500 Subject: [PATCH 04/10] test(builder): `show_window_option` -> `_show_option` --- tests/workspace/test_builder.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/tests/workspace/test_builder.py b/tests/workspace/test_builder.py index b26fda260d..b798bd8357 100644 --- a/tests/workspace/test_builder.py +++ b/tests/workspace/test_builder.py @@ -94,9 +94,9 @@ def test_focus_pane_index(session: Session) -> None: assert session.active_window.name == "focused window" - _pane_base_index = session.active_window.show_window_option( + _pane_base_index = session.active_window._show_option( "pane-base-index", - g=True, + _global=True, ) assert isinstance(_pane_base_index, int) pane_base_index = int(_pane_base_index) @@ -279,7 +279,7 @@ def test_global_session_env_options( assert isinstance(_visual_silence, bool) assert _visual_silence is True assert repeat_time == session._show_option("repeat-time") - assert main_pane_height == session.active_window.show_window_option( + assert main_pane_height == session.active_window._show_option( "main-pane-height", ) @@ -306,9 +306,9 @@ def test_window_options( p = p assert len(session.windows) == window_count assert isinstance(w, Window) - assert w.show_window_option("main-pane-height") == 5 + assert w._show_option("main-pane-height") == 5 if has_gte_version("2.3"): - assert w.show_window_option("pane-border-format") == " #P " + assert w._show_option("pane-border-format") == " #P " assert len(session.windows) == window_count window_count += 1 @@ -513,7 +513,7 @@ def check_window_name_mismatch() -> bool: assert retry_until(check_window_name_mismatch, 5, interval=0.25) def check_window_name_match() -> bool: - assert w.show_window_option("automatic-rename") + assert w._show_option("automatic-rename") return w.name in { pathlib.Path(os.getenv("SHELL", "bash")).name, portable_command, @@ -714,8 +714,10 @@ def test_pane_order(session: Session) -> None: window_count += 1 for w in session.windows: - pane_base_index = w.show_window_option("pane-base-index", g=True) + pane_base_index = w._show_option("pane-base-index", _global=True) + assert isinstance(pane_base_index, int) for p_index, p in enumerate(w.panes, start=pane_base_index): + assert p.index is not None assert int(p_index) == int(p.index) # pane-base-index start at base-index, pane_paths always start From 5bb840e40cbce20f5f1b6526b47d4f1496e1bd35 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:03:55 -0500 Subject: [PATCH 05/10] test(builder): `set_window_option` -> `set_option` --- tests/workspace/test_builder.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/workspace/test_builder.py b/tests/workspace/test_builder.py index b798bd8357..bca7c6046e 100644 --- a/tests/workspace/test_builder.py +++ b/tests/workspace/test_builder.py @@ -76,7 +76,7 @@ def test_split_windows_three_pane(session: Session) -> None: assert len(session.windows) == window_count window_count += 1 - w.set_window_option("main-pane-height", 50) + w.set_option("main-pane-height", 50) w.select_layout(wconf["layout"]) From 141e0615e8d910a8aa141c6d21c8661f88205897 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:05:00 -0500 Subject: [PATCH 06/10] builder: `show_window_option` -> `_show_option` --- src/tmuxp/workspace/builder.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/tmuxp/workspace/builder.py b/src/tmuxp/workspace/builder.py index fa4f8330f2..04c7ba2c33 100644 --- a/src/tmuxp/workspace/builder.py +++ b/src/tmuxp/workspace/builder.py @@ -464,7 +464,7 @@ def iter_create_panes( """ assert isinstance(window, Window) - pane_base_index_str = window.show_window_option("pane-base-index", g=True) + pane_base_index_str = window._show_option("pane-base-index", _global=True) assert pane_base_index_str is not None pane_base_index = int(pane_base_index_str) From 777a64464f2e0ce7c3fe3571a1d3bfa361359e9c Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:05:12 -0500 Subject: [PATCH 07/10] builder: `set_window_option` -> `set_option` --- src/tmuxp/workspace/builder.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/tmuxp/workspace/builder.py b/src/tmuxp/workspace/builder.py index 04c7ba2c33..4b00421ea7 100644 --- a/src/tmuxp/workspace/builder.py +++ b/src/tmuxp/workspace/builder.py @@ -433,7 +433,7 @@ def iter_create_windows( dict, ): for key, val in window_config["options"].items(): - window.set_window_option(key, val) + window.set_option(key, val) if window_config.get("focus"): window.select() @@ -585,7 +585,7 @@ def config_after_window( dict, ): for key, val in window_config["options_after"].items(): - window.set_window_option(key, val) + window.set_option(key, val) def find_current_attached_session(self) -> Session: """Return current attached session.""" From a02bb784e73884dd3c23212c45e7fa4f25300a47 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:05:38 -0500 Subject: [PATCH 08/10] docs(builder): Update docstring for `window_options` -> `window.options` --- src/tmuxp/workspace/builder.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/tmuxp/workspace/builder.py b/src/tmuxp/workspace/builder.py index 4b00421ea7..e2940d11d6 100644 --- a/src/tmuxp/workspace/builder.py +++ b/src/tmuxp/workspace/builder.py @@ -349,7 +349,7 @@ def iter_create_windows( Generator yielding :class:`libtmux.Window` by iterating through ``session_config['windows']``. - Applies ``window_options`` to window. + Applies ``options`` to window. Parameters ---------- From 1c0706989da0351010c7b50fe8a8177937a42109 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:05:59 -0500 Subject: [PATCH 09/10] freezer: `show_window_option` -> `_show_option` --- src/tmuxp/workspace/freezer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/tmuxp/workspace/freezer.py b/src/tmuxp/workspace/freezer.py index e782ccec2c..5923fc9395 100644 --- a/src/tmuxp/workspace/freezer.py +++ b/src/tmuxp/workspace/freezer.py @@ -70,7 +70,7 @@ def freeze(session: Session) -> t.Dict[str, t.Any]: for window in session.windows: window_config: t.Dict[str, t.Any] = { - "options": window.show_window_options(), + "options": window._show_options(), "window_name": window.name, "layout": window.window_layout, "panes": [], From bfdf0d047253335bdbcf030dfe7847b3969b19a0 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 6 Apr 2024 12:07:37 -0500 Subject: [PATCH 10/10] test(builder): Remove unused loop variables --- tests/workspace/test_builder.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/tests/workspace/test_builder.py b/tests/workspace/test_builder.py index bca7c6046e..0942ebcabe 100644 --- a/tests/workspace/test_builder.py +++ b/tests/workspace/test_builder.py @@ -47,9 +47,8 @@ def test_split_windows(session: Session) -> None: window_count = len(session.windows) # current window count assert len(session.windows) == window_count for w, wconf in builder.iter_create_windows(session): - for p in builder.iter_create_panes(w, wconf): + for _ in builder.iter_create_panes(w, wconf): w.select_layout("tiled") # fix glitch with pane size - p = p assert len(session.windows) == window_count assert isinstance(w, Window) @@ -68,9 +67,8 @@ def test_split_windows_three_pane(session: Session) -> None: window_count = len(session.windows) # current window count assert len(session.windows) == window_count for w, wconf in builder.iter_create_windows(session): - for p in builder.iter_create_panes(w, wconf): + for _ in builder.iter_create_panes(w, wconf): w.select_layout("tiled") # fix glitch with pane size - p = p assert len(session.windows) == window_count assert isinstance(w, Window) @@ -301,9 +299,8 @@ def test_window_options( window_count = len(session.windows) # current window count assert len(session.windows) == window_count for w, wconf in builder.iter_create_windows(session): - for p in builder.iter_create_panes(w, wconf): + for _ in builder.iter_create_panes(w, wconf): w.select_layout("tiled") # fix glitch with pane size - p = p assert len(session.windows) == window_count assert isinstance(w, Window) assert w._show_option("main-pane-height") == 5