From 593f4202e8ba59e11659dc34660d6cf6c72197b3 Mon Sep 17 00:00:00 2001 From: Elise Hinman <121896266+ehinman@users.noreply.github.com> Date: Fri, 8 Mar 2024 08:37:34 -0600 Subject: [PATCH] Add warning message for qw data queries (#134) * add warning message for qw data queries --------- Co-authored-by: Timothy Hodson <34148978+thodson-usgs@users.noreply.github.com> --- dataretrieval/nwis.py | 18 ++++++++++++++++-- dataretrieval/wqp.py | 4 ++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/dataretrieval/nwis.py b/dataretrieval/nwis.py index 8134a26..1c72714 100644 --- a/dataretrieval/nwis.py +++ b/dataretrieval/nwis.py @@ -126,12 +126,14 @@ def get_qwdata( .. warning:: - WARNING: Beginning in February 2024 the NWIS qw data endpoint will not deliver new data or updates to existing data. + WARNING: Beginning in March 2024 the NWIS qw data endpoint will + not deliver new data or updates to existing data. Eventually the endpoint will be retired. For updated information visit: https://waterdata.usgs.gov.nwis/qwdata For additional details, see the R package vignette: https://doi-usgs.github.io/dataRetrieval/articles/Status.html - If you have additional questions about the qw data service, email CompTools@usgs.gov. + If you have additional questions about the qw data service, + email CompTools@usgs.gov. Parameters ---------- @@ -175,6 +177,12 @@ def get_qwdata( ... ) """ + warnings.warn(('WARNING: Starting in March 2024, the NWIS qw data endpoint is ' + 'retiring and no longer receives updates. For more information, ' + 'refer to https://waterdata.usgs.gov.nwis/qwdata and ' + 'https://doi-usgs.github.io/dataRetrieval/articles/Status.html ' + 'or email CompTools@usgs.gov.')) + _check_sites_value_types(sites) kwargs['site_no'] = kwargs.pop('site_no', sites) @@ -758,6 +766,12 @@ def get_info(ssl_check: bool = True, **kwargs) -> Tuple[pd.DataFrame, BaseMetada """ seriesCatalogOutput = kwargs.pop('seriesCatalogOutput', None) if seriesCatalogOutput in ['True', 'TRUE', 'true', True]: + + warnings.warn(('WARNING: Starting in March 2024, the NWIS qw data endpoint is ' + 'retiring and no longer receives updates. For more information, ' + 'refer to https://waterdata.usgs.gov.nwis/qwdata and ' + 'https://doi-usgs.github.io/dataRetrieval/articles/Status.html ' + 'or email CompTools@usgs.gov.')) # convert bool to string if necessary kwargs['seriesCatalogOutput'] = 'True' else: diff --git a/dataretrieval/wqp.py b/dataretrieval/wqp.py index a352ef8..051b299 100644 --- a/dataretrieval/wqp.py +++ b/dataretrieval/wqp.py @@ -491,8 +491,8 @@ def _warn_v3_profiles_outage(): """Private function for warning message about WQX 3.0 profiles """ - warnings.warn(('NEWS: USGS discrete water quality data availability ' - 'and format are changing. Beginning in February 2024 ' + warnings.warn(('USGS discrete water quality data availability ' + 'and format are changing. Beginning in March 2024 ' 'the data obtained from legacy profiles will not ' 'include new USGS data or recent updates to existing ' 'data. To view the status of changes in data '