pytest-filecov
Overview
This is a pytest plugin to monitor file accesses while tests are running, then output a report listing files along with whether or not they were accessed:
$ py.test --filecov tests
============================= test session starts ==============================
platform linux -- Python 3.9.5, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
filecov: tests
rootdir: /home/rohan/src/pytest-filecov
plugins: cov-2.12.1, filecov-0.1.0
collected 3 items
tests/test_plugin.py ... [100%]
============================ pytest-filecov report =============================
Filename Covered?
-------- --------
tests/__init__.py 0
tests/fakecmd.py 1
tests/test_plugin.py 1
tests/some-file 1
tests/other-file 0
============================== 3 passed in 0.13s ===============================
Usage
Prerequisites:
- Linux
inotifywait(try installinginotify-toolspackage)
Install the plugin:
pip install pytest-filecov
When running your test suite, add --filecov <path> specifying the directory
tree(s) for which you'd like a report:
py.test --filecov somedir
Why?
This plugin targets the following scenario:
- You've got a large, complex test suite.
- You've got some tests relying on external data stored in files.
- After some refactors, you expect some of the test data files are now unused and you'd like to clean them up, but you have no reliable way to determine what is or is not used.
Just as pytest-cov can help you seek and destroy dead Python code after
refactors, pytest-filecov can do the same for dead/unused data files.
Caveats and missing features
This plugin is rudimentary, with many missing features.
- The format of the reporter is not configurable.
- The list of files included in the report comes from
git ls-filesand this is not configurable. .pyfiles may commonly be listed as uncovered for various reasons (e.g..pycfiles were used; or files were imported before monitoring began)
Contributions to improve any of the above are welcome.
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Metadata
Release files for pytest-filecov 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pytest-filecov-0.1.2.tar.gz | 17.1 kB | Without provenance | Details for pytest-filecov-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytest_filecov-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for pytest_filecov-0.1.2-py3-none-any.whl |
Total release size: 35.4 kB
Release files / pytest-filecov-0.1.2.tar.gz
| Download URL | pytest-filecov-0.1.2.tar.gz |
|---|---|
| Size | 17.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bcc64a9cd328902f40ae745be610faeac2eef4f04ed7fdd82f4c3c07fd1406c1
|
|
BLAKE2b-256 checksum How to use checksums |
6c4f37a9e0103aa1abde31379b0ef065a8f2cc29600fc5054e03fc0a481df9bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5
|
Release files / pytest_filecov-0.1.2-py3-none-any.whl
| Download URL | pytest_filecov-0.1.2-py3-none-any.whl |
|---|---|
| Size | 18.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e4d20169ecc79a1d53c58ef72d7669e185f8c2af05b46ee1abea372999a25e49
|
|
BLAKE2b-256 checksum How to use checksums |
49fe8d127674fad8f94ca9edcd0edfe47775798c9fb202e3aa9dcfeb5f041db1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5
|
Security for pytest-filecov 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.