eric: comparison eric7/DebugClients/Python/coverage/cmdline.py

-:d728227e8ebb
+:0802ae193343
 # Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
 # For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt
 """Command-line support for coverage.py."""
-from __future__ import print_function
 import glob
-import optparse
+import optparse     # pylint: disable=deprecated-module
+import os
 import os.path
 import shlex
 import sys
 import textwrap
 import traceback
 from coverage import Coverage
 from coverage import env
 from coverage.collector import CTracer
 from coverage.data import line_counts
 from coverage.debug import info_formatter, info_header, short_stack
+from coverage.exceptions import BaseCoverageException, ExceptionDuringRun, NoSource
 from coverage.execfile import PyRunner
-from coverage.misc import BaseCoverageException, ExceptionDuringRun, NoSource, output_encoding
+from coverage.misc import human_sorted
-from coverage.results import should_fail_under
+from coverage.results import Numbers, should_fail_under
-class Opts(object):
+class Opts:
 """A namespace class for individual options we'll build parsers from."""
 append = optparse.make_option(
 '-a', '--append', action='store_true',
 help="Append coverage data to .coverage, otherwise it starts clean each time.",
 ]
 concurrency = optparse.make_option(
 '', '--concurrency', action='store', metavar="LIB",
 choices=CONCURRENCY_CHOICES,
 help=(
-"Properly measure code using a concurrency library. "
+"Properly measure code using a concurrency library. " +
-"Valid values are: %s."
+"Valid values are: {}."
-) % ", ".join(CONCURRENCY_CHOICES),
+).format(", ".join(CONCURRENCY_CHOICES)),
 )
 context = optparse.make_option(
 '', '--context', action='store', metavar="LABEL",
 help="The context label to record for this coverage run.",
+)
+contexts = optparse.make_option(
+'', '--contexts', action='store',
+metavar="REGEX1,REGEX2,...",
+help=(
+"Only display data from lines covered in the given contexts. " +
+"Accepts Python regexes, which must be quoted."
+),
 )
 debug = optparse.make_option(
 '', '--debug', action='store', metavar="OPTS",
 help="Debug options, separated by commas. [env: COVERAGE_DEBUG]",
 )
 )
 include = optparse.make_option(
 '', '--include', action='store',
 metavar="PAT1,PAT2,...",
 help=(
-"Include only files whose paths match one of these patterns. "
+"Include only files whose paths match one of these patterns. " +
 "Accepts shell-style wildcards, which must be quoted."
 ),
 )
 pylib = optparse.make_option(
 '-L', '--pylib', action='store_true',
 help=(
-"Measure coverage even inside the Python installed library, "
+"Measure coverage even inside the Python installed library, " +
 "which isn't done by default."
 ),
-)
-sort = optparse.make_option(
-'--sort', action='store', metavar='COLUMN',
-help="Sort the report by the named column: name, stmts, miss, branch, brpart, or cover. "
-"Default is name."
 )
 show_missing = optparse.make_option(
 '-m', '--show-missing', action='store_true',
 help="Show line numbers of statements in each module that weren't executed.",
 )
-skip_covered = optparse.make_option(
+module = optparse.make_option(
-'--skip-covered', action='store_true',
+'-m', '--module', action='store_true',
-help="Skip files with 100% coverage.",
+help=(
-)
+"<pyfile> is an importable Python module, not a script path, " +
-no_skip_covered = optparse.make_option(
+"to be run as 'python -m' would run it."
-'--no-skip-covered', action='store_false', dest='skip_covered',
+),
-help="Disable --skip-covered.",
-)
-skip_empty = optparse.make_option(
-'--skip-empty', action='store_true',
-help="Skip files with no code.",
-)
-show_contexts = optparse.make_option(
-'--show-contexts', action='store_true',
-help="Show contexts for covered lines.",
 )
 omit = optparse.make_option(
 '', '--omit', action='store',
 metavar="PAT1,PAT2,...",
 help=(
-"Omit files whose paths match one of these patterns. "
+"Omit files whose paths match one of these patterns. " +
 "Accepts shell-style wildcards, which must be quoted."
-),
-)
-contexts = optparse.make_option(
-'', '--contexts', action='store',
-metavar="REGEX1,REGEX2,...",
-help=(
-"Only display data from lines covered in the given contexts. "
-"Accepts Python regexes, which must be quoted."
 ),
 )
 output_xml = optparse.make_option(
 '-o', '', action='store', dest="outfile",
 metavar="OUTFILE",
 help="Format the JSON for human readers.",
 )
 parallel_mode = optparse.make_option(
 '-p', '--parallel-mode', action='store_true',
 help=(
-"Append the machine name, process id and random number to the "
+"Append the machine name, process id and random number to the " +
-".coverage data file name to simplify collecting data from "
+".coverage data file name to simplify collecting data from " +
 "many processes."
-),
-)
-module = optparse.make_option(
-'-m', '--module', action='store_true',
-help=(
-"<pyfile> is an importable Python module, not a script path, "
-"to be run as 'python -m' would run it."
 ),
 )
 precision = optparse.make_option(
 '', '--precision', action='store', metavar='N', type=int,
 help=(
-"Number of digits after the decimal point to display for "
+"Number of digits after the decimal point to display for " +
 "reported coverage percentages."
 ),
+)
+quiet = optparse.make_option(
+'-q', '--quiet', action='store_true',
+help="Don't print messages about what is happening.",
 )
 rcfile = optparse.make_option(
 '', '--rcfile', action='store',
 help=(
-"Specify configuration file. "
+"Specify configuration file. " +
-"By default '.coveragerc', 'setup.cfg', 'tox.ini', and "
+"By default '.coveragerc', 'setup.cfg', 'tox.ini', and " +
 "'pyproject.toml' are tried. [env: COVERAGE_RCFILE]"
 ),
+)
+show_contexts = optparse.make_option(
+'--show-contexts', action='store_true',
+help="Show contexts for covered lines.",
+)
+skip_covered = optparse.make_option(
+'--skip-covered', action='store_true',
+help="Skip files with 100% coverage.",
+)
+no_skip_covered = optparse.make_option(
+'--no-skip-covered', action='store_false', dest='skip_covered',
+help="Disable --skip-covered.",
+)
+skip_empty = optparse.make_option(
+'--skip-empty', action='store_true',
+help="Skip files with no code.",
+)
+sort = optparse.make_option(
+'--sort', action='store', metavar='COLUMN',
+help="Sort the report by the named column: name, stmts, miss, branch, brpart, or cover. " +
+"Default is name."
 )
 source = optparse.make_option(
 '', '--source', action='store', metavar="SRC1,SRC2,...",
-help="A list of packages or directories of code to be measured.",
+help="A list of directories or importable names of code to measure.",
 )
 timid = optparse.make_option(
 '', '--timid', action='store_true',
 help=(
-"Use a simpler but slower trace method. Try this if you get "
+"Use a simpler but slower trace method. Try this if you get " +
 "seemingly impossible results!"
 ),
 )
 title = optparse.make_option(
 '', '--title', action='store', metavar="TITLE",
 '', '--version', action='store_true',
 help="Display version information and exit.",
 )
-class CoverageOptionParser(optparse.OptionParser, object):
+class CoverageOptionParser(optparse.OptionParser):
 """Base OptionParser for coverage.py.
 Problems don't exit the program.
 Defaults are initialized for all options.
 """
 def __init__(self, *args, **kwargs):
-super(CoverageOptionParser, self).__init__(
+super().__init__(
 add_help_option=False, *args, **kwargs
 )
 self.set_defaults(
 action=None,
 append=None,
 branch=None,
 concurrency=None,
 context=None,
+contexts=None,
 debug=None,
 directory=None,
 fail_under=None,
 help=None,
 ignore_errors=None,
 include=None,
 keep=None,
 module=None,
 omit=None,
-contexts=None,
 parallel_mode=None,
 precision=None,
 pylib=None,
+quiet=None,
 rcfile=True,
+show_contexts=None,
 show_missing=None,
 skip_covered=None,
 skip_empty=None,
-show_contexts=None,
 sort=None,
 source=None,
 timid=None,
 title=None,
 version=None,
 (ok, options, args)
 """
 try:
-options, args = super(CoverageOptionParser, self).parse_args(args, options)
+options, args = super().parse_args(args, options)
 except self.OptionParserError:
 return False, None, None
 return True, options, args
 def error(self, msg):
 class GlobalOptionParser(CoverageOptionParser):
 """Command-line parser for coverage.py global option arguments."""
 def __init__(self):
-super(GlobalOptionParser, self).__init__()
+super().__init__()
 self.add_options([
 Opts.help,
 Opts.version,
 ])
 `description` is the description of the command, for the help text.
 """
 if usage:
 usage = "%prog " + usage
-super(CmdOptionParser, self).__init__(
+super().__init__(
 usage=usage,
 description=description,
 )
 self.set_defaults(action=action, **(defaults or {}))
 self.add_options(options)
 self.cmd = action
 def __eq__(self, other):
 # A convenience equality, so that I can put strings in unit test
 # results, and they will compare equal to objects.
-return (other == "<CmdOptionParser:%s>" % self.cmd)
+return (other == f"<CmdOptionParser:{self.cmd}>")
 __hash__ = None     # This object doesn't need to be hashed.
 def get_prog_name(self):
 """Override of an undocumented function in optparse.OptionParser."""
-program_name = super(CmdOptionParser, self).get_prog_name()
+program_name = super().get_prog_name()
 # Include the sub-command for this parser as part of the command.
-return "{command} {subcommand}".format(command=program_name, subcommand=self.cmd)
+return f"{program_name} {self.cmd}"
 GLOBAL_ARGS = [
 Opts.debug,
 Opts.help,
 Opts.include,
 Opts.omit,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
 description=(
-"Make annotated copies of the given files, marking statements that are executed "
+"Make annotated copies of the given files, marking statements that are executed " +
 "with > and statements that are missed with !."
 ),
 ),
 'combine': CmdOptionParser(
 "combine",
 [
 Opts.append,
 Opts.keep,
+Opts.quiet,
 ] + GLOBAL_ARGS,
 usage="[options] <path1> <path2> ... <pathN>",
 description=(
-"Combine data from multiple coverage files collected "
+"Combine data from multiple coverage files collected " +
-"with 'run -p'.  The combined results are written to a single "
+"with 'run -p'.  The combined results are written to a single " +
-"file representing the union of the data. The positional "
+"file representing the union of the data. The positional " +
-"arguments are data files or directories containing data files. "
+"arguments are data files or directories containing data files. " +
-"If no paths are provided, data files in the default data file's "
+"If no paths are provided, data files in the default data file's " +
 "directory are combined."
 ),
 ),
 'debug': CmdOptionParser(
 "debug", GLOBAL_ARGS,
 usage="<topic>",
 description=(
-"Display information about the internals of coverage.py, "
+"Display information about the internals of coverage.py, " +
-"for diagnosing problems. "
+"for diagnosing problems. " +
-"Topics are: "
+"Topics are: " +
-"'data' to show a summary of the collected data; "
+"'data' to show a summary of the collected data; " +
-"'sys' to show installation information; "
+"'sys' to show installation information; " +
-"'config' to show the configuration; "
+"'config' to show the configuration; " +
 "'premain' to show what is calling coverage."
 ),
 ),
 'erase': CmdOptionParser(
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.precision,
+Opts.quiet,
 Opts.show_contexts,
 Opts.skip_covered,
 Opts.no_skip_covered,
 Opts.skip_empty,
 Opts.title,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
 description=(
-"Create an HTML report of the coverage of the files.  "
+"Create an HTML report of the coverage of the files.  " +
-"Each file gets its own page, with the source decorated to show "
+"Each file gets its own page, with the source decorated to show " +
 "executed, excluded, and missed lines."
 ),
 ),
 'json': CmdOptionParser(
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.output_json,
 Opts.json_pretty_print,
+Opts.quiet,
 Opts.show_contexts,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
 description="Generate a JSON report of coverage results."
 ),
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.output_xml,
+Opts.quiet,
 Opts.skip_empty,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
 description="Generate an XML report of coverage results."
 ),
 else:
 help_params['extension_modifier'] = 'without C extension'
 if error:
 print(error, file=sys.stderr)
-print("Use '%s help' for help." % (program_name,), file=sys.stderr)
+print(f"Use '{program_name} help' for help.", file=sys.stderr)
 elif parser:
 print(parser.format_help().strip())
 print()
 else:
 help_msg = textwrap.dedent(HELP_TOPICS.get(topic, '')).strip()
 if help_msg:
 print(help_msg.format(**help_params))
 else:
-print("Don't know topic %r" % topic)
+print(f"Don't know topic {topic!r}")
 print("Full documentation is at {__url__}".format(**help_params))
 OK, ERR, FAIL_UNDER = 0, 1, 2
-class CoverageScript(object):
+class CoverageScript:
 """The command-line interface to coverage.py."""
 def __init__(self):
 self.global_option = False
 self.coverage = None
 if self.global_option:
 parser = GlobalOptionParser()
 else:
 parser = CMDS.get(argv[0])
 if not parser:
-show_help("Unknown command: '%s'" % argv[0])
+show_help(f"Unknown command: {argv[0]!r}")
 return ERR
 argv = argv[1:]
 ok, options, args = parser.parse_args_ok(argv)
 if not ok:
 include=include,
 debug=debug,
 concurrency=options.concurrency,
 check_preimported=True,
 context=options.context,
+messages=not options.quiet,
 )
 if options.action == "debug":
 return self.do_debug(args)
 outfile=outfile,
 pretty_print=options.pretty_print,
 show_contexts=options.show_contexts,
 **report_args
 )
+else:
+# There are no other possible actions.
+raise AssertionError
 if total is not None:
 # Apply the command line fail-under options, and then use the config
 # value, so we can get fail_under from the config file.
 if options.fail_under is not None:
 self.coverage.set_option("report:fail_under", options.fail_under)
 fail_under = self.coverage.get_option("report:fail_under")
 precision = self.coverage.get_option("report:precision")
 if should_fail_under(total, fail_under, precision):
-msg = "total of {total:.{p}f} is less than fail-under={fail_under:.{p}f}".format(
+msg = "total of {total} is less than fail-under={fail_under:.{p}f}".format(
-total=total, fail_under=fail_under, p=precision,
+total=Numbers(precision=precision).display_covered(total),
+fail_under=fail_under,
+p=precision,
 )
 print("Coverage failure:", msg)
 return FAIL_UNDER
 return OK
 show_help("No module specified for -m")
 return ERR
 command_line = self.coverage.get_option("run:command_line")
 if command_line is not None:
 args = shlex.split(command_line)
-if args and args[0] == "-m":
+if args and args[0] in {"-m", "--module"}:
 options.module = True
 args = args[1:]
 if not args:
 show_help("Nothing to do.")
 return ERR
 for opt_name in ['branch', 'include', 'omit', 'pylib', 'source', 'timid']:
 # As it happens, all of these options have no default, meaning
 # they will be None if they have not been specified.
 if getattr(options, opt_name) is not None:
 show_help(
-"Options affecting multiprocessing must only be specified "
+"Options affecting multiprocessing must only be specified " +
-"in a configuration file.\n"
+"in a configuration file.\n" +
-"Remove --{} from the command line.".format(opt_name)
+f"Remove --{opt_name} from the command line."
 )
 return ERR
+os.environ["COVERAGE_RUN"] = "true"
 runner = PyRunner(args, as_module=bool(options.module))
 runner.prepare()
 if options.append:
 for info in args:
 if info == 'sys':
 sys_info = self.coverage.sys_info()
 print(info_header("sys"))
 for line in info_formatter(sys_info):
-print(" %s" % line)
+print(f" {line}")
 elif info == 'data':
 self.coverage.load()
 data = self.coverage.get_data()
 print(info_header("data"))
-print("path: %s" % data.data_filename())
+print(f"path: {data.data_filename()}")
 if data:
-print("has_arcs: %r" % data.has_arcs())
+print(f"has_arcs: {data.has_arcs()!r}")
 summary = line_counts(data, fullpath=True)
-filenames = sorted(summary.keys())
+filenames = human_sorted(summary.keys())
-print("\n%d files:" % len(filenames))
+print(f"\n{len(filenames)} files:")
 for f in filenames:
-line = "%s: %d lines" % (f, summary[f])
+line = f"{f}: {summary[f]} lines"
 plugin = data.file_tracer(f)
 if plugin:
-line += " [%s]" % plugin
+line += f" [{plugin}]"
 print(line)
 else:
 print("No data collected")
 elif info == 'config':
 print(info_header("config"))
 config_info = self.coverage.config.__dict__.items()
 for line in info_formatter(config_info):
-print(" %s" % line)
+print(f" {line}")
 elif info == "premain":
 print(info_header("premain"))
 print(short_stack())
 else:
-show_help("Don't know what you mean by %r" % info)
+show_help(f"Don't know what you mean by {info!r}")
 return ERR
 return OK
 traceback.print_exception(*err.args)    # pylint: disable=no-value-for-parameter
 status = ERR
 except BaseCoverageException as err:
 # A controlled error inside coverage.py: print the message to the user.
 msg = err.args[0]
-if env.PY2:
-msg = msg.encode(output_encoding())
 print(msg)
 status = ERR
 except SystemExit as err:
 # The user called `sys.exit()`.  Exit with their argument, if any.
 if err.args:

Mercurial Repositories > eric / file comparison

comparison: eric7/DebugClients/Python/coverage/cmdline.py

eric7/DebugClients/Python/coverage/cmdline.py