PK ~K,ZfZZcherry_picker/__init__.py"""Backport CPython changes from master to maintenance branches.""" __version__ = '0.2.6' PK|Jh7$]]cherry_picker/__main__.pyfrom .cherry_picker import cherry_pick_cli if __name__ == '__main__': cherry_pick_cli() PKTSKYa.&$9$9cherry_picker/cherry_picker.py#!/usr/bin/env python3 # -*- coding: utf-8 -*- import click import os import subprocess import webbrowser import sys import requests from gidgethub import sansio from . import __version__ CPYTHON_CREATE_PR_URL = "https://api.github.com/repos/python/cpython/pulls" class BranchCheckoutException(Exception): pass class CherryPickException(Exception): pass class CherryPicker: def __init__(self, pr_remote, commit_sha1, branches, *, dry_run=False, push=True, prefix_commit=True ): self.pr_remote = pr_remote self.commit_sha1 = commit_sha1 self.branches = branches self.dry_run = dry_run self.push = push self.prefix_commit = prefix_commit @property def upstream(self): """Get the remote name to use for upstream branches Uses "upstream" if it exists, "origin" otherwise """ cmd = "git remote get-url upstream" try: subprocess.check_output(cmd.split(), stderr=subprocess.DEVNULL) except subprocess.CalledProcessError: return "origin" return "upstream" @property def sorted_branches(self): return sorted( self.branches, reverse=True, key=lambda v: tuple(map(int, v.split('.')))) @property def username(self): cmd = f"git config --get remote.{self.pr_remote}.url" raw_result = subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT) result = raw_result.decode('utf-8') # implicit ssh URIs use : to separate host from user, others just use / username = result.replace(':', '/').split('/')[-2] return username def get_cherry_pick_branch(self, maint_branch): return f"backport-{self.commit_sha1[:7]}-{maint_branch}" def get_pr_url(self, base_branch, head_branch): return f"https://github.com/python/cpython/compare/{base_branch}...{self.username}:{head_branch}?expand=1" def fetch_upstream(self): """ git fetch """ self.run_cmd(f"git fetch {self.upstream}") def run_cmd(self, cmd, shell=False): if self.dry_run: click.echo(f" dry-run: {cmd}") return if not shell: output = subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT) else: output = subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT) click.echo(output.decode('utf-8')) def checkout_branch(self, branch_name): """ git checkout -b """ cmd = f"git checkout -b {self.get_cherry_pick_branch(branch_name)} {self.upstream}/{branch_name}" try: self.run_cmd(cmd) except subprocess.CalledProcessError as err: click.echo(f"Error checking out the branch {self.get_cherry_pick_branch(branch_name)}.") click.echo(err.output) raise BranchCheckoutException(f"Error checking out the branch {self.get_cherry_pick_branch(branch_name)}.") def get_commit_message(self, commit_sha): """ Return the commit message for the current commit hash, replace # with GH- """ cmd = f"git show -s --format=%B {commit_sha}" output = subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT) updated_commit_message = output.strip().decode('utf-8').replace('#', 'GH-') return updated_commit_message def checkout_master(self): """ git checkout master """ cmd = "git checkout master" self.run_cmd(cmd) def status(self): """ git status :return: """ cmd = "git status" self.run_cmd(cmd) def cherry_pick(self): """ git cherry-pick -x """ cmd = f"git cherry-pick -x {self.commit_sha1}" try: self.run_cmd(cmd) except subprocess.CalledProcessError as err: click.echo(f"Error cherry-pick {self.commit_sha1}.") click.echo(err.output) raise CherryPickException(f"Error cherry-pick {self.commit_sha1}.") def get_exit_message(self, branch): return \ f""" Failed to cherry-pick {self.commit_sha1} into {branch} \u2639 ... Stopping here. To continue and resolve the conflict: $ cherry_picker --status # to find out which files need attention # Fix the conflict $ cherry_picker --status # should now say 'all conflict fixed' $ cherry_picker --continue To abort the cherry-pick and cleanup: $ cherry_picker --abort """ def amend_commit_message(self, cherry_pick_branch): """ prefix the commit message with (X.Y) """ commit_prefix = "" if self.prefix_commit: commit_prefix = f"[{get_base_branch(cherry_pick_branch)}] " updated_commit_message = f"{commit_prefix}{self.get_commit_message(self.commit_sha1)}{os.linesep}(cherry picked from commit {self.commit_sha1})" updated_commit_message = updated_commit_message.replace('#', 'GH-') if self.dry_run: click.echo(f" dry-run: git commit --amend -m '{updated_commit_message}'") else: try: subprocess.check_output(["git", "commit", "--amend", "-m", updated_commit_message], stderr=subprocess.STDOUT) except subprocess.CalledProcessError as cpe: click.echo("Failed to amend the commit message \u2639") click.echo(cpe.output) return updated_commit_message def push_to_remote(self, base_branch, head_branch, commit_message=""): """ git push """ cmd = f"git push {self.pr_remote} {head_branch}" try: self.run_cmd(cmd) except subprocess.CalledProcessError: click.echo(f"Failed to push to {self.pr_remote} \u2639") else: gh_auth = os.getenv("GH_AUTH") if gh_auth: self.create_gh_pr(base_branch, head_branch, commit_message=commit_message, gh_auth=gh_auth) else: self.open_pr(self.get_pr_url(base_branch, head_branch)) def create_gh_pr(self, base_branch, head_branch, *, commit_message, gh_auth): """ Create PR in GitHub """ request_headers = sansio.create_headers( self.username, oauth_token=gh_auth) title, body = normalize_commit_message(commit_message) if not self.prefix_commit: title = f"[{base_branch}] {title}" data = { "title": title, "body": body, "head": f"{self.username}:{head_branch}", "base": base_branch, "maintainer_can_modify": True } response = requests.post(CPYTHON_CREATE_PR_URL, headers=request_headers, json=data) if response.status_code == requests.codes.created: click.echo(f"Backport PR created at {response.json()['html_url']}") else: click.echo(response.status_code) click.echo(response.text) def open_pr(self, url): """ open url in the web browser """ if self.dry_run: click.echo(f" dry-run: Create new PR: {url}") else: click.echo("Backport PR URL:") click.echo(url) webbrowser.open_new_tab(url) def delete_branch(self, branch): cmd = f"git branch -D {branch}" self.run_cmd(cmd) def cleanup_branch(self, branch): self.checkout_master() try: self.delete_branch(branch) except subprocess.CalledProcessError: click.echo(f"branch {branch} NOT deleted.") else: click.echo(f"branch {branch} has been deleted.") def backport(self): if not self.branches: raise click.UsageError("At least one branch must be specified.") self.fetch_upstream() for maint_branch in self.sorted_branches: click.echo(f"Now backporting '{self.commit_sha1}' into '{maint_branch}'") cherry_pick_branch = self.get_cherry_pick_branch(maint_branch) self.checkout_branch(maint_branch) commit_message = "" try: self.cherry_pick() commit_message = self.amend_commit_message(cherry_pick_branch) except subprocess.CalledProcessError as cpe: click.echo(cpe.output) click.echo(self.get_exit_message(maint_branch)) except CherryPickException: click.echo(self.get_exit_message(maint_branch)) raise else: if self.push: self.push_to_remote(maint_branch, cherry_pick_branch, commit_message) self.cleanup_branch(cherry_pick_branch) else: click.echo(\ f""" Finished cherry-pick {self.commit_sha1} into {cherry_pick_branch} \U0001F600 --no-push option used. ... Stopping here. To continue and push the changes: $ cherry_picker --continue To abort the cherry-pick and cleanup: $ cherry_picker --abort """) def abort_cherry_pick(self): """ run `git cherry-pick --abort` and then clean up the branch """ cmd = "git cherry-pick --abort" try: self.run_cmd(cmd) except subprocess.CalledProcessError as cpe: click.echo(cpe.output) # only delete backport branch created by cherry_picker.py if get_current_branch().startswith('backport-'): self.cleanup_branch(get_current_branch()) def continue_cherry_pick(self): """ git push origin open the PR clean up branch """ cherry_pick_branch = get_current_branch() if cherry_pick_branch.startswith('backport-'): # amend the commit message, prefix with [X.Y] base = get_base_branch(cherry_pick_branch) short_sha = cherry_pick_branch[cherry_pick_branch.index('-')+1:cherry_pick_branch.index(base)-1] full_sha = get_full_sha_from_short(short_sha) commit_message = self.get_commit_message(short_sha) updated_commit_message = f'[{base}] {commit_message}. \n(cherry picked from commit {full_sha})' if self.dry_run: click.echo(f" dry-run: git commit -am '{updated_commit_message}' --allow-empty") else: subprocess.check_output(["git", "commit", "-am", updated_commit_message, "--allow-empty"], stderr=subprocess.STDOUT) self.push_to_remote(base, cherry_pick_branch) self.cleanup_branch(cherry_pick_branch) click.echo("\nBackport PR:\n") click.echo(updated_commit_message) else: click.echo(f"Current branch ({cherry_pick_branch}) is not a backport branch. Will not continue. \U0001F61B") CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help']) @click.command(context_settings=CONTEXT_SETTINGS) @click.version_option(version=__version__) @click.option('--dry-run', is_flag=True, help="Prints out the commands, but not executed.") @click.option('--pr-remote', 'pr_remote', metavar='REMOTE', help='git remote to use for PR branches', default='origin') @click.option('--abort', 'abort', flag_value=True, default=None, help="Abort current cherry-pick and clean up branch") @click.option('--continue', 'abort', flag_value=False, default=None, help="Continue cherry-pick, push, and clean up branch") @click.option('--status', 'status', flag_value=True, default=None, help="Get the status of cherry-pick") @click.option('--push/--no-push', 'push', is_flag=True, default=True, help="Changes won't be pushed to remote") @click.argument('commit_sha1', 'The commit sha1 to be cherry-picked', nargs=1, default = "") @click.argument('branches', 'The branches to backport to', nargs=-1) def cherry_pick_cli(dry_run, pr_remote, abort, status, push, commit_sha1, branches): click.echo("\U0001F40D \U0001F352 \u26CF") if not is_cpython_repo(): click.echo("You're not inside a CPython repo right now! 🙅") sys.exit(-1) if dry_run: click.echo("Dry run requested, listing expected command sequence") cherry_picker = CherryPicker(pr_remote, commit_sha1, branches, dry_run=dry_run, push=push) if abort is not None: if abort: cherry_picker.abort_cherry_pick() else: cherry_picker.continue_cherry_pick() elif status: click.echo(cherry_picker.status()) else: try: cherry_picker.backport() except BranchCheckoutException: sys.exit(-1) except CherryPickException: sys.exit(-1) def get_base_branch(cherry_pick_branch): """ return '2.7' from 'backport-sha-2.7' """ prefix, sep, base_branch = cherry_pick_branch.rpartition('-') return base_branch def get_current_branch(): """ Return the current branch """ cmd = "git rev-parse --abbrev-ref HEAD" output = subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT) return output.strip().decode('utf-8') def get_full_sha_from_short(short_sha): cmd = f"git show --format=raw {short_sha}" output = subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT) full_sha = output.strip().decode('utf-8').split('\n')[0].split()[1] return full_sha def is_cpython_repo(): cmd = "git log -r 7f777ed95a19224294949e1b4ce56bbffcb1fe9f" try: subprocess.check_output(cmd.split(), stderr=subprocess.STDOUT) except subprocess.SubprocessError: return False return True def normalize_commit_message(commit_message): """ Return a tuple of title and body from the commit message """ split_commit_message = commit_message.split("\n") title = split_commit_message[0] body = "\n".join(split_commit_message[1:]) return title, body.lstrip("\n") if __name__ == '__main__': cherry_pick_cli() PKځ$K;%icherry_picker/test.pyfrom unittest import mock import pytest from .cherry_picker import get_base_branch, get_current_branch, \ get_full_sha_from_short, is_cpython_repo, CherryPicker, \ normalize_commit_message def test_get_base_branch(): cherry_pick_branch = 'backport-afc23f4-2.7' result = get_base_branch(cherry_pick_branch) assert result == '2.7' def test_get_base_branch_without_dash(): cherry_pick_branch ='master' result = get_base_branch(cherry_pick_branch) assert result == 'master' @mock.patch('subprocess.check_output') def test_get_current_branch(subprocess_check_output): subprocess_check_output.return_value = b'master' assert get_current_branch() == 'master' @mock.patch('subprocess.check_output') def test_get_full_sha_from_short(subprocess_check_output): mock_output = b"""commit 22a594a0047d7706537ff2ac676cdc0f1dcb329c tree 14ab2ea85e7a28adb9d40f185006308d87a67f47 parent 5908300e4b0891fc5ab8bd24fba8fac72012eaa7 author Armin Rigo 1492106895 +0200 committer Mariatta 1492106895 -0700 bpo-29694: race condition in pathlib mkdir with flags parents=True (GH-1089) diff --git a/Lib/pathlib.py b/Lib/pathlib.py index fc7ce5e..1914229 100644 --- a/Lib/pathlib.py +++ b/Lib/pathlib.py """ subprocess_check_output.return_value = mock_output assert get_full_sha_from_short('22a594a') == '22a594a0047d7706537ff2ac676cdc0f1dcb329c' @mock.patch('os.path.exists') def test_sorted_branch(os_path_exists): os_path_exists.return_value = True branches = ["3.1", "2.7", "3.10", "3.6"] cp = CherryPicker('origin', '22a594a0047d7706537ff2ac676cdc0f1dcb329c', branches) assert cp.sorted_branches == ["3.10", "3.6", "3.1", "2.7"] @mock.patch('os.path.exists') def test_get_cherry_pick_branch(os_path_exists): os_path_exists.return_value = True branches = ["3.6"] cp = CherryPicker('origin', '22a594a0047d7706537ff2ac676cdc0f1dcb329c', branches) assert cp.get_cherry_pick_branch("3.6") == "backport-22a594a-3.6" @mock.patch('os.path.exists') @mock.patch('subprocess.check_output') def test_get_pr_url(subprocess_check_output, os_path_exists): os_path_exists.return_value = True subprocess_check_output.return_value = b'https://github.com/mock_user/cpython.git' branches = ["3.6"] cp = CherryPicker('origin', '22a594a0047d7706537ff2ac676cdc0f1dcb329c', branches) assert cp.get_pr_url("3.6", cp.get_cherry_pick_branch("3.6")) \ == "https://github.com/python/cpython/compare/3.6...mock_user:backport-22a594a-3.6?expand=1" @pytest.mark.parametrize('url', [ b'git@github.com:mock_user/cpython.git', b'git@github.com:mock_user/cpython', b'ssh://git@github.com/mock_user/cpython.git', b'ssh://git@github.com/mock_user/cpython', b'https://github.com/mock_user/cpython.git', b'https://github.com/mock_user/cpython', ]) def test_username(url): with mock.patch('subprocess.check_output', return_value=url): branches = ["3.6"] cp = CherryPicker('origin', '22a594a0047d7706537ff2ac676cdc0f1dcb329c', branches) assert cp.username == 'mock_user' @mock.patch('os.path.exists') @mock.patch('subprocess.check_output') def test_get_updated_commit_message(subprocess_check_output, os_path_exists): os_path_exists.return_value = True subprocess_check_output.return_value = b'bpo-123: Fix Spam Module (#113)' branches = ["3.6"] cp = CherryPicker('origin', '22a594a0047d7706537ff2ac676cdc0f1dcb329c', branches) assert cp.get_commit_message('22a594a0047d7706537ff2ac676cdc0f1dcb329c') \ == 'bpo-123: Fix Spam Module (GH-113)' @mock.patch('subprocess.check_output') def test_is_cpython_repo(subprocess_check_output): subprocess_check_output.return_value = """commit 7f777ed95a19224294949e1b4ce56bbffcb1fe9f Author: Guido van Rossum Date: Thu Aug 9 14:25:15 1990 +0000 Initial revision """ assert is_cpython_repo() == True def test_is_not_cpython_repo(): assert is_cpython_repo() == False def test_normalize_long_commit_message(): commit_message = """[3.6] Fix broken `Show Source` links on documentation pages (GH-3113) The `Show Source` was broken because of a change made in sphinx 1.5.1 In Sphinx 1.4.9, the sourcename was "index.txt". In Sphinx 1.5.1+, it is now "index.rst.txt". (cherry picked from commit b9ff498793611d1c6a9b99df464812931a1e2d69)""" title, body = normalize_commit_message(commit_message) assert title == "[3.6] Fix broken `Show Source` links on documentation pages (GH-3113)" assert body == """The `Show Source` was broken because of a change made in sphinx 1.5.1 In Sphinx 1.4.9, the sourcename was "index.txt". In Sphinx 1.5.1+, it is now "index.rst.txt". (cherry picked from commit b9ff498793611d1c6a9b99df464812931a1e2d69)""" def test_normalize_short_commit_message(): commit_message = """[3.6] Fix broken `Show Source` links on documentation pages (GH-3113) (cherry picked from commit b9ff498793611d1c6a9b99df464812931a1e2d69)""" title, body = normalize_commit_message(commit_message) assert title == "[3.6] Fix broken `Show Source` links on documentation pages (GH-3113)" assert body == """(cherry picked from commit b9ff498793611d1c6a9b99df464812931a1e2d69)"""PK!HMj/M.cherry_picker-0.2.6.dist-info/entry_points.txtN+I/N.,()JH-*/LN-Ex9\\PK!H0RR#cherry_picker-0.2.6.dist-info/WHEEL1 W% 0n1JBZS`ޝ/Qf:3&.~l" kW*дY00?PK!H8) ( &cherry_picker-0.2.6.dist-info/METADATAYn.b ,ZJE>k%gwffA H^5<}3%]뀺l>0<ᆇJhx!Z},R`}`/DsVc-/K ;}2 Y/B9˹6B1#F*Y\%˜Ryj4e/-~,R]2%DwI|Ƣ_z28p_ Rn gPl ni/f;-L\LHH C7HyFXJЁǐiƵNgE\I0IJŲ >}`O<5'UO;s@2mތWn3/z!"FEa41t2 $!Y:bzL&'; 2cRPDN&ɤad( sÖiRYzMP˅ZZ c"G=~ hHh`ffUiOz3rk {KgdT-@Ԁ^Vi ??"yM_[x aI'N/j_8m9G|œ][ZV £4-<6p]Z~@˴6i0ۍ@[]bDXap ҅a 8R# HFJ Ye ɮp=հtH9ԔfRj/{3jjA!U:O 250ឣT)5ii Yڬ< B}})tʈᖬ;&^~v]fB2qËO'͸kxٚhZ9'8u!vAٴnwcŭ MPskS:8"^9kvף&-o*l}QgK GkB(@YzY;*J9z2yؗO,4njed=j 6,-.tQZΈWzE>?oXO&+AA}`ںya\ V^ȄZMP#1)V iqeD oZ&cYW@+D`zVt"Y̎;knYL`*BX@׎D̟$IJH ľ줝(kř@Vc;!e!/=c6>S.ec(5Ӊ-7p Qntύm@u"UV*?t8;^Dc7`d-&Q"/g!yA3$с_YAAkkgp< \EJ_='&rt;v_ۄu)zJBBXel;Y`MVPg,<2e0e X9UHB6wP QJ*ݻaMo'.3Imyпpx0xG_&|*F_F|!#>r =ÙP~X–]YD S-MoeJ,xr\u` "{FIĺ\ hWqj(xA}}As/,);۱="ٹNwBlUy2kqSmj~M+AXyPVnt@TfO?{{{8H61աk5jcT[5 *3EZYغ}{/ ǭk;%{9ij5y69v/El$*Q=}zB,Ѿ:\1=1A/2^aoS+pvl 7y >\F[{hp48C;p~8\B݁Y(YMs.iD[!~g[P7FP"&~$6)Ӱ3s-ﭝz09rt 3w>DFmQ^˴mMo`n!f)w5b8UE6|3Ă($PAڎ81cN{&myO&X uqw*ɵD_A3-;c͆Fzܸ hC1bkr73#jcDA2Z@i2#*Qsas/=[sAOUqtvHIEM=^ǁJeٜC;<͸Ab/F'PIx[?Tg(i|mKfP11 )_ %YU=RV7_L H xִ`a9}kE7UA:{h2ܐ}Slw~~Ҝ>z6i'^"Kt>}lo~Ą՜ GӚ1-;^({_|ǺW{~Жￄk A݀=7K =rחi&O_^< PK!Ha$cherry_picker-0.2.6.dist-info/RECORDIs@{~KCh01.ㅒEh U^^T8gWR=HGhL͑?j#\x.WyfSɲܧMjB{+ˑtSQBJ{̇/:ﯦ W\+'TJ?P8f+\\.sHhC=۵/+O.&