modflowpy / flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://flopy.readthedocs.io
Other
507 stars 307 forks source link

refactor(expired deprecation): raise AttributeError with to_shapefile #2200

Closed mwtoews closed 3 months ago

mwtoews commented 3 months ago

This PR changes deprecated .to_shapefile() functions to raise AttributeError with a helpful message.

These are the affected functions:

While these functions have been deprecated since 3.2.4 released in 2016 (changelog), they were never documented as such. Thus a helpful exception message and cross-referenced docstring is used instead of removing these functions.


Xref to #1884 where a similar approach was used.

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 69.8%. Comparing base (a49b613) to head (483c493). Report is 4 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2200 +/- ## ========================================= + Coverage 66.2% 69.8% +3.5% ========================================= Files 294 294 Lines 58856 59012 +156 ========================================= + Hits 39009 41224 +2215 + Misses 19847 17788 -2059 ``` | [Files](https://app.codecov.io/gh/modflowpy/flopy/pull/2200?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy) | Coverage Δ | | |---|---|---| | [flopy/mbase.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2200?src=pr&el=tree&filepath=flopy%2Fmbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvbWJhc2UucHk=) | `69.9% <100.0%> (+0.3%)` | :arrow_up: | | [flopy/pakbase.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2200?src=pr&el=tree&filepath=flopy%2Fpakbase.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvcGFrYmFzZS5weQ==) | `81.9% <100.0%> (+1.0%)` | :arrow_up: | | [flopy/utils/util\_list.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2200?src=pr&el=tree&filepath=flopy%2Futils%2Futil_list.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvdXRpbHMvdXRpbF9saXN0LnB5) | `73.9% <100.0%> (+1.1%)` | :arrow_up: | ... and [208 files with indirect coverage changes](https://app.codecov.io/gh/modflowpy/flopy/pull/2200/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy)