diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2020-09-12 19:42:14 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2020-09-12 19:42:39 -0400 |
commit | 263f3e1da8e5a6a32056a8697286f9adf0f6a55d (patch) | |
tree | a5dc4806aa85159ed15a4c80e228d8b58de38fef /coverage/control.py | |
parent | ecd6ab19a43a444bc7fc9dfbc08f3ca5274365ca (diff) | |
download | python-coveragepy-git-263f3e1da8e5a6a32056a8697286f9adf0f6a55d.tar.gz |
Docs and cleanup for source_pkgs
Diffstat (limited to 'coverage/control.py')
-rw-r--r-- | coverage/control.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/coverage/control.py b/coverage/control.py index ebc38009..7c4a4828 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -101,7 +101,7 @@ class Coverage(object): auto_data=False, timid=None, branch=None, config_file=True, source=None, source_pkgs=None, omit=None, include=None, debug=None, concurrency=None, check_preimported=False, context=None, - ): + ): # pylint: disable=too-many-arguments """ Many of these arguments duplicate and override values that can be provided in a configuration file. Parameters that are missing here @@ -146,6 +146,10 @@ class Coverage(object): in the trees indicated by the file paths or package names will be measured. + `source_pkgs` is a list of package names. It works the same as + `source`, but can be used to name packages where the name can also be + interpreted as a file path. + `include` and `omit` are lists of file name patterns. Files that match `include` will be measured, files that match `omit` will not. Each will also accept a single string argument. @@ -176,6 +180,9 @@ class Coverage(object): .. versionadded:: 5.0 The `check_preimported` and `context` parameters. + .. versionadded:: 5.3 + The `source_pkgs` parameter. + """ # data_file=None means no disk file at all. data_file missing means # use the value from the config file. |