File size: 9,931 Bytes
5e9fb2f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | # Copyright 2026 The HuggingFace Team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Output framework for the `hf` CLI."""
import dataclasses
import datetime
import json
import re
import sys
from collections.abc import Sequence
from enum import Enum
from typing import Any
import typer
from huggingface_hub.errors import ConfirmationError
from huggingface_hub.utils import ANSI, is_agent, tabulate
# TODO: remove OutputFormat in _cli_utils.py once all commands are migrated to OutputFormatWithAuto.
class OutputFormatWithAuto(str, Enum):
"""Output format for CLI commands with auto detection of agent/human mode."""
agent = "agent"
auto = "auto"
human = "human"
json = "json"
quiet = "quiet"
class Output:
"""Output sink for the `hf` CLI.
Mode is resolved once at init time based on `is_agent()` auto-detection
and can be overridden per-command via `set_mode()`.
"""
mode: OutputFormatWithAuto
def __init__(self) -> None:
self.set_mode()
def set_mode(self, mode: OutputFormatWithAuto = OutputFormatWithAuto.auto) -> None:
"""Override the output mode (called by commands that receive ``--format``)."""
if mode == OutputFormatWithAuto.auto:
mode = OutputFormatWithAuto.agent if is_agent() else OutputFormatWithAuto.human
self.mode = mode
def text(self, msg: str | None = None, *, human: str | None = None, agent: str | None = None) -> None:
"""Print a free-form text message to stdout."""
if msg is not None:
if human is not None or agent is not None:
raise ValueError("Cannot mix 'msg' with 'human'/'agent'.")
human = msg
agent = _strip_ansi(msg)
match self.mode:
case OutputFormatWithAuto.human:
if human is not None:
print(human)
case OutputFormatWithAuto.agent:
if agent is not None:
print(agent)
# json/quiet: no-op
def table(
self,
items: Sequence[dict[str, Any]],
*,
headers: list[str] | None = None,
id_key: str | None = None,
alignments: dict[str, str] | None = None,
) -> None:
"""Print tabular data to stdout.
Args:
items: List of dicts. Headers are auto-detected from keys if not provided.
headers: Explicit column names. If None, derived from dict keys (all-None columns filtered).
id_key: Key to print in quiet mode. If None, uses the first header.
alignments: Optional mapping of header name to "left" or "right". Defaults to "left".
"""
if not items:
match self.mode:
case OutputFormatWithAuto.agent | OutputFormatWithAuto.human:
print("No results found.")
case OutputFormatWithAuto.json:
print("[]")
return
if headers is None:
all_columns = list(items[0].keys())
headers = [col for col in all_columns if any(item.get(col) is not None for item in items)]
rows = [[item.get(h) for h in headers] for item in items]
match self.mode:
case OutputFormatWithAuto.human: # padded table, truncated cells, SCREAMING_SNAKE headers
formatted_rows: list[list[str | int]] = [[_format_table_cell_human(v) for v in row] for row in rows]
screaming_headers = [_to_header(h) for h in headers]
screaming_alignments = {_to_header(k): v for k, v in (alignments or {}).items()}
print(tabulate(formatted_rows, headers=screaming_headers, alignments=screaming_alignments))
case OutputFormatWithAuto.agent: # TSV, no truncation, full timestamps
print("\t".join(headers))
for row in rows:
print("\t".join(_format_table_cell_agent(v) for v in row))
case OutputFormatWithAuto.json: # compact JSON array
print(json.dumps(list(items), default=str))
case OutputFormatWithAuto.quiet: # id_key column (or first column), one per line
quiet_key = id_key or headers[0]
for item in items:
print(item.get(quiet_key, ""))
def dict(self, data: Any, *, id_key: str | None = None) -> None:
"""Print structured data as JSON in all modes (indented for human, compact otherwise).
Accepts a dict or a dataclass.
"""
if dataclasses.is_dataclass(data) and not isinstance(data, type):
data = _dataclass_to_dict(data)
if self.mode == OutputFormatWithAuto.quiet and id_key is not None:
print(data.get(id_key, ""))
return
indent = 2 if self.mode == OutputFormatWithAuto.human else None
print(json.dumps(data, indent=indent, default=str))
def result(self, message: str, **data: Any) -> None:
"""Print a success summary to stdout."""
match self.mode:
case OutputFormatWithAuto.human: # ✓ message + key: value lines
parts = [ANSI.green(f"✓ {message}")]
for k, v in data.items():
if v is not None:
parts.append(f" {k}: {v}")
print("\n".join(parts))
case OutputFormatWithAuto.agent: # key=val pairs, space-separated
parts = [f"{k}={v}" for k, v in data.items() if v is not None]
print(" ".join(parts) if parts else message)
case OutputFormatWithAuto.json: # json.dumps(data), message ignored
print(json.dumps(data, default=str) if data else "")
case OutputFormatWithAuto.quiet: # first value only
values = list(data.values())
if values:
print(values[0])
def confirm(self, message: str, *, default: bool = False, yes: bool = False) -> None:
"""
Ask for confirmation. Raises `ConfirmationError` in non-human modes.
"""
if yes:
return
if self.mode != OutputFormatWithAuto.human:
raise ConfirmationError(f"{message} Use --yes to skip confirmation.")
typer.confirm(message, default=default, abort=True)
def warning(self, message: str) -> None:
"""Print a non-fatal warning to stderr (all modes)."""
if self.mode == OutputFormatWithAuto.human:
print(ANSI.yellow(f"Warning: {message}"), file=sys.stderr)
else:
print(f"Warning: {message}", file=sys.stderr)
def error(self, message: str) -> None:
"""Print an error to stderr (all modes)."""
if self.mode == OutputFormatWithAuto.human:
print(ANSI.red(f"Error: {message}"), file=sys.stderr)
else:
print(f"Error: {message}", file=sys.stderr)
def hint(self, message: str) -> None:
"""Print a helpful hint to stderr (human: gray, agent/json: plain text)."""
if self.mode == OutputFormatWithAuto.human:
print(ANSI.gray(f"Hint: {message}"), file=sys.stderr)
else:
print(f"Hint: {message}", file=sys.stderr)
# HELPERS
def _serialize_value(v: object) -> object:
"""Recursively serialize a value to be JSON-compatible."""
if isinstance(v, datetime.datetime):
return v.isoformat()
elif isinstance(v, dict):
return {key: _serialize_value(val) for key, val in v.items() if val is not None}
elif isinstance(v, list):
return [_serialize_value(item) for item in v]
return v
def _dataclass_to_dict(info: Any) -> dict[str, Any]:
"""Convert a dataclass to a json-serializable dict."""
return {k: _serialize_value(v) for k, v in dataclasses.asdict(info).items() if v is not None}
_ANSI_RE = re.compile(r"\033\[[0-9;]*m")
_MAX_CELL_LENGTH = 35
def _strip_ansi(text: str) -> str:
return _ANSI_RE.sub("", text)
def _to_header(name: str) -> str:
"""Convert a camelCase or PascalCase string to SCREAMING_SNAKE_CASE."""
s = re.sub(r"([a-z])([A-Z])", r"\1_\2", name)
return s.upper()
def _format_table_value_human(value: Any) -> str:
"""Convert a value to string for terminal display."""
if value is None:
return ""
if isinstance(value, bool):
return "✔" if value else ""
if isinstance(value, datetime.datetime):
return value.strftime("%Y-%m-%d")
if isinstance(value, str) and re.match(r"^\d{4}-\d{2}-\d{2}T", value):
return value[:10]
if isinstance(value, list):
return ", ".join(_format_table_value_human(v) for v in value)
elif isinstance(value, dict):
if "name" in value: # Likely to be a user or org => print name
return str(value["name"])
return json.dumps(value)
return str(value)
def _format_table_cell_human(value: Any, max_len: int = _MAX_CELL_LENGTH) -> str:
"""Format a value + truncate it for table display."""
cell = _format_table_value_human(value)
if len(cell) > max_len:
cell = cell[: max_len - 3] + "..."
return cell
def _format_table_cell_agent(value: Any) -> str:
"""Format a cell value for agent TSV output (ISO timestamps, tabs escaped)."""
if isinstance(value, datetime.datetime):
return value.isoformat()
return str(value).replace("\t", " ")
out = Output()
|