Internals¶

Danger

No stability guarantee. Internal APIs are not covered by version policies. They can break or be removed between any minor versions without notice.

If you need an internal API stabilized please file an issue.

Dataclass helpers

Typed dataclass utilities used across internal modules.

Dataclass helpers - libtmux._internal.dataclasses
Query List

List filtering and attribute-based querying.

List querying - libtmux._internal.query_list
Constants

Internal format strings and tmux constants.

Internal Constants - libtmux._internal.constants
Sparse Array

Sparse array data structure for tmux format parsing.

Internal Sparse Array - libtmux._internal.sparse_array

Environmental variables¶

tmux format separator¶

Added in version 0.11.0b0.

LIBTMUX_TMUX_FORMAT_SEPARATOR can be used to override the default string used to split tmux(1)’s formatting information.

If you find any compatibility problems with the default, or better yet find a string copacetic many environments and tmux releases, note it at https://github.com/tmux-python/libtmux/discussions/355.