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

-:04e5dfbd3f3d
+:3586ebd9fac8
 import glob
 import optparse
 import os.path
 import sys
+import textwrap
 import traceback
 from coverage import env
+from coverage.collector import CTracer
 from coverage.execfile import run_python_file, run_python_module
 from coverage.misc import CoverageException, ExceptionDuringRun, NoSource
 from coverage.debug import info_formatter, info_header
 class Opts(object):
 """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 is started "
+help="Append coverage data to .coverage, otherwise it is started clean with each run.",
-"clean with each run."
+)
-)
 branch = optparse.make_option(
 '', '--branch', action='store_true',
-help="Measure branch coverage in addition to statement coverage."
+help="Measure branch coverage in addition to statement coverage.",
 )
 CONCURRENCY_CHOICES = [
 "thread", "gevent", "greenlet", "eventlet", "multiprocessing",
 ]
 concurrency = optparse.make_option(
 '', '--concurrency', action='store', metavar="LIB",
 choices=CONCURRENCY_CHOICES,
-help="Properly measure code using a concurrency library. "
+help=(
-"Valid values are: %s." % ", ".join(CONCURRENCY_CHOICES)
+"Properly measure code using a concurrency library. "
-)
+"Valid values are: %s."
+) % ", ".join(CONCURRENCY_CHOICES),
+)
 debug = optparse.make_option(
 '', '--debug', action='store', metavar="OPTS",
-help="Debug options, separated by commas"
+help="Debug options, separated by commas",
 )
 directory = optparse.make_option(
 '-d', '--directory', action='store', metavar="DIR",
-help="Write the output files to DIR."
+help="Write the output files to DIR.",
 )
 fail_under = optparse.make_option(
 '', '--fail-under', action='store', metavar="MIN", type="int",
-help="Exit with a status of 2 if the total coverage is less than MIN."
+help="Exit with a status of 2 if the total coverage is less than MIN.",
 )
 help = optparse.make_option(
 '-h', '--help', action='store_true',
-help="Get help on this command."
+help="Get help on this command.",
 )
 ignore_errors = optparse.make_option(
 '-i', '--ignore-errors', action='store_true',
-help="Ignore errors while reading source files."
+help="Ignore errors while reading source files.",
 )
 include = optparse.make_option(
 '', '--include', action='store',
 metavar="PAT1,PAT2,...",
-help="Include only files whose paths match one of these patterns. "
+help=(
-"Accepts shell-style wildcards, which must be quoted."
+"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, "
+help=(
-"which isn't done by default."
+"Measure coverage even inside the Python installed library, "
-)
+"which isn't done by default."
+),
+)
 show_missing = optparse.make_option(
 '-m', '--show-missing', action='store_true',
-help="Show line numbers of statements in each module that weren't "
+help="Show line numbers of statements in each module that weren't executed.",
-"executed."
+)
-)
 skip_covered = optparse.make_option(
 '--skip-covered', action='store_true',
-help="Skip files with 100% coverage."
+help="Skip files with 100% coverage.",
 )
 omit = optparse.make_option(
 '', '--omit', action='store',
 metavar="PAT1,PAT2,...",
-help="Omit files whose paths match one of these patterns. "
+help=(
-"Accepts shell-style wildcards, which must be quoted."
+"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",
 metavar="OUTFILE",
-help="Write the XML report to this file. Defaults to 'coverage.xml'"
+help="Write the XML report to this file. Defaults to 'coverage.xml'",
 )
 parallel_mode = optparse.make_option(
 '-p', '--parallel-mode', action='store_true',
-help="Append the machine name, process id and random number to the "
+help=(
-".coverage data file name to simplify collecting data from "
+"Append the machine name, process id and random number to the "
-"many processes."
+".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, "
+help=(
-"to be run as 'python -m' would run it."
+"<pyfile> is an importable Python module, not a script path, "
-)
+"to be run as 'python -m' would run it."
+),
+)
 rcfile = optparse.make_option(
 '', '--rcfile', action='store',
-help="Specify configuration file.  Defaults to '.coveragerc'"
+help="Specify configuration file.  Defaults to '.coveragerc'",
 )
 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 packages or directories of code to be measured.",
 )
 timid = optparse.make_option(
 '', '--timid', action='store_true',
-help="Use a simpler but slower trace method.  Try this if you get "
+help=(
-"seemingly impossible results!"
+"Use a simpler but slower trace method.  Try this if you get "
-)
+"seemingly impossible results!"
+),
+)
 title = optparse.make_option(
 '', '--title', action='store', metavar="TITLE",
-help="A text string to use as the title on the HTML."
+help="A text string to use as the title on the HTML.",
 )
 version = optparse.make_option(
 '', '--version', action='store_true',
-help="Display version information and exit."
+help="Display version information and exit.",
 )
 class CoverageOptionParser(optparse.OptionParser, object):
 """Base OptionParser for coverage.py.
 class CmdOptionParser(CoverageOptionParser):
 """Parse one of the new-style commands for coverage.py."""
-def __init__(self, action, options=None, defaults=None, usage=None,
+def __init__(self, action, options=None, defaults=None, usage=None, description=None):
-description=None
-):
 """Create an OptionParser for a coverage.py command.
 `action` is the slug to put into `options.action`.
 `options` is a list of Option's for the command.
 `defaults` is a dict of default value for options.
 """
 if usage:
 usage = "%prog " + usage
 super(CmdOptionParser, self).__init__(
-prog="coverage %s" % action,
 usage=usage,
 description=description,
 )
 self.set_defaults(action=action, **(defaults or {}))
 if options:
 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)
+def get_prog_name(self):
+"""Override of an undocumented function in optparse.OptionParser."""
+program_name = super(CmdOptionParser, self).get_prog_name()
+# Include the sub-command for this parser as part of the command.
+return "%(command)s %(subcommand)s" % {'command': program_name, 'subcommand': self.cmd}
 GLOBAL_ARGS = [
 Opts.debug,
 Opts.help,
 Opts.rcfile,
 ]
 CMDS = {
-'annotate': CmdOptionParser("annotate",
+'annotate': CmdOptionParser(
+"annotate",
 [
 Opts.directory,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 ] + GLOBAL_ARGS,
-usage = "[options] [modules]",
+usage="[options] [modules]",
-description = "Make annotated copies of the given files, marking "
+description=(
-"statements that are executed with > and statements that are "
+"Make annotated copies of the given files, marking statements that are executed "
-"missed with !."
+"with > and statements that are missed with !."
 ),
+),
-'combine': CmdOptionParser("combine", GLOBAL_ARGS,
-usage = "<path1> <path2> ... <pathN>",
+'combine': CmdOptionParser(
-description = "Combine data from multiple coverage files collected "
+"combine",
+GLOBAL_ARGS,
+usage="<path1> <path2> ... <pathN>",
+description=(
+"Combine data from multiple coverage files collected "
 "with 'run -p'.  The combined results are written to a single "
 "file representing the union of the data. The positional "
 "arguments are data files or directories containing data files. "
 "If no paths are provided, data files in the default data file's "
 "directory are combined."
 ),
+),
-'debug': CmdOptionParser("debug", GLOBAL_ARGS,
-usage = "<topic>",
+'debug': CmdOptionParser(
-description = "Display information on the internals of coverage.py, "
+"debug", GLOBAL_ARGS,
+usage="<topic>",
+description=(
+"Display information on the internals of coverage.py, "
 "for diagnosing problems. "
 "Topics are 'data' to show a summary of the collected data, "
 "or 'sys' to show installation information."
 ),
+),
-'erase': CmdOptionParser("erase", GLOBAL_ARGS,
-usage = " ",
+'erase': CmdOptionParser(
-description = "Erase previously collected coverage data."
+"erase", GLOBAL_ARGS,
-),
+usage=" ",
+description="Erase previously collected coverage data.",
-'help': CmdOptionParser("help", GLOBAL_ARGS,
+),
-usage = "[command]",
-description = "Describe how to use coverage.py"
+'help': CmdOptionParser(
-),
+"help", GLOBAL_ARGS,
+usage="[command]",
-'html': CmdOptionParser("html",
+description="Describe how to use coverage.py",
+),
+'html': CmdOptionParser(
+"html",
 [
 Opts.directory,
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.title,
 ] + GLOBAL_ARGS,
-usage = "[options] [modules]",
+usage="[options] [modules]",
-description = "Create an HTML report of the coverage of the files.  "
+description=(
+"Create an HTML report of the coverage of the files.  "
 "Each file gets its own page, with the source decorated to show "
 "executed, excluded, and missed lines."
 ),
+),
-'report': CmdOptionParser("report",
+'report': CmdOptionParser(
+"report",
 [
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.show_missing,
 Opts.skip_covered,
 ] + GLOBAL_ARGS,
-usage = "[options] [modules]",
+usage="[options] [modules]",
-description = "Report coverage statistics on modules."
+description="Report coverage statistics on modules."
 ),
-'run': CmdOptionParser("run",
+'run': CmdOptionParser(
+"run",
 [
 Opts.append,
 Opts.branch,
 Opts.concurrency,
 Opts.include,
 Opts.pylib,
 Opts.parallel_mode,
 Opts.source,
 Opts.timid,
 ] + GLOBAL_ARGS,
-usage = "[options] <pyfile> [program options]",
+usage="[options] <pyfile> [program options]",
-description = "Run a Python program, measuring code execution."
+description="Run a Python program, measuring code execution."
 ),
-'xml': CmdOptionParser("xml",
+'xml': CmdOptionParser(
+"xml",
 [
 Opts.fail_under,
 Opts.ignore_errors,
 Opts.include,
 Opts.omit,
 Opts.output_xml,
 ] + GLOBAL_ARGS,
-usage = "[options] [modules]",
+usage="[options] [modules]",
-description = "Generate an XML report of coverage results."
+description="Generate an XML report of coverage results."
 ),
 }
 OK, ERR, FAIL_UNDER = 0, 1, 2
 self.help_fn = _help_fn or self.help
 self.path_exists = _path_exists or os.path.exists
 self.global_option = False
 self.coverage = None
+self.program_name = os.path.basename(sys.argv[0])
+if env.WINDOWS:
+# entry_points={'console_scripts':...} on Windows makes files
+# called coverage.exe, coverage3.exe, and coverage-3.5.exe. These
+# invoke coverage-script.py, coverage3-script.py, and
+# coverage-3.5-script.py.  argv[0] is the .py file, but we want to
+# get back to the original form.
+auto_suffix = "-script.py"
+if self.program_name.endswith(auto_suffix):
+self.program_name = self.program_name[:-len(auto_suffix)]
 def command_line(self, argv):
 """The bulk of the command line interface to coverage.py.
 `argv` is the argument list to process.
 include = unshell_list(options.include)
 debug = unshell_list(options.debug)
 # Do something.
 self.coverage = self.covpkg.coverage(
-data_suffix = options.parallel_mode,
+data_suffix=options.parallel_mode,
-cover_pylib = options.pylib,
+cover_pylib=options.pylib,
-timid = options.timid,
+timid=options.timid,
-branch = options.branch,
+branch=options.branch,
-config_file = options.rcfile,
+config_file=options.rcfile,
-source = source,
+source=source,
-omit = omit,
+omit=omit,
-include = include,
+include=include,
-debug = debug,
+debug=debug,
-concurrency = options.concurrency,
+concurrency=options.concurrency,
 )
 if options.action == "debug":
 return self.do_debug(args)
 self.coverage.save()
 return OK
 # Remaining actions are reporting, with some common options.
 report_args = dict(
-morfs = unglob_args(args),
+morfs=unglob_args(args),
-ignore_errors = options.ignore_errors,
+ignore_errors=options.ignore_errors,
-omit = omit,
+omit=omit,
-include = include,
+include=include,
 )
 self.coverage.load()
 total = None
 def help(self, error=None, topic=None, parser=None):
 """Display an error message, or the named topic."""
 assert error or topic or parser
 if error:
 print(error)
-print("Use 'coverage help' for help.")
+print("Use '%s help' for help." % (self.program_name,))
 elif parser:
 print(parser.format_help().strip())
 else:
-help_msg = HELP_TOPICS.get(topic, '').strip()
+help_params = dict(self.covpkg.__dict__)
+help_params['program_name'] = self.program_name
+if CTracer is not None:
+help_params['extension_modifier'] = 'with C extension'
+else:
+help_params['extension_modifier'] = 'without C extension'
+help_msg = textwrap.dedent(HELP_TOPICS.get(topic, '')).strip()
 if help_msg:
-print(help_msg % self.covpkg.__dict__)
+print(help_msg.format(**help_params))
 else:
 print("Don't know topic %r" % topic)
 def do_help(self, options, args, parser):
 """Deal with help requests.
 args = globbed
 return args
 HELP_TOPICS = {
-# -------------------------
+'help': """\
-'help': """\
+Coverage.py, version {__version__} {extension_modifier}
-Coverage.py, version %(__version__)s
+Measure, collect, and report on code coverage in Python programs.
-Measure, collect, and report on code coverage in Python programs.
+usage: {program_name} <command> [options] [args]
-usage: coverage <command> [options] [args]
+Commands:
-Commands:
+annotate    Annotate source files with execution information.
-annotate    Annotate source files with execution information.
+combine     Combine a number of data files.
-combine     Combine a number of data files.
+erase       Erase previously collected coverage data.
-erase       Erase previously collected coverage data.
+help        Get help on using coverage.py.
-help        Get help on using coverage.py.
+html        Create an HTML report.
-html        Create an HTML report.
+report      Report coverage stats on modules.
-report      Report coverage stats on modules.
+run         Run a Python program and measure code execution.
-run         Run a Python program and measure code execution.
+xml         Create an XML report of coverage results.
-xml         Create an XML report of coverage results.
+Use "{program_name} help <command>" for detailed help on any command.
-Use "coverage help <command>" for detailed help on any command.
+For full documentation, see {__url__}
-For full documentation, see %(__url__)s
+""",
-""",
-# -------------------------
+'minimum_help': """\
-'minimum_help': """\
+Code coverage for Python.  Use '{program_name} help' for help.
-Code coverage for Python.  Use 'coverage help' for help.
+""",
-""",
-# -------------------------
+'version': """\
-'version': """\
+Coverage.py, version {__version__} {extension_modifier}
-Coverage.py, version %(__version__)s.
+Documentation at {__url__}
-Documentation at %(__url__)s
+""",
-""",
 }
 def main(argv=None):
 """The main entry point to coverage.py.

Mercurial Repositories > eric / file comparison

comparison: DebugClients/Python/coverage/cmdline.py

DebugClients/Python/coverage/cmdline.py