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

-:ca8e477c590c
+:2fc945191992
 # 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."""
 import glob
 import optparse     # pylint: disable=deprecated-module
 import os
 import os.path
 import coverage
 from coverage import Coverage
 from coverage import env
 from coverage.collector import CTracer
 from coverage.config import CoverageConfig
+from coverage.control import DEFAULT_DATAFILE
 from coverage.data import combinable_files, debug_data_file
-from coverage.debug import info_formatter, info_header, short_stack
+from coverage.debug import info_header, short_stack, write_formatted_info
 from coverage.exceptions import _BaseCoverageException, _ExceptionDuringRun, NoSource
 from coverage.execfile import PyRunner
 from coverage.results import Numbers, should_fail_under
+# When adding to this file, alphabetization is important.  Look for
+# "alphabetize" comments throughout.
 class Opts:
 """A namespace class for individual options we'll build parsers from."""
+# Keep these entries alphabetized (roughly) by the option name as it
+# appears on the command line.
 append = optparse.make_option(
 '-a', '--append', action='store_true',
 help="Append coverage data to .coverage, otherwise it starts clean each time.",
 )
 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',
+'', '--contexts', action='store', metavar="REGEX1,REGEX2,...",
-metavar="REGEX1,REGEX2,...",
 help=(
 "Only display data from lines covered in the given contexts. " +
 "Accepts Python regexes, which must be quoted."
+),
+)
+combine_datafile = optparse.make_option(
+'', '--data-file', action='store', metavar="DATAFILE",
+help=(
+"Base name of the data files to operate on. " +
+"Defaults to '.coverage'. [env: COVERAGE_FILE]"
+),
+)
+input_datafile = optparse.make_option(
+'', '--data-file', action='store', metavar="INFILE",
+help=(
+"Read coverage data for report generation from this file. " +
+"Defaults to '.coverage'. [env: COVERAGE_FILE]"
+),
+)
+output_datafile = optparse.make_option(
+'', '--data-file', action='store', metavar="OUTFILE",
+help=(
+"Write the recorded coverage data to this file. " +
+"Defaults to '.coverage'. [env: COVERAGE_FILE]"
 ),
 )
 debug = optparse.make_option(
 '', '--debug', action='store', metavar="OPTS",
 help="Debug options, separated by commas. [env: COVERAGE_DEBUG]",
 ignore_errors = optparse.make_option(
 '-i', '--ignore-errors', action='store_true',
 help="Ignore errors while reading source files.",
 )
 include = optparse.make_option(
-'', '--include', action='store',
+'', '--include', action='store', metavar="PAT1,PAT2,...",
-metavar="PAT1,PAT2,...",
 help=(
 "Include only files whose paths match one of these patterns. " +
 "Accepts shell-style wildcards, which must be quoted."
 ),
 )
 "<pyfile> is an importable Python module, not a script path, " +
 "to be run as 'python -m' would run it."
 ),
 )
 omit = optparse.make_option(
-'', '--omit', action='store',
+'', '--omit', action='store', metavar="PAT1,PAT2,...",
-metavar="PAT1,PAT2,...",
 help=(
 "Omit files whose paths match one of these patterns. " +
 "Accepts shell-style wildcards, which must be quoted."
 ),
 )
 output_xml = optparse.make_option(
-'-o', '', action='store', dest="outfile",
+'-o', '', action='store', dest="outfile", metavar="OUTFILE",
-metavar="OUTFILE",
 help="Write the XML report to this file. Defaults to 'coverage.xml'",
 )
 output_json = optparse.make_option(
-'-o', '', action='store', dest="outfile",
+'-o', '', action='store', dest="outfile", metavar="OUTFILE",
-metavar="OUTFILE",
 help="Write the JSON report to this file. Defaults to 'coverage.json'",
+)
+output_lcov = optparse.make_option(
+'-o', '', action='store', dest='outfile', metavar="OUTFILE",
+help="Write the LCOV report to this file. Defaults to 'coverage.lcov'",
 )
 json_pretty_print = optparse.make_option(
 '', '--pretty-print', action='store_true',
 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 " +
-".coverage data file name to simplify collecting data from " +
+"data file name to simplify collecting data from " +
 "many processes."
 ),
 )
 precision = optparse.make_option(
 '', '--precision', action='store', metavar='N', type=int,
 '--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. " +
+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 directories or importable names of code to measure.",
 )
 def __init__(self, *args, **kwargs):
 super().__init__(
 add_help_option=False, *args, **kwargs
 )
 self.set_defaults(
+# Keep these arguments alphabetized by their names.
 action=None,
 append=None,
 branch=None,
 concurrency=None,
 context=None,
 contexts=None,
+data_file=None,
 debug=None,
 directory=None,
 fail_under=None,
 help=None,
 ignore_errors=None,
 program_name = super().get_prog_name()
 # Include the sub-command for this parser as part of the command.
 return f"{program_name} {self.cmd}"
+# In lists of Opts, keep them alphabetized by the option names as they appear
+# on the command line, since these lists determine the order of the options in
+# the help output.
+#
+# In COMMANDS, keep the keys (command names) alphabetized.
 GLOBAL_ARGS = [
 Opts.debug,
 Opts.help,
 Opts.rcfile,
 ]
-CMDS = {
+COMMANDS = {
 'annotate': CmdOptionParser(
 "annotate",
 [
 Opts.directory,
+Opts.input_datafile,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
 'combine': CmdOptionParser(
 "combine",
 [
 Opts.append,
+Opts.combine_datafile,
 Opts.keep,
 Opts.quiet,
 ] + GLOBAL_ARGS,
 usage="[options] <path1> <path2> ... <pathN>",
 description=(
 "for diagnosing problems. " +
 "Topics are: " +
 "'data' to show a summary of the collected data; " +
 "'sys' to show installation information; " +
 "'config' to show the configuration; " +
-"'premain' to show what is calling coverage."
+"'premain' to show what is calling coverage; " +
+"'pybehave' to show internal flags describing Python behavior."
 ),
 ),
 'erase': CmdOptionParser(
-"erase", GLOBAL_ARGS,
+"erase",
+[
+Opts.combine_datafile
+] + GLOBAL_ARGS,
 description="Erase previously collected coverage data.",
 ),
 'help': CmdOptionParser(
 "help", GLOBAL_ARGS,
 'html': CmdOptionParser(
 "html",
 [
 Opts.contexts,
 Opts.directory,
+Opts.input_datafile,
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.precision,
 'json': CmdOptionParser(
 "json",
 [
 Opts.contexts,
+Opts.input_datafile,
 Opts.fail_under,
 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."
+description="Generate a JSON report of coverage results.",
+),
+'lcov': CmdOptionParser(
+"lcov",
+[
+Opts.input_datafile,
+Opts.fail_under,
+Opts.ignore_errors,
+Opts.include,
+Opts.output_lcov,
+Opts.omit,
+Opts.quiet,
+] + GLOBAL_ARGS,
+usage="[options] [modules]",
+description="Generate an LCOV report of coverage results.",
 ),
 'report': CmdOptionParser(
 "report",
 [
 Opts.contexts,
+Opts.input_datafile,
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.precision,
 Opts.skip_covered,
 Opts.no_skip_covered,
 Opts.skip_empty,
 ] + GLOBAL_ARGS,
 usage="[options] [modules]",
-description="Report coverage statistics on modules."
+description="Report coverage statistics on modules.",
 ),
 'run': CmdOptionParser(
 "run",
 [
 Opts.append,
 Opts.branch,
 Opts.concurrency,
 Opts.context,
+Opts.output_datafile,
 Opts.include,
 Opts.module,
 Opts.omit,
 Opts.pylib,
 Opts.parallel_mode,
 Opts.source,
 Opts.timid,
 ] + GLOBAL_ARGS,
 usage="[options] <pyfile> [program options]",
-description="Run a Python program, measuring code execution."
+description="Run a Python program, measuring code execution.",
 ),
 'xml': CmdOptionParser(
 "xml",
 [
+Opts.input_datafile,
 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."
+description="Generate an XML report of coverage results.",
 ),
 }
 def show_help(error=None, topic=None, parser=None):
 # switch syntax always starts with an option.
 self.global_option = argv[0].startswith('-')
 if self.global_option:
 parser = GlobalOptionParser()
 else:
-parser = CMDS.get(argv[0])
+parser = COMMANDS.get(argv[0])
 if not parser:
 show_help(f"Unknown command: {argv[0]!r}")
 return ERR
 argv = argv[1:]
 else:
 concurrency = None
 # Do something.
 self.coverage = Coverage(
+data_file=options.data_file or DEFAULT_DATAFILE,
 data_suffix=options.parallel_mode,
 cover_pylib=options.pylib,
 timid=options.timid,
 branch=options.branch,
 config_file=options.rcfile,
 self.coverage.load()
 total = None
 if options.action == "report":
 total = self.coverage.report(
+precision=options.precision,
 show_missing=options.show_missing,
 skip_covered=options.skip_covered,
 skip_empty=options.skip_empty,
-precision=options.precision,
 sort=options.sort,
 **report_args
 )
 elif options.action == "annotate":
 self.coverage.annotate(directory=options.directory, **report_args)
 elif options.action == "html":
 total = self.coverage.html_report(
 directory=options.directory,
-title=options.title,
+precision=options.precision,
 skip_covered=options.skip_covered,
 skip_empty=options.skip_empty,
 show_contexts=options.show_contexts,
-precision=options.precision,
+title=options.title,
 **report_args
 )
 elif options.action == "xml":
-outfile = options.outfile
 total = self.coverage.xml_report(
-outfile=outfile, skip_empty=options.skip_empty,
+outfile=options.outfile,
+skip_empty=options.skip_empty,
 **report_args
 )
 elif options.action == "json":
-outfile = options.outfile
 total = self.coverage.json_report(
-outfile=outfile,
+outfile=options.outfile,
 pretty_print=options.pretty_print,
 show_contexts=options.show_contexts,
 **report_args
 )
+elif options.action == "lcov":
+total = self.coverage.lcov_report(
+outfile=options.outfile,
+**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)
+if options.precision is not None:
+self.coverage.set_option("report:precision", options.precision)
 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} is less than fail-under={fail_under:.{p}f}".format(
 return True
 if options.action == "help":
 if args:
 for a in args:
-parser = CMDS.get(a)
+parser = COMMANDS.get(a)
 if parser:
 show_help(parser=parser)
 else:
 show_help(topic=a)
 else:
 def do_debug(self, args):
 """Implementation of 'coverage debug'."""
 if not args:
-show_help("What information would you like: config, data, sys, premain?")
+show_help("What information would you like: config, data, sys, premain, pybehave?")
 return ERR
 if args[1:]:
 show_help("Only one topic at a time, please")
 return ERR
-if args[0] == 'sys':
+if args[0] == "sys":
-sys_info = self.coverage.sys_info()
+write_formatted_info(print, "sys", self.coverage.sys_info())
-print(info_header("sys"))
+elif args[0] == "data":
-for line in info_formatter(sys_info):
-print(f" {line}")
-elif args[0] == 'data':
 print(info_header("data"))
 data_file = self.coverage.config.data_file
 debug_data_file(data_file)
 for filename in combinable_files(data_file):
 print("-----")
 debug_data_file(filename)
-elif args[0] == 'config':
+elif args[0] == "config":
-print(info_header("config"))
+write_formatted_info(print, "config", self.coverage.config.debug_info())
-config_info = sorted(self.coverage.config.__dict__.items())
-for line in info_formatter(config_info):
-print(f" {line}")
 elif args[0] == "premain":
 print(info_header("premain"))
 print(short_stack())
+elif args[0] == "pybehave":
+write_formatted_info(print, "pybehave", env.debug_info())
 else:
 show_help(f"Don't know what you mean by {args[0]!r}")
 return ERR
 return OK
 debug       Display information about the internals of coverage.py
 erase       Erase previously collected coverage data.
 help        Get help on using coverage.py.
 html        Create an HTML report.
 json        Create a JSON report of coverage results.
+lcov        Create an LCOV report of coverage results.
 report      Report coverage stats on modules.
 run         Run a Python program and measure code execution.
 xml         Create an XML report of coverage results.
 Use "{program_name} help <command>" for detailed help on any command.

Mercurial Repositories > eric / file comparison

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

eric7/DebugClients/Python/coverage/cmdline.py