cmd/gitcheckup.py

235 lines
6.9 KiB
Python
Raw Normal View History

2020-08-20 18:10:55 +00:00
'''
This program helps you check the commit and push status of your favorite git
repositories. The output looks like this:
[ ][P] D:\\Git\\cmd (~1)
[C][P] D:\\Git\\Etiquette
[ ][P] D:\\Git\\voussoirkit (+1)
[C][ ] D:\\Git\\YCDL (3)
To specify the list of git directories, you may either:
- Create a gitcheckup.txt file in the same directory as this file, where every
line contains an absolute path to the directory, or
- Pass directories as a series of arguments to this program.
flags:
--fetch:
Run `git fetch --all` in each directory.
--pull:
Run `git pull --all` in each directory.
Examples:
> gitcheckup
> gitcheckup --fetch
> gitcheckup D:\\Git\\cmd D:\\Git\\YCDL --pull
'''
import argparse
2020-01-11 09:44:20 +00:00
import os
2020-01-11 11:14:01 +00:00
import subprocess
import sys
2020-01-11 09:44:20 +00:00
2020-08-20 18:10:55 +00:00
from voussoirkit import betterhelp
from voussoirkit import dotdict
2020-01-11 09:44:20 +00:00
from voussoirkit import winwhich
GIT = winwhich.which('git')
# https://git-scm.com/docs/git-status#_short_format
# Here is an example of typical `git status --short` output:
#
# M file1
# D file2
# A file4
# ?? file3
class GitCheckupException(Exception):
pass
class NoConfigFile(GitCheckupException):
def __str__(self):
return f'Please put your git repo locations in "{self.args[0]}".'
class NoUpstreamBranch(GitCheckupException):
def __str__(self):
return f'No upstream branch for {self.args[0]}.'
# HELPERS
################################################################################
def check_output(command):
output = subprocess.check_output(command, stderr=subprocess.STDOUT)
output = output.decode().strip()
return output
def read_directories_file():
directories_file = os.path.join(os.path.dirname(__file__), 'gitcheckup.txt')
try:
handle = open(directories_file, 'r')
except FileNotFoundError as exc:
raise NoConfigFile(exc.filename) from exc
with handle:
directories = handle.readlines()
directories = [line.strip() for line in directories]
directories = [line for line in directories if line]
return directories
# GIT FUNCTIONS
################################################################################
def git_commits_between(a, b):
command = [GIT, 'log', '--oneline', f'{a}..{b}']
output = check_output(command)
lines = output.splitlines()
return lines
def git_current_branch():
command = [GIT, 'rev-parse', '--abbrev-ref', 'HEAD']
return check_output(command)
def git_fetch():
command = [GIT, 'fetch', '--all']
return check_output(command)
def git_merge_base():
command = [GIT, 'merge-base', '@', '@{u}']
return check_output(command)
2020-08-12 19:21:00 +00:00
def git_pull():
command = [GIT, 'pull', '--all']
return check_output(command)
def git_rev_parse(rev):
2020-02-19 23:08:02 +00:00
command = [GIT, 'rev-parse', rev]
return check_output(command)
def git_status():
command = [GIT, 'status', '--short', '--untracked-files=all']
return check_output(command)
# CHECKUP
################################################################################
def checkup_committed():
details = dotdict.DotDict(default=None)
details.added = 0
details.modified = 0
details.deleted = 0
for line in git_status().splitlines():
status = line.split()[0].strip()
# These are ifs instead of elifs because you might have a file that is
# added in the index but deleted on disk, etc. Anyway these numbers
# don't need to be super accurate, just enough to remind you to commit.
if {'A', '?'}.intersection(status):
details.added += 1
if {'M', 'R', '!'}.intersection(status):
details.modified += 1
if {'D'}.intersection(status):
details.deleted += 1
details.committed = (details.added, details.modified, details.deleted) == (0, 0, 0)
return details
2020-01-11 09:44:20 +00:00
def checkup_pushed():
details = dotdict.DotDict(default=None)
my_head = git_rev_parse('@')
try:
remote_head = git_rev_parse('@{u}')
except subprocess.CalledProcessError as exc:
current_branch = git_current_branch()
details.error = NoUpstreamBranch(current_branch)
return details
if my_head == remote_head:
details.to_push = 0
details.to_pull = 0
else:
merge_base = git_merge_base()
if my_head == merge_base:
details.to_push = 0
details.to_pull = len(git_commits_between(merge_base, remote_head))
elif remote_head == merge_base:
details.to_push = len(git_commits_between(merge_base, my_head))
details.to_pull = 0
else:
details.to_push = len(git_commits_between(merge_base, my_head))
details.to_pull = len(git_commits_between(merge_base, remote_head))
details.pushed = (details.to_push, details.to_pull) == (0, 0)
return details
2020-08-12 19:21:00 +00:00
def gitcheckup(directory, do_fetch=False, do_pull=False):
directory = os.path.abspath(directory)
os.chdir(directory)
if do_fetch:
git_fetch()
2020-01-11 09:44:20 +00:00
2020-08-12 19:21:00 +00:00
if do_pull:
git_pull()
try:
commit_details = checkup_committed()
push_details = checkup_pushed()
except subprocess.CalledProcessError as exc:
raise Exception(exc.output)
2020-01-28 09:14:35 +00:00
committed = 'C' if commit_details.committed else ' '
pushed = 'P' if push_details.pushed else ' '
details = []
commit_summary = []
if commit_details.added: commit_summary.append(f'+{commit_details.added}')
if commit_details.deleted: commit_summary.append(f'-{commit_details.deleted}')
if commit_details.modified: commit_summary.append(f'~{commit_details.modified}')
commit_summary = ', '.join(commit_summary)
if commit_summary: details.append(f'({commit_summary})')
push_summary = []
if push_details.to_push: push_summary.append(f'{push_details.to_push}')
if push_details.to_pull: push_summary.append(f'{push_details.to_pull}')
if push_details.error: push_summary.append(f'!{push_details.error}')
push_summary = ', '.join(push_summary)
if push_summary: details.append(f'({push_summary})')
details = ' '.join(details)
details = (' ' + details).rstrip()
print(f'[{committed}][{pushed}] {directory}{details}')
# COMMAND LINE
################################################################################
def gitcheckup_argparse(args):
if args.directories:
directories = args.directories
else:
directories = read_directories_file()
for directory in directories:
2020-08-12 19:21:00 +00:00
gitcheckup(directory, do_fetch=args.do_fetch, do_pull=args.do_pull)
def main(argv):
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('directories', nargs='*')
parser.add_argument('--fetch', dest='do_fetch', action='store_true')
2020-08-12 19:21:00 +00:00
parser.add_argument('--pull', dest='do_pull', action='store_true')
parser.set_defaults(func=gitcheckup_argparse)
try:
2020-08-20 18:10:55 +00:00
return betterhelp.single_main(argv, parser, docstring=__doc__)
except GitCheckupException as exc:
print(exc)
return 1
2020-01-11 09:44:20 +00:00
if __name__ == '__main__':
raise SystemExit(main(sys.argv[1:]))