skilleter-thingy 0.3.14__py3-none-any.whl

skilleter_thingy/git_hold.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+"""Archive one or more branches by tagging the branch then deleting it
+   The branch tag is 'archive/BRANCH_NAME'"""
+
+import os
+import sys
+import argparse
+import fnmatch
+
+from skilleter_modules import colour
+from skilleter_modules import git
+
+################################################################################
+# Prefix for tags representing archived branches
+
+ARCHIVE_PREFIX = 'archive/'
+
+################################################################################
+
+def archive_tag_name(branch):
+    """Return the tag name for an archive branch"""
+
+    return f'{ARCHIVE_PREFIX}{branch}'
+
+################################################################################
+
+def archive_branch_name(tag):
+    """Return the branch name for an archive tag"""
+
+    if not tag.startswith(ARCHIVE_PREFIX):
+        raise git.GitError(f'{tag} is not an archive tag')
+
+    return tag[len(ARCHIVE_PREFIX):]
+
+################################################################################
+
+def archive_tags():
+    """Return the list of current archive tags"""
+
+    return [tag for tag in git.tags() if tag.startswith(ARCHIVE_PREFIX)]
+
+################################################################################
+
+def archive_branches(branches):
+    """Archive one or more branches"""
+
+    tags = archive_tags()
+    current_branch = git.branch()
+
+    for branch in branches:
+        if not git.isbranch(branch):
+            colour.error(f'Branch {branch} does not exist', prefix=True)
+
+        if archive_tag_name(branch) in tags:
+            colour.error(f'An archive tag already exists for branch {branch}', prefix=True)
+
+        if branch == current_branch:
+            colour.error('Cannot archive the current branch', prefix=True)
+
+    for branch in branches:
+        tag_name = archive_tag_name(branch)
+
+        git.tag_apply(tag_name, branch)
+        git.delete_branch(branch, force=True)
+
+    for remote in git.remotes():
+        git.push(repository=remote, tags=True)
+
+################################################################################
+
+def list_archive_branches(branches):
+    """List archive branches, optionally only those matching entries in the
+       branches parameter"""
+
+    tags = archive_tags()
+
+    if branches:
+        report = set()
+
+        for branch in branches:
+            for tag in tags:
+                branch_name = archive_branch_name(tag)
+                if branch_name not in report and fnmatch.fnmatch(branch_name, branch):
+                    report.add(branch_name)
+    else:
+        report = set(tags)
+
+    for branch_name in sorted(report):
+        print(branch_name)
+
+################################################################################
+
+def restore_archive_branches(branches):
+    """Restore archived branches"""
+
+    tags = archive_tags()
+
+    for branch in branches:
+        if archive_tag_name(branch) not in tags:
+            colour.error(f'Archive branch {branch} does not exist', prefix=True)
+
+    archive_tag_names = []
+
+    for branch in branches:
+        archive_tag = archive_tag_name(branch)
+        archive_tag_names.append(archive_tag)
+
+        git.checkout(branch, commit=archive_tag)
+        git.tag_delete(archive_tag)
+
+    for remote in git.remotes():
+        git.push(repository=remote, delete=True, refspec=archive_tag_names)
+
+################################################################################
+
+def main():
+    """Main function"""
+
+    parser = argparse.ArgumentParser(description='Archive, list or recover one or more Git branches')
+    parser.add_argument('--list', '-l', action='store_true', help='List archived branches')
+    parser.add_argument('--restore', '-r', action='store_true', help='Restore archived branches')
+    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='Branches')
+
+    args = parser.parse_args()
+
+    if args.list and args.restore:
+        colour.error('The list and restore options cannot be specified together', prefix=True)
+
+    if not args.branches and not args.list:
+        colour.error('No branches specified', prefix=True)
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    if args.list:
+        list_archive_branches(args.branches)
+    elif args.restore:
+        restore_archive_branches(args.branches)
+    else:
+        archive_branches(args.branches)
+
+################################################################################
+
+def git_hold():
+    """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_hold()

skilleter_thingy/git_parent.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+"""
+Attempt to determine the parent branch of a commit by tracking down
+the branch commit history and looking for other branches that share
+the same commit. Can optionally ignore feature branches and/or report
+the distance to the potential parent.
+"""
+
+import os
+import argparse
+import sys
+
+from skilleter_modules import git
+from skilleter_modules import colour
+
+################################################################################
+
+def main():
+    """ Main function """
+
+    current_branch = git.branch()
+
+    parser = argparse.ArgumentParser(description='Attempt to determine the parent branch for the specified branch (defaulting to the current one)')
+    parser.add_argument('--all', '-a', action='store_true', help='Include feature branches as possible parents')
+    parser.add_argument('--verbose', '-v', action='store_true', help='Report verbose results (includes number of commits between branch and parent)')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
+    parser.add_argument('branch', action='store', nargs='?', type=str, default=current_branch,
+                        help=f'Branch, commit or commit (defaults to current branch; {current_branch})')
+
+    args = parser.parse_args()
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    if args.all:
+        any_parents, any_distance = git.parents(args.branch)
+    else:
+        any_parents = []
+
+    parents, distance = git.parents(args.branch, ignore='feature/*')
+
+    # If we have feature and non-feature branch candidates, decide which to report
+    # (one or both) based on distance.
+
+    if parents and any_parents:
+        if any_distance < distance:
+            parents = any_parents
+            distance = any_distance
+        elif any_distance == distance:
+            for more in any_parents:
+                if more not in parents:
+                    parents.append(more)
+
+    if parents:
+        if args.verbose:
+            if len(parents) == 1:
+                colour.write(f'Parent branch [BLUE:{parents[0]}] is [BLUE:{distance}] commits away from [BLUE:{args.branch}]')
+            else:
+                colour.write(f'Parent branches [BLUE:%s] are [BLUE:{distance}] commits away from [BLUE:{args.branch}]' % (', '.join(parents)))
+        else:
+            print(', '.join(parents))
+    else:
+        colour.error('Could not determine parent branch\n', prefix=True)
+
+################################################################################
+
+def git_parent():
+    """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_parent()

skilleter_thingy/git_retag.py

@@ -0,0 +1,67 @@
+#! /usr/bin/env python3
+
+################################################################################
+""" Apply or update a tag, optionally updating it on the remote as well.
+
+    Copyright (C) 2025 John Skilleter
+
+    Licence: GPL v3 or later
+"""
+################################################################################
+
+import os
+import sys
+import argparse
+
+from skilleter_modules import git
+from skilleter_modules import colour
+
+################################################################################
+
+def main():
+    """ Main function """
+
+    # Command line parameters
+
+    parser = argparse.ArgumentParser(description='Apply or update a tag, optionally updating it on the remote as well.')
+    parser.add_argument('--push', '-p', action='store_true', help='Push the tag to the remote')
+    parser.add_argument('--path', '-C', nargs=1, type=str, default=None,
+                        help='Run the command in the specified directory')
+    parser.add_argument('tag', nargs=1, help='The tag')
+
+    args = parser.parse_args()
+
+    # Change directory, if specified
+
+    if args.path:
+        os.chdir(args.path[0])
+
+    tag = args.tag[0]
+
+    # Delete the tag if it currently exists, optionally pushing the deletion
+
+    if tag in git.tags():
+        git.tag_delete(tag, push=args.push)
+
+    # Apply the tag
+
+    git.tag_apply(tag, 'HEAD', push=args.push)
+
+################################################################################
+
+def git_retag():
+    """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_retag()