skilleter-thingy 0.0.74__py3-none-any.whl → 0.0.76__py3-none-any.whl

skilleter_thingy/multigit.py

@@ -22,17 +22,24 @@ import thingy.colour as colour
     # Default settings
 
     [repo_path]
-    name = path
     default branch = name
 """
 
+# TODO: [ ] If the config file isn't in the current directory then search up the directory tree for it but run in the current directory
 # TODO: [ ] -j option to run in parallel?
 # TODO: [ ] init function
-# TODO: [ ] Use the configuration file
-# TODO: [ ] Don't use a fixed list of default branch names
-# TODO: [ ] / Output name of each git repo as it is processed as command sits there seeming to do nothing otherwise.
+# TODO: [/] Use the configuration file
+# TODO: [/] Don't use a fixed list of default branch names
+# TODO: [/] / Output name of each git repo as it is processed as command sits there seeming to do nothing otherwise.
 # TODO: [ ] ? Pull/fetch - only output after running command and only if something updated
 # TODO: [ ] Don't save the configuration on exit if it hasn't changed
+# TODO: [ ] Consistent colours in output
+# TODO: [ ] Is it going to be a problem if the same repo is checked out twice or more in the same workspace
+# TODO: [ ] Better error-handling - e.g. continue/abort option after failure in one repo
+# TODO: [ ] Dry-run option
+# TODO: [ ] Verbose option
+# TODO: [ ] When specifying list of repos, if repo name doesn't contain '/' prefix it with '*'?
+
 ################################################################################
 
 DEFAULT_CONFIG_FILE = 'multigit.toml'
@@ -64,8 +71,13 @@ def show_progress(width, msg):
 def find_git_repos(directory, wildcard):
     """Locate and return a list of '.git' directory parent directories in the
        specified path.
+
        If wildcard is not None then it is treated as a list of wildcards and
-       only repos matching at least one of the wildcards are returned."""
+       only repos matching at least one of the wildcards are returned.
+
+       If the same repo matches multiple times it will only be returned once. """
+
+    repos = set()
 
     for root, dirs, _ in os.walk(directory):
         if '.git' in dirs:
@@ -75,10 +87,14 @@ def find_git_repos(directory, wildcard):
             if wildcard:
                 for card in wildcard:
                     if fnmatch.fnmatch(root, card):
-                        yield root
+                        if root not in repos:
+                            yield root
+                            repos.add(root)
                         break
             else:
-                yield root
+                if root not in repos:
+                    yield root
+                    repos.add(root)
 
 ################################################################################
 
@@ -100,6 +116,8 @@ def mg_init(args, config, console):
 def mg_status(args, config, console):
     """Report Git status for any repo that has a non-empty status"""
 
+    # TODO: [ ] More user-friendly output
+
     for repo in find_git_repos(args.directory, args.repos):
         if not args.quiet:
             show_progress(console.columns, repo)
@@ -229,6 +247,23 @@ def mg_push(args, config, console):
     # TODO: Add option for force-push?
     # TODO: Add option for manual confirmation?
 
+    for repo in find_git_repos(args.directory, args.repos):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        branch = git.branch(path=repo)
+
+        if branch != config[repo]['default branch']:
+            colour.write(f'Pushing changes to [BLUE:{branch}] in [BOLD:{repo}]')
+
+            result = git.push(path=repo)
+
+            if result:
+                for line in result:
+                    colour.write(f'    {line}')
+
+            colour.write()
+
 ################################################################################
 
 def mg_checkout(args, config, console):
@@ -237,7 +272,10 @@ def mg_checkout(args, config, console):
        if the branch exists in the repo.
        If the 'create' option is specified then branch is created"""
 
-    # TODO: Add --create handling
+    # TODO: [ ] Add --create handling
+    # TODO: [ ] Checkout remote branches
+    # TODO: [ ] only try checkout if branch exists
+    # TODO: [ ] option to fetch before checking out
 
     for repo in find_git_repos(args.directory, args.repos):
         if not args.quiet:
@@ -246,9 +284,90 @@ def mg_checkout(args, config, console):
         branch = args.branch or config[repo]['default branch']
 
         if git.branch(path=repo) != branch:
-            console.write(f'Checking out [BLUE:{branch}] in [BLUE:{repo}]')
+            colour.write(f'Checking out [BLUE:{branch}] in [BOLD:{repo}]')
+
+            git.checkout(branch, create=args.create, path=repo)
 
+################################################################################
+
+def mg_commit(args, config, console):
+    """For every repo that has a branch checked out and changes present,
+       commit those changes onto the branch"""
+
+    # TODO [ ] Option to amend the commit if it is not the first one on the current branch
+    # TODO [ ] Prevent commits if current branch is the default branch
+
+    for repo in find_git_repos(args.directory, args.repos):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        branch = git.branch(path=repo)
+        modified = git.status(path=repo)
+
+        if branch != config[repo]['default branch'] and modified:
+            colour.write(f'Committing [BOLD:{len(modified)}] changes onto [BLUE:{branch}] branch in [BOLD:{repo}]')
+
+            git.commit(all=True, message=args.message, path=repo)
+
+################################################################################
+
+def mg_update(args, config, console):
+    """For every repo, pull the default branch and if the current branch
+       is not the default branch, rebase it onto the default branch"""
+
+    # TODO: [ ] Option to pull current branch
+    # TODO: [ ] Use git-update
+    # TODO: [ ] Option to delete current branch before pulling (to get updates without conflicts)
+    # TODO: [ ] Option to stash changes on current branch before updating and unstash afterwards
+
+    for repo in find_git_repos(args.directory, args.repos):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        branch = git.branch(path=repo)
+        default_branch = config[repo]['default branch']
+
+        colour.write(f'Updating branch [BLUE:{branch}] in [BOLD:{repo}]')
+
+        if branch != default_branch:
+            git.checkout(default_branch, path=repo)
+
+        git.pull(path=repo)
+
+        if branch != default_branch:
             git.checkout(branch, path=repo)
+            result = git.rebase(default_branch, path=repo)
+            colour.write(f'    {result[0].strip()}')
+
+################################################################################
+
+def mg_clean(args, config, console):
+    """Clean the repos"""
+
+    for repo in find_git_repos(args.directory, args.repos):
+        if not args.quiet:
+            show_progress(console.columns, repo)
+
+        result = git.clean(recurse=args.recurse, force=args.force, dry_run=args.dry_run,
+                           quiet=args.quiet, exclude=args.exclude, ignore_rules=args.x,
+                           remove_only_ignored=args.X, path=repo)
+
+        first_skip = True
+
+        if result:
+            colour.write(f'[BOLD:{repo}]')
+
+            for item in result:
+                skipping = item.startswith('Skipping repository ')
+
+                if skipping and not args.verbose:
+                    if first_skip:
+                        colour.write(f'    Skipping sub-repositories')
+                        first_skip = False
+                else:
+                    colour.write(f'    {item.strip()}')
+
+            colour.write()
 
 ################################################################################
 
@@ -262,11 +381,14 @@ def main():
        'pull': mg_pull,
        'push': mg_push,
        'checkout':  mg_checkout,
+       'commit': mg_commit,
+       'update': mg_update,
+       'clean': mg_clean,
     }
 
     # Parse args in the form COMMAND OPTIONS SUBCOMMAND SUBCOMMAND_OPTIONS PARAMETERS
 
-    parser = argparse.ArgumentParser(description='Gitlab commands')
+    parser = argparse.ArgumentParser(description='Run git commands in multiple Git repos. DISCLAIMER: This is beta-quality software, with missing features and liable to fail with stack dump, but shouldn\'t eat your data')
 
     parser.add_argument('--dryrun', '--dry-run', '-D', action='store_true', help='Dry-run comands')
     parser.add_argument('--debug', '-d', action='store_true', help='Debug')
@@ -274,7 +396,7 @@ def main():
     parser.add_argument('--quiet', '-q', action='store_true', help='Minimal console output')
     parser.add_argument('--config', '-c', action='store', default=DEFAULT_CONFIG_FILE, help=f'The configuration file (defaults to {DEFAULT_CONFIG_FILE})')
     parser.add_argument('--directory', '--dir', action='store', default='.', help='The top-level directory of the multigit tree (defaults to the current directory)')
-    parser.add_argument('--repos', '-r', action='append', default=None, help='The list of repo names to work on (defaults to all repos and can contain shell wildcards)')
+    parser.add_argument('--repos', '-r', action='append', default=None, help='The repo names to work on (defaults to all repos and can contain shell wildcards and can be issued multiple times on the command line)')
 
     subparsers = parser.add_subparsers(dest='command')
 
@@ -288,9 +410,25 @@ def main():
     parser_push = subparsers.add_parser('push', help='Run git push in every repo where the current branch isn\'t the default and the most recent commit was by the current user')
 
     parser_checkout = subparsers.add_parser('checkout', help='Checkout the specified branch')
-    parser_checkout.add_argument('--create', action='store_true', help='Create the specified branch and check it out')
+    parser_checkout.add_argument('--create', '-b', action='store_true', help='Create the specified branch and check it out')
     parser_checkout.add_argument('branch', nargs='?', default=None, action='store', help='The branch name to check out (defaults to the default branch)')
 
+    parser_commit = subparsers.add_parser('commit', help='Commit changes')
+    parser_commit.add_argument('--message', '-m', action='store', default=None, help='The commit message')
+
+    parser_update = subparsers.add_parser('update', help='Pull the default branch and if the current branch isn\'t the default branch, rebase it onto the default branch')
+
+    parser_clean = subparsers.add_parser('clean', help='Remove untracked files from the working tree')
+
+    parser_clean.add_argument('--recurse', '-d', action='store_true', help='Recurse into subdirectories')
+    parser_clean.add_argument('--force', '-f', action='store_true', help='If the Git configuration variable clean.requireForce is not set to false, git clean will refuse to delete files or directories unless given -f or -i')
+    #parser_clean.add_argument('--interactive', '-i', action='store_true', help='Show what would be done and clean files interactively.')
+    parser_clean.add_argument('--dry-run', '-n', action='store_true', help='Don’t actually remove anything, just show what would be done.')
+    #parser_clean.add_argument('--quiet', '-q', , action='store_true', help='Be quiet, only report errors, but not the files that are successfully removed.')
+    parser_clean.add_argument('--exclude', '-e', action='store', help='Use the given exclude pattern in addition to the standard ignore rules.')
+    parser_clean.add_argument('-x', action='store_true', help='Don’t use the standard ignore rules, but still use the ignore rules given with -e options from the command line.')
+    parser_clean.add_argument('-X', action='store_true', help='Remove only files ignored by Git. This may be useful to rebuild everything from scratch, but keep manually created files.')
+
     # Parse the command line
 
     args = parser.parse_args()
@@ -300,8 +438,6 @@ def main():
     if not args.command:
         error('No command specified')
 
-    # TODO: If the config file isn't in the current directory then search up the directory tree for it but run in the current directory
-
     # If the configuration file exists, read it
 
     config = configparser.ConfigParser()
@@ -321,10 +457,10 @@ def main():
 
     commands[args.command](args, config, console)
 
-    # Save the updated configuration file
+    # Save the updated configuration file if it has changed (currently, only the init command will do this).
 
-    if config:
-        with open(args.config, 'w') as configfile:
+    if config and args.command == 'init':
+        with open(args.config, 'w', encoding='utf8') as configfile:
             config.write(configfile)
 
 ################################################################################
@@ -336,9 +472,14 @@ def multigit():
         main()
     except KeyboardInterrupt:
         sys.exit(1)
+
     except BrokenPipeError:
         sys.exit(2)
 
+    except git.GitError as exc:
+        print(exc)
+        sys.exit(3)
+
 ################################################################################
 
 if __name__ == '__main__':

skilleter_thingy/thingy/git2.py

@@ -15,7 +15,8 @@
     * Functions will raise exceptions on error. If the underlying git command
       returns an error, a git.GitError() exception is raised.
 
-    * TODO: Cache list of branches when git.branches/isbranch called
+    * TODO: [ ] Cache list of branches when git.branches/isbranch called
+    * TODO: [ ] API change - git_run_status should raise an exception on failure and just return the git output
 """
 ################################################################################
 
@@ -53,13 +54,13 @@ def git(cmd, stdout=None, stderr=None, path=None):
         to get the exception.
         Optionally redirect stdout and stderr as specified. """
 
-    logging.debug('Running git %s', ' '.join(cmd))
-
     git_cmd = ['git']
 
     if path:
         git_cmd += ['-C', path]
 
+    logging.debug('Running %s', ' '.join(git_cmd + cmd))
+
     try:
         return run.run(git_cmd + cmd, stdout=stdout, stderr=stderr)
     except run.RunError as exc:
@@ -274,10 +275,10 @@ def rebase_required(branch, parent):
 
 ################################################################################
 
-def rebase(branch):
+def rebase(branch, path=None):
     """ Rebase the current branch against the specified branch """
 
-    return git_run_status(['rebase', branch])
+    return git_run_status(['rebase', branch], path=path)
 
 ################################################################################
 
@@ -622,7 +623,8 @@ def rm(files):
 
 def commit(files=None,
            message=None,
-           all=False, amend=False, foreground=False, patch=False, dry_run=False):
+           all=False, amend=False, foreground=False, patch=False, dry_run=False,
+           path=None):
     """ Commit files to git """
 
     cmd = ['commit']
@@ -647,16 +649,17 @@ def commit(files=None,
         cmd += ['-m', message]
 
     if foreground:
-        return git(cmd, stdout=sys.stdout, stderr=sys.stderr)
+        return git(cmd, stdout=sys.stdout, stderr=sys.stderr, path=path)
 
-    return git(cmd)
+    return git(cmd, path=path)
 
 ################################################################################
 
 def push(all=False, mirror=False, tags=False, atomic=False, dry_run=False,
          follow_tags=False, receive_pack=False, repo=None, force=False, delete=False,
          prune=False, verbose=False, set_upstream=False, push_options=[], signed=None,
-         force_with_lease=False, no_verify=False, repository=None, refspec=None):
+         force_with_lease=False, no_verify=False, repository=None, refspec=None,
+         path=None):
     """ Push commits to a remote """
 
     cmd = ['push']
@@ -720,7 +723,7 @@ def push(all=False, mirror=False, tags=False, atomic=False, dry_run=False,
         for ref in refspec:
             cmd.append(ref)
 
-    return git(cmd)
+    return git(cmd, path=path)
 
 ################################################################################
 
@@ -1236,6 +1239,38 @@ def log(branch1, branch2=None):
 
     return git(cmd)
 
+################################################################################
+
+def clean(recurse=False, force=False, dry_run=False, quiet=False,
+          exclude=None, ignore_rules=False, remove_only_ignored=False, path=None):
+
+    """ Run git clean """
+
+    cmd = ['clean']
+
+    if recurse:
+        cmd.append('-d')
+
+    if force:
+        cmd.append('--force')
+
+    if dry_run:
+        cmd.append('--dry-run')
+
+    if quiet:
+        cmd.append('--quiet')
+
+    if exclude:
+        cmd += ['--exclude', exclude]
+
+    if ignore_rules:
+        cmd.append('-x')
+
+    if remove_only_ignored:
+        cmd.append('-X')
+
+    return git(cmd, path=path)
+
 ################################################################################
 # Entry point
 

{skilleter_thingy-0.0.74.dist-info → skilleter_thingy-0.0.76.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.74
+Version: 0.0.76
 Summary: A collection of useful utilities, mainly aimed at making Git more friendly
 Author-email: John Skilleter <john@skilleter.org.uk>
 Project-URL: Home, https://skilleter.org.uk

{skilleter_thingy-0.0.74.dist-info → skilleter_thingy-0.0.76.dist-info}/RECORD

@@ -25,7 +25,7 @@ skilleter_thingy/gl.py,sha256=9zbGpKxw6lX9RghLkdy-Q5sZlqtbB3uGFO04qTu1dH8,5954
 skilleter_thingy/gphotosync.py,sha256=Vb2zYTEFp26BYdkG810SRg9afyfDqvq4CLHTk-MFf60,22388
 skilleter_thingy/linecount.py,sha256=5voQtjJjDCVx4zjPwVRy620NpuLiwwFitzxjIsRGtxQ,4310
 skilleter_thingy/moviemover.py,sha256=j_Xb9_jFdgpFBAXcF4tEqbnKH_FonlnUU39LiCK980k,4470
-skilleter_thingy/multigit.py,sha256=2E3lizBNO4o0zJzg-nPA38ogj3c-RMaSK6HpqIVBMDc,12178
+skilleter_thingy/multigit.py,sha256=TiPpPKO-xB0MUrV1Obv4UEZMi209vrcidFolDdFH8hM,18788
 skilleter_thingy/photodupe.py,sha256=l0hbzSLb2Vk2ceteg-x9fHXCEE1uUuFo84hz5rsZUPA,4184
 skilleter_thingy/phototidier.py,sha256=5gSjlINUxf3ZQl3NG0o7CsWwODvTbokIMIafLFvn8Hc,7818
 skilleter_thingy/py_audit.py,sha256=xJm5k5qyeA6ii8mODa4dOkmP8L1drv94UHuxR54RsIM,4384
@@ -52,7 +52,7 @@ skilleter_thingy/thingy/dircolors.py,sha256=5NbXMsGWdABLvvZfB70VPmN6N5HyyihfpgoQ
 skilleter_thingy/thingy/docker.py,sha256=9EFatudoVPfB1UbDEtzdJDB3o6ToHiNHv8-oLsUeqiQ,2449
 skilleter_thingy/thingy/files.py,sha256=oW6E6WWwVFSUPdrZnKMx7P_w_hh3etjoN7RrqvYHCHc,4705
 skilleter_thingy/thingy/git.py,sha256=qXWIduF4jbP5pKFYt_hW9Ex5iL9mSBBrcNKBkULhRTg,38834
-skilleter_thingy/thingy/git2.py,sha256=jh2zNsQB6d-nROTPZXbeHCXG9TQIDV8ItsHhdGoeQk0,35752
+skilleter_thingy/thingy/git2.py,sha256=UEXeSyT5PlYGtdUAQDEZC7Sc7JmYdAlP6osa1tVmpO8,36620
 skilleter_thingy/thingy/gitlab.py,sha256=uXAF918xnPk6qQyiwPQDbMZfqtJzhiRqDS7yEtJEIAg,6079
 skilleter_thingy/thingy/path.py,sha256=8uM2Q9zFRWv_SaVOX49PeecQXttl7J6lsmBuRXWsXKY,4732
 skilleter_thingy/thingy/popup.py,sha256=jW-nbpdeswqEMTli7OmBv1J8XQsvFoMI0J33O6dOeu8,2529
@@ -61,9 +61,9 @@ skilleter_thingy/thingy/run.py,sha256=6SNKWF01fSxzB10GMU9ajraXYZqAL1w0PXkqjJdr1U
 skilleter_thingy/thingy/tfm_pane.py,sha256=oqy5zBzKwfbjbGqetbbhpKi4x5He7sl4qkmhUeqtdZc,19789
 skilleter_thingy/thingy/tidy.py,sha256=71DCyj0VJrj52RmjQyj1eOiQJIfy5EIPHuThOrS6ZTA,5876
 skilleter_thingy/thingy/venv_template.py,sha256=SsVNvSwojd8NnFeQaZPCRQYTNdwJRplpZpygbUEXRnY,1015
-skilleter_thingy-0.0.74.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
-skilleter_thingy-0.0.74.dist-info/METADATA,sha256=PGTpGZ8NmFGHyRJDykHfY3anHyLU3W1X-CFasmWH83k,5313
-skilleter_thingy-0.0.74.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-skilleter_thingy-0.0.74.dist-info/entry_points.txt,sha256=uW11ofmIbfPP_5B-pxb8YDkHbeZ_xeCoO6358R9wGVI,2146
-skilleter_thingy-0.0.74.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
-skilleter_thingy-0.0.74.dist-info/RECORD,,
+skilleter_thingy-0.0.76.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
+skilleter_thingy-0.0.76.dist-info/METADATA,sha256=88wOrTIgIDHyAdQssoVO1z_DCE0rWxNey0c8XnJEjq0,5313
+skilleter_thingy-0.0.76.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+skilleter_thingy-0.0.76.dist-info/entry_points.txt,sha256=uW11ofmIbfPP_5B-pxb8YDkHbeZ_xeCoO6358R9wGVI,2146
+skilleter_thingy-0.0.76.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
+skilleter_thingy-0.0.76.dist-info/RECORD,,