search

modflowpy / flopy

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

refactor(datafile): deprecate list_records() and other list_ methods #2232

Closed mwtoews closed 2 months ago

mwtoews commented 2 months ago

Now that data files have a .headers data frame property (#2221), there is no need to have methods that print parts of this information to stdout (they return None). This PR deprecates the following:

The last two only apply to CellBudgetFile. This PR does not apply to flopy.mf6.utils.mfobservation.list_records().

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 70.8%. Comparing base (e2a85a3) to head (d331ae1). Report is 1 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2232 +/- ## ========================================= - Coverage 70.8% 70.8% -0.1% ========================================= Files 294 294 Lines 59026 59025 -1 ========================================= - Hits 41832 41806 -26 - Misses 17194 17219 +25 ``` | [Files](https://app.codecov.io/gh/modflowpy/flopy/pull/2232?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy) | Coverage Δ | | |---|---|---| | [flopy/utils/binaryfile.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2232?src=pr&el=tree&filepath=flopy%2Futils%2Fbinaryfile.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvdXRpbHMvYmluYXJ5ZmlsZS5weQ==) | `82.0% <100.0%> (+0.5%)` | :arrow_up: | | [flopy/utils/datafile.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2232?src=pr&el=tree&filepath=flopy%2Futils%2Fdatafile.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvdXRpbHMvZGF0YWZpbGUucHk=) | `74.7% <100.0%> (+1.4%)` | :arrow_up: | | [flopy/utils/formattedfile.py](https://app.codecov.io/gh/modflowpy/flopy/pull/2232?src=pr&el=tree&filepath=flopy%2Futils%2Fformattedfile.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy#diff-ZmxvcHkvdXRpbHMvZm9ybWF0dGVkZmlsZS5weQ==) | `88.9% <ø> (ø)` | | ... and [9 files with indirect coverage changes](https://app.codecov.io/gh/modflowpy/flopy/pull/2232/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=modflowpy)