Skip to content

Push text

push_text

Text renderers for GitPushTool dual-format ToolResult.

Transform the structured data dict produced by :class:axm_git.tools.push.GitPushTool into a compact text representation::

Text Only
git_push | ✓ | {branch} → {remote} [· upstream set]
git_push | ✗ | {error}

render_failure_text(*, error, data)

Render the failure-path text representation.

Lists dirty paths when data carries dirty_files (tree not clean), or a child-repo hint when data carries suggestions (not-a-repo).

Source code in packages/axm-git/src/axm_git/tools/push_text.py
Python
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def render_failure_text(*, error: str, data: dict[str, object] | None) -> str:
    """Render the failure-path text representation.

    Lists dirty paths when *data* carries ``dirty_files`` (tree not clean),
    or a child-repo hint when *data* carries ``suggestions`` (not-a-repo).
    """
    header = f"git_push | ✗ | {error}"
    if data is None:
        return header
    dirty = _as_str_list(data.get("dirty_files"))
    if dirty:
        return f"{header}\ndirty: {', '.join(dirty)}"
    suggestions = _as_str_list(data.get("suggestions"))
    if suggestions:
        return f"{header}\nhint: pass one as path: {', '.join(suggestions)}"
    return header

render_text(data)

Render the success-path data dict.

{"branch", "remote", "pushed", "set_upstream"} → git_push | ✓ | {branch} → {remote}[ · upstream set].

Source code in packages/axm-git/src/axm_git/tools/push_text.py
Python
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def render_text(data: dict[str, object]) -> str:
    """Render the success-path ``data`` dict.

    ``{"branch", "remote", "pushed", "set_upstream"}`` →
    ``git_push | ✓ | {branch} → {remote}[ · upstream set]``.
    """
    branch = _as_str(data.get("branch"))
    remote = _as_str(data.get("remote"))
    header = f"git_push | ✓ | {branch} → {remote}"
    if data.get("set_upstream"):
        header += " · upstream set"
    force_mode = data.get("force_mode")
    if force_mode:
        header += f" · {force_mode}"
    return header