skilleter-thingy 0.3.14__py3-none-any.whl

skilleter_thingy/ggrep.py

@@ -0,0 +1,155 @@
+#! /usr/bin/env python3
+
+""" Run 'git grep' in all Git working trees under the current directory or just
+   in the current directory if the current director is in a working tree.
+
+   Copyright (C) 2019-21 John Skilleter
+"""
+
+################################################################################
+
+import os
+import re
+import sys
+import argparse
+
+from skilleter_modules import colour
+from skilleter_modules import git
+
+################################################################################
+
+BINARY_RE = re.compile(r'(Binary file )(.*)( matches)')
+
+################################################################################
+
+def parse_command_line():
+    """ Validate the command line, return the arguments """
+
+    parser = argparse.ArgumentParser(
+        description='Run a git grep in either the current working tree or all working git working trees under the current directory')
+
+    parser.add_argument('--follow', '-f', action='store_true', help='Follow symlinks')
+    parser.add_argument('--text', '-a', action='store_true', help='Process binary files as if they were text.')
+    parser.add_argument('--ignore-case', '-i', action='store_true', help='Ignore case differences between the patterns and the files.')
+    parser.add_argument('--word-regexp', '-w', action='store_true',
+                        help='Match the pattern only at word boundary (either begin at the beginning of a line, or preceded by a non-word character; end at the end of a line or followed by a non-word character).')
+    parser.add_argument('--invert-match', '-v', action='store_true', help='Select non-matching lines.')
+    parser.add_argument('--fixed-strings', '-F', action='store_true', help='Use fixed strings for patterns (don’t interpret pattern as a regex).')
+    parser.add_argument('--line-number', '-n', action='store_true', help='Prefix the line number to matching lines.')
+    parser.add_argument('--files-with-matches', '-l', action='store_true', help='Show only the names of files that contain matches')
+    parser.add_argument('--files-without-matches', '-L', action='store_true', help='Show only the names of files that do NOT contain matches')
+    parser.add_argument('--wildcard', '-W', action='append', help='Only search files matching the wildcard(s)')
+    parser.add_argument('--only-matching', '-o', action='store_true',
+                        help='Print only the matched (non-empty) parts of a matching line, with each such part on a separate output line.')
+    parser.add_argument('--no-color', action='store_true', help='Turn off match highlighting')
+    parser.add_argument('pattern', action='store', help='Regular expression to search for')
+    parser.add_argument('paths', nargs='*', help='Optional list of one or more paths to search')
+
+    return parser.parse_args()
+
+################################################################################
+
+def git_grep(args, path, pattern):
+    """ Grep a git """
+
+    if path == '.':
+        path = ''
+    elif path[0:2] == './':
+        path = path[2:]
+
+    grep_options = {'color': True, 'extended_regexp': True}
+
+    if args.text:
+        grep_options['text'] = True
+
+    if args.ignore_case:
+        grep_options['ignore_case'] = True
+
+    if args.word_regexp:
+        grep_options['word_regexp'] = True
+
+    if args.invert_match:
+        grep_options['invert_match'] = True
+
+    if args.fixed_strings:
+        grep_options['fixed_strings'] = True
+
+    if args.line_number:
+        grep_options['line_number'] = True
+
+    if args.files_without_matches:
+        grep_options['files_without_matches'] = True
+
+    if args.files_with_matches:
+        grep_options['files_with_matches'] = True
+
+    if args.only_matching:
+        grep_options['only_matching'] = True
+
+    if path:
+        output, status = git.grep(pattern, git_dir=os.path.join(path, '.git'), work_tree=path, options=grep_options, wildcards=args.wildcard)
+    else:
+        output, status = git.grep(pattern, options=grep_options, wildcards=args.wildcard)
+
+    if status > 1:
+        colour.error(output)
+    elif status == 0:
+        for out in output.split('\n'):
+            if out:
+                bin_match = BINARY_RE.match(out)
+                if bin_match:
+                    match_path = os.path.join(path, bin_match.group(2))
+                    colour.write(f'[BOLD:{match_path}]: Binary file match')
+                else:
+                    subdir = os.path.join(path, out.split(':', 1)[0])
+                    data = out.split(':', 1)[1]
+
+                    colour.write(f'[BLUE:{subdir}]: {data.strip()}')
+
+################################################################################
+
+def git_grep_path(args, path):
+    """ Look for git working trees under the specified path and grep them """
+
+    for root, dirs, _ in os.walk(path, followlinks=args.follow):
+        if '.git' in dirs:
+            git_grep(args, root, args.pattern)
+
+################################################################################
+
+def main():
+    """ If we are in a repo, just run git grep, otherwise, hunt for
+        repos and git grep them. """
+
+    args = parse_command_line()
+
+    if not args.paths:
+        # No paths specified so if the current directory is in a working tree
+        # just run git grep, otherwise, look for working trees in subdirectories
+
+        if git.working_tree():
+            git_grep(args, '.', args.pattern)
+        else:
+            args.paths = ['.']
+
+    if args.paths:
+        for path in args.paths:
+            git_grep_path(args, path)
+
+################################################################################
+
+def ggrep():
+    """Entry point"""
+
+    try:
+        main()
+
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    ggrep()

skilleter_thingy/git_br.py

@@ -0,0 +1,186 @@
+#! /usr/bin/env python3
+
+################################################################################
+""" Thingy 'git-br' command - output branch information
+
+    Author: John Skilleter
+
+    Licence: GPL v3 or later
+
+    TODO: Command line options for list of fields to output
+    TODO: Command line options for sort order
+    TODO: Debate the delete option, which currently isn't implemented
+"""
+################################################################################
+
+import os
+import sys
+import argparse
+import fnmatch
+import datetime
+
+from dateutil.parser import parse
+from dateutil.relativedelta import relativedelta
+
+from skilleter_modules import git
+from skilleter_modules import colour
+
+################################################################################
+
+def parse_command_line():
+    """ Parse the command line """
+
+    parser = argparse.ArgumentParser(description='List or delete branches that have been merged')
+
+    parser.add_argument('--all', '-a', action='store_true', help='List all branches, including remotes')
+    parser.add_argument('--delete', '-d', action='store_true',
+                        help='Delete the specified branch(es), even if it is the current one (list of branches to delete must be supplied as parameters)')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
+    parser.add_argument('branches', nargs='*', help='Filter the list of branches according to one or more patterns')
+
+    args = parser.parse_args()
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    if args.delete and not args.branches:
+        colour.error('You must specify the branches to delete', prefix=True)
+
+    return args
+
+################################################################################
+
+def branch_match(ref, matching_branches):
+    """ Return True if ref matches an entry in matching_branches """
+
+    if matching_branches:
+        for branch in matching_branches:
+            if '?' in branch or '*' in branch:
+                if branch[0] not in ['?', '*']:
+                    branch = f'*{branch}'
+                if branch[-1] not in ['?', '*']:
+                    branch = f'{branch}*'
+
+                if fnmatch.fnmatch(ref, branch):
+                    return True
+            elif branch in ref:
+                return True
+
+        return False
+
+    return True
+
+################################################################################
+
+def get_matching_branches(args):
+    """ Get a list of branches matching those specified in the script arguments  """
+
+    # Get the SHA1, date, author and name of the tip commit on each branch, including remotes
+    # and keep track of the maximum length of each field
+
+    branches = []
+
+    for ref in git.ref(sort='-committerdate', fields=('objectname:short', 'committerdate', 'authorname', 'refname:short'), remotes=args.all):
+        if branch_match(ref[3], args.branches):
+            branches.append(ref)
+
+    return branches
+
+################################################################################
+
+def list_branches(branches):
+    """ List branches. """
+
+    max_len = [0] * len(branches[0])
+
+    user = git.config_get('user', 'name')
+
+    # Output the fields in columns, highlighting user's own branches and those owned by Jenkins
+    # Replacing references to today and yesterday's dates with 'today' and 'yesterday' and
+    # reformatting dates and time for readability.
+
+    today = datetime.date.today()
+    yesterday = today - relativedelta(days=1)
+
+    all_output = []
+
+    current_branch = git.branch()
+
+    for branch in branches:
+        output = []
+
+        for i, field in enumerate(branch):
+            if i == 1:
+                field = parse(field)
+                time_str = field.strftime('%H:%M:%S')
+
+                if field.date() == today:
+                    field = 'today      ' + time_str
+                elif field.date() == yesterday:
+                    field = 'yesterday  ' + time_str
+                else:
+                    field = field.date().strftime('%d/%m/%Y') + ' ' + time_str
+
+            output.append('%-*s' % (max_len[i], field))
+            max_len[i] = max(max_len[i], len(field))
+
+        highlight = 'GREEN' if branch[3] in ('master', 'main', 'develop') \
+                    else 'BOLD' if branch[3] == current_branch \
+                    else 'BLUE' if branch[2] == user \
+                    else 'NORMAL'
+
+        all_output.append({'highlight': highlight, 'output': output})
+
+    for output in all_output:
+        line = []
+        for i, field in enumerate(output['output']):
+            line.append('%-*s' % (max_len[i], field))
+
+        colour.write('[%s:%s]' % (output['highlight'], '  '.join(line).rstrip()))
+
+################################################################################
+
+def delete_branches(branches):
+    """ Delete matching branches. Report an error if no branches specified """
+
+    if not branches:
+        print('ERROR: The branches to delete must be specified')
+        sys.exit(1)
+
+    print('TODO: Deleting %s' % branches)
+
+    # TODO: List branches, prompt user, delete each branch - if current branch then checkout develop, main or master first
+
+################################################################################
+
+def main():
+    """ Main function """
+
+    args = parse_command_line()
+
+    branches = get_matching_branches(args)
+
+    if args.delete:
+        delete_branches(branches)
+    else:
+        list_branches(branches)
+
+################################################################################
+
+def git_br():
+    """Entry point"""
+
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+    except git.GitError as exc:
+        colour.error(exc.msg, status=exc.status, prefix=True)
+
+################################################################################
+
+if __name__ == '__main__':
+    git_br()

skilleter_thingy/git_ca.py

@@ -0,0 +1,147 @@
+#! /usr/bin/env python3
+
+################################################################################
+""" Thingy "git-ca" command - an intelligent version of "git commit --amend"
+
+    Copyright (C) 2017-18 John Skilleter
+
+    Licence: GPL v3 or later
+
+    TODO: Handle attempt to amend commit in newly-initialised repo with no commits in.
+    TODO: Fix failure with "fatal: pathspec "FILENAME" did not match any files" whilst amending a commit to include a deleted file.
+"""
+################################################################################
+
+import os
+import argparse
+import sys
+import logging
+
+from skilleter_modules import colour
+from skilleter_modules import git
+
+################################################################################
+
+def main():
+    """ Amend a comment, updating modified files that are already committed and
+        adding files that are listed on the command line """
+
+    # Files to add to git before committing and files to commit
+
+    files_to_add = []
+    files_to_commit = []
+
+    # Parse the command line
+
+    parser = argparse.ArgumentParser(
+        description='Amend changes to the current commit. Updates files that are already in the commit and, optionally, adds additional files.')
+
+    parser.add_argument('--added', '-A', action='store_true', help='Update files in the current commit, including files added with "git add"')
+    parser.add_argument('--all', '-a', action='store_true', help='Append all locally-modified, tracked files to the current commit')
+    parser.add_argument('--everything', '-e', action='store_true', help='Append all modified and untracked files to the current commit (implies --all)')
+    parser.add_argument('--ignored', '-i', action='store_true', dest='ignored', help='Include files normally hidden by .gitignore')
+    parser.add_argument('--patch', '-p', action='store_true', help='Use the interactive patch selection interface to chose which changes to commit.')
+    parser.add_argument('--verbose', '-v', action='store_true', help='Verbose mode')
+    parser.add_argument('--dry-run', '-D', action='store_true', help='Dry-run')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
+
+    parser.add_argument('files', nargs='*', help='List of files to add to the commit')
+
+    args = parser.parse_args()
+
+    # Configure logger
+
+    if args.verbose:
+        logging.basicConfig(level=logging.INFO)
+        logging.info('Debug logging enabled')
+
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    # 'Add' implies 'all'
+
+    if args.everything:
+        args.all = True
+
+    # If there are any files on the command line then add them
+    # to the list of files to be committed
+
+    if args.files:
+        for filename in args.files:
+            rel_path = git.tree_path(filename)
+            files_to_add.append(rel_path)
+
+    # Move to the working tree
+
+    working_tree = git.working_tree()
+
+    if not working_tree:
+        colour.error('fatal: not a git repository (or any of the parent directories)')
+
+    os.chdir(working_tree)
+
+    # Get the list of files modified in the most recent commit
+
+    current_commit = git.commit_changes()
+
+    # Get the list of locally-modified and untracked files, including
+    # files matching .gitignore, if necessary
+
+    logging.info('Getting list of changed files')
+    local_changes = git.status_info(args.ignored)
+
+    for change in local_changes:
+        logging.info('Changed: %s (%s)', change, local_changes[change])
+
+        if change in current_commit or (args.added and local_changes[change][0] == 'A'):
+            # Locally changed and already in the commit or, optionally, added to it, so update it
+
+            files_to_commit.append(change)
+
+        elif args.all and (local_changes[change][1] in ('M', 'A', 'D', 'T') or local_changes[change][0] == 'D'):
+            # Tracked and 'all' option specified so add it to the commit
+
+            files_to_commit.append(change)
+
+        elif args.everything and local_changes[change][0] in ('!', '?'):
+            # Untracked and 'add' option specified so add it to Git and the commit
+
+            files_to_add.append(change)
+
+    if files_to_add:
+        try:
+            git.add(files_to_add)
+        except git.GitError as exc:
+            colour.error(exc.msg, status=exc.status)
+
+        files_to_commit += files_to_add
+
+    # Perform the commit running in the foreground in case the user is using a console
+    # mode text editor for commit comments.
+
+    logging.info('Files to commit: %s', files_to_commit)
+
+    try:
+        git.commit(files_to_commit, amend=True, foreground=True, patch=args.patch, dry_run=args.dry_run)
+    except git.GitError as exc:
+        sys.exit(exc.status)
+
+################################################################################
+
+def git_ca():
+    """Entry point"""
+
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)
+    except BrokenPipeError:
+        sys.exit(2)
+
+################################################################################
+
+if __name__ == '__main__':
+    git_ca()