Source code for bag.git.delete_old_branches

#!/usr/bin/env python3

"""A solution to the problem of cleaning old git branches.

A command that removes git branches that have been merged onto
the current branch.

Usage::

    # Try this to see the supported arguments:
    delete_old_branches --help

    # Ensure you are in the branch "master" before starting.
    # Test first, by printing the names of the branches that would be deleted:
    delete_old_branches -l -r origin -y 0 --dry

    # If you agree, run the command again without --dry:
    delete_old_branches -l -r origin -y 0

If you don't like the 2 steps, just omit ``-y`` and the command will confirm
each branch with you before deleting it.

The zero in the above example is a number of days since the branch was
merged into the branch you are in.

Don't forget to do a "git fetch --all --prune" on other machines
after deleting remote branches. Other machines may still have
obsolete tracking branches (see them with "git branch -a").
"""

from datetime import date, timedelta
from bag.reify import reify
from argh import ArghParser, arg  # easy_install argh
from bag.command import checked_execute  # , CommandError
from bag.console import bool_input

IGNORE = ['develop', 'master']


[docs]def merged_branches(remote=None, ignore=IGNORE): """Sequence of branches that have been merged onto the current branch.""" if remote: command = 'git branch -a --merged' else: command = 'git branch --merged' for name in checked_execute(command).split('\n'): # The command also lists the current branch, so we get rid of it if name.startswith('* ') or ' -> ' in name: continue name = name.strip() if remote and name.startswith('remotes/'): name = name[8:] if name.startswith(remote): branch = Branch(name=name[len(remote) + 1:], remote=remote) else: continue else: branch = Branch(name) if branch.name in ignore: continue yield branch
[docs]class Branch: def __init__(self, name, remote=''): self.name = name self.remote = remote def __repr__(self): return 'remotes/{}/{}'.format( self.remote, self.name) if self.remote else self.name
[docs] @reify def merge_date(self): """Return the date when the specified branch was merged. ...into the current branch. On the console, you can try this command: git show --pretty=format:"%Cgreen%ci %Cblue%cr%Creset" BRANCH | head -n 1 """ branch_spec = repr(self) line = checked_execute( 'git show --pretty=format:"%ci" {} | head -n 1' .format(branch_spec)) sdate = line[:10] year, month, day = [int(x) for x in sdate.split('-')] return date(year, month, day)
[docs] def is_older_than_days(self, age): return timedelta(int(age)) < date.today() - self.merge_date
[docs] def delete(self): if self.remote: checked_execute('git push {} :{}'.format(self.remote, self.name), accept_codes=[0, 1]) else: checked_execute('git branch -d {}'.format(self))
[docs]@arg('--dry', action='store_true', help='Dry run: only list the branches') @arg('-i', '--ignore', action='append', default=IGNORE, help='Branches to leave untouched') @arg('-l', '--locally', action='store_true', help='Delete the branches locally') @arg('-r', '--remote', metavar='REMOTE', help='Delete the branches on the remote REMOTE') @arg('-y', action='store_true', help='Do not interactively confirm before deleting branches') @arg('days', type=int, help='Minimum age in days') def delete_old_branches(days, dry=False, locally=False, remote=None, y=False, ignore=IGNORE): if not locally and not remote: print('You must specify -l or -r or both.') import sys sys.exit(4242) for branch in merged_branches(remote=remote, ignore=ignore): if not remote and branch.remote: continue if not locally and not branch.remote: continue if days and not branch.is_older_than_days(days): continue if y: print(' ' + str(branch)) else: if not bool_input('Delete the branch "{}"?'.format(branch), default=False): continue if dry: continue branch.delete()
[docs]def command(): # http://argh.readthedocs.org/en/latest/ parser = ArghParser(description=__doc__) parser.set_default_command(delete_old_branches) # parser.add_commands([delete_old_branches]) parser.dispatch()
if __name__ == '__main__': command()