Improve testing #37
Merged
Improve testing #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`unittest` is a builtin, and as of py36, so is mock.
Since all commands from `python setup.py` have been deprecated, it doesn't make sense to use `python setup.py test` anymore. This is the only place (AFAIK) where `tests_require` is used. As an alternative, this can be installed as an extra (as is already in the GitHub Actions workflow) with `pip install .[test]
Tox is much more reproducible for tests as it also handles installing all package and testing requirements
Un-hardcoding these numbers makes it possible to arbitrarily extend the metric set definitions without needing to change the test code
Codecov Report
@@ Coverage Diff @@
## main #37 +/- ##
=======================================
Coverage 99.77% 99.77%
=======================================
Files 16 16
Lines 874 874
=======================================
Hits 872 872
Misses 2 2
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the documentation of installation, testing, and makes the unit tests less rigid to future improvements
Changes
python setup.pyhave been deprecated, it doesn't make sense to usepython setup.py testanymore. This is the only place (AFAIK) wheretests_requireis used. As an alternative, this can be installed as an extra (as is already in the GitHub Actions workflow) withpip install .[test](20cf0f9)python setup.py installtopip install .(dfff1af)toxbecause it's more simple and takes care of all installation of package and testing requirements (as solved in previous bullet point) (4f0815a)