some fixs

tools/gh_api.py

@@ -1,96 +1,104 b''
 """Functions for Github authorisation."""
 from __future__ import print_function
 
 try:
     input = raw_input
 except NameError:
     pass
 
 import requests
 import getpass
 import json
 
 # Keyring stores passwords by a 'username', but we're not storing a username and
 # password
 fake_username = 'ipython_tools'
 
 token = None
 def get_auth_token():
     global token
     
     if token is not None:
         return token
     
     import keyring
     token = keyring.get_password('github', fake_username)
     if token is not None:
         return token
     
     print("Please enter your github username and password. These are not "
            "stored, only used to get an oAuth token. You can revoke this at "
            "any time on Github.")
     user = input("Username: ")
     pw = getpass.getpass("Password: ")
     
     auth_request = {
       "scopes": [
         "public_repo",
         "gist"
       ],
       "note": "IPython tools",
       "note_url": "https://github.com/ipython/ipython/tree/master/tools",
     }
     response = requests.post('https://api.github.com/authorizations',
                             auth=(user, pw), data=json.dumps(auth_request))
     response.raise_for_status()
     token = json.loads(response.text)['token']
     keyring.set_password('github', fake_username, token)
     return token
 
 def make_auth_header():
     return {'Authorization': 'token ' + get_auth_token()}
 
 def post_issue_comment(project, num, body):
     url = 'https://api.github.com/repos/{project}/issues/{num}/comments'.format(project=project, num=num)
     payload = json.dumps({'body': body})
     r = requests.post(url, data=payload, headers=make_auth_header())
 
 def post_gist(content, description='', filename='file', auth=False):
     """Post some text to a Gist, and return the URL."""
     post_data = json.dumps({
       "description": description,
       "public": True,
       "files": {
         filename: {
           "content": content
         }
       }
     }).encode('utf-8')
     
     headers = make_auth_header() if auth else {}
     response = requests.post("https://api.github.com/gists", data=post_data, headers=headers)
     response.raise_for_status()
     response_data = json.loads(response.text)
     return response_data['html_url']
     
-def get_pull_request(project, num, httpv2=False):
-    if httpv2 :
+def get_pull_request(project, num, github_api=3):
+    """get pull request info  by number
+
+    github_api : version of github api to use
+    """
+    if github_api==2 :
         url = "http://github.com/api/v2/json/pulls/{project}/{num}".format(project=project, num=num)
-    else:
+    elif github_api == 3:
         url = "https://api.github.com/repos/{project}/pulls/{num}".format(project=project, num=num)
     response = requests.get(url)
     response.raise_for_status()
     if httpv2 :
         return json.loads(response.text)['pull']
     return json.loads(response.text)
 
-def get_pulls_list(project,httpv2=False):
-    if not httpv2 :
+def get_pulls_list(project, github_api=3):
+    """get pull request list
+
+    github_api : version of github api to use
+    """
+    if github_api == 3 :
         url = "https://api.github.com/repos/{project}/pulls".format(project=project)
     else :
         url = "http://github.com/api/v2/json/pulls/{project}".format(project=project)
     response = requests.get(url)
     response.raise_for_status()
     if httpv2 :
         return json.loads(response.text)['pulls']
     return json.loads(response.text)

tools/git-mpr.py

@@ -1,117 +1,136 b''
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
 Usage:
-    python test_pr.py 1657
+    python git-mpr.py -m 1657
 """
 from __future__ import print_function
 
 import re
 import requests
+import argparse
 from subprocess import call, check_call, check_output, CalledProcessError
 import sys
 
 import gh_api
 
 ipy_repository = 'git://github.com/ipython/ipython.git'
 gh_project="ipython/ipython"
 not_merged={}
 
-def get_branch(repo, branch, owner, mergeable):
+
+def merge_branch(repo, branch, owner, mergeable):
+    """try to merge the givent branch into the current one
+    
+    If something does not goes smoothly, merge is aborted
+    
+    Returns True if merge sucessfull, False otherwise
+    """
     merged_branch = "%s-%s" % (owner, branch)
     # Delete the branch first
     try :
         check_call(['git', 'pull','--no-edit',repo, branch])
     except CalledProcessError :
         check_call(['git', 'merge', '--abort'])
         return False
     return True
 
-def merge_pr(num,httpv2=False):
+
+def merge_pr(num,github_api=3):
+    """ try to merge the branch of PR `num` into current branch
+    
+    github_api : use github api v2 (to bypass https and issues with proxy) to find the
+             remote branch that should be merged by it's number
+    """
     # Get Github authorisation first, so that the user is prompted straight away
     # if their login is needed.
     
-    pr = gh_api.get_pull_request(gh_project, num, httpv2)
-    if(httpv2):
+    pr = gh_api.get_pull_request(gh_project, num, github_api)
+    if github_api == 2:
         repo = pr['head']['repository']['url']
-        owner=pr['head']['user']['name'],
-    else :
+        owner = pr['head']['user']['name']
+    elif github_api == 2 :
         repo=pr['head']['repo']['clone_url']
-        owner=pr['head']['repo']['owner']['login'],
+        owner = pr['head']['repo']['owner']['login']
 
     branch=pr['head']['ref']
-    mergeable = get_branch(repo=repo, 
+    mergeable = merge_branch(repo=repo, 
                  branch=branch,
                  owner=owner,
                  mergeable=pr['mergeable'],
               )
     if not mergeable :
         cmd = "git pull "+repo+" "+branch
         not_merged[str(num)]=cmd
         print("==============================================================================")
         print("Something went wrong merging this branch, you can try it manually by runngin :")
         print(cmd)
         print("==============================================================================")
         
     
-
-if __name__ == '__main__':
-    import argparse
+def main(*args):
     parser = argparse.ArgumentParser(
             description="""
                 Merge (one|many) github pull request by their number.\
                 
                 If pull request can't be merge as is, cancel merge,
                 and continue to the next if any.
                 """
             )
-    parser.add_argument('-v2','--githubapiv2', action='store_const', const=True)
+    parser.add_argument('-v2','--githubapiv2', action='store_const', const=2)
 
     grp = parser.add_mutually_exclusive_group()
     grp.add_argument(
             '-l',
             '--list',
             action='store_const',
             const=True,
             help='list PR, their number and their mergeability')
     grp.add_argument('-a',
             '--merge-all',
             action='store_const',
             const=True ,
             help='try to merge as many PR as possible, one by one')
     grp.add_argument('-m',
             '--merge',
             type=int,
             help="The pull request numbers",
             nargs='*',
             metavar='pr-number')
     not_merged = {}; 
     args = parser.parse_args()
-    ghv2 = args.githubapiv2
+    if args.githubapiv2 == 2 :
+        github_api = 2
+    else  :
+        github_api = 3
+
     if(args.list):
-        pr_list = gh_api.get_pulls_list(gh_project, ghv2)
+        pr_list = gh_api.get_pulls_list(gh_project, github_api)
         for pr in pr_list :
-            mergeable = gh_api.get_pull_request(gh_project, pr['number'],httpv2=ghv2)['mergeable']
+            mergeable = gh_api.get_pull_request(gh_project, pr['number'],github_api=github_api)['mergeable']
 
             ismgb = u"√" if mergeable else " "
             print(u"* #{number} [{ismgb}]:  {title}".format(
                 number=pr['number'],
                 title=pr['title'],
                 ismgb=ismgb))
 
     if(args.merge_all):
         pr_list = gh_api.get_pulls_list(gh_project)
         for pr in pr_list :
             merge_pr(pr['number'])
 
 
     elif args.merge:
         for num in args.merge :
-            merge_pr(num,httpv2=ghv2)
+            merge_pr(num, github_api=github_api)
 
     if not_merged :
         print('*************************************************************************************')
         print('the following branch have not been merged automatically, considere doing it by hand :')
         for num,cmd in not_merged.items() :
             print( "PR {num}: {cmd}".format(num=num,cmd=cmd))
         print('*************************************************************************************')
+
+if __name__ == '__main__':
+    main()