ENH: Deal appropriately with user warnings #2478
Conversation
jhlegarreta
commented
Nov 4, 2021
•
jhlegarreta
commented
- ENH: Appropriately deal with user warnings in tests
- STYLE: Improve the warning message style
- DOC: Fix method name typo in deprecation warning
|
Not sure why these are failing: Windows CONDA Python37-64bit + OPTIONAL_DEPS: errors installing DIPY Windows CONDA Python37-64bit: errors installing DIPY Windows Python38-64bit: failing at Error reports all seem unrelated to the patch set. Maybe re-running them would allow tests to pass. |
Codecov Report
@@ Coverage Diff @@
## master #2478 +/- ##
==========================================
- Coverage 81.96% 81.95% -0.01%
==========================================
Files 125 125
Lines 16637 16637
Branches 2703 2703
==========================================
- Hits 13636 13635 -1
Misses 2373 2373
- Partials 628 629 +1
|
|
LGTM. The CI failures are unrelated, right? |
Updated my previous comment with the additional two builds that failed. CI failures seem unrelated to me. |
jhlegarreta
force-pushed
the
DealAppropriatelyWithUserWarnings
branch
from
55a00a1
to
254c09e
Compare
|
Had left one warning behind. Push-forced. |
jhlegarreta
force-pushed
the
DealAppropriatelyWithUserWarnings
branch
from
254c09e
to
4088f4a
Compare
jhlegarreta
force-pushed
the
DealAppropriatelyWithUserWarnings
branch
2 times, most recently
from
6ee3500
to
36e0b9d
Compare
|
Rebased on |
There was a problem hiding this comment.
Thanks @jhlegarreta for this. I have just a small comment below
Appropriately deal with user warnings in tests:
- Avoid unnecessarily raising user warnings.
- Catch user warnings where required.
Avoids unnecessarily displaying warnings:
```
reconst/tests/test_ivim.py::test_single_voxel_fit
/home/vsts/work/1/s/venv/lib/python3.9/site-packages/dipy/core/gradients.py:300:
UserWarning:
b0_threshold (value: 0) is too low, increase your b0_threshold. It should be higher than the lowest b0 value (5.0).
warn("b0_threshold (value: {0}) is too low, increase your \
```
and
```
reconst/tests/test_mcsd.py::test_mask_for_response_msmt_nvoxels
/home/vsts/work/1/s/venv/lib/python3.9/site-packages/dipy/reconst/mcsd.py:590: UserWarning:
Some b-values are higher than 1200.
The DTI fit might be affected.
warnings.warn(msg_bvals, UserWarning)
```
and
```
reconst/tests/test_shm.py::test_real_sym_sh_mrtrix
/home/vsts/work/1/s/venv/lib/python3.9/site-packages/dipy/reconst/tests/test_shm.py:120:
DeprecationWarning: dipy.reconst.shm.real_sym_sh_mrtix is deprecated, Please use dipy.reconst.shm.real_sh_tournier instead
```
Visible, for example, in:
https://dev.azure.com/dipy/dipy/_build/results?buildId=1340&view=logs&j=b82538f6-45b4-59fa-d676-9f3844eed7f4&t=6b675e20-6c23-5053-d81a-1533e41542cf&l=5362
and
https://dev.azure.com/dipy/dipy/_build/results?buildId=1340&view=logs&j=b82538f6-45b4-59fa-d676-9f3844eed7f4&t=6b675e20-6c23-5053-d81a-1533e41542cf&l=5372
and
https://dev.azure.com/dipy/dipy/_build/results?buildId=1340&view=logs&j=b82538f6-45b4-59fa-d676-9f3844eed7f4&t=6b675e20-6c23-5053-d81a-1533e41542cf&l=5386
Improve the warning message style: avoid whitespaces due to string
literal line breaks in code.
Allows to show:
```
UserWarning: b0_threshold (value: 0) is too low, increase your b0_threshold. It should be higher than the lowest b0 value (5.0).
warn("b0_threshold (value: {0}) is too low, increase your "
```
instead of:
```
UserWarning: b0_threshold (value: 0) is too low, increase your b0_threshold. It should be higher than the lowest b0 value (5.0).
warn("b0_threshold (value: {0}) is too low, increase your \
```
Fix method name typo in deprecation warning.
jhlegarreta
force-pushed
the
DealAppropriatelyWithUserWarnings
branch
from
36e0b9d
to
db632c6
Compare
|
Linux CONDA Python37-64bit: failing at Windows CONDA Python37-64bit: failing at Windows Python36-64bit: failing at Unrelated. |
|
thank you @jhlegarreta! |
