Update `check_satpy` to use new `show_version` to display package versions

verduijn commented 2 months ago

MR to add show_versions to satpy.utils to allow for use in satpy.utils.check_satpy. Use case is to help in figuring out run-time environment factors while debugging issues.

verduijn commented 2 months ago

Thanks for the feedback!

I figured that check_satpy was in the default issue template, so it could be useful to have the versions information in there.

From there:

I thought i could expose the show_versions functionality itself without much downside
check_satpy was flexible with extras so I just did the same
since extras and packages was essentially the same I just renamed it

rounding up I think we should either:

remove show_versions and add it, with hardcoded packages, in check_satpy
Having a hard coded show_versions function and reverting the check_satpy function if it's not desirable to add the versions in check_satpy.

djhoese commented 2 months ago

Good point with it being in the issue template. We wouldn't want users to have to run multiple things to show similar information. In that case I agree that the versions after the readers/writers in check_satpy does make more sense than the "ok" that is there now. Ok I'm coming around. Thanks for explaining your reasoning.

verduijn commented 1 month ago

I guess it's ready for review?

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.05%. Comparing base (9e3b342) to head (692c9b1). Report is 79 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2913 +/- ## ========================================== - Coverage 96.06% 96.05% -0.01% ========================================== Files 373 373 Lines 54465 54479 +14 ========================================== + Hits 52321 52330 +9 - Misses 2144 2149 +5 ``` | [Flag](https://app.codecov.io/gh/pytroll/satpy/pull/2913/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pytroll) | Coverage Δ | | |---|---|---| | [behaviourtests](https://app.codecov.io/gh/pytroll/satpy/pull/2913/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pytroll) | `3.99% <11.90%> (+<0.01%)` | :arrow_up: | | [unittests](https://app.codecov.io/gh/pytroll/satpy/pull/2913/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pytroll) | `96.15% <100.00%> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pytroll#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coveralls commented 1 month ago

Pull Request Test Coverage Report for Build 11236933264

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

42 of 42 (100.0%) changed or added relevant lines in 2 files are covered.
14 unchanged lines in 5 files lost coverage.
Overall coverage decreased (-0.01%) to 96.151%

Files with Coverage Reduction	New Missed Lines	%
satpy/composites/config_loader.py	2	94.12%
satpy/tests/utils.py	2	93.16%
satpy/tests/reader_tests/gms/test_gms5_vissr_l1b.py	3	98.67%
satpy/tests/reader_tests/gms/test_gms5_vissr_navigation.py	3	97.18%
satpy/readers/msi_safe.py	4	98.41%
<!--	Total:	14	-->

Totals
Change from base Build 10957325874:	-0.01%
Covered Lines:	52564
Relevant Lines:	54668

pytroll / satpy