skilleter-thingy 0.0.88__py3-none-any.whl → 0.0.89__py3-none-any.whl

skilleter_thingy/multigit.py

@@ -4,11 +4,10 @@
 
 import os
 import sys
-import argparse
 import fnmatch
 import configparser
-import shlex
-from collections import defaultdict
+
+from dataclasses import dataclass, field
 
 import thingy.git2 as git
 import thingy.colour as colour
@@ -21,14 +20,14 @@ import thingy.colour as colour
 # DONE: Use the configuration file
 # DONE: init function
 # TODO: -j option to run in parallel?
-# TODO: Pull/fetch - only output after running command and only if something updated
-# TODO: Better error-handling - e.g. continue/abort option after failure in one repo
+# NOPE: Pull/fetch - only output after running command and only if something updated
+# DONE: Better error-handling - e.g. continue/abort option after failure in one repo
 # TODO: Consistent colours in output
 # TODO: Dry-run option
 # DONE: 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: If run in a subdirectory, only process repos in that tree (or have an option to do so)
 # TODO: Is it going to be a problem if the same repo is checked out twice or more in the same workspace
-# TODO: Switch to tomlkit
+# NOPE: Switch to tomlkit
 # TODO: Verbose option
 # TODO: When specifying list of repos, if repo name doesn't contain '/' prefix it with '*'?
 
@@ -43,6 +42,59 @@ DEFAULT_BRANCH = 'DEFAULT'
 
 ################################################################################
 
+HELP_INFO = """usage: multigit [-h] [--dryrun] [--debug] [--verbose] [--quiet] [--config CONFIG] [--directory DIRECTORY] [--repos REPOS] [--modified] [--branched]
+                {+init, +config, +dir, GIT_COMMAND} ...
+
+Run git commands in multiple Git repos. DISCLAIMER: This is beta-quality software, with missing features and liable to fail with a stack trace, but shouldn't eat your data
+
+options:
+  -h, --help            show this help message and exit
+  --dryrun, --dry-run, -D
+                        Dry-run comands
+  --debug, -d           Debug
+  --verbose, -v         Verbosity to the maximum
+  --quiet, -q           Minimal console output
+  --config CONFIG, -c CONFIG
+                        The configuration file (defaults to multigit.toml)
+  --directory DIRECTORY, --dir DIRECTORY
+                        The top-level directory of the multigit tree (defaults to the current directory)
+  --repos REPOS, -r REPOS
+                        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)
+  --modified, -m        Select repos that have local modifications
+  --branched, -b        Select repos that do not have the default branch checked out
+  --continue, -C        Continue if a git command returns an error (by default, executation terminates when a command fails)
+
+Sub-commands:
+  {+init,+dir,+config,GIT_COMMAND}
+    +init                Build or update the configuration file using the current branch in each repo as the default branch
+    +config              Return the name and location of the configuration file
+    +dir                 Return the location of a working tree, given the repo name
+    GIT_COMMAND          Any git command, including options and parameters - this is then run in all specified working trees
+
+"""
+
+################################################################################
+
+@dataclass
+class Arguments():
+    """Data class to contain command line options and parameters"""
+
+    dryrun: bool = False
+    debug: bool = False
+    quiet: bool = False
+    verbose: bool = False
+    configuration_file: str = DEFAULT_CONFIG_FILE
+    directory: str = '.'
+    repos: list[str] = field(default_factory=list)
+    modified: bool = False
+    branched: bool = False
+    command: str = None
+    error_continue: bool = False
+    parameters: list[str] = field(default_factory=list)
+    internal_command: bool = False
+
+################################################################################
+
 def error(msg, status=1):
     """Quit with an error"""
 
@@ -51,6 +103,26 @@ def error(msg, status=1):
 
 ################################################################################
 
+def find_configuration(args):
+    """If the configuration file name has path elements, try and read it, otherwise
+       search up the directory tree looking for the configuration file.
+       Returns configuration file path or None if the configuration file
+       could not be found."""
+
+    if '/' in args.configuration_file:
+        config_file = args.configuration_file
+    else:
+        config_path = os.getcwd()
+        config_file = os.path.join(config_path, args.configuration_file)
+
+        while not os.path.isfile(config_file) and config_path != '/':
+            config_path = os.path.dirname(config_path)
+            config_file = os.path.join(config_path, args.configuration_file)
+
+    return config_file if os.path.isfile(config_file) else None
+
+################################################################################
+
 def show_progress(width, msg):
     """Show a single line progress message"""
 
@@ -76,7 +148,7 @@ def find_git_repos(args):
 
     repos = set()
 
-    for root, dirs, _ in os.walk(args.directory):
+    for root, dirs, _ in os.walk(os.path.dirname(args.configuration_file)):
         if '.git' in dirs:
             if root.startswith('./'):
                 root = root[2:]
@@ -147,21 +219,6 @@ def branch_name(name, default_branch):
 
 ################################################################################
 
-def run_git_status(cmd, path, cont=False, redirect=True):
-    """Run a git command and exit if it fails"""
-
-    output, status = git.git_run_status(cmd, path=path, redirect=redirect)
-
-    if output:
-        colour.write(f'[BOLD:{path}]')
-        colour.write()
-        colour.write(output, indent=4)
-
-    if status and not cont:
-        sys.exit(status)
-
-################################################################################
-
 def mg_init(args, config, console):
     """Create or update the configuration
        By default, it scans the tree for git directories and adds or updates them
@@ -190,279 +247,6 @@ 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 select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        status = git.status(path=repo.name)
-        branch = git.branch(path=repo.name)
-
-        if status or branch != repo['default branch']:
-            if branch == repo['default branch']:
-                colour.write(f'[BOLD:{repo.name}]')
-            else:
-                colour.write(f'[BOLD:{repo.name}] - branch: [BLUE:{branch}]')
-
-            staged = defaultdict(list)
-            unstaged = defaultdict(list)
-            untracked = []
-
-            for entry in status:
-                if entry[0] == '??':
-                    untracked.append(entry[1])
-                elif entry[0][0] == 'M':
-                    staged['Updated'].append(entry[1])
-                elif entry[0][0] == 'T':
-                    staged['Type changed'].append(entry[1])
-                elif entry[0][0] == 'A':
-                    staged['Added'].append(entry[1])
-                elif entry[0][0] == 'D':
-                    staged['Deleted'].append(entry[1])
-                elif entry[0][0] == 'R':
-                    staged['Renamed'].append(entry[1])
-                elif entry[0][0] == 'C':
-                    staged['Copied'].append(entry[1])
-                elif entry[0][1] == 'M':
-                    colour.write(f'    WT Updated:      [BLUE:{entry[1]}]')
-                elif entry[0][1] == 'T':
-                    colour.write(f'    WT Type changed: [BLUE:{entry[1]}]')
-                elif entry[0][1] == 'D':
-                    unstaged['Deleted'].append(entry[1])
-                elif entry[0][1] == 'R':
-                    colour.write(f'    WT Renamed:      [BLUE:{entry[1]}]')
-                elif entry[0][1] == 'C':
-                    colour.write(f'    WT Copied:       [BLUE:{entry[1]}]')
-                else:
-                    staged['Other'].append(f'    {entry[0]}:    [BLUE:{entry[1]}]')
-
-            if untracked:
-                colour.write()
-                colour.write('Untracked files:')
-
-                for git_object in untracked:
-                    colour.write(f'    [BLUE:{git_object}]')
-
-            if staged:
-                colour.write()
-                colour.write('Changes staged for commit:')
-
-                for item in staged:
-                    for git_object in staged[item]:
-                        colour.write(f'    {item}: [BLUE:{git_object}]')
-
-            if unstaged:
-                colour.write()
-                colour.write('Changes not staged for commit:')
-
-                for item in unstaged:
-                    for git_object in unstaged[item]:
-                        colour.write(f'    {item}: [BLUE:{git_object}]')
-
-            colour.write()
-
-################################################################################
-
-def mg_fetch(args, config, console):
-    """Run git fetch everywhere"""
-
-    _ = config
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        colour.write(f'Fetching updates for [BLUE:{repo.name}]')
-
-        result = git.fetch(path=repo.name)
-
-        if result:
-            colour.write(f'[BOLD:{repo.name}]')
-            for item in result:
-                if item.startswith('From '):
-                    colour.write(f'    [BLUE:{item}]')
-                else:
-                    colour.write(f'    {item}')
-
-            colour.write()
-
-################################################################################
-
-def mg_pull(args, config, console):
-    """Run git pull everywhere"""
-
-    _ = config
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        colour.write(f'Pulling updates for [BLUE:{repo.name}]')
-
-        try:
-            result = git.pull(path=repo.name)
-        except git.GitError as exc:
-            error(f'Error in {repo.name}: {exc}')
-
-        if result and result[0] != 'Already up-to-date.':
-            colour.write(f'[BOLD:{repo.name}]')
-            for item in result:
-                if item.startswith('Updating'):
-                    colour.write(f'    [BLUE:{item}]')
-                else:
-                    colour.write(f'    {item}')
-
-            colour.write()
-
-################################################################################
-
-def mg_push(args, config, console):
-    """Run git push everywhere where the current branch isn't one of the defaults
-       and where the most recent commit was the current user and was on the branch
-    """
-
-    # DONE: Add option for force-push?
-    # TODO: Add option for manual confirmation?
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        branch = git.branch(path=repo.name)
-
-        if branch != repo['default branch']:
-            colour.write(f'Pushing changes to [BLUE:{branch}] in [BOLD:{repo.name}]')
-
-            result = git.push(path=repo.name, force_with_lease=args.force)
-
-            if result:
-                colour.write(result, indent=4)
-
-            colour.write()
-
-################################################################################
-
-def mg_checkout(args, config, console):
-    """Run git checkout everywhere.
-       By default it just checks out the specified branch (or the default branch)
-       if the branch exists in the repo.
-       If the 'create' option is specified then branch is created"""
-
-    # 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 select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        branch = branch_name(args.branch, repo['default branch'])
-
-        if git.branch(path=repo.name) != branch:
-            colour.write(f'Checking out [BLUE:{branch}] in [BOLD:{repo.name}]')
-
-            git.checkout(branch, create=args.create, path=repo.name)
-
-################################################################################
-
-def mg_commit(args, config, console):
-    """For every repo that has a branch checked out and changes present,
-       commit those changes onto the branch"""
-
-    # DONE: Option to amend the commit if it is not the first one on the current branch
-    # DONE: Prevent commits if current branch is the default branch
-    # DONE: Option to specify wildcard for files to commit (default is all files)
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        branch = git.branch(path=repo.name)
-        modified = git.status(path=repo.name)
-
-        if branch != repo['default branch'] and modified:
-            colour.write(f'Committing [BOLD:{len(modified)}] changes onto [BLUE:{branch}] branch in [BOLD:{repo.name}]')
-
-            git.commit(all=True, message=args.message, path=repo.name)
-
-################################################################################
-
-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 select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        branch = git.branch(path=repo.name)
-        default_branch = repo['default branch']
-
-        colour.write(f'Updating branch [BLUE:{branch}] in [BOLD:{repo.name}]')
-
-        if branch != default_branch:
-            if not args.quiet:
-                colour.write(f'Checking out [BLUE:{default_branch}]', indent=4)
-
-            git.checkout(default_branch, path=repo.name)
-
-        if not args.quiet:
-            colour.write('Pulling updates from remote', indent=4)
-
-        git.pull(path=repo.name)
-
-        if branch != default_branch:
-            if not args.quiet:
-                colour.write(f'Checking out [BLUE:{branch}] and rebasing against [BLUE:{default_branch}]', indent=4)
-
-            git.checkout(branch, path=repo.name)
-            result = git.rebase(default_branch, path=repo.name)
-            colour.write(result[0], indent=4)
-
-################################################################################
-
-def mg_clean(args, config, console):
-    """Clean the repos"""
-
-    _ = config
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        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.name)
-
-        first_skip = True
-
-        if result:
-            colour.write(f'[BOLD:{repo.name}]')
-
-            for item in result:
-                skipping = item.startswith('Skipping repository ')
-
-                if skipping and not args.verbose:
-                    if first_skip:
-                        colour.write('Skipping sub-repositories', indent=4)
-                        first_skip = False
-                else:
-                    colour.write(item.strip(), indent=4)
-
-            colour.write()
-
-################################################################################
-
 def mg_dir(args, config, console):
     """Return the location of a working tree, given the name. Returns an
        error unless there is a unique match"""
@@ -472,11 +256,13 @@ def mg_dir(args, config, console):
     _ = console
     _ = config
 
+    if len(args.parameters) != 1:
+        error('The +dir command takes one parameter - the name of the working tree to search for')
+
     location = []
-    search_dir = args.dir[0]
 
     for repo in select_git_repos(args, config):
-        if fnmatch.fnmatch(repo['name'], search_dir):
+        if fnmatch.fnmatch(repo['name'], args.parameters[0]):
             location.append(repo.name)
 
     if len(location) == 0:
@@ -484,7 +270,7 @@ def mg_dir(args, config, console):
     elif len(location) > 1:
         error(f'Multiple matches with {search_dir}')
 
-    colour.write(os.path.join(os.path.dirname(args.config), location[0]))
+    colour.write(os.path.join(os.path.dirname(args.configuration_file), location[0]))
 
 ################################################################################
 
@@ -494,181 +280,150 @@ def mg_config(args, config, console):
     _ = config
     _ = console
 
-    colour.write(args.config)
+    if len(args.parameters):
+        error('The +config command does not take parameters')
+
+    colour.write(args.configuration_file)
 
 ################################################################################
 
-def mg_run(args, config, console):
+def run_git_command(args, config, console):
     """Run a command in each of the working trees, optionally continuing if
        there's an error"""
 
     _ = config
-
-    if len(args.cmd) == 0:
-        error('No command specified')
-    elif len(args.cmd) == 1:
-        command = shlex.split(args.cmd[0])
-    else:
-        command = args.cmd
-
+    _ = console
 
     for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
-
-        repo_command = []
-        for cmd in command:
+        repo_command = [args.command]
+        for cmd in args.parameters:
             repo_command.append(branch_name(cmd, repo['default branch']))
 
-        run_git_status(repo_command, repo.name, args.cont)
-
-################################################################################
-
-def mg_review(args, config, console):
-    """Run the git review command"""
-
-    # TODO: Better parsing to replace DEFAULT with default branch only where appropriate
-
-    for repo in select_git_repos(args, config):
-        if not args.quiet:
-            show_progress(console.columns, repo.name)
+        colour.write(f'\n[BOLD:{repo.name}]\n')
 
-        params = []
-        for p in args.parameters:
-            params += shlex.split(p.replace(DEFAULT_BRANCH, repo['default branch']))
+        _, status = git.git_run_status(repo_command, path=repo.name, redirect=False)
 
-        colour.write(f'Running review in [BOLD:{repo.name}]')
-        run_git_status(['review'] + params, repo.name, cont=True, redirect=False)
+        if status and not args.error_continue:
+            sys.exit(status)
 
 ################################################################################
 
-def find_configuration(args):
-    """If the configuration file name has path elements, try and read it, otherwise
-       search up the directory tree looking for the configuration file.
-       Returns configuration file path or None if the configuration file
-       could not be found."""
+def parse_command_line():
+    """Manually parse the command line as we want to be able to accept 'multigit <OPTIONS> <+MULTIGITCOMMAND | ANY_GIT_COMMAND_WITH_OPTIONS>
+       and I can't see a way to get ArgumentParser to accept arbitrary command+options"""
 
-    if '/' in args.config:
-        config_file = args.config
-    else:
-        config_path = os.getcwd()
-        config_file = os.path.join(config_path, args.config)
+    args = Arguments()
 
-        while not os.path.isfile(config_file) and config_path != '/':
-            config_path = os.path.dirname(config_path)
-            config_file = os.path.join(config_path, args.config)
+    # Expand arguments so that, for instance '-dv' is parsed as '-d -v'
 
-    return config_file if os.path.isfile(config_file) else None
+    argv = []
 
-################################################################################
+    for arg in sys.argv:
+        if arg[0] != '-' or arg.startswith('--'):
+            argv.append(arg)
+        else:
+            for c in arg[1:]:
+                argv.append('-' + c)
 
-def main():
-    """Main function"""
+    # Currently doesn't handle single letter options in concatenated form - e.g. -dv
 
-    commands = {
-       'init': mg_init,
-       'status': mg_status,
-       'fetch': mg_fetch,
-       'pull': mg_pull,
-       'push': mg_push,
-       'checkout':  mg_checkout,
-       'commit': mg_commit,
-       'update': mg_update,
-       'clean': mg_clean,
-       'dir': mg_dir,
-       'config': mg_config,
-       'run': mg_run,
-       'review': mg_review,
-    }
+    i = 1
+    while i < len(argv):
+        param = argv[i]
 
-    # Parse args in the form COMMAND OPTIONS SUBCOMMAND SUBCOMMAND_OPTIONS PARAMETERS
+        if param in ('--dryrun', '--dry-run', '-D'):
+            args.dryrun = True
 
-    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')
+        elif param in ('--debug', '-d'):
+            args.debug = True
 
-    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('--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 repo names to work on (defaults to all repos and can contain shell wildcards and can be issued multiple times on the command line)')
-    parser.add_argument('--modified', '-m', action='store_true', help='Select repos that have local modifications')
-    parser.add_argument('--branched', '-b', action='store_true', help='Select repos that do not have the default branch checked out')
+        elif param in ('--verbose', '-v'):
+            args.verbose = True
 
-    subparsers = parser.add_subparsers(dest='command')
+        elif param in ('--quiet', '-q'):
+            args.quiet = True
 
-    # Subcommands - currently just init, status, fetch, pull, push, with more to come
+        elif param in ('--config', '-c'):
+            try:
+                i += 1
+                args.configuration_file = argv[i]
+            except IndexError:
+                error('--config - missing configuration file parameter')
 
-    parser_init = subparsers.add_parser('init', help='Build or update the configuration file using the current branch in each repo as the default branch')
+        elif param in ('--repos', '-r'):
+            try:
+                i += 1
+                args.repos.append(argv[i])
+            except IndexError:
+                error('--repos - missing repo parameter')
 
-    parser_status = subparsers.add_parser('status', help='Report git status in every repo that has something to report')
-    parser_fetch = subparsers.add_parser('fetch', help='Run git fetch in every repo')
-    parser_pull = subparsers.add_parser('pull', help='Run git pull in every repo')
+        elif param in ('--modified', '-m'):
+            args.modified = True
 
-    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_push.add_argument('--force', '-f', action='store_true', help='Use --force-push-with-least to update a remote branch if the local branch has been rebased')
+        elif param in ('--branched', '-b'):
+            args.branched = True
 
-    parser_checkout = subparsers.add_parser('checkout', help='Checkout the specified branch')
-    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)')
+        elif param in ('--continue', '-C'):
+            args.error_continue = True
 
-    parser_commit = subparsers.add_parser('commit', help='Commit changes')
-    parser_commit.add_argument('--message', '-m', action='store', default=None, help='The commit message')
+        elif param in ('--help', '-h'):
+            print(HELP_INFO)
+            sys.exit(0)
 
-    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')
+        elif param[0] == '-':
+            error(f'Invalid option: "{param}"')
+        else:
+            break
 
-    parser_clean = subparsers.add_parser('clean', help='Remove untracked files from the working tree')
+        i += 1
 
-    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')
-    # TODO: 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.')
-    # TODO: 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.')
+    # After the options, we either have a multigit command (prefixed with '+') or a git command
+    # followed by parameter
 
-    parser_dir = subparsers.add_parser('dir', help='Return the location of a working tree, given the repo name')
-    parser_dir.add_argument('dir', nargs=1, action='store', help='The name of the working tree')
+    try:
+        if argv[i][0] == '+':
+            args.command = argv[i][1:]
+            args.internal_command = True
+        else:
+            args.command = argv[i]
+            args.internal_command = False
 
-    parser_config = subparsers.add_parser('config', help='Return the name and location of the configuration file')
+    except IndexError:
+        error('Missing command')
 
-    parser_run = subparsers.add_parser('run', help='Run any git command in each of the working trees')
-    parser_run.add_argument('--cont', '-c', action='store_true', help='Continue if the command returns an error in any of the working trees')
-    parser_run.add_argument('cmd', nargs='*', action='store', help='The command to run (the command may need to be quoted)')
+    args.parameters = argv[i+1:]
 
-    parser_review = subparsers.add_parser('review', help='Review the changes in a working tree')
-    parser_review.add_argument('parameters', nargs='*', action='store', help='Parameters passed to the "git review" command')
+    args.configuration_file = find_configuration(args)
 
-    # Parse the command line
+    return args
 
-    args = parser.parse_args()
+################################################################################
 
-    # Basic error checking
+def main():
+    """Main function"""
 
-    if not args.command:
-        error('No command specified')
+    commands = {
+       'init': mg_init,
+       'dir': mg_dir,
+       'config': mg_config,
+    }
+
+    args = parse_command_line()
 
-    if args.command not in commands:
-        error(f'Unrecognized command "{args.command}"')
+    if args.internal_command and args.command not in commands:
+        error(f'Invalid command "{args.command}"')
 
     # If the configuration file exists, read it
 
     config = configparser.ConfigParser()
 
-    args.config = find_configuration(args)
-
-    if args.config:
-        config.read(args.config)
-        os.chdir(os.path.dirname(args.config))
+    if not (args.internal_command and args.command == 'init'):
+        if not os.path.isfile(args.configuration_file):
+            error(f'Cannot read configuration file {args.configuration_file}')
 
-    # Command-specific validation
-
-    if args.command == 'init':
-        if args.modified or args.branched:
-            error('The "--modified" and "--branched" options cannot be used with the "init" subcommand')
-    elif not config:
-        error(f'Unable to location configuration file "{args.config}"')
+    if os.path.isfile(args.configuration_file):
+        config.read(args.configuration_file)
+        os.chdir(os.path.dirname(args.configuration_file))
 
     # Get the console size
 
@@ -678,15 +433,27 @@ def main():
         console = None
         args.quiet = True
 
-    # Run the subcommand
+    # Run an internal or external command-specific validation
+
+    if args.internal_command:
+        if args.command == 'init':
+            if args.modified or args.branched:
+                error('The "--modified" and "--branched" options cannot be used with the "init" subcommand')
+        elif not config:
+            error(f'Unable to location configuration file "{args.configuration_file}"')
+
+        # Run the subcommand
 
-    commands[args.command](args, config, console)
+        commands[args.command](args, config, console)
 
-    # Save the updated configuration file if it has changed (currently, only the init command will do this).
+        # Save the updated configuration file if it has changed (currently, only the init command will do this).
 
-    if config and args.command == 'init':
-        with open(args.config, 'w', encoding='utf8') as configfile:
-            config.write(configfile)
+        if config and args.command == 'init':
+            with open(args.configuration_file, 'w', encoding='utf8') as configfile:
+                config.write(configfile)
+
+    else:
+        run_git_command(args, config, console)
 
 ################################################################################
 

skilleter_thingy/thingy/git2.py

@@ -64,10 +64,12 @@ def git(cmd, stdout=None, stderr=None, path=None):
     if path:
         git_cmd += ['-C', path]
 
+    git_cmd += cmd if isinstance(cmd, list) else [cmd]
+
     logging.debug('Running %s', ' '.join(git_cmd + cmd))
 
     try:
-        return run.run(git_cmd + cmd, stdout=stdout, stderr=stderr)
+        return run.run(git_cmd, stdout=stdout, stderr=stderr)
     except run.RunError as exc:
         raise GitError(exc.msg, exc.status)
 
@@ -85,15 +87,17 @@ def git_run_status(cmd, stdout=None, stderr=None, path=None, redirect=True):
     if path:
         git_cmd += ['-C', path]
 
+    git_cmd += cmd if isinstance(cmd, list) else [cmd]
+
     if redirect:
-        result = subprocess.run(git_cmd + cmd,
+        result = subprocess.run(git_cmd,
                                 stdout=stdout or subprocess.PIPE,
                                 stderr=stderr or subprocess.PIPE,
                                 text=True, check=False,
                                 errors='ignore',
                                 universal_newlines=True)
     else:
-        result = subprocess.run(git_cmd + cmd)
+        result = subprocess.run(git_cmd)
 
     return (result.stdout or result.stderr), result.returncode
 

{skilleter_thingy-0.0.88.dist-info → skilleter_thingy-0.0.89.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.88
+Version: 0.0.89
 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
@@ -43,6 +43,12 @@ This is intended for use in a situation where you have a collection of related g
 
 Start by running ensuring that the default branch (e.g. `main`) is checked out in each of the working trees and, in the top-level directory, run `multigit init` to create the configuration file which, by default is called `multigit.toml` - this is just a text file that sets the configuration for each working tree in terms of name, origin, default branch and location.
 
+The multigit command line format is:
+
+    multigit OPTIONS COMMAND
+
+Where COMMAND is an internal multigit command if it starts with a '+' and is a git command otherwise.
+
 By default, when a multigit command, other than `init` is run, it runs a git command in each of the working trees. The command takes a number of options that can be used to select the list of working trees that each of the subcommands that it supports runs in:
 
 *--repos / -r* Allows a list of working trees to be specfied, either as the full or relative path, the name or a wildcard.
@@ -51,46 +57,27 @@ By default, when a multigit command, other than `init` is run, it runs a git com
 
 *--branched / -b* Run only working trees where the current branch that is checked out is NOT the default branch
 
-# TODO - Do we actually need any commands other than init, dir, config as everything else can be done via run?
-# TODO - Could just make the commands multigit +init/+dir/+config and then for anything else, just pass the whole of the command line to git once we've parsed the default branch?
-
-Multigit supports a (growing) list of subcommands:
-
-*init* - Create or update the configuration file
-
-*status* - Run `git status` in each of the working trees.
-
-*fetch* - Run `git fetch` in each of the working trees
-
-*pull* - Run `git pull` in each of the working trees
-
-*push* - Run `git push` in each of the working trees
-
-*co*
-
-*commit*
-
-*update*
+Multigit supports a small list of subcommands:
 
-*clean*
+*+init* - Create or update the configuration file
 
-*dir*
+*+dir* - Given the name of a working tree, prin the location within the multigit tree
 
-*config*
+*+config* - Print the name and location of the multigit configuration file.
 
-*review*
+Any command not prefixed with '+' is run in each of the working trees (filtered by the various multigit options) as a git command.
 
-*run*
+For example; `multigit -m commit -ab` would run `git commit -a` in each of the working trees that is branched and contains modified files.
 
 # Miscellaneous Git Utilities
 
 ## ggit
 
-Run a git command in all working trees under the current directory (note that this is not related to multigit (see below)).
+Run a git command in all working trees under the current directory (note that this is not related to multigit).
 
 ## ggrep
 
-Run 'git grep' in all repos under the current directory (note that this is not related to multigit (see below)).
+Run 'git grep' in all repos under the current directory (note that this is not related to multigit).
 
 ## gitprompt
 

{skilleter_thingy-0.0.88.dist-info → skilleter_thingy-0.0.89.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=E7Gsp4vnGEGicZXIt3GYFx6G1BOlPHAvftFSGuzQlas,27319
+skilleter_thingy/multigit.py,sha256=hAMF5glefQ82_tMs-zGXj-5FGkXpytQZO5hjqjqA95M,16212
 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=092CvXzdfYoinzB6QXD3zvJ3N2BwXDSd6ZXFgf8AmIg,37062
+skilleter_thingy/thingy/git2.py,sha256=WfX85zWz-0h3FiP1ME5VJ-OUBVMX9Vr2JGo401jk9oc,37156
 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.88.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
-skilleter_thingy-0.0.88.dist-info/METADATA,sha256=gXBQaiSXfgKjKq_tduHXU_lb0_4FKxjEBRMx87_JsSk,8239
-skilleter_thingy-0.0.88.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-skilleter_thingy-0.0.88.dist-info/entry_points.txt,sha256=u5ymS-KPljIGTnprV5yJsAjz7qgeT2BZ-Qo_Con_PFM,2145
-skilleter_thingy-0.0.88.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
-skilleter_thingy-0.0.88.dist-info/RECORD,,
+skilleter_thingy-0.0.89.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
+skilleter_thingy-0.0.89.dist-info/METADATA,sha256=m_ybn_cE_YK_cnxhqEmXKxyPm32Kx5cYWuRPwcqURUA,8236
+skilleter_thingy-0.0.89.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+skilleter_thingy-0.0.89.dist-info/entry_points.txt,sha256=u5ymS-KPljIGTnprV5yJsAjz7qgeT2BZ-Qo_Con_PFM,2145
+skilleter_thingy-0.0.89.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
+skilleter_thingy-0.0.89.dist-info/RECORD,,