Core LibrarystableAPI 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.

function libtmux stable

parse_output

Parse a tmux -F line into a dict keyed by Obj field name.

Source and package
Qualified name
libtmux.neo.parse_output
Module
libtmux.neo
Package
libtmux
Source
src/libtmux/neo.py
parse_output ( output: str, list_cmd: str = "list-panes", tmux_version: str = "3.2a", ) → OutputRaw

Description#

The (list_cmd, tmux_version) pair must match what was passed to get_output_format when the -F template was built — otherwise the field order won't line up with the split values.

Examples#

>>> from libtmux.neo import get_output_format, parse_output
>>> from libtmux.formats import FORMAT_SEPARATOR
>>> fields, fmt = get_output_format("list-sessions", "3.6a")
>>> values = [''] * len(fields)
>>> values[fields.index('session_id')] = '$1'
>>> result = parse_output(
... FORMAT_SEPARATOR.join(values) + FORMAT_SEPARATOR,
... list_cmd="list-sessions",
... tmux_version="3.6a",
... )
>>> result['session_id']
'$1'
>>> 'pane_id' in result
False
Parameters
Returns

OutputRaw A dict mapping field names to non-empty string values.

Esc

Type to search.

Reference preview Open reference