Skip to content

Commit

Permalink
Run black on sources. (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ZolotukhinM
ZolotukhinM authored Oct 6, 2024
1 parent a2af242 commit f6aa5ae
Show file tree
Hide file tree
Showing 3 changed files with 142 additions and 51 deletions.
163 changes: 120 additions & 43 deletions src/stack_pr/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,9 @@ def commit_id(self) -> str:
return self._search_group(RE_RAW_COMMIT_ID, "commit")

def parents(self) -> List[str]:
return [m.group("commit") for m in RE_RAW_PARENT.finditer(self.raw_header)]
return [
m.group("commit") for m in RE_RAW_PARENT.finditer(self.raw_header)
]

def author(self) -> str:
return self._search_group(RE_RAW_AUTHOR, "author")
Expand All @@ -217,7 +219,8 @@ def author_email(self) -> str:

def commit_msg(self) -> str:
return "\n".join(
m.group("line") for m in RE_RAW_COMMIT_MSG_LINE.finditer(self.raw_header)
m.group("line")
for m in RE_RAW_COMMIT_MSG_LINE.finditer(self.raw_header)
)


Expand Down Expand Up @@ -398,7 +401,9 @@ def is_ancestor(commit1: str, commit2: str, verbose: bool) -> bool:
# TODO: We need to check returncode of this command more carefully, as the
# command simply might fail (rc != 0 and rc != 1).
p = run_shell_command(
["git", "merge-base", "--is-ancestor", commit1, commit2], check=False, quiet=not verbose
["git", "merge-base", "--is-ancestor", commit1, commit2],
check=False,
quiet=not verbose,
)
return p.returncode == 0

Expand All @@ -424,7 +429,9 @@ def get_stack(base: str, head: str, verbose: bool) -> List[StackEntry]:
st: List[StackEntry] = []
stack = (
split_header(
get_command_output(["git", "rev-list", "--header", "^" + base, head])
get_command_output(
["git", "rev-list", "--header", "^" + base, head]
)
)
)[::-1]

Expand Down Expand Up @@ -514,7 +521,9 @@ def draft_bitmask_type(value: str) -> List[bool]:
# ===----------------------------------------------------------------------=== #
# SUBMIT
# ===----------------------------------------------------------------------=== #
def add_or_update_metadata(e: StackEntry, needs_rebase: bool, verbose: bool) -> bool:
def add_or_update_metadata(
e: StackEntry, needs_rebase: bool, verbose: bool
) -> bool:
if needs_rebase:
run_shell_command(
[
Expand All @@ -538,7 +547,9 @@ def add_or_update_metadata(e: StackEntry, needs_rebase: bool, verbose: bool) ->
# Add the stack info metadata to the commit message
commit_msg += f"\n\nstack-info: PR: {e.pr}, branch: {e.head}"
run_shell_command(
["git", "commit", "--amend", "-F", "-"], input=commit_msg.encode(), quiet=not verbose
["git", "commit", "--amend", "-F", "-"],
input=commit_msg.encode(),
quiet=not verbose,
)
return True

Expand Down Expand Up @@ -581,7 +592,10 @@ def init_local_branches(st: List[StackEntry], remote: str, verbose: bool):
log(h("Initializing local branches"), level=1)
set_head_branches(st, remote, verbose)
for e in st:
run_shell_command(["git", "checkout", e.commit.commit_id(), "-B", e.head], quiet=not verbose)
run_shell_command(
["git", "checkout", e.commit.commit_id(), "-B", e.head],
quiet=not verbose,
)


def push_branches(st: List[StackEntry], remote, verbose: bool):
Expand All @@ -593,14 +607,14 @@ def push_branches(st: List[StackEntry], remote, verbose: bool):

def print_cmd_failure_details(exc: SubprocessError):
cmd_stdout = (
exc.stdout.decode("utf-8").replace("\\n", "\n").replace("\\t", "\t")
if exc.stdout
else None
exc.stdout.decode("utf-8")
.replace("\\n", "\n")
.replace("\\t", "\t") if exc.stdout else None
)
cmd_stderr = (
exc.stderr.decode("utf-8").replace("\\n", "\n").replace("\\t", "\t")
if exc.stderr
else None
exc.stderr.decode("utf-8")
.replace("\\n", "\n")
.replace("\\t", "\t") if exc.stderr else None
)
print(f"Exitcode: {exc.returncode}")
print(f"Stdout: {cmd_stdout}")
Expand Down Expand Up @@ -678,7 +692,9 @@ def add_cross_links(st: List[StackEntry], keep_body: bool, verbose: bool):
if keep_body:
# Keep current body of the PR after the cross links component
current_pr_body = get_current_pr_body(e)
pr_body.append(current_pr_body.split(CROSS_LINKS_DELIMETER, 1)[-1].lstrip())
pr_body.append(
current_pr_body.split(CROSS_LINKS_DELIMETER, 1)[-1].lstrip()
)
else:
pr_body.extend(
[
Expand Down Expand Up @@ -718,11 +734,15 @@ def add_cross_links(st: List[StackEntry], keep_body: bool, verbose: bool):
#
# To avoid this, we temporarily set all base branches to point to 'main' - once
# all the branches are pushed we can set the actual base branches.
def reset_remote_base_branches(st: List[StackEntry], target: str, verbose: bool):
def reset_remote_base_branches(
st: List[StackEntry], target: str, verbose: bool
):
log(h("Resetting remote base branches"), level=1)

for e in filter(lambda e: e.has_pr(), st):
run_shell_command(["gh", "pr", "edit", e.pr, "-B", target], quiet=not verbose)
run_shell_command(
["gh", "pr", "edit", e.pr, "-B", target], quiet=not verbose
)


# If local 'main' lags behind 'origin/main', and 'head' contains all commits
Expand All @@ -736,7 +756,9 @@ def reset_remote_base_branches(st: List[StackEntry], target: str, verbose: bool)
# already in remote into their stack, they can use a different notation for the
# base (e.g. explicit hash of the commit) - but most probably nobody ever would
# need that.
def should_update_local_base(head: str, base: str, remote: str, target: str, verbose: bool):
def should_update_local_base(
head: str, base: str, remote: str, target: str, verbose: bool
):
base_hash = get_command_output(["git", "rev-parse", base])
target_hash = get_command_output(["git", "rev-parse", f"{remote}/{target}"])
return (
Expand All @@ -748,7 +770,9 @@ def should_update_local_base(head: str, base: str, remote: str, target: str, ver

def update_local_base(base: str, remote: str, target: str, verbose: bool):
log(h(f"Updating local branch {base} to {remote}/{target}"), level=1)
run_shell_command(["git", "rebase", f"{remote}/{target}", base], quiet=not verbose)
run_shell_command(
["git", "rebase", f"{remote}/{target}", base], quiet=not verbose
)


class CommonArgs(NamedTuple):
Expand All @@ -763,7 +787,14 @@ class CommonArgs(NamedTuple):

@classmethod
def from_args(cls, args: argparse.Namespace) -> "CommonArgs":
return cls(args.base, args.head, args.remote, args.target, args.hyperlinks, args.verbose)
return cls(
args.base,
args.head,
args.remote,
args.target,
args.hyperlinks,
args.verbose,
)


# If the base isn't explicitly specified, find the merge base between
Expand All @@ -784,7 +815,12 @@ def deduce_base(args: CommonArgs) -> CommonArgs:
["git", "merge-base", args.head, f"{args.remote}/{args.target}"]
)
return CommonArgs(
deduced_base, args.head, args.remote, args.target, args.hyperlinks, args.verbose
deduced_base,
args.head,
args.remote,
args.target,
args.hyperlinks,
args.verbose,
)


Expand Down Expand Up @@ -815,9 +851,13 @@ def command_submit(

current_branch = get_current_branch_name()

if should_update_local_base(args.head, args.base, args.remote, args.target, args.verbose):
if should_update_local_base(
args.head, args.base, args.remote, args.target, args.verbose
):
update_local_base(args.base, args.remote, args.target, args.verbose)
run_shell_command(["git", "checkout", current_branch], quiet=not args.verbose)
run_shell_command(
["git", "checkout", current_branch], quiet=not args.verbose
)

# Determine what commits belong to the stack
st = get_stack(args.base, args.head, args.verbose)
Expand All @@ -842,7 +882,9 @@ def command_submit(
# If the current branch contains commits from the stack, we will need to
# rebase it in the end since the commits will be modified.
top_branch = st[-1].head
need_to_rebase_current = is_ancestor(top_branch, current_branch, args.verbose)
need_to_rebase_current = is_ancestor(
top_branch, current_branch, args.verbose
)

reset_remote_base_branches(st, args.target, args.verbose)

Expand All @@ -852,7 +894,9 @@ def command_submit(
# Now we have all the branches, so we can create the corresponding PRs
log(h("Submitting PRs"), level=1)
for e_idx, e in enumerate(st):
is_pr_draft = draft or ((draft_bitmask is not None) and draft_bitmask[e_idx])
is_pr_draft = draft or (
(draft_bitmask is not None) and draft_bitmask[e_idx]
)
create_pr(e, is_pr_draft, reviewer)

# Verify consistency in everything we have so far
Expand Down Expand Up @@ -883,11 +927,13 @@ def command_submit(
current_branch,
"--committer-date-is-author-date",
],
quiet=not args.verbose
quiet=not args.verbose,
)
else:
log(h(f"Checking out the original branch '{current_branch}'"), level=1)
run_shell_command(["git", "checkout", current_branch], quiet=not args.verbose)
run_shell_command(
["git", "checkout", current_branch], quiet=not args.verbose
)

delete_local_branches(st, args.verbose)
print_tips_after_export(st, args)
Expand Down Expand Up @@ -920,7 +966,9 @@ def rebase_pr(e: StackEntry, remote: str, target: str, verbose: bool):
except Exception:
error(ERROR_CANT_REBASE.format(**locals()))
raise
run_shell_command(["git", "push", remote, "-f", f"{e.head}:{e.head}"], quiet=not verbose)
run_shell_command(
["git", "push", remote, "-f", f"{e.head}:{e.head}"], quiet=not verbose
)


def land_pr(e: StackEntry, remote: str, target: str, verbose: bool):
Expand All @@ -935,7 +983,9 @@ def land_pr(e: StackEntry, remote: str, target: str, verbose: bool):
raise

# Switch PR base branch to 'main'
run_shell_command(["gh", "pr", "edit", e.pr, "-B", target], quiet=not verbose)
run_shell_command(
["gh", "pr", "edit", e.pr, "-B", target], quiet=not verbose
)

# Form the commit message: it should contain the original commit message
# and nothing else.
Expand All @@ -950,7 +1000,7 @@ def land_pr(e: StackEntry, remote: str, target: str, verbose: bool):
run_shell_command(
["gh", "pr", "merge", e.pr, "--squash", "-t", title, "-F", "-"],
input=pr_body.encode(),
quiet=not verbose
quiet=not verbose,
)


Expand Down Expand Up @@ -992,9 +1042,13 @@ def command_land(args: CommonArgs):

current_branch = get_current_branch_name()

if should_update_local_base(args.head, args.base, args.remote, args.target, args.verbose):
if should_update_local_base(
args.head, args.base, args.remote, args.target, args.verbose
):
update_local_base(args.base, args.remote, args.target, args.verbose)
run_shell_command(["git", "checkout", current_branch], quiet=not args.verbose)
run_shell_command(
["git", "checkout", current_branch], quiet=not args.verbose
)

# Determine what commits belong to the stack
st = get_stack(args.base, args.head, args.verbose)
Expand Down Expand Up @@ -1023,10 +1077,15 @@ def command_land(args: CommonArgs):
for e in prs_to_rebase:
rebase_pr(e, args.remote, args.target, args.verbose)
# Change the target of the new bottom-most PR in the stack to 'target'
run_shell_command(["gh", "pr", "edit", prs_to_rebase[0].pr, "-B", args.target], quiet=not args.verbose)
run_shell_command(
["gh", "pr", "edit", prs_to_rebase[0].pr, "-B", args.target],
quiet=not args.verbose,
)

# Delete local and remote stack branches
run_shell_command(["git", "checkout", current_branch], quiet=not args.verbose)
run_shell_command(
["git", "checkout", current_branch], quiet=not args.verbose
)

delete_local_branches(st, args.verbose)
delete_remote_branches(st[:1], args.remote, args.verbose)
Expand All @@ -1035,9 +1094,12 @@ def command_land(args: CommonArgs):
if branch_exists(args.target):
run_shell_command(
["git", "rebase", f"{args.remote}/{args.target}", args.target],
quiet=not args.verbose
quiet=not args.verbose,
)
run_shell_command(["git", "rebase", f"{args.remote}/{args.target}", current_branch], quiet=not args.verbose)
run_shell_command(
["git", "rebase", f"{args.remote}/{args.target}", current_branch],
quiet=not args.verbose,
)

log(h(blue("SUCCESS!")), level=1)

Expand All @@ -1051,9 +1113,13 @@ def strip_metadata(e: StackEntry, verbose: bool) -> str:
m = RE_STACK_INFO_LINE.sub("", m)
run_shell_command(
["git", "rebase", e.base, e.head, "--committer-date-is-author-date"],
quiet=not verbose
quiet=not verbose,
)
run_shell_command(
["git", "commit", "--amend", "-F", "-"],
input=m.encode(),
quiet=not verbose,
)
run_shell_command(["git", "commit", "--amend", "-F", "-"], input=m.encode(), quiet=not verbose)

return get_command_output(["git", "rev-parse", e.head])

Expand Down Expand Up @@ -1081,7 +1147,9 @@ def command_abandon(args: CommonArgs):
last_hash = strip_metadata(e, args.verbose)

log(h("Rebasing the current branch on top of updated top branch"), level=1)
run_shell_command(["git", "rebase", last_hash, current_branch], quiet=not args.verbose)
run_shell_command(
["git", "rebase", last_hash, current_branch], quiet=not args.verbose
)

delete_local_branches(st, args.verbose)
delete_remote_branches(st, args.remote, args.verbose)
Expand Down Expand Up @@ -1122,7 +1190,9 @@ def print_tips_after_view(st: List[StackEntry], args: CommonArgs):
def command_view(args: CommonArgs):
log(h("VIEW"), level=1)

if should_update_local_base(args.head, args.base, args.remote, args.target, args.verbose):
if should_update_local_base(
args.head, args.base, args.remote, args.target, args.verbose
):
log(
red(
f"\nWarning: Local '{args.base}' is behind"
Expand Down Expand Up @@ -1166,9 +1236,13 @@ def create_argparser() -> argparse.ArgumentParser:
subparsers = parser.add_subparsers(help="sub-command help", dest="command")

common_parser = argparse.ArgumentParser(add_help=False)
common_parser.add_argument("-R", "--remote", default="origin", help="Remote name")
common_parser.add_argument(
"-R", "--remote", default="origin", help="Remote name"
)
common_parser.add_argument("-B", "--base", help="Local base branch")
common_parser.add_argument("-H", "--head", default="HEAD", help="Local head branch")
common_parser.add_argument(
"-H", "--head", default="HEAD", help="Local head branch"
)
common_parser.add_argument(
"-T", "--target", default="main", help="Remote target branch"
)
Expand All @@ -1179,7 +1253,8 @@ def create_argparser() -> argparse.ArgumentParser:
help="Enable or disable hyperlink support.",
)
common_parser.add_argument(
"-V", "--verbose",
"-V",
"--verbose",
action="store_true",
default=False,
help="Enable verbose output from Git subcommands.",
Expand Down Expand Up @@ -1273,7 +1348,9 @@ def main():
raise Exception(f"Unknown command {args.command}")
except Exception as exc:
# If something failed, checkout the original branch
run_shell_command(["git", "checkout", current_branch], quiet=not common_args.verbose)
run_shell_command(
["git", "checkout", current_branch], quiet=not common_args.verbose
)
if isinstance(exc, SubprocessError):
print_cmd_failure_details(exc)
raise
Expand Down
Loading

0 comments on commit f6aa5ae

Please sign in to comment.