The most important thing in the coverage module is the
coverage.Coverage class, described in The Coverage class, but there
are a few other things also.
A tuple of five elements, similar to
sys.version_info: major, minor, micro, releaselevel, and
serial. All values except releaselevel are integers; the release level is
sys.version_info, the elements are not
available by name.
A string with the version of coverage.py, for example,
- class coverage.CoverageException¶
The base class of all exceptions raised by Coverage.py.
Starting coverage.py automatically¶
This function is used to start coverage measurement automatically when Python starts. See Measuring sub-processes for details.
- coverage.process_startup() Optional[Coverage] ¶
Call this at Python start-up to perhaps measure coverage.
If the environment variable COVERAGE_PROCESS_START is defined, coverage measurement is started. The value of the variable is the config file to use.
There are two ways to configure your Python installation to invoke this function when Python starts:
Create or append to sitecustomize.py to add these lines:
import coverage coverage.process_startup()
Create a .pth file in your Python installation containing:
import coverage; coverage.process_startup()
Coverageinstance that was started, or None if it was not started by this call.