skilleter-thingy 0.0.22__py3-none-any.whl

skilleter_thingy/gitprompt.py

@@ -0,0 +1,274 @@
+#! /usr/bin/env python3
+
+""" Thingy gitprompt command
+
+    Copyright (C) 2017 John Skilleter
+
+    Used to create the portion of the shell prompt that optionally shows
+    the current git repo name and branch and to output a colour code indicating
+    the status of the current working tree.
+
+    Normally used in the shell setup scripts (e.g. ~/.bashrc) as:
+
+        export PS1=$(gitprompt OPTIONS)
+
+    Command line options:
+
+    '--colour'
+
+        Output a background colour code indicating the status of the
+        current tree, rather than the repo name and branch.
+
+        Colours used are:
+
+            Green   - Clean repo, no local changes
+            Cyan    - Clean repo with untracked file(s)
+            Yellow  - Uncommitted local changes (added, copied or renamed files)
+            Red     - Local changes that have not been added (files modified or deleted)
+            Magenta - Unmerged files
+
+    Other options are set via the Git configuration:
+
+        prompt.prefix: 0 - No prefix
+                       1 - Single letter indications of git status (untracked, modified, etc)
+                       2 - One word indications (untracked, modified, etc)
+
+    TODO: Limit the total prompt length more 'intelligently', rather than just bits of it.
+    TODO: Indicate whether current directory is writeable and/or put current owner in prompt if no the current user
+"""
+
+################################################################################
+
+# Try and reduce the scope for an auto-repeating ^C to screw up the shell prompt
+
+import signal
+
+signal.signal(signal.SIGINT, signal.SIG_IGN)
+
+import os
+import sys
+import argparse
+
+from skilleter_thingy import git
+from skilleter_thingy import colour
+
+################################################################################
+# Constants
+
+# Prefix text used when showing git status in the prompt - first entry is the
+# abbreviated form and the second is the verbose.
+
+STATUS_PREFIX = \
+    {
+        'untracked': ('u', 'untracked'),
+        'added': ('A', 'added'),
+        'modified': ('M', 'modified'),
+        'unmerged': ('U', 'unmerged'),
+        'deleted': ('D', 'deleted'),
+        'copied': ('C', 'copied'),
+        'renamed': ('R', 'renamed'),
+        'stash': ('S', 'stashed')
+    }
+
+MAX_BRANCH_NAME_LENGTH = int(os.environ.get('COLUMNS', 96)) / 3
+
+################################################################################
+
+def write_colour_prompt(gitstate: dict):
+    """ Output the colour for the prompt, according to the current state of the
+        working tree. """
+
+    colour.write('[NORMAL]', newline=False)
+
+    if gitstate['modified'] or gitstate['deleted']:
+        colour.write('[REVERSE][RED]', newline=False)
+
+    elif gitstate['added'] or gitstate['copied'] or gitstate['renamed']:
+        colour.write('[REVERSE][YELLOW]', newline=False)
+
+    elif gitstate['unmerged']:
+        colour.write('[REVERSE][MAGENTA]', newline=False)
+
+    elif gitstate['untracked']:
+        colour.write('[REVERSE][CYAN]', newline=False)
+
+    elif gitstate['merging'] or gitstate['bisecting'] or gitstate['rebasing']:
+        colour.write('[REVERSE][BLACK]', newline=False)
+
+    else:
+        colour.write('[REVERSE][GREEN]', newline=False)
+
+################################################################################
+
+def write_prompt_prefix(gitstate: dict):
+    """ Build a prompt prefix containing the type and number
+      of changes in the repo. """
+
+    prefix = []
+
+    # Get the status configuration from gitconfig and restrict it to the
+    # range 0..2
+
+    try:
+        status_prefix = int(git.config_get('prompt', 'prefix', defaultvalue='0'))
+    except ValueError:
+        status_prefix = 0
+    else:
+        status_prefix = max(min(status_prefix, 2), 0)
+
+    # Only output the status information if the prefix is non-zero
+
+    if status_prefix > 0:
+        i = status_prefix - 1
+
+        stashed = len(git.stash())
+
+        if stashed:
+            prefix.append('%s:%d' % (STATUS_PREFIX['stash'][i], stashed))
+
+        if gitstate['untracked']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['untracked'][i], gitstate['untracked']))
+
+        if gitstate['added']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['added'][i], gitstate['added']))
+
+        if gitstate['modified']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['modified'][i], gitstate['modified']))
+
+        if gitstate['unmerged']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['unmerged'][i], gitstate['unmerged']))
+
+        if gitstate['deleted']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['deleted'][i], gitstate['deleted']))
+
+        if gitstate['copied']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['copied'][i], gitstate['copied']))
+
+        if gitstate['renamed']:
+            prefix.append('%s:%d' % (STATUS_PREFIX['renamed'][i], gitstate['renamed']))
+
+    # Get the current branch, tag or commit
+
+    branch = git.branch() or git.tag() or git.current_commit(short=True)
+
+    # TODO: More intelligent branch name pruning - currently just trims it if longer than limit
+    # TODO: Keep branch name up to minimum characters long - use more components if still shorter
+
+    if len(branch) > MAX_BRANCH_NAME_LENGTH:
+        truncated_name = None
+
+        for sep in (' ', '-', '_', '/'):
+            shortname = sep.join(branch.split(sep)[0:2])
+            if (truncated_name and len(truncated_name) > len(shortname)) or not truncated_name:
+                truncated_name = shortname
+
+        if truncated_name:
+            branch = '%s...' % truncated_name
+
+    if gitstate['rebasing']:
+        prefix.append('(rebasing)')
+    elif gitstate['bisecting']:
+        prefix.append('(bisecting)')
+    elif gitstate['merging']:
+        prefix.append('(merging)')
+
+    if prefix:
+        sys.stdout.write(' {%s}' % ' '.join(prefix))
+
+    project = git.project(short=True)
+
+    if project:
+        sys.stdout.write(f' {project}: {branch} ')
+    else:
+        sys.stdout.write(f' {branch} ')
+
+################################################################################
+
+def git_status(colour_output: str, prompt_output: str):
+    """ Catalogue the current state of the working tree then call the function
+        to either output a suitable colour or the prompt text or both """
+
+    # Get the working tree, just return if there's an error
+
+    try:
+        working_tree = git.working_tree()
+    except git.GitError:
+        return
+
+    # Return if we are not in a working tree
+
+    if not working_tree:
+        return
+
+    # gitstate contains counters for numbers of modified (etc.) elements in the tree and flags to indicate
+    # whether we're currently in a merge/rebase/bisect state.
+
+    gitstate = {'modified': 0, 'added': 0, 'untracked': 0, 'unmerged': 0, 'deleted': 0, 'renamed': 0, 'copied': 0}
+
+    # Set flags if we are currently merging/rebasing/bisecting and get the current status
+
+    try:
+        gitstate['merging'] = git.merging()
+        gitstate['rebasing'] = git.rebasing()
+        gitstate['bisecting'] = git.bisecting()
+
+        status = git.status()
+    except git.GitError as exc:
+        # Major failure of gitness - report the error and quit
+
+        if colour_output:
+            colour.write('[WHITE][BRED]', newline=False)
+        else:
+            colour.write(' ERROR: %s ' % exc.msg.split('\n')[0], newline=False)
+
+        return
+
+    # Count the number of files in each state
+
+    for st in status:
+        gitstate['untracked'] += '?' in st[0]
+        gitstate['added'] += 'A' in st[0]
+        gitstate['modified'] += 'M' in st[0]
+        gitstate['unmerged'] += 'U' in st[0]
+        gitstate['deleted'] += 'D' in st[0]
+        gitstate['copied'] += 'C' in st[0]
+        gitstate['renamed'] += 'R' in st[0]
+
+    # Set the output colour or output the prompt prefix
+
+    if colour_output:
+        write_colour_prompt(gitstate)
+
+    if prompt_output or not colour_output:
+        write_prompt_prefix(gitstate)
+
+################################################################################
+
+def main():
+    """ Parse the command line and output colour or status """
+
+    parser = argparse.ArgumentParser(description='Report current branch and, optionally, git repo name to be embedded in shell prompt')
+    parser.add_argument('--colour', action='store_true', help='Output colour code indicating working tree status')
+    parser.add_argument('--prompt', action='store_true', help='Output the prompt (default if --colour not specified)')
+
+    args = parser.parse_args()
+
+    git_status(args.colour, args.prompt)
+
+################################################################################
+
+def gitprompt():
+    """Entry point"""
+
+    try:
+        main()
+
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    gitprompt()

skilleter_thingy/gl.py

@@ -0,0 +1,174 @@
+#! /usr/bin/env python3
+
+""" Nearly MVP of a command to do things to GitLab
+    Currently just implements the 'mr-list' command which outputs a list
+    of merge requests from all projects in CSV format.
+
+    TODO: Lots and lots of things! """
+
+################################################################################
+
+import argparse
+import os
+import sys
+from collections import defaultdict
+
+from skilleter_thingy import colour
+from skilleter_thingy import gitlab
+
+################################################################################
+
+def mr_list(args):
+    """ List merge requests """
+
+    gl = gitlab.GitLab(args.server)
+
+    # TODO: Could incorporate some/all filtering in the request rather than getting all MRs and filtering them
+
+    mrs = gl.merge_requests(scope='all')
+
+    # TODO: Output format other than CSV
+    # TODO: More filtering
+
+    if args.summary:
+        authors = defaultdict(int)
+        reviewers = defaultdict(int)
+        combos = defaultdict(int)
+
+        count = 0
+        for mr in mrs:
+            author = mr['author']['username']
+            authors[author] += 1
+
+            if mr['state'] == 'merged':
+                try:
+                    reviewer = mr['merged_by']['username']
+                except TypeError:
+                    reviewer = 'UNKNOWN'
+
+                reviewers[reviewer] += 1
+                combos[f"{author}|{reviewer}"] += 1
+
+            count += 1
+            if args.limit and count > args.limit:
+                break
+
+        print('Number of merge requests by author')
+
+        for value in sorted(set(authors.values()), reverse=True):
+            for person in authors:
+                if authors[person] == value:
+                    print(f'    {person:32}: {authors[person]}')
+
+        print()
+        print('Number of merge requests by reviewer')
+
+        for value in sorted(set(reviewers.values()), reverse=True):
+            for person in reviewers:
+                if reviewers[person] == value:
+                    print(f'    {person:32}: {reviewers[person]}')
+
+        print()
+        print('Author/Reviewer combinations for merged changes')
+
+        for value in sorted(set(combos.values()), reverse=True):
+            for combo in combos:
+                if combos[combo] == value:
+                    author, reviewer = combo.split('|')
+
+                    print(f'    Written by {author}, reviewed by {reviewer}: {combos[combo]}')
+
+    else:
+        print('state,merge id,project id,author,approver,title,merge date')
+
+        for mr in mrs:
+            if args.author and mr['author']['username'] != args.author:
+                continue
+
+            if mr['state'] == 'merged':
+                try:
+                    merged_by = mr['merged_by']['username']
+                except TypeError:
+                    merged_by = 'NONE'
+
+                if args.approver and merged_by != args.approver:
+                    continue
+
+                if not args.summary:
+                    print('%s,%s,%s,%s,%s,%s,"%s"' % (mr['state'], mr['id'], mr['project_id'],
+                          mr['author']['username'], merged_by, mr['title'], mr['merged_at']))
+            elif args.all and not args.summary:
+                print('%s,%s,%s,%s,,"%s",' % (mr['state'], mr['id'], mr['project_id'], mr['author']['username'], mr['title']))
+
+            count += 1
+            if args.limit and count > args.limit:
+                break
+
+################################################################################
+
+def main():
+    """ Entry point """
+
+    parser = argparse.ArgumentParser(description='Gitlab commands')
+
+    parser.add_argument('--dryrun', '--dry-run', '-D', action='store_true', help='Dry-run comands')
+    parser.add_argument('--debug', '-d', action='store_true', help='Debug')
+    parser.add_argument('--verbose', '-v', action='store_true', help='Verbosity to the maximum')
+    parser.add_argument('--server', '-s', default=None, help='The GitLab server')
+    parser.add_argument('--token', '-t', default=None, help='The GitLab access token')
+
+    subparsers = parser.add_subparsers(dest='command')
+
+    parser_mr_list = subparsers.add_parser('mr-list', help='List merge requests')
+    parser_mr_list.add_argument('--all', action='store_true', help='List un-merged merge requests')
+    parser_mr_list.add_argument('--author', action='store', help='List merge requests created by a specific user')
+    parser_mr_list.add_argument('--approver', action='store', help='List merge requests approved by a specific user')
+    parser_mr_list.add_argument('--summary', action='store_true', help='Produce a summary report')
+    parser_mr_list.add_argument('--limit', action='store', type=int, help='Output the first N merge requests')
+
+    # TODO: Other subcommands
+
+    # Parse the command line
+
+    args = parser.parse_args()
+
+    # Check the server/token configuration
+
+    if not args.server:
+        args.server = os.environ.get('GITLAB_SERVER', None)
+
+        if not args.server:
+            colour.error('The GitLab server must be specified on the command line or via the [BLUE:GITLAB_SERVER] environment variable')
+
+    if not args.token:
+        args.token = os.environ.get('GITLAB_TOKEN', None)
+
+        if not args.token:
+            colour.error('GitLab access token must be specified on the command line or via the [BLUE:GITLAB_TOKEN] environment variable')
+
+    # Invoke the subcommand
+
+    if args.command == 'mr-list':
+        mr_list(args)
+
+    elif not args.command:
+        colour.error('No command specified')
+    else:
+        colour.error(f'Invalid command: "{args.command}"')
+
+################################################################################
+
+def gl():
+    """Entry point"""
+
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    gl()