refactor(datafile): deprecate list_records() and other list_ methods #2232
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.
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 returnNone
). This PR deprecates the following:list_records()
: useheaders
insteadlist_unique_records()
: useheaders[["text", "imeth"]].drop_duplicates()
insteadlist_unique_packages(to=True/False)
: useheaders.paknam.drop_duplicates()
orheaders.paknam2.unique()
(there are a few ways)The last two only apply to CellBudgetFile. This PR does not apply to
flopy.mf6.utils.mfobservation.list_records()
.