tmuxp.cli.search.normalize_fields

API reference · Markdown

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

function [source] ¶

function [source] ¶

tmuxp.cli.search.normalize_fields

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

• InvalidFieldError – If a field name is not recognized.