fix(nwis): stop emitting a DeprecationWarning at import time#300
Draft
thodson-usgs wants to merge 1 commit into
Draft
fix(nwis): stop emitting a DeprecationWarning at import time#300thodson-usgs wants to merge 1 commit into
thodson-usgs wants to merge 1 commit into
Conversation
nwis.py warned at module top-level, and dataretrieval/__init__ star-imports nwis, so `import dataretrieval` emitted a DeprecationWarning for every consumer (including waterdata-only users) and failed to import entirely under `-W error::DeprecationWarning`, which is common in CI. Deprecation is already signaled where it matters: the @_deprecated decorator emits a per-function warning on every nwis call. Removed the redundant module-level warning; the per-function warnings are unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Problem
dataretrieval/nwis.pyissues aDeprecationWarningat module top-level, anddataretrieval/__init__.pydoesfrom dataretrieval.nwis import *unconditionally. Soimport dataretrievalemits aDeprecationWarningfor every consumer — even users who only touch thewaterdatamodule — and fails to import at all under-W error::DeprecationWarning(a common CI configuration):Fix
Remove the module-level warning. Deprecation is already signaled where it's actionable: the
@_deprecateddecorator wraps every public nwis function and emits a per-functionDeprecationWarningon use (with a thread-local guard so layered wrappers warn once). That targeted mechanism is unchanged.Verification
python -W error::DeprecationWarning -c "import dataretrieval"now succeeds.nwis.get_record(...)→`nwis.get_record` is deprecated and will be removed ... use the appropriate `waterdata.get_*()` ...ruffclean.🤖 Generated with Claude Code