diff options
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 105 |
1 files changed, 54 insertions, 51 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index ae7282f8..3a3451af 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -6,84 +6,87 @@ Coverage command line usage :history: 20090524T134300, brand new docs. :history: 20090613T164000, final touches for 3.0 +:history: 20090913T084400, new command line syntax .. highlight:: console When you install coverage, a command-line script called coverage is placed in -the Python scripts directory. Coverage performs a number of actions, determined -by the flags on the command line: +your Python scripts directory. Coverage has a number of commands which +determine the action performed: -* -e Erase previously collected coverage data. +* **run** -- Run a Python program and collect execution data. -* -x Execute a Python program and collect execution data. +* **report** -- Report coverage results. -* -c Combine together a number of data files. +* **html** -- Produce annotated HTML listings with coverage results. -* -r Report coverage results. +* **erase** -- Erase previously collected coverage data. -* -a Annotate source files with coverage results. +* **combine** -- Combine together a number of data files. -* -b Produce annotated HTML listings with coverage results. - -Some of these can be combined: for example, "-e -x" is the simple way to run a -program without carrying over previous data. - - -Data file ---------- - -Coverage collects execution data in a file called ".coverage". If need be, you can -set a new file name with the COVERAGE_FILE environment variable. Data accumulates -from run to run, so that you can collect a complete data set of which parts of -your code are executed. - -To erase the collected data, use the "-e" command-line switch:: - - $ coverage -e +* **annotate** -- Annotate source files with coverage results. Execution --------- -Coverage collects data by running your Python program with -x:: +You collect execution data by running your Python program with the **run** +coverage command:: - $ coverage -x my_program.py arg1 arg2 + $ coverage run my_program.py arg1 arg2 blah blah ..your program's output.. blah blah Your program runs just as if it had been invoked with the Python command line. Arguments after your file name are passed to your program in sys.argv. By default, coverage does not measure code installed with the Python interpreter. -If you want to measure that code as well as your own, add the -L flag. +If you want to measure that code as well as your own, add the ``-L`` flag. If your coverage results seems to be overlooking code that you know has been -executed, try running coverage again with the --timid flag. This uses a simpler +executed, try running coverage again with the ``--timid`` flag. This uses a simpler but slower trace method. Projects that use DecoratorTools, including TurboGears, -will need to use --timid to get correct results. This option can also be set -with the environment variable COVERAGE_OPTIONS set to '--timid'. +will need to use ``--timid`` to get correct results. This option can also be set +with the environment variable COVERAGE_OPTIONS set to ``--timid``. + + + +Data file +--------- + +Coverage collects execution data in a file called ".coverage". If need be, you can +set a new file name with the COVERAGE_FILE environment variable. By default, +each run of your program starts with an empty data set. If you need to run your +program multiple times to get complete data (for example, because you need to +supply disjoint options), you can accumulate data across runs with the ``-a`` +flag on the **run** command. + +To erase the collected data, use the **erase** command:: + + $ coverage erase + Combining data files -------------------- If you need to collect coverage data from different machines, coverage can -combine multiple files into one for reporting. Use the -p flag during execution -to append a machine name and process id to the .coverage data file name. +combine multiple files into one for reporting. Use the ``-p`` flag during +execution to append a machine name and process id to the .coverage data file +name. Once you have created a number of these files, you can copy them all to a single -directory, and use the -c flag to combine them into one .coverage data file:: - - $ coverage -c +directory, and use the **combine** command to combine them into one .coverage +data file. Reporting --------- Coverage provides a few styles of reporting. The simplest is a textual summary -produced with -r:: +produced with **report**:: - $ coverage -r + $ coverage report Name Stmts Exec Cover --------------------------------------------- my_program 20 16 80% @@ -96,9 +99,9 @@ For each module executed, the report shows the count of executable statements, the number of those statements executed, and the resulting coverage, expressed as a percentage. -The -m flag also shows the line numbers of missing statements:: +The ``-m`` flag also shows the line numbers of missing statements:: - $ coverage -r -m + $ coverage report -m Name Stmts Exec Cover Missing ------------------------------------------------------- my_program 20 16 80% 33-35, 39 @@ -110,7 +113,7 @@ The -m flag also shows the line numbers of missing statements:: You can restrict the report to only certain files by naming them on the command line:: - $ coverage -r -m my_program.py my_other_module.py + $ coverage report -m my_program.py my_other_module.py Name Stmts Exec Cover Missing ------------------------------------------------------- my_program 20 16 80% 33-35, 39 @@ -118,10 +121,10 @@ command line:: ------------------------------------------------------- TOTAL 76 66 87% -The -o flag omits files that begin with specified prefixes. For example, this +The ``-o`` flag omits files that begin with specified prefixes. For example, this will omit any modules in the django directory:: - $ coverage -r -m -o django + $ coverage report -m -o django @@ -129,9 +132,9 @@ HTML annotation --------------- Coverage can annotate your source code for which lines were executed -and which were not. The -b flag creates an HTML report similar to the -r -summary, but as an HTML file. Each module name links to the source file -decorated to show the status of each line. +and which were not. The **html** command creates an HTML report similar to the +**report** summary, but as an HTML file. Each module name links to the source +file decorated to show the status of each line. Here's a `sample report </code/coverage/sample_html/index.html>`_. @@ -139,18 +142,18 @@ Lines are highlighted green for executed, red for missing, and gray for excluded. The counts at the top of the file are buttons to turn on and off the highlighting. -The -d argument to specify an output directory is required:: +The ``-d`` argument to specify an output directory is required:: - $ coverage -b -d covhtml + $ coverage html -d covhtml Text annotation --------------- -The -a flag produces a text annotation of your source code. With a -d argument -specifying an output directory, each Python file becomes a text file in that -directory. Without -d, the files are written into the same directories as the -original Python files. +The **annotate** command produces a text annotation of your source code. With a +``-d`` argument specifying an output directory, each Python file becomes a text +file in that directory. Without ``-d``, the files are written into the same +directories as the original Python files. Coverage status for each line of source is indicated with a character prefix:: |