Workspace ManagerstableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tmuxp.cli.search.normalize_fields

tmuxp.cli.search.normalize_fields ( fields: list[str] | None, ) → tuple[str, ...]

Normalize field names using aliases.

Examples#

>>> normalize_fields(None)
('name', 'session_name', 'path', 'window', 'pane')
>>> normalize_fields(["s", "n"])
('session_name', 'name')
>>> normalize_fields(["session_name", "path"])
('session_name', 'path')
>>> normalize_fields(["invalid"]) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
tmuxp.cli.search.InvalidFieldError: Unknown search field: 'invalid'. ...
Parameters
  • fields (list[str] | None) # – Field names or aliases to normalize. If None, returns DEFAULT_FIELDS.

Returns

tuple[str, ...] Tuple of canonical field names.

Raises
Esc

Type to search.

Reference preview Open reference