From d8afc77d2c14143a8eade4c8c27d84b1a17961a3 Mon Sep 17 00:00:00 2001 From: Dave Tapley Date: Thu, 1 Jun 2023 10:58:07 -0700 Subject: [PATCH 1/2] Add DataFrame type annotation This is sufficient for Pyright to infer the complete return type for (at least) nwis.get_info and nwis.get_iv. https://github.com/DOI-USGS/dataretrieval-python/issues/97 --- dataretrieval/nwis.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dataretrieval/nwis.py b/dataretrieval/nwis.py index 57cbccf6..92434e01 100644 --- a/dataretrieval/nwis.py +++ b/dataretrieval/nwis.py @@ -31,7 +31,7 @@ WATERDATA_SERVICES = ['qwdata', 'measurements', 'peaks', 'pmcodes', 'water_use', 'ratings'] -def format_response(df, service=None, **kwargs): +def format_response(df: pd.DataFrame, service=None, **kwargs): """Setup index for response from query. This function formats the response from the NWIS web services, in @@ -79,7 +79,7 @@ def format_response(df, service=None, **kwargs): return df.sort_index() -def preformat_peaks_response(df): +def preformat_peaks_response(df: pd.DataFrame): """Datetime formatting for the 'peaks' service response. Function to format the datetime column of the 'peaks' service response. From 05b30e66282dba7cbd8865f2078d9ff0da66f492 Mon Sep 17 00:00:00 2001 From: Dave Tapley Date: Mon, 5 Jun 2023 11:44:25 -0700 Subject: [PATCH 2/2] Update dataretrieval/nwis.py Co-authored-by: Timothy Hodson <34148978+thodson-usgs@users.noreply.github.com> --- dataretrieval/nwis.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dataretrieval/nwis.py b/dataretrieval/nwis.py index 92434e01..0f3a1a99 100644 --- a/dataretrieval/nwis.py +++ b/dataretrieval/nwis.py @@ -31,7 +31,7 @@ WATERDATA_SERVICES = ['qwdata', 'measurements', 'peaks', 'pmcodes', 'water_use', 'ratings'] -def format_response(df: pd.DataFrame, service=None, **kwargs): +def format_response(df: pd.DataFrame, service=None, **kwargs) -> pd.DataFrame: """Setup index for response from query. This function formats the response from the NWIS web services, in