Skip to content

Deprecate nadp module#243

Merged
thodson-usgs merged 1 commit intoDOI-USGS:mainfrom
thodson-usgs:deprecate-nadp
May 1, 2026
Merged

Deprecate nadp module#243
thodson-usgs merged 1 commit intoDOI-USGS:mainfrom
thodson-usgs:deprecate-nadp

Conversation

@thodson-usgs
Copy link
Copy Markdown
Collaborator

@thodson-usgs thodson-usgs commented May 1, 2026 •
edited
Loading

Summary

  • Adds a DeprecationWarning to every public function in dataretrieval.nadp (get_annual_MDN_map, get_annual_NTN_map, get_zip).
  • The warning notes the scheduled removal date of 2026-11-01 (six months from this deprecation) and points users to retrieve NADP data directly from https://nadp.slh.wisc.edu/.
  • Adds a NEWS.md entry.

Tracking issue with full justification and timeline: #244.

Test plan

  • python3 -c "import dataretrieval.nadp; ..." confirms each of the three public functions raises DeprecationWarning with the expected message.
  • Existing tests/nadp_test.py should continue to pass (warnings are emitted but not errors); CI to confirm.

🤖 Generated with Claude Code

@thodson-usgs @claude
Deprecate nadp module ahead of 2026-11-01 removal
0782f70 
Each public function in `dataretrieval.nadp` (`get_annual_MDN_map`,
`get_annual_NTN_map`, `get_zip`) now emits a `DeprecationWarning` on
call, pointing users to retrieve NADP data directly from
https://nadp.slh.wisc.edu/. NADP is not a USGS service, and the
module has been lightly maintained (with several long-standing TODOs
that were never picked up); keeping it in `dataretrieval` is out of
scope for a USGS water-data package.

The module is scheduled for removal on or after 2026-11-01 (six
months after this deprecation lands), tracked in the linked issue.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@thodson-usgs thodson-usgs mentioned this pull request May 1, 2026
Open
@thodson-usgs thodson-usgs changed the title Deprecate nadp module ahead of 2026-11-01 removal Deprecate nadp module May 1, 2026
@thodson-usgs thodson-usgs merged commit 51ac674 into DOI-USGS:main May 1, 2026
8 checks passed
@thodson-usgs thodson-usgs mentioned this pull request May 4, 2026
Merged
2 tasks
thodson-usgs added a commit that referenced this pull request May 4, 2026
@thodson-usgs @claude
Skip NADP live-API tests (module deprecated) (#259)
40eac2b 
The NADP module is deprecated and scheduled for removal on 2026-11-01
(see #243). Both tests in this file hit the live NADP services and have
been intermittently exhausting CI retries. Skip them via `pytestmark`
rather than deleting, so the test bodies remain available if needed
during the deprecation window.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 6, 2026
Closed
Merged
Merged
thodson-usgs added a commit to thodson-usgs/dataretrieval-python that referenced this pull request May 7, 2026
@thodson-usgs @claude
Deprecate the remaining active nwis functions ahead of 2027-05-06 rem…
68dbd73 
…oval

The module-level "use waterdata instead" warning has been firing on
import for a while; this PR makes the migration guidance actionable
by emitting a per-function DeprecationWarning that names the specific
waterdata replacement the user should switch to.

Once peaks (DOI-USGS#267) and ratings (DOI-USGS#269) land, every active nwis function
has a waterdata replacement, so all nine of them are deprecated here:

  nwis.get_dv               -> waterdata.get_daily()
  nwis.get_iv               -> waterdata.get_continuous()
  nwis.get_info             -> waterdata.get_monitoring_locations()
  nwis.what_sites           -> waterdata.get_monitoring_locations()
  nwis.get_stats            -> waterdata.get_stats_por() /
                              waterdata.get_stats_date_range()
  nwis.get_discharge_peaks  -> waterdata.get_peaks()
  nwis.get_ratings          -> waterdata.get_ratings()
  nwis.get_record           -> the appropriate waterdata.get_*()
  nwis.query_waterdata      -> a high-level waterdata.get_*() helper
  nwis.query_waterservices  -> a high-level waterdata.get_*() helper

(get_qwdata, get_discharge_measurements, get_gwlevels, get_pmcodes,
and get_water_use are already defunct and raise NameError.)

Implementation follows the nadp deprecation template (DOI-USGS#243): a small
_REPLACEMENTS dict + a _warn_deprecated(func_name) helper called as
the first line of each public function. stacklevel=3 makes the
warning point at the caller's code, not the helper's frame.

11 new parametrized tests pin the warning text — that the function
name appears, the replacement helper appears, and the removal date
appears — plus one end-to-end test that get_iv() actually fires
its warning when called.

Removal date is set to 2027-05-06, one full year out (vs. the six
months used for nadp), since nwis is much more widely used and most
users will need migration time. Maintainer can adjust if desired.

This depends on DOI-USGS#267 (waterdata.get_peaks) and DOI-USGS#269 (waterdata.get_ratings)
being merged: until then the deprecation messages for get_discharge_peaks
and get_ratings point at functions users can't yet call. Hold this PR
draft until those land.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
thodson-usgs added a commit to thodson-usgs/dataretrieval-python that referenced this pull request May 7, 2026
@thodson-usgs @claude
Deprecate the remaining active nwis functions ahead of 2027-05-06 rem…
6510ff0 
…oval

The module-level "use waterdata instead" warning has been firing on
import for a while; this PR makes the migration guidance actionable
by emitting a per-function DeprecationWarning that names the specific
waterdata replacement the user should switch to.

Once peaks (DOI-USGS#267) and ratings (DOI-USGS#269) land, every active nwis function
has a waterdata replacement, so all nine of them are deprecated here:

  nwis.get_dv               -> waterdata.get_daily()
  nwis.get_iv               -> waterdata.get_continuous()
  nwis.get_info             -> waterdata.get_monitoring_locations()
  nwis.what_sites           -> waterdata.get_monitoring_locations()
  nwis.get_stats            -> waterdata.get_stats_por() /
                              waterdata.get_stats_date_range()
  nwis.get_discharge_peaks  -> waterdata.get_peaks()
  nwis.get_ratings          -> waterdata.get_ratings()
  nwis.get_record           -> the appropriate waterdata.get_*()
  nwis.query_waterdata      -> a high-level waterdata.get_*() helper
  nwis.query_waterservices  -> a high-level waterdata.get_*() helper

(get_qwdata, get_discharge_measurements, get_gwlevels, get_pmcodes,
and get_water_use are already defunct and raise NameError.)

Implementation follows the nadp deprecation template (DOI-USGS#243): a small
_REPLACEMENTS dict + a _warn_deprecated(func_name) helper called as
the first line of each public function. stacklevel=3 makes the
warning point at the caller's code, not the helper's frame.

11 new parametrized tests pin the warning text — that the function
name appears, the replacement helper appears, and the removal date
appears — plus one end-to-end test that get_iv() actually fires
its warning when called.

Removal date is set to 2027-05-06, one full year out (vs. the six
months used for nadp), since nwis is much more widely used and most
users will need migration time. Maintainer can adjust if desired.

This depends on DOI-USGS#267 (waterdata.get_peaks) and DOI-USGS#269 (waterdata.get_ratings)
being merged: until then the deprecation messages for get_discharge_peaks
and get_ratings point at functions users can't yet call. Hold this PR
draft until those land.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
thodson-usgs added a commit that referenced this pull request May 7, 2026
@thodson-usgs @claude
Deprecate remaining active nwis functions ahead of 2027-05-06 removal (…
18f831f 
…#271)

The module-level "use waterdata instead" warning has been firing on
import for a while; this PR makes the migration guidance actionable
by emitting a per-function DeprecationWarning that names the specific
waterdata replacement the user should switch to.

Every active nwis function has a waterdata replacement, so all nine of them are deprecated here:

  nwis.get_dv               -> waterdata.get_daily()
  nwis.get_iv               -> waterdata.get_continuous()
  nwis.get_info             -> waterdata.get_monitoring_locations()
  nwis.what_sites           -> waterdata.get_monitoring_locations()
  nwis.get_stats            -> waterdata.get_stats_por() /
                              waterdata.get_stats_date_range()
  nwis.get_discharge_peaks  -> waterdata.get_peaks()
  nwis.get_ratings          -> waterdata.get_ratings()
  nwis.get_record           -> the appropriate waterdata.get_*()
  nwis.query_waterdata      -> a high-level waterdata.get_*() helper
  nwis.query_waterservices  -> a high-level waterdata.get_*() helper

(get_qwdata, get_discharge_measurements, get_gwlevels, get_pmcodes,
and get_water_use are already defunct and raise NameError.)

Implementation follows the nadp deprecation template (#243): a small
_REPLACEMENTS dict + a _warn_deprecated(func_name) helper called as
the first line of each public function. stacklevel=3 makes the
warning point at the caller's code, not the helper's frame.

Removal date is set to 2027-05-06. Maintainer can adjust if desired.


Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@thodson-usgs