Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove hardcoded format in nwis.get_discharge_measurements #149

Closed
wants to merge 2 commits into from
Closed

Remove hardcoded format in nwis.get_discharge_measurements #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d35a2e4
Remove hardcoded format in nwis.get_discharge_measurements
thodson-usgs Aug 7, 2024
c39a7d4
Update URL format in tests
thodson-usgs Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion dataretrieval/nwis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,8 +309,11 @@ def get_discharge_measurements(
kwargs['begin_date'] = kwargs.pop('begin_date', start)
kwargs['end_date'] = kwargs.pop('end_date', end)

if 'format' not in kwargs:
kwargs['format'] = 'rdb'

response = query_waterdata(
'measurements', format='rdb', ssl_check=ssl_check, **kwargs
'measurements', ssl_check=ssl_check, **kwargs
)
return _read_rdb(response.text), NWIS_Metadata(response, **kwargs)

Expand Down
66 changes: 33 additions & 33 deletions tests/waterservices_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ def test_get_dv(requests_mock):
"""Tests get_dv method correctly generates the request url and returns the result in a DataFrame"""
format = "json"
site = '01491000%2C01645000'
request_url = 'https://waterservices.usgs.gov/nwis/dv?format={}' \
'&startDT=2020-02-14&endDT=2020-02-15&sites={}'.format(format, site)
request_url = f'https://waterservices.usgs.gov/nwis/dv?format={format}' \
f'&startDT=2020-02-14&endDT=2020-02-15&sites={site}'
response_file_path = 'data/waterservices_dv.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_dv(sites=["01491000", "01645000"], start='2020-02-14', end='2020-02-15')
Expand All @@ -95,10 +95,10 @@ def test_get_dv(requests_mock):
@pytest.mark.parametrize("site_input_type_list", [True, False])
def test_get_dv_site_value_types(requests_mock, site_input_type_list):
"""Tests get_dv method for valid input types for the 'sites' parameter"""
_format = "json"
format = "json"
site = '01491000'
request_url = 'https://waterservices.usgs.gov/nwis/dv?format={}' \
'&startDT=2020-02-14&endDT=2020-02-15&sites={}'.format(_format, site)
request_url = f'https://waterservices.usgs.gov/nwis/dv?format={format}' \
f'&startDT=2020-02-14&endDT=2020-02-15&sites={site}'
response_file_path = 'data/waterservices_dv.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand All @@ -116,8 +116,8 @@ def test_get_iv(requests_mock):
"""Tests get_iv method correctly generates the request url and returns the result in a DataFrame"""
format = "json"
site = '01491000%2C01645000'
request_url = 'https://waterservices.usgs.gov/nwis/iv?format={}' \
'&startDT=2019-02-14&endDT=2020-02-15&sites={}'.format(format, site)
request_url = f'https://waterservices.usgs.gov/nwis/iv?format={format}' \
f'&startDT=2019-02-14&endDT=2020-02-15&sites={site}'
response_file_path = 'data/waterservices_iv.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_iv(sites=["01491000", "01645000"], start='2019-02-14', end='2020-02-15')
Expand All @@ -132,10 +132,10 @@ def test_get_iv(requests_mock):
@pytest.mark.parametrize("site_input_type_list", [True, False])
def test_get_iv_site_value_types(requests_mock, site_input_type_list):
"""Tests get_iv method for valid input type for the 'sites' parameter"""
_format = "json"
format = "json"
site = '01491000'
request_url = 'https://waterservices.usgs.gov/nwis/iv?format={}' \
'&startDT=2019-02-14&endDT=2020-02-15&sites={}'.format(_format, site)
request_url = f'https://waterservices.usgs.gov/nwis/iv?format={format}' \
f'&startDT=2019-02-14&endDT=2020-02-15&sites={site}'
response_file_path = 'data/waterservices_iv.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand All @@ -158,7 +158,7 @@ def test_get_info(requests_mock):
format = "rdb"
site = '01491000%2C01645000'
parameter_cd = "00618"
request_url = 'https://waterservices.usgs.gov/nwis/site?sites={}&parameterCd={}&siteOutput=Expanded&format={}'.format(site, parameter_cd, format)
request_url = f'https://waterservices.usgs.gov/nwis/site?sites={site}&parameterCd={parameter_cd}&siteOutput=Expanded&format={format}'
response_file_path = 'data/waterservices_site.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_info(sites=["01491000", "01645000"], parameterCd="00618")
Expand All @@ -182,10 +182,10 @@ def test_get_qwdata(requests_mock):
"""Tests get_qwdata method correctly generates the request url and returns the result in a DataFrame"""
format = "rdb"
site = '01491000%2C01645000'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/qwdata?site_no={}' \
'&qw_sample_wide=qw_sample_wide&agency_cd=USGS&format={}&pm_cd_compare=Greater+than' \
'&inventory_output=0&rdb_inventory_output=file&TZoutput=0&rdb_qw_attributes=expanded' \
'&date_format=YYYY-MM-DD&rdb_compression=value&submitted_form=brief_list'.format(site, format)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/qwdata?site_no={site}' \
f'&qw_sample_wide=qw_sample_wide&agency_cd=USGS&format={format}&pm_cd_compare=Greater+than' \
f'&inventory_output=0&rdb_inventory_output=file&TZoutput=0&rdb_qw_attributes=expanded' \
f'&date_format=YYYY-MM-DD&rdb_compression=value&submitted_form=brief_list'
response_file_path = 'data/waterdata_qwdata.txt'
mock_request(requests_mock, request_url, response_file_path)
with pytest.warns(DeprecationWarning):
Expand All @@ -212,10 +212,10 @@ def test_get_qwdata_site_value_types(requests_mock, site_input_type_list):
"""Tests get_qwdata method for valid input types for the 'sites' parameter"""
_format = "rdb"
site = '01491000'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/qwdata?site_no={}' \
'&qw_sample_wide=qw_sample_wide&agency_cd=USGS&format={}&pm_cd_compare=Greater+than' \
'&inventory_output=0&rdb_inventory_output=file&TZoutput=0&rdb_qw_attributes=expanded' \
'&date_format=YYYY-MM-DD&rdb_compression=value&submitted_form=brief_list'.format(site, _format)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/qwdata?site_no={site}' \
f'&qw_sample_wide=qw_sample_wide&agency_cd=USGS&format={format}&pm_cd_compare=Greater+than' \
f'&inventory_output=0&rdb_inventory_output=file&TZoutput=0&rdb_qw_attributes=expanded' \
f'&date_format=YYYY-MM-DD&rdb_compression=value&submitted_form=brief_list'
response_file_path = 'data/waterdata_qwdata.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand All @@ -232,8 +232,8 @@ def test_get_gwlevels(requests_mock):
"""Tests get_gwlevels method correctly generates the request url and returns the result in a DataFrame."""
format = "rdb"
site = '434400121275801'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/gwlevels?format={}&begin_date=1851-01-01' \
'&site_no={}'.format(format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/gwlevels?format={format}&begin_date=1851-01-01' \
f'&site_no={site}'
response_file_path = 'data/waterdata_gwlevels.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_gwlevels(sites=site)
Expand All @@ -247,10 +247,10 @@ def test_get_gwlevels(requests_mock):
@pytest.mark.parametrize("site_input_type_list", [True, False])
def test_get_gwlevels_site_value_types(requests_mock, site_input_type_list):
"""Tests get_gwlevels method for valid input types for the 'sites' parameter."""
_format = "rdb"
format = "rdb"
site = '434400121275801'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/gwlevels?format={}&begin_date=1851-01-01' \
'&site_no={}'.format(_format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/gwlevels?format={format}&begin_date=1851-01-01' \
f'&site_no={site}'
response_file_path = 'data/waterdata_gwlevels.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand All @@ -267,8 +267,8 @@ def test_get_discharge_peaks(requests_mock):
"""Tests get_discharge_peaks method correctly generates the request url and returns the result in a DataFrame"""
format = "rdb"
site = '01594440'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/peaks?format={}&site_no={}' \
'&begin_date=2000-02-14&end_date=2020-02-15'.format(format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/peaks?format={format}&site_no={site}' \
f'&begin_date=2000-02-14&end_date=2020-02-15'
response_file_path = 'data/waterservices_peaks.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_discharge_peaks(sites=[site], start='2000-02-14', end='2020-02-15')
Expand All @@ -283,10 +283,10 @@ def test_get_discharge_peaks(requests_mock):
def test_get_discharge_peaks_sites_value_types(requests_mock, site_input_type_list):
"""Tests get_discharge_peaks for valid input types of the 'sites' parameter"""

_format = "rdb"
format = "rdb"
site = '01594440'
request_url = 'https://nwis.waterdata.usgs.gov/nwis/peaks?format={}&site_no={}' \
'&begin_date=2000-02-14&end_date=2020-02-15'.format(_format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/peaks?format={format}&site_no={site}' \
f'&begin_date=2000-02-14&end_date=2020-02-15'
response_file_path = 'data/waterservices_peaks.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand All @@ -306,8 +306,8 @@ def test_get_discharge_measurements(requests_mock):
DataFrame"""
format = "rdb"
site = "01594440"
request_url = 'https://nwis.waterdata.usgs.gov/nwis/measurements?format={}&site_no={}' \
'&begin_date=2000-02-14&end_date=2020-02-15'.format(format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/measurements?site_no={site}' \
f'&begin_date=2000-02-14&end_date=2020-02-15&format={format}'
response_file_path = 'data/waterdata_measurements.txt'
mock_request(requests_mock, request_url, response_file_path)
df, md = get_discharge_measurements(sites=[site], start='2000-02-14', end='2020-02-15')
Expand All @@ -323,8 +323,8 @@ def test_get_discharge_measurements_sites_value_types(requests_mock, site_input_
"""Tests get_discharge_measurements method for valid input types for 'sites' parameter"""
_format = "rdb"
site = "01594440"
request_url = 'https://nwis.waterdata.usgs.gov/nwis/measurements?format={}&site_no={}' \
'&begin_date=2000-02-14&end_date=2020-02-15'.format(_format, site)
request_url = f'https://nwis.waterdata.usgs.gov/nwis/measurements?site_no={site}' \
f'&begin_date=2000-02-14&end_date=2020-02-15&format={format}'
response_file_path = 'data/waterdata_measurements.txt'
mock_request(requests_mock, request_url, response_file_path)
if site_input_type_list:
Expand Down
Loading