Skip to content

fix(waterdata)!: return (df, BaseMetadata) from get_codes #301

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

Merged
thodson-usgs merged 1 commit into from
Jun 1, 2026
+9 −2
Merged

fix(waterdata)!: return (df, BaseMetadata) from get_codes #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions dataretrieval/waterdata/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2100,7 +2100,7 @@ def get_reference_table(
)


def get_codes(code_service: CODE_SERVICES) -> pd.DataFrame:
def get_codes(code_service: CODE_SERVICES) -> tuple[pd.DataFrame, BaseMetadata]:
"""Return codes from a Samples code service.

Parameters
Expand All @@ -2109,6 +2109,13 @@ def get_codes(code_service: CODE_SERVICES) -> pd.DataFrame:
One of the following options: "states", "counties", "countries"
"sitetype", "samplemedia", "characteristicgroup", "characteristics",
or "observedproperty"

Returns
-------
df : ``pandas.DataFrame``
The requested code table.
md : :obj:`dataretrieval.utils.BaseMetadata`
Metadata for the query (URL, query time, response headers).
"""
valid_code_services = get_args(CODE_SERVICES)
if code_service not in valid_code_services:
Expand All @@ -2128,7 +2135,7 @@ def get_codes(code_service: CODE_SERVICES) -> pd.DataFrame:

df = pd.DataFrame(data_list)

return df
return df, BaseMetadata(response)


def _get_samples_csv(
Expand Down
Loading