skilleter-thingy 0.0.95__py3-none-any.whl → 0.0.96__py3-none-any.whl

skilleter_thingy/multigit.py

@@ -16,10 +16,12 @@ import thingy.colour as colour
 
 # DONE: / Output name of each git repo as it is processed as command sits there seeming to do nothing otherwise.
 # DONE: Better error-handling - e.g. continue/abort option after failure in one repo
+# DONE: Currently doesn't handle single letter options in concatenated form - e.g. -dv
 # DONE: Don't save the configuration on exit if it hasn't changed
 # DONE: Don't use a fixed list of default branch names
 # 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
 # DONE: Use the configuration file
+# DONE: command to categorise repos then command line filter to only act on repos in category (in addition to other filtering options) - +tag <TAG> command tags all selected repors and updates the configuration, +untag <TAG> command to remove tags in the same way
 # DONE: init function
 # NOPE: Dry-run option - just pass the option to the Git command
 # NOPE: Is it going to be a problem if the same repo is checked out twice or more in the same workspace - user problem
@@ -29,9 +31,12 @@ import thingy.colour as colour
 # TODO: Command that takes partial repo name and either returns full path or pops up window to autocomplete until single match found
 # TODO: Consistent colours in output
 # TODO: If run in a subdirectory, only process repos in that tree (or have an option to do so)
+# TODO: Option to +dir to return all matches so that caller can select one they want
 # TODO: Verbose option
+# TODO: When filtering by tag, if tag starts with '!' only match if tag isn't present (and don't allow '!' at start of tag otherwise)
 # TODO: When specifying list of repos, if repo name doesn't contain '/' prefix it with '*'?
 # TODO: select_git_repos() and +dir should use consist way of selecting repos if possible
+# TODO: +run command to do things other than git commands
 ################################################################################
 
 DEFAULT_CONFIG_FILE = 'multigit.toml'
@@ -43,16 +48,13 @@ DEFAULT_BRANCH = 'DEFAULT'
 
 ################################################################################
 
-HELP_INFO = """usage: multigit [-h] [--dryrun] [--debug] [--verbose] [--quiet] [--config CONFIG] [--directory DIRECTORY] [--repos REPOS] [--modified] [--branched]
+HELP_INFO = """usage: multigit [-h] [--verbose] [--quiet] [--config CONFIG] [--directory DIRECTORY] [--repos REPOS] [--modified] [--branched] [--tag TAGS]
                 {+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
@@ -63,6 +65,7 @@ options:
                         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
+  --tag TAG, -t TAG     Select repos that have the specified tag (can be issued multiple times on the command line)
   --continue, -C        Continue if a git command returns an error (by default, executation terminates when a command fails)
 
 Sub-commands:
@@ -70,6 +73,8 @@ Sub-commands:
     +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, or if no parameter specified, the root directory of the multigit tree
+    +tag TAG             Apply a configuration tag to repos filtered by the command line options (list configuration tags if no parameter specified)
+    +untag TAG           Remove a configuration tag to repos filtered by the command line options
     GIT_COMMAND          Any git command, including options and parameters - this is then run in all specified working trees
 
 """
@@ -80,19 +85,19 @@ Sub-commands:
 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)
+    tag: 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
+    config_modified: bool = False
 
 ################################################################################
 
@@ -170,26 +175,27 @@ def find_git_repos(args):
 
 def select_git_repos(args, config):
     """Return git repos from the configuration that match the criteria on the
-       multigit command line (the --repos, --modified and --branched options)
+       multigit command line (the --repos, --tag, --modified and --branched options)
        or, return them all if no relevant options specified"""
 
-    for repo in config.sections():
-        # If repos are specified, then only match according to wildcards, full
-        # path or just basename.
+    for repo_path in config.sections():
+        # If repos are specified, then only match according to exact name match,
+        # exact path match or wildcard match
 
         if args.repos:
             for entry in args.repos:
+                if config[repo_path]['repo name'] == entry:
+                    matching = True
+                    break
+
+                if repo_path == entry:
+                    matching = True
+                    break
+
                 if '?' in entry or '*' in entry:
-                    if fnmatch.fnmatch(repo, entry):
+                    if fnmatch.fnmatch(repo_path, entry) or fnmatch.fnmatch(config[repo_path]['repo name'], entry):
                         matching = True
                         break
-                elif '/' in entry:
-                    if repo == entry:
-                        matching = True
-                        break
-                elif os.path.basename(repo) == entry:
-                    matching = True
-                    break
 
             else:
                 matching = False
@@ -199,17 +205,32 @@ def select_git_repos(args, config):
         # If branched specified, only match if the repo is matched _and_ branched
 
         if matching and args.branched:
-            if git.branch(path=repo) == config[repo]['default branch']:
+            if git.branch(path=repo_path) == config[repo_path]['default branch']:
                 matching = False
 
         # If modified specified, only match if the repo is matched _and_ modified
 
         if matching and args.modified:
-            if not git.status(path=repo):
+            if not git.status(path=repo_path):
+                matching = False
+
+        # If tag filtering specified, only match if the repo is tagged with one of the specified tags
+
+        if matching and args.tag:
+            for entry in args.tag:
+                try:
+                    tags = config[repo_path]['tags'].split(',')
+                    if entry in tags:
+                        break
+                except KeyError:
+                    pass
+            else:
                 matching = False
 
+        # If we have a match, yield the config entry to the caller
+
         if matching:
-            yield config[repo]
+            yield config[repo_path]
 
 ################################################################################
 
@@ -227,8 +248,8 @@ def mg_init(args, config, console):
 
     # Sanity checks
 
-    if args.modified or args.branched:
-        error('The "--modified" and "--branched" options cannot be used with the "init" subcommand')
+    if args.modified or args.branched or args.tag:
+        error('The "--tag", "--modified" and "--branched" options cannot be used with the "init" subcommand')
     elif not config:
         error(f'Unable to location configuration file "{args.configuration_file}"')
 
@@ -253,6 +274,8 @@ def mg_init(args, config, console):
         else:
             config[repo]['repo name'] = os.path.basename(repo)
 
+    args.config_modified = True
+
 ################################################################################
 
 def mg_dir(args, config, console):
@@ -288,12 +311,15 @@ def mg_dir(args, config, console):
                 elif fnmatch.fnmatch(repo['repo name'], f'*{search_name}*'):
                     wild_location.append(repo.name)
 
+        # Look for a single exact match, a prefix with '*' match or prefix+suffix
+
         destination = None
         for destinations in (location, wild_prefix_location, wild_location):
             if len(destinations) == 1:
                 destination = destinations
                 break
-            elif len(destinations) > 1:
+
+            if len(destinations) > 1:
                 destination = destinations
 
         if not destination:
@@ -308,6 +334,51 @@ def mg_dir(args, config, console):
 
 ################################################################################
 
+def mg_tag(args, config, console):
+    """Apply a configuration tag"""
+
+    _ = console
+
+    if len(args.parameters) > 1:
+        error('The +tag command takes no more than one parameter')
+
+    for repo in select_git_repos(args, config):
+        try:
+            tags = repo.get('tags').split(',')
+        except AttributeError:
+            tags = []
+
+        if args.parameters:
+            if args.parameters[0] not in tags:
+                tags.append(args.parameters[0])
+                repo['tags'] = ','.join(tags)
+                args.config_modified = True
+        elif tags:
+            colour.write(f'[BOLD:{repo["repo name"]}] - {", ".join(tags)}')
+
+################################################################################
+
+def mg_untag(args, config, console):
+    """Remove a configuration tag"""
+
+    _ = console
+
+    if len(args.parameters) > 1:
+        error('The +tag command takes no more than one parameter')
+
+    for repo in select_git_repos(args, config):
+        try:
+            tags = repo.get('tags', '').split(',')
+        except AttributeError:
+            tags = []
+
+        if args.parameters[0] in tags:
+            tags.remove(args.parameters[0])
+            repo['tags'] = ','.join(tags)
+            args.config_modified = True
+
+################################################################################
+
 def mg_config(args, config, console):
     """Output the path to the configuration file"""
 
@@ -359,19 +430,13 @@ def parse_command_line():
             for c in arg[1:]:
                 argv.append('-' + c)
 
-    # Currently doesn't handle single letter options in concatenated form - e.g. -dv
+    # Parse the command line
 
     i = 1
     while i < len(argv):
         param = argv[i]
 
-        if param in ('--dryrun', '--dry-run', '-D'):
-            args.dryrun = True
-
-        elif param in ('--debug', '-d'):
-            args.debug = True
-
-        elif param in ('--verbose', '-v'):
+        if param in ('--verbose', '-v'):
             args.verbose = True
 
         elif param in ('--quiet', '-q'):
@@ -391,6 +456,13 @@ def parse_command_line():
             except IndexError:
                 error('--repos - missing repo parameter')
 
+        elif param in ('--tag', '-t'):
+            try:
+                i += 1
+                args.tag.append(argv[i])
+            except IndexError:
+                error('--tag - missing tag parameter')
+
         elif param in ('--modified', '-m'):
             args.modified = True
 
@@ -440,6 +512,8 @@ def main():
        'init': mg_init,
        'dir': mg_dir,
        'config': mg_config,
+       'tag': mg_tag,
+       'untag': mg_untag,
     }
 
     args = parse_command_line()
@@ -478,7 +552,7 @@ def main():
 
         # Save the updated configuration file if it has changed (currently, only the init command will do this).
 
-        if config and args.command == 'init':
+        if config and args.config_modified:
             with open(args.configuration_file, 'w', encoding='utf8') as configfile:
                 config.write(configfile)
 

{skilleter_thingy-0.0.95.dist-info → skilleter_thingy-0.0.96.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: skilleter_thingy
-Version: 0.0.95
+Version: 0.0.96
 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
@@ -50,15 +50,21 @@ The multigit command line format is:
 
 Where COMMAND is an internal multigit command if it starts with a '+' and is a git command otherwise.
 
-By default, when multigit is invoked with a git command, it runs a the command in each of the working trees selected by the command line options passed to multigit (if no options are specified then the command is run in all the working trees. 
+By default, when multigit is invoked with a git command, it runs a the command in each of the working trees selected by the command line options passed to multigit (if no options are specified then the command is run in *all* 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.
+*--repos REPO / -r REPO* Allows a list of working trees to be specfied, either by path, name or a wildcard matching either.
 
 *--modified / -m* Run only in working trees containing locally modified files
 
-*--branched / -b* Run only working trees where the current branch that is checked out is NOT the default branch
+*--branched / -b* Run only in working trees where the current branch that is checked out is NOT the default branch
+
+*--tag TAG / -t TAG* Run only in working trees that are tagged with the specified tag
+
+These options are AND-ed together, so specifying `--modified --branched --tag WOMBAT` will select only working trees that are modified AND branched AND tagged with 'WOMBAT', but the parameters to the `--repos` and `--tag` options are OR-ed together, so specifying `--tag WOMBAT --tag EMU` will select repos that are tagged as `WOMBAT` *OR* `EMU`.
+
+Multigit tags are stored in the configuration file, not within the working tree and each working tree can have multiple tags.
 
 Multigit supports a small list of subcommands, each of which are prefixed with a `+` to distinguish them from Git commands:
 
@@ -68,6 +74,10 @@ Multigit supports a small list of subcommands, each of which are prefixed with a
 
 *+config* - Print the name and location of the multigit configuration file.
 
+*+tag TAG* - If no tag specified list tags applied to the specified working trees. If a tag *is* specified, then *apply* the tag to the specified working trees.
+
+*+untag TAG* - Remove the tag from the specified working trees (do nothing if the tag is not applied in the first place).
+
 Any command not prefixed with '+' is run in each of the working trees (filtered by the various multigit options) as a git command.
 
 For example; `multigit -m commit -ab` would run `git commit -a` in each of the working trees that is branched and contains modified files.

{skilleter_thingy-0.0.95.dist-info → skilleter_thingy-0.0.96.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=ehTN6VD76i4U5k6dXuYoiqSRHI67_BP-bziklNAJSKY,4309
 skilleter_thingy/moviemover.py,sha256=QzUAWQzQ1AWWREIhl-VMaLo2h8MMhOekBnao5jGWV1s,4470
-skilleter_thingy/multigit.py,sha256=4NoT1rtsj2rO8MzilOGwb4dRh_gBZzVWVs5NqEVTMPQ,17885
+skilleter_thingy/multigit.py,sha256=vcwVtjDVehnheP2Kr0WtxtH6tbhwK8w90uK55AE7Fns,20908
 skilleter_thingy/photodupe.py,sha256=l0hbzSLb2Vk2ceteg-x9fHXCEE1uUuFo84hz5rsZUPA,4184
 skilleter_thingy/phototidier.py,sha256=BOu-cKHMivDlBqlRqv7sL3J6Ix1K2dxWWNcderldyZo,7818
 skilleter_thingy/py_audit.py,sha256=xJm5k5qyeA6ii8mODa4dOkmP8L1drv94UHuxR54RsIM,4384
@@ -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.95.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
-skilleter_thingy-0.0.95.dist-info/METADATA,sha256=lPNdi82HQgWSYHv74vHD2EYglAYtSOiQCtyQ4DXhz10,8894
-skilleter_thingy-0.0.95.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-skilleter_thingy-0.0.95.dist-info/entry_points.txt,sha256=u5ymS-KPljIGTnprV5yJsAjz7qgeT2BZ-Qo_Con_PFM,2145
-skilleter_thingy-0.0.95.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
-skilleter_thingy-0.0.95.dist-info/RECORD,,
+skilleter_thingy-0.0.96.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
+skilleter_thingy-0.0.96.dist-info/METADATA,sha256=uHydWMbSFN811U97D-3OTxf5pIV_KNCAcFkN5i0rkRI,9746
+skilleter_thingy-0.0.96.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+skilleter_thingy-0.0.96.dist-info/entry_points.txt,sha256=u5ymS-KPljIGTnprV5yJsAjz7qgeT2BZ-Qo_Con_PFM,2145
+skilleter_thingy-0.0.96.dist-info/top_level.txt,sha256=8-JhgToBBiWURunmvfpSxEvNkDHQQ7r25-aBXtZv61g,17
+skilleter_thingy-0.0.96.dist-info/RECORD,,