fix(autotest): skip tests that need an optional dependency - #2797
Merged
Conversation
The nightly optional dependency job runs the test suite with only the required dependencies installed. Tests that build a DISV or DISU grid, an hfb array, or a Delaunay triangulation failed there with an ImportError for shapely or scipy rather than being skipped, and a module level import of pyshp or scipy stopped test_export, test_grid, and test_shapefile_utils from being collected at all. Those tests are now marked with the package they need and the module level imports have been moved into the tests that use them. The parameter list for test_voronoi_grid was emptied when shapely or scipy was missing while its list of ids was not, which is a collection error; the test is skipped by its requires_pkg mark, so the guard has been removed.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2797 +/- ##
===========================================
+ Coverage 55.5% 72.8% +17.2%
===========================================
Files 644 662 +18
Lines 124135 133012 +8877
===========================================
+ Hits 68947 96847 +27900
+ Misses 55188 36165 -19023 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates FloPy’s test suite to correctly skip tests that require optional dependencies (notably shapely, scipy, and pyshp) so that optional-dependency CI jobs don’t fail on ImportError and test modules remain collectable.
Changes:
- Added
requires_pkg(...)markers (orpytest.importorskip(...)in fixtures) to tests that require optional dependencies. - Moved module-level optional imports (
scipy.spatial.Delaunay,shapefile) into the specific tests that use them to avoid collection-time import failures. - Removed the
has_pkg(...)parameter-list guard intest_voronoi_gridthat could cause a collection error whenidsremained non-empty.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| autotest/test_postprocessing.py | Marks DISV/DISU transmissivity tests as requiring shapely. |
| autotest/test_plot_map_view.py | Skips non-structured grid HFB fixtures when shapely is unavailable. |
| autotest/test_plot_cross_section.py | Skips non-structured grid HFB cross-section fixtures when shapely is unavailable. |
| autotest/test_lgrutil.py | Marks the hanging-vertices LGR test as requiring shapely. |
| autotest/test_hfb_util.py | Applies a module-level requires_pkg("shapely") mark since all tests require it. |
| autotest/test_gridintersect.py | Adds requires_pkg("shapely") to specific tests that require shapely geometry helpers. |
| autotest/test_grid.py | Moves Delaunay imports into tests and marks them with requires_pkg("scipy"); removes faulty param-list guard now covered by requires_pkg. |
| autotest/test_export.py | Moves shapefile import into the shapefile export tests (already guarded by requires_pkg("pyshp", ...)). |
| autotest/test_cellbudgetfile.py | Marks DISV/DISU-related MF6 budget tests as requiring shapely. |
| autotest/test_binaryfile.py | Marks DISV/DISU-related MF6 headfile tests as requiring shapely. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
Tests that build a DISV or DISU grid, an hfb array, or a Delaunay triangulation failed in the nightly optional dependency job with an
ImportErrorfor shapely or scipy rather than being skipped, and a module level import of pyshp or scipy stoppedtest_export,test_grid, andtest_shapefile_utilsfrom being collected. Those tests are now marked with the package they need and the module level imports have been moved into the tests that use them.The parameter list for
test_voronoi_gridwas emptied when shapely or scipy was missing while its list of ids was not, which is a collection error; the test is skipped by itsrequires_pkgmark, so the guard has been removed.