misc: Changes per pull request

 * Set options in alphabetical order
 * Rename "dump-signal" to "save-signal"

Signed-off-by: Arkady Gilinsky <[email protected]>

Author: ark-g

coverage/cmdline.py

@@ -190,6 +190,15 @@ class Opts:
             "'pyproject.toml' are tried. [env: COVERAGE_RCFILE]"
         ),
     )
+    save_signal = optparse.make_option(
+        '', '--save-signal', action='store', metavar='SAVE_SIGNAL',
+        choices = ['USR1', 'USR2'],
+        help=(
+            "Define a system signal that will trigger coverage report save operation. " +
+            "It is important that target script do not intercept this signal. " +
+            "Currently supported options are: USR1, USR2."
+        ),
+    )
     show_contexts = optparse.make_option(
         "--show-contexts", action="store_true",
         help="Show contexts for covered lines.",
@@ -229,15 +238,6 @@ class Opts:
         "", "--version", action="store_true",
         help="Display version information and exit.",
     )
-    dump_signal = optparse.make_option(
-        '', '--dump_signal', action='store', metavar='DUMP_SIGNAL',
-        choices = ['USR1', 'USR2'],
-        help=(
-            "Define a system signal that will trigger coverage report dump. " +
-            "It is important that target script do not intercept this signal. " +
-            "Currently supported options are: USR1, USR2."
-        ),
-    )
 
 class CoverageOptionParser(optparse.OptionParser):
     """Base OptionParser for coverage.py.
@@ -261,7 +261,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
             data_file=None,
             debug=None,
             directory=None,
-            dump_signal=None,
             fail_under=None,
             format=None,
             help=None,
@@ -275,6 +274,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
             pylib=None,
             quiet=None,
             rcfile=True,
+            save_signal=None,
             show_contexts=None,
             show_missing=None,
             skip_covered=None,
@@ -534,9 +534,9 @@ def get_prog_name(self) -> str:
             Opts.omit,
             Opts.pylib,
             Opts.parallel_mode,
+            Opts.save_signal,
             Opts.source,
             Opts.timid,
-            Opts.dump_signal,
             ] + GLOBAL_ARGS,
         usage="[options] <pyfile> [program options]",
         description="Run a Python program, measuring code execution.",
@@ -819,9 +819,9 @@ def do_help(
 
         return False
 
-    def do_dump(self, _signum: int, _frame: types.FrameType | None) -> None:
-        """ Signal handler to dump coverage report """
-        print("Dumping coverage data ...")
+    def do_signal_save(self, _signum: int, _frame: types.FrameType | None) -> None:
+        """ Signal handler to save coverage report """
+        print("Saving coverage data ...")
         self.coverage.save()
 
     def do_run(self, options: optparse.Values, args: list[str]) -> int:
@@ -868,13 +868,13 @@ def do_run(self, options: optparse.Values, args: list[str]) -> int:
         if options.append:
             self.coverage.load()
 
-        if options.dump_signal:
-            if options.dump_signal.upper() == 'USR1':
-                signal.signal(signal.SIGUSR1, self.do_dump)
-            elif options.dump_signal.upper() == 'USR2':
-                signal.signal(signal.SIGUSR2, self.do_dump)
+        if options.save_signal:
+            if options.save_signal.upper() == 'USR1':
+                signal.signal(signal.SIGUSR1, self.do_signal_save)
+            elif options.save_signal.upper() == 'USR2':
+                signal.signal(signal.SIGUSR2, self.do_signal_save)
             else:
-                show_help(f"Unsupported signal for dump coverage report: {options.dump_signal}")
+                show_help(f"Unsupported signal for save coverage report: {options.save_signal}")
                 return ERR
 
         # Run the script.

doc/cmd.rst

@@ -133,22 +133,22 @@ There are many options:
       -p, --parallel-mode   Append the machine name, process id and random number
                             to the data file name to simplify collecting data from
                             many processes.
+      --save-signal=SAVE_SIGNAL
+                            Define a system signal that will trigger coverage
+                            report save operation. It is important that target
+                            script do not intercept this signal. Currently
+                            supported options are: USR1, USR2.
       --source=SRC1,SRC2,...
                             A list of directories or importable names of code to
                             measure.
       --timid               Use the slower Python trace function core.
-      --dump_signal=DUMP_SIGNAL
-                            Define a system signal that will trigger coverage
-                            report dump. It is important that target script do not
-                            intercept this signal. Currently supported options
-                            are: USR1, USR2.
       --debug=OPTS          Debug options, separated by commas. [env:
                             COVERAGE_DEBUG]
       -h, --help            Get help on this command.
       --rcfile=RCFILE       Specify configuration file. By default '.coveragerc',
                             'setup.cfg', 'tox.ini', and 'pyproject.toml' are
                             tried. [env: COVERAGE_RCFILE]
-.. [[[end]]] (sum: kxkJi2xQZv)
+.. [[[end]]] (sum: 1+s3B5JO5I)
 
 If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
 flag.  Otherwise only statement coverage is measured.