tmuxp.cli.search.parse_query_terms
-
Parse query terms into search tokens.
Description#
Each term can optionally have a field prefix (e.g., "name:dev"). Terms without prefixes search the default fields.
Examples#
>>> tokens = parse_query_terms(["dev"])>>> tokens[0].fields('name', 'session_name', 'path', 'window', 'pane')>>> tokens[0].pattern'dev'>>> tokens = parse_query_terms(["name:dev", "s:prod"])>>> tokens[0]SearchToken(fields=('name',), pattern='dev')>>> tokens[1]SearchToken(fields=('session_name',), pattern='prod')>>> tokens = parse_query_terms(["window:editor", "shell"])>>> tokens[0].fields('window',)>>> tokens[1].fields('name', 'session_name', 'path', 'window', 'pane')Unknown prefixes are treated as literal patterns (allows URLs, etc.):
>>> tokens = parse_query_terms(["http://example.com"])>>> tokens[0].pattern'http://example.com'>>> tokens[0].fields # Searches default fields('name', 'session_name', 'path', 'window', 'pane')- Parameters
- Returns
-
list[SearchToken] List of parsed search tokens.
- Raises
-
-
Invalid
Field – If a field prefix is not recognized.Error
-