Libtmux

Breaking changes (426)

- Finding objects / relations

- 0.16 and below: `session._windows()`, `session.list_windows()`, etc.

0.17 and after: {attr}`session.windows <libtmux.Session.windows>`

- 0.16 and below: `session.find_where({'window_name': my_window})`

0.17 and after: {meth}`session.windows.get(window_name=my_window, default=None) <libtmux.Session.windows>`

- If not found and not `default`, raises {exc}`~libtmux._internal.query_list.ObjectDoesNotExist`
- If multiple objects found, raises {exc}`~libtmux._internal.query_list.MultipleObjectsReturned`

- 0.16 and below: `session.where({'window_name': my_window})`

0.17 and after: {meth}`session.windows.filter(window_name=my_window) <libtmux.Session.windows>`

- Accessing attributes

- 0.16 and below: `window['id']`

0.17 and after: `window.id`

- 0.16 and below: `window.get('id')`

0.17 and after: `window.id`

- 0.16 and below: `window.get('id', None)`

0.17 and after: `getattr(window, 'id', None)`

New features

Detect if server active (448)

- `Server.is_alive()`
- `Server.raise_if_dead()`

Internal

- Remove unused `sphinx-click` development dependency

Fixes

- Remove reliance on `packaging.version.Version` (461)

This is too critical of a package to pin a dependency as it may interfere with other packages the user relies on. In addition, libtmux doesn't need strict compatibility with `packaging`.

Breaking changes

- Fix `distutils` warning, vendorize `LegacyVersion` (351)

Removal of reliancy on `distutils.version.LooseVersion`, which does not
support `tmux(1)` versions like `3.1a`.

Fixes warning:

> DeprecationWarning: distutils Version classes are deprecated. Use
> packaging.version instead.

The temporary workaround, before 0.16.0 (assuming _setup.cfg_):

ini
[tool:pytest]
filterwarnings =
ignore:.* Use packaging.version.*:DeprecationWarning::
ignore:The frontend.Option(Parser)? class.*:DeprecationWarning::


Features

- `Window.split_window()` and `Session.new_window()` now support an optional
dictionary of environmental variables, via (453), credit zappolowski.

_There will be more improvements over the coming weeks and months to shore up
flakiness across shells and environments._

Tests

- Compatibility improvement for `test_capture_pane` and `env` (452), credit:
zappolowski!
- Remove more BASHisms from tests (455)

Bug fix

- `tmux_cmd()`: Fix raise of TmuxCommandNotFound (450)

CI

- Use python 3.11 (451)

Packaging

- Add python 3.11 to trove classifiers (451)

Development

- Add python 3.11 to asdf and pyenv configurations (451)

Bug fix

- `Session.new_window()`: Improve support for `window_name: ''` downstream in tmuxp (444, credit: trankchung)