Cleanups (#527)

• Streamline {Server,Session,Window,Pane}.cmd(), across all usages to:

  • Use cmd: str as first positional
  • Removed unused keyword arguments **kwargs

Renamings (#527)

• Session.attached_window renamed to Session.active_window()
  • Session.attached_window deprecated
• Session.attached_pane renamed to Session.active_pane()
  • Session.attached_pane deprecated
• Window.attached_pane renamed to Window.active_pane()
  • Window.attached_pane deprecated

Improvements (#527)

• Server.attached_windows now users QueryList’s .filter()

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.30.2...v0.31.0

• TMUX_MAX_VERSION: 3.3 -> 3.4

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.30.1...v0.30.2

• pytest plugin, test module: Update to renamed methods introduced in v0.30.0

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.30.0...v0.30.1

New and improved commands

by @tony in https://github.com/tmux-python/libtmux/pull/525

New commands

• Pane.kill()

Renamed commands

• Window.select_window() renamed to Window.select()
  • Deprecated Window.select_window()
• Pane.select_pane() renamed to Pane.select()
  • Deprecated Pane.pane_select()
• Session.attach_session() renamed to Session.attach()
  • Deprecated Session.attach_session()
• Server.kill_server() renamed to Server.kill()
  • Deprecated Server.kill_server()
• Session.kill_session() renamed to Session.kill()
  • Deprecated Session.kill_session()
• Window.kill_window() renamed to Window.kill()
  • Deprecated Window.kill_window()

Improved commands

• Server.new_session(): Support environment variables

• Window.split_window(): Support size via -l

  Supports columns/rows (size=10) and percentage (size='10%')

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.29.0...v0.30.0

Develpment

• fix(warnings): Use DeprecationWarning for APIs being deprecated by @tony in https://github.com/tmux-python/libtmux/pull/526

Testing

• pytest: Ignore DeprecationWarning in tests @tony in https://github.com/tmux-python/libtmux/pull/526

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.28.1...v0.29.0

Maintenance only, no bug fixes or new features

Testing

• CI: Bump actions to node 20+ versions

Documentation

• Refine docs and add migration for v0.28.0

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.28.0...v0.28.1

Breaking changes

Session.new_window() + Window.split_window(): No longer attaches by default

• 0.28 +: Now defaults to attach=False.
• 0.27.1 and before: defaults to attach=True.

Pass attach=True for the old behavior.

Pane.resize_pane() renamed to Pane.resize(): (#523)

This convention will be more consistent with Window.resize().

Pane.resize_pane(): Params changed (#523)

• No longer accepts -U, -D, -L, -R directly, instead accepts
  ResizeAdjustmentDirection.

New features

Pane.resize(): Improved param coverage (#523)

• Learned to accept adjustments via adjustment_direction w/
  ResizeAdjustmentDirection + adjustment.

• Learned to accept manual height and / or width (columns/rows or percentage)

• Zoom (and unzoom)

Window.resize_window(): New Method (#523)

If Pane.resize_pane() (now Pane.resize()) didn’t work before, try resizing the window.

Bug fixes

Window.refresh() and Pane.refresh(): Refresh more underlying state (#523)

Obj._refresh: Allow passing args (#523)

e.g. -a (all) to list-panes and list-windows

Server.panes: Fix listing of panes (#523)

Would list only panes in attached session, rather than all in a server.

Improvements

• Pane, Window: Improve parsing of option values that return numbers
  (#520)
• Obj._refresh: Allow passing list_extra_args to ensure list-windows and
  list-panes can return more than the target (#523)

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.27.1...v0.28.0

What’s Changed

• pyproject: Include MIGRATION in sdist by @tony in https://github.com/tmux-python/libtmux/pull/517, for https://github.com/tmux-python/libtmux/issues/508

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.27.0...v0.27.1

Improvements

• QueryList: Generic fixes by @tony in https://github.com/tmux-python/libtmux/pull/515

  • This improves the annotations in descendant objects such as:

    • Server.sessions
    • Session.windows
    • Window.panes

  • Bolster tests (ported from libvcs): doctests and pytests

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.26.0...v0.27.0

What’s Changed

Breaking change

• get_by_id() (already deprecated) keyword argument renamed from id to
  Server.get_by_id(session_id), Session.get_by_id(window_id), and Window.get_by_id(pane_id) (#514)

Documentation

• Various docstring fixes and tweaks (#514)

Development

• Strengthen linting (#514)

  • Add flake8-commas (COM)

    • https://docs.astral.sh/ruff/rules/#flake8-commas-com
    • https://pypi.org/project/flake8-commas/

  • Add flake8-builtins (A)

    • https://docs.astral.sh/ruff/rules/#flake8-builtins-a
    • https://pypi.org/project/flake8-builtins/

  • Add flake8-errmsg (EM)

    • https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
    • https://pypi.org/project/flake8-errmsg/

CI

• Move CodeQL from advanced configuration file to GitHub’s default

Full Changelog: https://github.com/tmux-python/libtmux/compare/v0.25.0...v0.26.0