Module

output

Structured output formatting for CLI commands.

Functions

format_output 3 str
Format command output based on requested format. Formats: plain — human-r…
def format_output(data: Any, fmt: str = 'plain', template: str = '') -> str

Format command output based on requested format.

Formats:

plain  — human-readable (default)
json   — JSON output
table  — tabular output (for lists of dicts)
template — render through a kida template
Parameters
Name Type Description
data Any
fmt str Default:'plain'
template str Default:''
Returns
str
_format_json 1 str
JSON output.
def _format_json(data: Any) -> str
Parameters
Name Type Description
data Any
Returns
str
_format_plain 1 str
Human-readable plain output.
def _format_plain(data: Any) -> str
Parameters
Name Type Description
data Any
Returns
str
_format_table 1 str
Table output using kida's table filter if available.
def _format_table(data: Any) -> str
Parameters
Name Type Description
data Any
Returns
str
_format_template 2 str
Render through a kida template.
def _format_template(data: Any, template_name: str) -> str
Parameters
Name Type Description
data Any
template_name str
Returns
str
write_output 3 None
Format and write command output to stdout.
def write_output(data: Any, fmt: str = 'plain', template: str = '') -> None
Parameters
Name Type Description
data Any
fmt str Default:'plain'
template str Default:''