refactor: unify settings and build to pyproject.toml

Author: dshemetov

.dockerignore

@@ -7,4 +7,5 @@ __pycache__
 .pytest_cache
 *.egg-info
 /dist
-.DS_Store
+.DS_Store
+/build

.gitignore

@@ -27,7 +27,7 @@ Prepare virtual environment and install dependencies
 ```sh
 python -m venv venv
 source ./venv/bin/activate
-pip install --use-feature=2020-resolver -r requirements.txt -r requirements-dev.txt
+pip install -e ".[dev]"
 ```
 
 ### Common Commands

README.md

@@ -19,9 +19,7 @@
 from ._covidcast import define_covidcast_fields, GeoType, TimeType
 
 
-def get_wildcard_equivalent_dates(
-    time_value: str, time_type: Literal["day", "week"]
-) -> str:
+def get_wildcard_equivalent_dates(time_value: str, time_type: Literal["day", "week"]) -> str:
     if time_value == "*":
         if time_type == "day":
             return EpiRange("10000101", "30000101")
@@ -35,28 +33,16 @@ def reformat_epirange(epirange: EpiRange, to_type: str) -> EpiRange:
     if to_type not in ("day", "week"):
         raise InvalidArgumentException("`to_type` must be 'day' or 'week'")
 
-    if (
-        to_type == "day"
-        and isinstance(epirange.start, (str, int))
-        and len(str(epirange.start)) == 6
-    ):
+    if to_type == "day" and isinstance(epirange.start, (str, int)) and len(str(epirange.start)) == 6:
         coercion_msg = (
             "`collection_weeks` is in week format but `pub_covid_hosp_facility`"
             "expects day format; dates will be converted to day format but may not"
             "correspond exactly to desired time range"
         )
         warnings.warn(coercion_msg, UserWarning)
-        epirange = EpiRange(
-            parse_api_week(epirange.start), parse_api_week(epirange.end)
-        )
-    elif (
-        to_type == "week"
-        and isinstance(epirange.start, (int, str))
-        and len(str(epirange.start)) == 8
-    ):
-        epirange = EpiRange(
-            format_epiweek(epirange.start), format_epiweek(epirange.end)
-        )
+        epirange = EpiRange(parse_api_week(epirange.start), parse_api_week(epirange.end))
+    elif to_type == "week" and isinstance(epirange.start, (int, str)) and len(str(epirange.start)) == 8:
+        epirange = EpiRange(format_epiweek(epirange.start), format_epiweek(epirange.end))
 
     return epirange
 
@@ -98,9 +84,7 @@ def pvt_cdc(
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "day")
 
         if auth is None or epiweeks is None or locations is None:
-            raise InvalidArgumentException(
-                "`auth`, `epiweeks`, and `locations` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `epiweeks`, and `locations` are all required")
 
         return self._create_call(
             "cdc/",
@@ -132,9 +116,7 @@ def pub_covid_hosp_facility_lookup(
         """Lookup COVID hospitalization facility identifiers."""
 
         if all((v is None for v in (state, ccn, city, zip, fips_code))):
-            raise InvalidArgumentException(
-                "one of `state`, `ccn`, `city`, `zip`, or `fips_code` is required"
-            )
+            raise InvalidArgumentException("one of `state`, `ccn`, `city`, `zip`, or `fips_code` is required")
 
         return self._create_call(
             "covid_hosp_facility_lookup/",
@@ -168,9 +150,7 @@ def pub_covid_hosp_facility(
         """Fetch COVID hospitalization data for specific facilities."""
 
         if hospital_pks is None or collection_weeks is None:
-            raise InvalidArgumentException(
-                "`hospital_pks` and `collection_weeks` are both required"
-            )
+            raise InvalidArgumentException("`hospital_pks` and `collection_weeks` are both required")
 
         collection_weeks = get_wildcard_equivalent_dates(collection_weeks, "day")
 
@@ -310,9 +290,7 @@ def pub_covid_hosp_state_timeseries(
             raise InvalidArgumentException("`states` and `dates` are both required")
 
         if issues is not None and as_of is not None:
-            raise InvalidArgumentException(
-                "`issues` and `as_of` are mutually exclusive"
-            )
+            raise InvalidArgumentException("`issues` and `as_of` are mutually exclusive")
 
         dates = get_wildcard_equivalent_dates(dates, "day")
 
@@ -511,14 +489,10 @@ def pub_covidcast(
                 "`data_source`, `signals`, `time_type`, `geo_type`, `time_values`, and `geo_values` are all required."
             )
         if sum([issues is not None, lag is not None, as_of is not None]) > 1:
-            raise InvalidArgumentException(
-                "`issues`, `lag`, and `as_of` are mutually exclusive."
-            )
+            raise InvalidArgumentException("`issues`, `lag`, and `as_of` are mutually exclusive.")
 
         if data_source == "nchs-mortality" and time_type != "week":
-            raise InvalidArgumentException(
-                "nchs-mortality data source only supports the week time type."
-            )
+            raise InvalidArgumentException("nchs-mortality data source only supports the week time type.")
 
         return self._create_call(
             "covidcast/",
@@ -552,16 +526,12 @@ def pub_delphi(self, system: str, epiweek: Union[int, str]) -> CALL_TYPE:
             only_supports_classic=True,
         )
 
-    def pub_dengue_nowcast(
-        self, locations: StringParam, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pub_dengue_nowcast(self, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch Delphi's dengue nowcast."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`locations` and `epiweeks` are both required"
-            )
+            raise InvalidArgumentException("`locations` and `epiweeks` are both required")
 
         return self._create_call(
             "dengue_nowcast/",
@@ -585,9 +555,7 @@ def pvt_dengue_sensors(
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if auth is None or names is None or locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`auth`, `names`, `locations`, and `epiweeks` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `names`, `locations`, and `epiweeks` are all required")
 
         return self._create_call(
             "dengue_sensors/",
@@ -645,9 +613,7 @@ def pub_flusurv(
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`locations` and `epiweeks` are both required"
-            )
+            raise InvalidArgumentException("`locations` and `epiweeks` are both required")
 
         if issues is not None and lag is not None:
             raise InvalidArgumentException("`issues` and `lag` are mutually exclusive")
@@ -764,16 +730,12 @@ def pub_fluview(
             ],
         )
 
-    def pub_gft(
-        self, locations: StringParam, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pub_gft(self, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch Google Flu Trends data."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`locations` and `epiweeks` are both required"
-            )
+            raise InvalidArgumentException("`locations` and `epiweeks` are both required")
 
         return self._create_call(
             "gft/",
@@ -794,9 +756,7 @@ def pvt_ght(
     ) -> CALL_TYPE:
         """Fetch Google Health Trends data."""
         if auth is None or locations is None or epiweeks is None or query == "":
-            raise InvalidArgumentException(
-                "`auth`, `locations`, `epiweeks`, and `query` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `locations`, `epiweeks`, and `query` are all required")
 
         return self._create_call(
             "ght/",
@@ -859,16 +819,12 @@ def pub_meta(self) -> CALL_TYPE:
             only_supports_classic=True,
         )
 
-    def pub_nidss_dengue(
-        self, locations: StringParam, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pub_nidss_dengue(self, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch NIDSS dengue data."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`locations` and `epiweeks` are both required"
-            )
+            raise InvalidArgumentException("`locations` and `epiweeks` are both required")
 
         return self._create_call(
             "nidss_dengue/",
@@ -909,16 +865,12 @@ def pub_nidss_flu(
             ],
         )
 
-    def pvt_norostat(
-        self, auth: str, location: str, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pvt_norostat(self, auth: str, location: str, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch NoroSTAT data (point data, no min/max)."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if auth is None or location is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`auth`, `location`, and `epiweeks` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `location`, and `epiweeks` are all required")
 
         return self._create_call(
             "norostat/",
@@ -930,16 +882,12 @@ def pvt_norostat(
             ],
         )
 
-    def pub_nowcast(
-        self, locations: StringParam, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pub_nowcast(self, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch Delphi's wILI nowcast."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`locations` and `epiweeks` are both required"
-            )
+            raise InvalidArgumentException("`locations` and `epiweeks` are both required")
 
         return self._create_call(
             "nowcast/",
@@ -985,16 +933,12 @@ def pub_paho_dengue(
             ],
         )
 
-    def pvt_quidel(
-        self, auth: str, locations: StringParam, epiweeks: EpiRangeParam = "*"
-    ) -> CALL_TYPE:
+    def pvt_quidel(self, auth: str, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL_TYPE:
         """Fetch Quidel data."""
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if auth is None or epiweeks is None or locations is None:
-            raise InvalidArgumentException(
-                "`auth`, `epiweeks`, and `locations` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `epiweeks`, and `locations` are all required")
 
         return self._create_call(
             "quidel/",
@@ -1017,9 +961,7 @@ def pvt_sensors(
         epiweeks = get_wildcard_equivalent_dates(epiweeks, "week")
 
         if auth is None or names is None or locations is None or epiweeks is None:
-            raise InvalidArgumentException(
-                "`auth`, `names`, `locations`, and `epiweeks` are all required"
-            )
+            raise InvalidArgumentException("`auth`, `names`, `locations`, and `epiweeks` are all required")
 
         return self._create_call(
             "sensors/",
@@ -1061,9 +1003,7 @@ def pvt_twitter(
             raise InvalidArgumentException("`auth` and `locations` are both required")
 
         if not (dates is None) ^ (epiweeks is None):
-            raise InvalidArgumentException(
-                "exactly one of `dates` and `epiweeks` is required"
-            )
+            raise InvalidArgumentException("exactly one of `dates` and `epiweeks` is required")
 
         time_field = (
             EpidataFieldInfo("date", EpidataFieldType.date)
@@ -1114,9 +1054,7 @@ def pub_wiki(
             raise InvalidArgumentException("`articles` is required")
 
         if not (dates is None) ^ (epiweeks is None):
-            raise InvalidArgumentException(
-                "exactly one of `dates` and `epiweeks` is required"
-            )
+            raise InvalidArgumentException("exactly one of `dates` and `epiweeks` is required")
 
         time_field = (
             EpidataFieldInfo("date", EpidataFieldType.date)

epidatpy/_endpoints.py

@@ -87,9 +87,7 @@ def __str__(self) -> str:
         return f"{format_date(self.start)}-{format_date(self.end)}"
 
 
-EpiDataResponse = TypedDict(
-    "EpiDataResponse", {"result": int, "message": str, "epidata": List}
-)
+EpiDataResponse = TypedDict("EpiDataResponse", {"result": int, "message": str, "epidata": List})
 
 
 EpiRangeParam = Union[EpiRangeLike, Iterable[EpiRangeLike]]
@@ -268,9 +266,7 @@ def _parse_row(
     ) -> Mapping[str, Union[str, float, int, date, None]]:
         if not self.meta:
             return row
-        return {
-            k: self._parse_value(k, v, disable_date_parsing) for k, v in row.items()
-        }
+        return {k: self._parse_value(k, v, disable_date_parsing) for k, v in row.items()}
 
     def _as_df(
         self,
@@ -289,19 +285,15 @@ def _as_df(
             if info.type == EpidataFieldType.bool:
                 data_types[info.name] = bool
             elif info.type == EpidataFieldType.categorical:
-                data_types[info.name] = CategoricalDtype(
-                    categories=info.categories or None, ordered=True
-                )
+                data_types[info.name] = CategoricalDtype(categories=info.categories or None, ordered=True)
             elif info.type == EpidataFieldType.int:
                 data_types[info.name] = int
             elif info.type in (
                 EpidataFieldType.date,
                 EpidataFieldType.epiweek,
                 EpidataFieldType.date_or_epiweek,
             ):
-                data_types[info.name] = (
-                    int if disable_date_parsing else "datetime64[ns]"
-                )
+                data_types[info.name] = int if disable_date_parsing else "datetime64[ns]"
             elif info.type == EpidataFieldType.float:
                 data_types[info.name] = float
             else: