Skip to content

Commit 702ea29

Browse files
thodson-usgsthodson-usgs
committed
Widen string-filter annotations on get_combined_metadata / get_field_measurements_metadata / get_peaks
These three metadata functions were added to main while PR 229 was in flight, so their string-filter parameters used the narrower `str | list[str] | None`. PR 229's centralized `_get_args` materializes any non-string Iterable (pd.Series, np.ndarray, generators) before sending the request, so the runtime accepts more than `list[str]`. Bring the type annotations in line with the other 11 OGC getters (`str | Iterable[str] | None`). `properties` is intentionally left as `str | list[str] | None` because the join-by-comma site downstream of `_get_args` only handles `list` correctly after the single-string wrap; mirroring the other getters here.
1 parent 42852a8 commit 702ea29

1 file changed

Lines changed: 67 additions & 67 deletions

File tree

‎dataretrieval/waterdata/api.py‎

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -950,61 +950,61 @@ def get_time_series_metadata(
950950

951951

952952
def get_combined_metadata(
953-
monitoring_location_id: str | list[str] | None = None,
954-
parameter_code: str | list[str] | None = None,
955-
parameter_name: str | list[str] | None = None,
956-
parameter_description: str | list[str] | None = None,
957-
unit_of_measure: str | list[str] | None = None,
958-
statistic_id: str | list[str] | None = None,
959-
data_type: str | list[str] | None = None,
960-
computation_identifier: str | list[str] | None = None,
953+
monitoring_location_id: str | Iterable[str] | None = None,
954+
parameter_code: str | Iterable[str] | None = None,
955+
parameter_name: str | Iterable[str] | None = None,
956+
parameter_description: str | Iterable[str] | None = None,
957+
unit_of_measure: str | Iterable[str] | None = None,
958+
statistic_id: str | Iterable[str] | None = None,
959+
data_type: str | Iterable[str] | None = None,
960+
computation_identifier: str | Iterable[str] | None = None,
961961
thresholds: float | list[float] | None = None,
962-
sublocation_identifier: str | list[str] | None = None,
963-
primary: str | list[str] | None = None,
964-
parent_time_series_id: str | list[str] | None = None,
965-
web_description: str | list[str] | None = None,
966-
last_modified: str | list[str] | None = None,
967-
begin: str | list[str] | None = None,
968-
end: str | list[str] | None = None,
969-
agency_code: str | list[str] | None = None,
970-
agency_name: str | list[str] | None = None,
971-
monitoring_location_number: str | list[str] | None = None,
972-
monitoring_location_name: str | list[str] | None = None,
973-
district_code: str | list[str] | None = None,
974-
country_code: str | list[str] | None = None,
975-
country_name: str | list[str] | None = None,
976-
state_code: str | list[str] | None = None,
977-
state_name: str | list[str] | None = None,
978-
county_code: str | list[str] | None = None,
979-
county_name: str | list[str] | None = None,
980-
minor_civil_division_code: str | list[str] | None = None,
981-
site_type_code: str | list[str] | None = None,
982-
site_type: str | list[str] | None = None,
983-
hydrologic_unit_code: str | list[str] | None = None,
984-
basin_code: str | list[str] | None = None,
985-
altitude: str | list[str] | None = None,
986-
altitude_accuracy: str | list[str] | None = None,
987-
altitude_method_code: str | list[str] | None = None,
988-
altitude_method_name: str | list[str] | None = None,
989-
vertical_datum: str | list[str] | None = None,
990-
vertical_datum_name: str | list[str] | None = None,
991-
horizontal_positional_accuracy_code: str | list[str] | None = None,
992-
horizontal_positional_accuracy: str | list[str] | None = None,
993-
horizontal_position_method_code: str | list[str] | None = None,
994-
horizontal_position_method_name: str | list[str] | None = None,
995-
original_horizontal_datum: str | list[str] | None = None,
996-
original_horizontal_datum_name: str | list[str] | None = None,
997-
drainage_area: str | list[str] | None = None,
998-
contributing_drainage_area: str | list[str] | None = None,
999-
time_zone_abbreviation: str | list[str] | None = None,
1000-
uses_daylight_savings: str | list[str] | None = None,
1001-
construction_date: str | list[str] | None = None,
1002-
aquifer_code: str | list[str] | None = None,
1003-
national_aquifer_code: str | list[str] | None = None,
1004-
aquifer_type_code: str | list[str] | None = None,
1005-
well_constructed_depth: str | list[str] | None = None,
1006-
hole_constructed_depth: str | list[str] | None = None,
1007-
depth_source_code: str | list[str] | None = None,
962+
sublocation_identifier: str | Iterable[str] | None = None,
963+
primary: str | Iterable[str] | None = None,
964+
parent_time_series_id: str | Iterable[str] | None = None,
965+
web_description: str | Iterable[str] | None = None,
966+
last_modified: str | Iterable[str] | None = None,
967+
begin: str | Iterable[str] | None = None,
968+
end: str | Iterable[str] | None = None,
969+
agency_code: str | Iterable[str] | None = None,
970+
agency_name: str | Iterable[str] | None = None,
971+
monitoring_location_number: str | Iterable[str] | None = None,
972+
monitoring_location_name: str | Iterable[str] | None = None,
973+
district_code: str | Iterable[str] | None = None,
974+
country_code: str | Iterable[str] | None = None,
975+
country_name: str | Iterable[str] | None = None,
976+
state_code: str | Iterable[str] | None = None,
977+
state_name: str | Iterable[str] | None = None,
978+
county_code: str | Iterable[str] | None = None,
979+
county_name: str | Iterable[str] | None = None,
980+
minor_civil_division_code: str | Iterable[str] | None = None,
981+
site_type_code: str | Iterable[str] | None = None,
982+
site_type: str | Iterable[str] | None = None,
983+
hydrologic_unit_code: str | Iterable[str] | None = None,
984+
basin_code: str | Iterable[str] | None = None,
985+
altitude: str | Iterable[str] | None = None,
986+
altitude_accuracy: str | Iterable[str] | None = None,
987+
altitude_method_code: str | Iterable[str] | None = None,
988+
altitude_method_name: str | Iterable[str] | None = None,
989+
vertical_datum: str | Iterable[str] | None = None,
990+
vertical_datum_name: str | Iterable[str] | None = None,
991+
horizontal_positional_accuracy_code: str | Iterable[str] | None = None,
992+
horizontal_positional_accuracy: str | Iterable[str] | None = None,
993+
horizontal_position_method_code: str | Iterable[str] | None = None,
994+
horizontal_position_method_name: str | Iterable[str] | None = None,
995+
original_horizontal_datum: str | Iterable[str] | None = None,
996+
original_horizontal_datum_name: str | Iterable[str] | None = None,
997+
drainage_area: str | Iterable[str] | None = None,
998+
contributing_drainage_area: str | Iterable[str] | None = None,
999+
time_zone_abbreviation: str | Iterable[str] | None = None,
1000+
uses_daylight_savings: str | Iterable[str] | None = None,
1001+
construction_date: str | Iterable[str] | None = None,
1002+
aquifer_code: str | Iterable[str] | None = None,
1003+
national_aquifer_code: str | Iterable[str] | None = None,
1004+
aquifer_type_code: str | Iterable[str] | None = None,
1005+
well_constructed_depth: str | Iterable[str] | None = None,
1006+
hole_constructed_depth: str | Iterable[str] | None = None,
1007+
depth_source_code: str | Iterable[str] | None = None,
10081008
properties: str | list[str] | None = None,
10091009
skip_geometry: bool | None = None,
10101010
bbox: list[float] | None = None,
@@ -1763,13 +1763,13 @@ def get_field_measurements(
17631763

17641764

17651765
def get_field_measurements_metadata(
1766-
monitoring_location_id: str | list[str] | None = None,
1767-
parameter_code: str | list[str] | None = None,
1768-
parameter_name: str | list[str] | None = None,
1769-
parameter_description: str | list[str] | None = None,
1770-
begin: str | list[str] | None = None,
1771-
end: str | list[str] | None = None,
1772-
last_modified: str | list[str] | None = None,
1766+
monitoring_location_id: str | Iterable[str] | None = None,
1767+
parameter_code: str | Iterable[str] | None = None,
1768+
parameter_name: str | Iterable[str] | None = None,
1769+
parameter_description: str | Iterable[str] | None = None,
1770+
begin: str | Iterable[str] | None = None,
1771+
end: str | Iterable[str] | None = None,
1772+
last_modified: str | Iterable[str] | None = None,
17731773
properties: str | list[str] | None = None,
17741774
skip_geometry: bool | None = None,
17751775
bbox: list[float] | None = None,
@@ -1880,12 +1880,12 @@ def get_field_measurements_metadata(
18801880

18811881

18821882
def get_peaks(
1883-
monitoring_location_id: str | list[str] | None = None,
1884-
parameter_code: str | list[str] | None = None,
1885-
time_series_id: str | list[str] | None = None,
1886-
unit_of_measure: str | list[str] | None = None,
1887-
time: str | list[str] | None = None,
1888-
last_modified: str | list[str] | None = None,
1883+
monitoring_location_id: str | Iterable[str] | None = None,
1884+
parameter_code: str | Iterable[str] | None = None,
1885+
time_series_id: str | Iterable[str] | None = None,
1886+
unit_of_measure: str | Iterable[str] | None = None,
1887+
time: str | Iterable[str] | None = None,
1888+
last_modified: str | Iterable[str] | None = None,
18891889
water_year: int | list[int] | None = None,
18901890
year: int | list[int] | None = None,
18911891
month: int | list[int] | None = None,

0 commit comments

Comments
 (0)