Numtest
Numtest is a doctest extension that simplifies the test of numerical results.
It provides a new doctest directive NUMBER to use with numerical tests:
>>> import math >>> math.pi # doctest: +NUMBER 3.14
To enable it, import the module numtest before you run the tests.
How does it work ?
A major issue in numerical tests is the control of the precision of the results.
Numtest infers the precision that you want from the number of digits used in the expected result: the string "3.14" used in the above example means that the best three-digit approximation of math.pi should be 3.14.
For example, a math module that would declare pi as any of the numbers
3.141592653589793, 3.14, 3
would pass the above test while the values
100, 3, 3.1, 3.149
would fail the same test.
Additional Features
Numtest supports comparison of list of numbers and NumPy arrays. For example, the test below passes:
>>> import numpy >>> x = numpy.linspace(0.0, 1.0, 4) >>> x # doctest: +NUMBER [0.00, 0.333, 0.667, 1.00]
Only the shape and values of lists or arrays are tested: lists may be successfully compared to arrays, arrays of integers with arrays of floats, etc.
Gotchas
Be aware that NumPy displays arrays with only a 8-digits precision by default. Hence the test below would fail:
>>> x # doctest: +NUMBER [0.00, 0.333333333333, 0.667, 1.00]
However, the display precision used by NumPy is configurable. The prior invocation of
>>> numpy.set_printoptions(precision=17)
will make the test pass as expected.
1 maintainer
Metadata
1 maintainer
Release files for numtest 2.0.6
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 | |
|---|---|---|---|---|
| numtest-2.0.6.tar.gz | 431.6 kB | Without provenance | Details |
Release files / numtest-2.0.6.tar.gz
| Download URL | numtest-2.0.6.tar.gz |
|---|---|
| Size | 431.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31da8011f07cba4763a1db5bb456f9101322ab2ae93da6b6fb3b9639b766a6aa
|
|
BLAKE2b-256 checksum How to use checksums |
8d59295a69caa984ba4b0056fbedf453389a9fa0f69d84c1315905b3e8c1ced5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for numtest 2.0.6
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.
