Skip to content

Pr recovery

pr_recovery

Shared recovery for an already-existing GitHub pull request.

When gh pr create fails because a PR already exists for the branch, :class:~axm_git.tools.pr.GitPRTool recovers it via gh pr view. This module factors that recovery into a result-agnostic helper.

PRRecovery dataclass

Normalized result of recovering an existing pull request.

On success error is None and url/number are populated. On failure error carries the reason and url/number are empty.

Source code in packages/axm-git/src/axm_git/core/pr_recovery.py
Python
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@dataclass(frozen=True)
class PRRecovery:
    """Normalized result of recovering an existing pull request.

    On success ``error`` is ``None`` and ``url``/``number`` are populated.
    On failure ``error`` carries the reason and ``url``/``number`` are empty.
    """

    url: str = ""
    number: str = ""
    already_existed: bool = False
    error: str | None = None

    @property
    def ok(self) -> bool:
        """Whether recovery succeeded."""
        return self.error is None
ok property

Whether recovery succeeded.

is_already_exists(stderr)

Return True when stderr signals an existing PR (case-insensitive).

Source code in packages/axm-git/src/axm_git/core/pr_recovery.py
Python
41
42
43
def is_already_exists(stderr: str) -> bool:
    """Return ``True`` when *stderr* signals an existing PR (case-insensitive)."""
    return "already exists" in stderr.lower()

recover_existing_pr(working_dir)

Resolve the existing PR via gh pr view after an 'already exists' error.

Parameters:

Name Type Description Default
working_dir Path

Repository working directory.

 required

Returns:

Name Type Description
A PRRecovery

class:PRRecovery with url/number/already_existed on
PRRecovery

success, or with error set when the PR could not be retrieved.
Source code in packages/axm-git/src/axm_git/core/pr_recovery.py
Python
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def recover_existing_pr(working_dir: Path) -> PRRecovery:
    """Resolve the existing PR via ``gh pr view`` after an 'already exists' error.

    Args:
        working_dir: Repository working directory.

    Returns:
        A :class:`PRRecovery` with ``url``/``number``/``already_existed`` on
        success, or with ``error`` set when the PR could not be retrieved.
    """
    view = run_gh(["pr", "view", "--json", "url,number"], working_dir)
    if view.returncode != 0:
        return PRRecovery(
            error=f"PR already exists but could not retrieve it: {view.stderr}"
        )
    try:
        data = json.loads(view.stdout)
        return PRRecovery(
            url=data["url"],
            number=str(data["number"]),
            already_existed=True,
        )
    except (json.JSONDecodeError, KeyError) as exc:
        return PRRecovery(error=f"PR already exists but could not parse it: {exc}")