Skip to content

Pr text

pr_text

Text renderers for GitPRTool dual-format ToolResult.

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

Text Only
git_pr | ✓ | #{pr_number} [· auto-merge]
{pr_url}
git_pr | ✗ | {error}

render_failure_text(*, error, data)

Render the failure-path text representation.

Appends a child-repo hint when data carries suggestions (the not-a-repo enrichment).

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

    Appends a child-repo hint when *data* carries ``suggestions``
    (the not-a-repo enrichment).
    """
    header = f"git_pr | ✗ | {error}"
    suggestions = _as_str_list(data.get("suggestions")) if data else []
    if suggestions:
        return f"{header}\nhint: pass one as path: {', '.join(suggestions)}"
    return header

render_text(data)

Render the success-path data dict.

{"pr_url", "pr_number", "auto_merge"} → #{number}[ · auto-merge] header plus the PR url on the next line.

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

    ``{"pr_url", "pr_number", "auto_merge"}`` → ``#{number}[ · auto-merge]``
    header plus the PR url on the next line.
    """
    number = _as_str(data.get("pr_number"))
    header = f"git_pr | ✓ | #{number}"
    if data.get("auto_merge"):
        header += " · auto-merge"
    url = _as_str(data.get("pr_url"))
    return f"{header}\n{url}" if url else header