Add SiteTypeCode and StatisticCode enums for waterdata parameters#234
Draft
thodson-usgs wants to merge 1 commit intoDOI-USGS:mainfrom
Draft
Add SiteTypeCode and StatisticCode enums for waterdata parameters#234thodson-usgs wants to merge 1 commit intoDOI-USGS:mainfrom
thodson-usgs wants to merge 1 commit intoDOI-USGS:mainfrom
Conversation
Exposes discoverable constants for the `site_type_code` and `statistic_id` parameters so callers get IDE autocompletion without breaking any existing string-based usage (both enums extend `str`). Closes DOI-USGS#98 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SiteTypeCodeandStatisticCodeasstr-based enums indataretrieval/waterdata/enums.pydataretrieval.waterdatapublic APIstr, so existing callers passing plain strings are unaffected — the enums are purely additiveSiteTypeCodecovers all 56 site types fromget_reference_table("site-types")StatisticCodecovers the 17 named statistic codes (excluding the 90+ numeric percentile entries)Usage example:
Closes #98
Test plan
python -m pytest tests/waterdata_test.py— all 26 tests passget_monitoring_locations(state_name="Connecticut", site_type_code=SiteTypeCode.WELL)returns onlyGWsitesrequestsserializes enum values correctly (uses native string value, not__repr__)