Python/apps/py-cutils: cutils/treesum.py comparison

comparison cutils/treesum.py @ 300:1fc117f5f9a1

treesum: Implement --include/--exclude commandline parsing for file name inclusion and exclusion. BUGS: - Real filename matching not yet implemented - Pattern description only very rudimentary

author	Franz Glasner <fzglas.hg@dom66.de>
date	Tue, 04 Mar 2025 16:30:10 +0100
parents	bcbc68d8aa12
children	d246b631b85a

comparison

equal deleted inserted replaced

-:bcbc68d8aa12
+:1fc117f5f9a1
 from . import (__version__, __revision__)
 from . import util
 from .util import cm
 from .util import digest
+from .util import fnmatch
 from .util import walk
 from .util.crc32 import crc32
 def main(argv=None):
 gp.add_argument(
 "--comment", action="append", default=[],
 help="Put given comment COMMENT into the output as \"COMMENT\". "
 "Can be given more than once.")
 gp.add_argument(
+"--exclude", "-X", action=PatternMatchAction, kind="exclude",
+dest="fnmatch_filters", metavar="PATTERN",
+help="""Exclude names matching the given PATTERN.
+For help on PATTERN use \"help patterns\".""")
+gp.add_argument(
 "--follow-directory-symlinks", "-l", action=SymlinkAction,
 const="follow-directory-symlinks",
 default=FollowSymlinkConfig(False, False, True),
 dest="follow_symlinks",
 help="""Follow symbolic links to directories when walking a
 help="""Follow symbolic links given on the command line but do
 not follow symlinks while traversing the directory tree.
 Overwrites any other symlink related options
 (--physical, --logical, -p, --no-follow-directory-symlinks,
 --no-follow-file-symlinks, et al.).""")
+gp.add_argument(
+"--include", "-I", action=PatternMatchAction, kind="include",
+dest="fnmatch_filters", metavar="PATTERN",
+help="""Include names matching the given PATTERN.
+For help on PATTERN use \"help patterns\".""")
 gp.add_argument(
 "--logical", "-L", action=SymlinkAction, dest="follow_symlinks",
 const=FollowSymlinkConfig(True, True, True),
 help="""Follow symbolic links everywhere: on command line
 arguments and -- while walking -- directory and file symbolic links.
 hparser = subparsers.add_parser(
 "help",
 help="Show this help message or a subcommand's help and exit",
 description="Show this help message or a subcommand's help and exit.")
 hparser.add_argument("help_command", nargs='?', metavar="COMMAND")
+patparser = subparsers.add_parser(
+"patterns",
+help="Show the help for PATTERNs and exit",
+description=fnmatch.HELP_DESCRIPTION,
+formatter_class=argparse.RawDescriptionHelpFormatter)
 vparser = subparsers.add_parser(
 "version",
 help="Show the program's version number and exit",
 description="Show the program's version number and exit.")
 infoparser.print_help()
 elif opts.help_command == "version":
 vparser.print_help()
 elif opts.help_command == "help":
 hparser.print_help()
+elif opts.help_command == "patterns":
+patparser.print_help()
 else:
 parser.print_help()
 return 0
 # Reparse strictly
 stream=sys.stderr,
 format="[%(asctime)s][%(levelname)s][%(process)d:%(name)s] %(message)s"
 )
 logging.captureWarnings(True)
-return treesum(opts)
+return treesum(opts, patparser=patparser)
 FollowSymlinkConfig = collections.namedtuple("FollowSymlinkConfig",
 ["command_line",
 "directory",
 assert False, "Implementation error: not yet implemented"
 setattr(namespace, self.dest, curval)
+class PatternMatchAction(argparse.Action):
+def __init__(self, *args, **kwargs):
+if "nargs" in kwargs:
+raise argparse.ArgumentError(None, "`nargs' not allowed")
+if "type" in kwargs:
+raise argparse.ArgumentError(None, "`type' not allowed")
+kwargs["nargs"] = 1
+self.__kind = kwargs.pop("kind", None)
+if self.__kind is None:
+raise argparse.ArgumentError(None, "`kind' is required")
+if self.__kind not in ("exclude", "include"):
+raise argparse.ArgumentError(
+None, "`kind' must be one of `include' or `exclude'")
+super(PatternMatchAction, self).__init__(*args, **kwargs)
+def __call__(self, parser, namespace, values, option_string=None):
+items = getattr(namespace, self.dest, None)
+if items is None:
+items = []
+setattr(namespace, self.dest, items)
+for v in values:
+items.append((self.__kind, v))
 def gen_generate_opts(directories=[],
 algorithm=util.default_algotag(),
 append_output=False,
 base64=False,
 comment=[],
+fnmatch_filters=[],
 follow_symlinks=FollowSymlinkConfig(False, False, False),
 full_mode=False,
 generator="normal",
 logical=None,
 minimal=None,
 print_size=False,
 size_only=False,
 utf8=False):
 if not isinstance(follow_symlinks, FollowSymlinkConfig):
 raise TypeError("`follow_symlinks' must be a FollowSymlinkConfig")
+if not isinstance(fnmatch_filters, (list, tuple, type(None))):
+raise TypeError("`fnmatch_filters' must be a sequence (list, tuple)")
+if fnmatch_filters:
+for f in fnmatch_filters:
+if not isinstance(f, (tuple, list)):
+raise TypeError(
+"items in `fnmatch_filters' must be tuples or lists")
+if f[0] not in ("exclude", "include"):
+raise ValueError(
+"every kind of every item in `fnmatch_filters' must be"
+" \"include\" or \"exclude\""
+)
 # Not following symlinks to files is not yet supported: reset to True
 #    if not follow_symlinks.file:
 #        follow_symlinks = follow_symlinks._make([follow_symlinks.command_line,
 #                                                 follow_symlinks.directory,
 #                                                 True])
 directories=directories,
 algorithm=util.argv2algo(algorithm),
 append_output=append_output,
 base64=base64,
 comment=comment,
+fnmatch_filters=fnmatch_filters,
 follow_symlinks=follow_symlinks,
 generator=generator,
 logical=logical,
 minimal=minimal,
 mmap=mmap,
 digest_files=digest_files,
 print_only_last_block=last)
 return opts
-def treesum(opts):
+def treesum(opts, patparser=None):
 # XXX TBD: opts.check and opts.checklist (as in shasum.py)
 if opts.subcommand in ("generate", "gen"):
 return generate_treesum(opts)
 elif opts.subcommand == "info":
 return print_treesum_digestfile_infos(opts)
+elif opts.subcommand == "patterns":
+patparser.print_help()
 else:
 raise RuntimeError(
 "command `{}' not yet handled".format(opts.subcommand))

Mercurial > hgrepos > Python > apps > py-cutils

comparison cutils/treesum.py @ 300:1fc117f5f9a1