ghstack 0.12.0__tar.gz → 0.14.0__tar.gz

ghstack-0.14.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) Edward Z. Yang <ezyang@mit.edu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{ghstack-0.12.0 → ghstack-0.14.0}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ghstack
-Version: 0.12.0
+Version: 0.14.0
 Summary: Stack diff support for GitHub
 Author: Edward Z. Yang
 Author-email: Edward Z. Yang <ezyang@mit.edu>
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent

{ghstack-0.12.0 → ghstack-0.14.0}/pyproject.toml

@@ -2,7 +2,10 @@
 authors = [
     {name = "Edward Z. Yang", email = "ezyang@mit.edu"},
 ]
-license = {text = "MIT"}
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
 requires-python = "<4.0.0,>=3.9.1"
 dependencies = [
     "aiohttp<4,>=3",
@@ -13,7 +16,7 @@ dependencies = [
     "flake8<8.0.0,>=7.0.0",
 ]
 name = "ghstack"
-version = "0.12.0"
+version = "0.14.0"
 description = "Stack diff support for GitHub"
 readme = "README.md"
 classifiers = [

ghstack-0.14.0/src/ghstack/checkout.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+
+import logging
+import re
+
+import ghstack.github
+import ghstack.github_utils
+import ghstack.shell
+
+
+def main(
+    pull_request: str,
+    github: ghstack.github.GitHubEndpoint,
+    sh: ghstack.shell.Shell,
+    remote_name: str,
+    same_base: bool = False,
+) -> None:
+
+    params = ghstack.github_utils.parse_pull_request(
+        pull_request, sh=sh, remote_name=remote_name
+    )
+    head_ref = github.get_head_ref(**params)
+    orig_ref = re.sub(r"/head$", "/orig", head_ref)
+    if orig_ref == head_ref:
+        logging.warning(
+            "The ref {} doesn't look like a ghstack reference".format(head_ref)
+        )
+
+    # TODO: Handle remotes correctly too (so this subsumes hub)
+
+    # If --same-base is specified, check if checkout would change the merge-base
+    if same_base:
+        # Get the default branch name from the repo
+        repo_info = ghstack.github_utils.get_github_repo_info(
+            github=github,
+            sh=sh,
+            repo_owner=params["owner"],
+            repo_name=params["name"],
+            github_url=params["github_url"],
+            remote_name=remote_name,
+        )
+        default_branch = repo_info["default_branch"]
+        default_branch_ref = f"{remote_name}/{default_branch}"
+
+        # Get current merge-base with default branch
+        current_base = sh.git("merge-base", default_branch_ref, "HEAD")
+    else:
+        current_base = None
+        default_branch_ref = None
+
+    sh.git("fetch", "--prune", remote_name)
+
+    # If --same-base is specified, check what the new merge-base would be
+    if same_base:
+        target_ref = remote_name + "/" + orig_ref
+        new_base = sh.git("merge-base", default_branch_ref, target_ref)
+
+        if current_base != new_base:
+            raise RuntimeError(
+                f"Checkout would change merge-base from {current_base[:8]} to {new_base[:8]}, "
+                f"aborting due to --same-base flag"
+            )
+
+    sh.git("checkout", remote_name + "/" + orig_ref)

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/cli.py

@@ -1,5 +1,6 @@
 import asyncio
 import contextlib
+import sys
 from typing import Generator, List, Optional, Tuple
 
 import click
@@ -79,6 +80,12 @@ def main(
     """
     Submit stacks of diffs to Github
     """
+    if sys.version_info >= (3, 14):
+        # Create new event loop as asyncio.get_event_loop() throws runtime error in 3.14
+        import asyncio as _asyncio
+
+        _asyncio.set_event_loop(_asyncio.new_event_loop())
+
     EXIT_STACK.enter_context(ghstack.logs.manager(debug=debug))
 
     if not ctx.invoked_subcommand:
@@ -113,8 +120,13 @@ def action(close: bool, pull_request: str) -> None:
 
 
 @main.command("checkout")
+@click.option(
+    "--same-base",
+    is_flag=True,
+    help="Only checkout if merge-base with main branch would remain the same",
+)
 @click.argument("pull_request", metavar="PR")
-def checkout(pull_request: str) -> None:
+def checkout(same_base: bool, pull_request: str) -> None:
     """
     Checkout a PR
     """
@@ -124,6 +136,7 @@ def checkout(pull_request: str) -> None:
             github=github,
             sh=shell,
             remote_name=config.remote_name,
+            same_base=same_base,
         )
 
 
@@ -250,6 +263,18 @@ def status(pull_request: str) -> None:
     "With --no-stack, we support only non-range identifiers, and will submit each commit "
     "listed in the command line.",
 )
+@click.option(
+    "--reviewer",
+    default=None,
+    help="Comma-separated list of GitHub usernames to add as reviewers to new PRs "
+    "(overrides .ghstackrc setting)",
+)
+@click.option(
+    "--label",
+    default=None,
+    help="Comma-separated list of labels to add to new PRs "
+    "(overrides .ghstackrc setting)",
+)
 @click.option(
     "--direct/--no-direct",
     "direct_opt",
@@ -273,6 +298,8 @@ def submit(
     base: Optional[str],
     revs: Tuple[str, ...],
     stack: bool,
+    reviewer: Optional[str],
+    label: Optional[str],
 ) -> None:
     """
     Submit or update a PR stack
@@ -294,6 +321,8 @@ def submit(
             revs=revs,
             stack=stack,
             direct_opt=direct_opt,
+            reviewer=reviewer if reviewer is not None else config.reviewer,
+            label=label if label is not None else config.label,
         )
 
 

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/config.py

@@ -5,8 +5,10 @@ import getpass
 import logging
 import os
 import re
+import shutil
+import subprocess
 from pathlib import Path
-from typing import NamedTuple, Optional
+from typing import NamedTuple, Optional, Tuple
 
 import requests
 
@@ -15,6 +17,71 @@ import ghstack.logs
 DEFAULT_GHSTACKRC_PATH = Path.home() / ".ghstackrc"
 GHSTACKRC_PATH_VAR = "GHSTACKRC_PATH"
 
+
+def is_gh_cli_available() -> bool:
+    """Check if the GitHub CLI (gh) is available in PATH."""
+    return shutil.which("gh") is not None
+
+
+def get_gh_cli_credentials(
+    github_url: str = "github.com",
+) -> Tuple[Optional[str], Optional[str], Optional[str]]:
+    """
+    Extract credentials from the GitHub CLI if available and authenticated.
+
+    Args:
+        github_url: The GitHub host to get credentials for.
+
+    Returns:
+        A tuple of (token, username, url) or (None, None, None) if unavailable.
+    """
+    if not is_gh_cli_available():
+        return None, None, None
+
+    try:
+        # Check if gh is authenticated for this host
+        auth_status = subprocess.run(
+            ["gh", "auth", "status", "-h", github_url],
+            capture_output=True,
+            text=True,
+        )
+        if auth_status.returncode != 0:
+            logging.debug(f"gh CLI not authenticated for {github_url}")
+            return None, None, None
+
+        # Get the token
+        token_result = subprocess.run(
+            ["gh", "auth", "token", "-h", github_url],
+            capture_output=True,
+            text=True,
+        )
+        if token_result.returncode != 0:
+            logging.debug("Failed to get token from gh CLI")
+            return None, None, None
+        token = token_result.stdout.strip()
+        if not token:
+            return None, None, None
+
+        # Get the username using gh api
+        username_result = subprocess.run(
+            ["gh", "api", "user", "-q", ".login", "--hostname", github_url],
+            capture_output=True,
+            text=True,
+        )
+        username = None
+        if username_result.returncode == 0:
+            username = username_result.stdout.strip()
+
+        logging.debug(
+            f"Successfully retrieved credentials from gh CLI for {github_url}"
+        )
+        return token, username, github_url
+
+    except Exception as e:
+        logging.debug(f"Error getting credentials from gh CLI: {e}")
+        return None, None, None
+
+
 Config = NamedTuple(
     "Config",
     [
@@ -40,6 +107,10 @@ Config = NamedTuple(
         ("github_url", str),
         # Name of the upstream remote
         ("remote_name", str),
+        # Default reviewers to add to new pull requests (comma-separated usernames)
+        ("reviewer", Optional[str]),
+        # Default labels to add to new pull requests (comma-separated labels)
+        ("label", Optional[str]),
     ],
 )
 
@@ -97,6 +168,7 @@ def read_config(
     # Environment variable overrides config file
     # This envvar is legacy from ghexport days
     github_oauth = os.getenv("OAUTH_TOKEN")
+    gh_cli_username = None  # Track username from gh CLI
     if github_oauth is not None:
         logging.warning(
             "Deprecated OAUTH_TOKEN environment variable used to populate github_oauth--"
@@ -105,6 +177,17 @@ def read_config(
         )
     if github_oauth is None and config.has_option("ghstack", "github_oauth"):
         github_oauth = config.get("ghstack", "github_oauth")
+
+    # Try GitHub CLI if available and no token found yet
+    if github_oauth is None and request_github_token:
+        gh_token, gh_username, _ = get_gh_cli_credentials(github_url)
+        if gh_token is not None:
+            print(f"Using GitHub credentials from gh CLI for {github_url}")
+            github_oauth = gh_token
+            gh_cli_username = gh_username
+            # Don't save gh CLI credentials to config - they may change/expire
+
+    # Fall back to device flow if still no token
     if github_oauth is None and request_github_token:
         print("Generating GitHub access token...")
         CLIENT_ID = "89cc88ca50efbe86907a"
@@ -150,6 +233,11 @@ def read_config(
     github_username = None
     if config.has_option("ghstack", "github_username"):
         github_username = config.get("ghstack", "github_username")
+    # Use username from gh CLI if we got it
+    if github_username is None and gh_cli_username is not None:
+        github_username = gh_cli_username
+        # Don't save gh CLI username to config - it comes from gh CLI
+    # Fall back to API lookup if we have a token but no username yet
     if github_username is None and github_oauth is not None:
         request_url: str
         if github_url == "github.com":
@@ -203,6 +291,16 @@ def read_config(
     else:
         remote_name = "origin"
 
+    if config.has_option("ghstack", "reviewer"):
+        reviewer = config.get("ghstack", "reviewer")
+    else:
+        reviewer = None
+
+    if config.has_option("ghstack", "label"):
+        label = config.get("ghstack", "label")
+    else:
+        label = None
+
     if write_back:
         with open(config_path, "w") as f:
             config.write(f)
@@ -218,6 +316,8 @@ def read_config(
         default_project_dir=default_project_dir,
         github_url=github_url,
         remote_name=remote_name,
+        reviewer=reviewer,
+        label=label,
     )
     logging.debug(f"conf = {conf}")
     return conf

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/github_fake.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 
+import dataclasses
 import os.path
 import re
 from dataclasses import dataclass
@@ -271,6 +272,8 @@ class PullRequest(Node):
     # state: PullRequestState
     title: str
     url: str
+    reviewers: List[str] = dataclasses.field(default_factory=list)
+    labels: List[str] = dataclasses.field(default_factory=list)
 
     def repository(self, info: GraphQLResolveInfo) -> Repository:
         return github_state(info).repositories[self._repository]
@@ -473,6 +476,24 @@ class FakeGitHubEndpoint(ghstack.github.GitHubEndpoint):
                     GitHubNumber(int(m.group(3))),
                     cast(CreateIssueCommentInput, kwargs),
                 )
+            if m := re.match(
+                r"^repos/([^/]+)/([^/]+)/pulls/([^/]+)/requested_reviewers", path
+            ):
+                # Handle adding reviewers
+                state = self.state
+                repo = state.repository(m.group(1), m.group(2))
+                pr = state.pull_request(repo, GitHubNumber(int(m.group(3))))
+                reviewers = kwargs.get("reviewers", [])
+                pr.reviewers.extend(reviewers)
+                return {}
+            if m := re.match(r"^repos/([^/]+)/([^/]+)/issues/([^/]+)/labels", path):
+                # Handle adding labels
+                state = self.state
+                repo = state.repository(m.group(1), m.group(2))
+                pr = state.pull_request(repo, GitHubNumber(int(m.group(3))))
+                labels = kwargs.get("labels", [])
+                pr.labels.extend(labels)
+                return {}
         elif method == "patch":
             if m := re.match(r"^repos/([^/]+)/([^/]+)(?:/pulls/([^/]+))?$", path):
                 owner, name, number = m.groups()

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/github_utils.py

@@ -25,7 +25,9 @@ def get_github_repo_name_with_owner(
     remote_name: str,
 ) -> GitHubRepoNameWithOwner:
     # Grovel in remotes to figure it out
-    remote_url = sh.git("remote", "get-url", remote_name)
+    # Use --push to get the push URL, which is what matters for determining
+    # where commits will actually be pushed to
+    remote_url = sh.git("remote", "get-url", "--push", remote_name)
     while True:
         match = r"^git@{github_url}:/?([^/]+)/(.+?)(?:\.git)?$".format(
             github_url=github_url
@@ -138,20 +140,32 @@ GitHubPullRequestParams = TypedDict(
 )
 
 
+def _normalize_remote_url(remote_url: str) -> str:
+    """Convert SSH remote URL to HTTPS format, strip .git suffix."""
+    # git@github.com:owner/repo.git -> https://github.com/owner/repo
+    m = re.match(r"^git@([^:]+):/?(.+?)(?:\.git)?$", remote_url)
+    if m:
+        return f"https://{m.group(1)}/{m.group(2)}"
+    return re.sub(r"\.git$", "", remote_url)
+
+
 def parse_pull_request(
     pull_request: str,
     *,
     sh: Optional[ghstack.shell.Shell] = None,
     remote_name: Optional[str] = None,
 ) -> GitHubPullRequestParams:
+    pull_request = pull_request.lstrip("#")
     m = RE_PR_URL.match(pull_request)
     if not m:
         # We can reconstruct the URL if just a PR number is passed
         if sh is not None and remote_name is not None:
-            remote_url = sh.git("remote", "get-url", remote_name)
+            remote_url = sh.git("remote", "get-url", "--push", remote_name)
             # Do not pass the shell to avoid infinite loop
             try:
-                return parse_pull_request(remote_url + "/pull/" + pull_request)
+                return parse_pull_request(
+                    _normalize_remote_url(remote_url) + "/pull/" + pull_request
+                )
             except RuntimeError:
                 # Fall back on original error message
                 pass

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/submit.py

@@ -343,6 +343,12 @@ class Submitter:
     # merged.  If None, infer whether or not the PR should be direct or not.
     direct_opt: Optional[bool] = None
 
+    # Default reviewers to add to new pull requests (comma-separated usernames)
+    reviewer: Optional[str] = None
+
+    # Default labels to add to new pull requests (comma-separated labels)
+    label: Optional[str] = None
+
     # ~~~~~~~~~~~~~~~~~~~~~~~~
     # Computed in post init
 
@@ -1434,6 +1440,32 @@ is closed (likely due to being merged).  Please rebase to upstream and try again
             )
             comment_id = rc["id"]
 
+        # Add reviewers if specified
+        if self.reviewer:
+            reviewers = [r.strip() for r in self.reviewer.split(",") if r.strip()]
+            if reviewers:
+                try:
+                    self.github.post(
+                        f"repos/{self.repo_owner}/{self.repo_name}/pulls/{number}/requested_reviewers",
+                        reviewers=reviewers,
+                    )
+                    logging.info(f"Added reviewers: {', '.join(reviewers)}")
+                except Exception as e:
+                    logging.warning(f"Failed to add reviewers: {e}")
+
+        # Add labels if specified
+        if self.label:
+            labels = [label.strip() for label in self.label.split(",") if label.strip()]
+            if labels:
+                try:
+                    self.github.post(
+                        f"repos/{self.repo_owner}/{self.repo_name}/issues/{number}/labels",
+                        labels=labels,
+                    )
+                    logging.info(f"Added labels: {', '.join(labels)}")
+                except Exception as e:
+                    logging.warning(f"Failed to add labels: {e}")
+
         logging.info("Opened PR #{}".format(number))
 
         pull_request_resolved = ghstack.diff.PullRequestResolved(

{ghstack-0.12.0 → ghstack-0.14.0}/src/ghstack/test_prelude.py

@@ -12,6 +12,7 @@ from typing import Any, Callable, Iterator, List, Optional, Sequence, Tuple, Uni
 
 from expecttest import assert_expected_inline
 
+import ghstack.checkout
 import ghstack.cherry_pick
 
 import ghstack.github
@@ -32,6 +33,7 @@ __all__ = [
     "gh_land",
     "gh_unlink",
     "gh_cherry_pick",
+    "gh_checkout",
     "GitCommitHash",
     "checkout",
     "amend",
@@ -49,6 +51,8 @@ __all__ = [
     "get_sh",
     "get_upstream_sh",
     "get_github",
+    "get_pr_reviewers",
+    "get_pr_labels",
     "tick",
     "captured_output",
 ]
@@ -192,6 +196,8 @@ def gh_submit(
     base: Optional[str] = None,
     revs: Sequence[str] = (),
     stack: bool = True,
+    reviewer: Optional[str] = None,
+    label: Optional[str] = None,
 ) -> List[ghstack.submit.DiffMeta]:
     self = CTX
     r = ghstack.submit.main(
@@ -212,6 +218,8 @@ def gh_submit(
         revs=revs,
         stack=stack,
         check_invariants=True,
+        reviewer=reviewer,
+        label=label,
     )
     self.check_global_github_invariants(self.direct)
     return r
@@ -251,6 +259,17 @@ def gh_cherry_pick(pull_request: str, stack: bool = False) -> None:
     )
 
 
+def gh_checkout(pull_request: str, same_base: bool = False) -> None:
+    self = CTX
+    return ghstack.checkout.main(
+        pull_request=pull_request,
+        github=self.github,
+        sh=self.sh,
+        remote_name="origin",
+        same_base=same_base,
+    )
+
+
 def write_file_and_add(filename: str, contents: str) -> None:
     self = CTX
     with self.sh.open(filename, "w") as f:
@@ -373,6 +392,26 @@ def is_direct() -> bool:
     return CTX.direct
 
 
+def get_github() -> ghstack.github_fake.FakeGitHubEndpoint:
+    return CTX.github
+
+
+def get_pr_reviewers(pr_number: int) -> List[str]:
+    """Get the reviewers for a PR number."""
+    github = get_github()
+    repo = github.state.repository("pytorch", "pytorch")
+    pr = github.state.pull_request(repo, ghstack.github_fake.GitHubNumber(pr_number))
+    return pr.reviewers
+
+
+def get_pr_labels(pr_number: int) -> List[str]:
+    """Get the labels for a PR number."""
+    github = get_github()
+    repo = github.state.repository("pytorch", "pytorch")
+    pr = github.state.pull_request(repo, ghstack.github_fake.GitHubNumber(pr_number))
+    return pr.labels
+
+
 def assert_eq(a: Any, b: Any) -> None:
     assert a == b, f"{a} != {b}"
 
@@ -406,9 +445,5 @@ def get_upstream_sh() -> ghstack.shell.Shell:
     return CTX.upstream_sh
 
 
-def get_github() -> ghstack.github.GitHubEndpoint:
-    return CTX.github
-
-
 def tick() -> None:
     CTX.sh.test_tick()

ghstack-0.12.0/src/ghstack/checkout.py

@@ -1,31 +0,0 @@
-#!/usr/bin/env python3
-
-import logging
-import re
-
-import ghstack.github
-import ghstack.github_utils
-import ghstack.shell
-
-
-def main(
-    pull_request: str,
-    github: ghstack.github.GitHubEndpoint,
-    sh: ghstack.shell.Shell,
-    remote_name: str,
-) -> None:
-
-    params = ghstack.github_utils.parse_pull_request(
-        pull_request, sh=sh, remote_name=remote_name
-    )
-    head_ref = github.get_head_ref(**params)
-    orig_ref = re.sub(r"/head$", "/orig", head_ref)
-    if orig_ref == head_ref:
-        logging.warning(
-            "The ref {} doesn't look like a ghstack reference".format(head_ref)
-        )
-
-    # TODO: Handle remotes correctly too (so this subsumes hub)
-
-    sh.git("fetch", "--prune", remote_name)
-    sh.git("checkout", remote_name + "/" + orig_ref)