style: make sonarcloud happy

Author: dshemetov

src/client/delphi_epidata.py

@@ -26,6 +26,19 @@
 
 _HEADERS = {"user-agent": "delphi_epidata/" + _version + " (Python)"}
 
+
+class EpidataException(Exception):
+    ...
+
+
+class EpidataBadRequestException(EpidataException):
+    ...
+
+
+REGIONS_EPIWEEKS_REQUIRED = "`regions` and `epiweeks` are both required"
+ISSUES_LAG_EXCLUSIVE = "`issues` and `lag` are mutually exclusive"
+LOCATIONS_EPIWEEKS_REQUIRED = "`locations` and `epiweeks` are both required"
+
 # Because the API is stateless, the Epidata class only contains static methods
 class Epidata:
     """An interface to DELPHI's Epidata API."""
@@ -90,7 +103,7 @@ def check(resp):
         """Raise an Exception on error, otherwise return epidata."""
         if resp["result"] != 1:
             msg, code = resp["message"], resp["result"]
-            raise Exception(f"Error fetching epidata: {msg}. (result={int(code)})")
+            raise EpidataException(f"Error fetching epidata: {msg}. (result={int(code)})")
         return resp["epidata"]
 
     # Build a `range` object (ex: dates/epiweeks)
@@ -107,9 +120,9 @@ def fluview(regions, epiweeks, issues=None, lag=None, auth=None):
         """Fetch FluView data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(ISSUES_LAG_EXCLUSIVE)
         # Set up request
         params = {
             "endpoint": "fluview",
@@ -142,9 +155,9 @@ def fluview_clinical(regions, epiweeks, issues=None, lag=None):
         """Fetch FluView clinical data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "fluview_clinical",
@@ -164,9 +177,9 @@ def flusurv(locations, epiweeks, issues=None, lag=None):
         """Fetch FluSurv data."""
         # Check parameters
         if locations is None or epiweeks is None:
-            raise Exception("`locations` and `epiweeks` are both required")
+            raise EpidataBadRequestException(LOCATIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "flusurv",
@@ -186,9 +199,9 @@ def paho_dengue(regions, epiweeks, issues=None, lag=None):
         """Fetch PAHO Dengue data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "paho_dengue",
@@ -208,9 +221,9 @@ def ecdc_ili(regions, epiweeks, issues=None, lag=None):
         """Fetch ECDC ILI data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "ecdc_ili",
@@ -230,9 +243,9 @@ def kcdc_ili(regions, epiweeks, issues=None, lag=None):
         """Fetch KCDC ILI data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "kcdc_ili",
@@ -252,7 +265,7 @@ def gft(locations, epiweeks):
         """Fetch Google Flu Trends data."""
         # Check parameters
         if locations is None or epiweeks is None:
-            raise Exception("`locations` and `epiweeks` are both required")
+            raise EpidataBadRequestException(LOCATIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "gft",
@@ -268,7 +281,9 @@ def ght(auth, locations, epiweeks, query):
         """Fetch Google Health Trends data."""
         # Check parameters
         if auth is None or locations is None or epiweeks is None or query is None:
-            raise Exception("`auth`, `locations`, `epiweeks`, and `query` are all required")
+            raise EpidataBadRequestException(
+                "`auth`, `locations`, `epiweeks`, and `query` are all required"
+            )
         # Set up request
         params = {
             "endpoint": "ght",
@@ -286,9 +301,9 @@ def twitter(auth, locations, dates=None, epiweeks=None):
         """Fetch HealthTweets data."""
         # Check parameters
         if auth is None or locations is None:
-            raise Exception("`auth` and `locations` are both required")
+            raise EpidataBadRequestException("`auth` and `locations` are both required")
         if not ((dates is None) ^ (epiweeks is None)):
-            raise Exception("exactly one of `dates` and `epiweeks` is required")
+            raise EpidataBadRequestException("exactly one of `dates` and `epiweeks` is required")
         # Set up request
         params = {
             "endpoint": "twitter",
@@ -308,9 +323,9 @@ def wiki(articles, dates=None, epiweeks=None, hours=None, language="en"):
         """Fetch Wikipedia access data."""
         # Check parameters
         if articles is None:
-            raise Exception("`articles` is required")
+            raise EpidataBadRequestException("`articles` is required")
         if not ((dates is None) ^ (epiweeks is None)):
-            raise Exception("exactly one of `dates` and `epiweeks` is required")
+            raise EpidataBadRequestException("exactly one of `dates` and `epiweeks` is required")
         # Set up request
         params = {
             "endpoint": "wiki",
@@ -332,7 +347,7 @@ def cdc(auth, epiweeks, locations):
         """Fetch CDC page hits."""
         # Check parameters
         if auth is None or epiweeks is None or locations is None:
-            raise Exception("`auth`, `epiweeks`, and `locations` are all required")
+            raise EpidataBadRequestException("`auth`, `epiweeks`, and `locations` are all required")
         # Set up request
         params = {
             "endpoint": "cdc",
@@ -349,7 +364,7 @@ def quidel(auth, epiweeks, locations):
         """Fetch Quidel data."""
         # Check parameters
         if auth is None or epiweeks is None or locations is None:
-            raise Exception("`auth`, `epiweeks`, and `locations` are all required")
+            raise EpidataBadRequestException("`auth`, `epiweeks`, and `locations` are all required")
         # Set up request
         params = {
             "endpoint": "quidel",
@@ -366,7 +381,7 @@ def norostat(auth, location, epiweeks):
         """Fetch NoroSTAT data (point data, no min/max)."""
         # Check parameters
         if auth is None or location is None or epiweeks is None:
-            raise Exception("`auth`, `location`, and `epiweeks` are all required")
+            raise EpidataBadRequestException("`auth`, `location`, and `epiweeks` are all required")
         # Set up request
         params = {
             "endpoint": "norostat",
@@ -383,7 +398,7 @@ def meta_norostat(auth):
         """Fetch NoroSTAT metadata."""
         # Check parameters
         if auth is None:
-            raise Exception("`auth` is required")
+            raise EpidataBadRequestException("`auth` is required")
         # Set up request
         params = {
             "endpoint": "meta_norostat",
@@ -398,9 +413,9 @@ def nidss_flu(regions, epiweeks, issues=None, lag=None):
         """Fetch NIDSS flu data."""
         # Check parameters
         if regions is None or epiweeks is None:
-            raise Exception("`regions` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "nidss_flu",
@@ -420,7 +435,7 @@ def nidss_dengue(locations, epiweeks):
         """Fetch NIDSS dengue data."""
         # Check parameters
         if locations is None or epiweeks is None:
-            raise Exception("`locations` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "nidss_dengue",
@@ -436,7 +451,7 @@ def delphi(system, epiweek):
         """Fetch Delphi's forecast."""
         # Check parameters
         if system is None or epiweek is None:
-            raise Exception("`system` and `epiweek` are both required")
+            raise EpidataBadRequestException("`system` and `epiweek` are both required")
         # Set up request
         params = {
             "endpoint": "delphi",
@@ -452,7 +467,9 @@ def sensors(auth, names, locations, epiweeks):
         """Fetch Delphi's digital surveillance sensors."""
         # Check parameters
         if names is None or locations is None or epiweeks is None:
-            raise Exception("`names`, `locations`, and `epiweeks` are all required")
+            raise EpidataBadRequestException(
+                "`names`, `locations`, and `epiweeks` are all required"
+            )
         # Set up request
         params = {
             "endpoint": "sensors",
@@ -471,7 +488,9 @@ def dengue_sensors(auth, names, locations, epiweeks):
         """Fetch Delphi's digital surveillance sensors."""
         # Check parameters
         if auth is None or names is None or locations is None or epiweeks is None:
-            raise Exception("`auth`, `names`, `locations`, and `epiweeks` " "are all required")
+            raise EpidataBadRequestException(
+                "`auth`, `names`, `locations`, and `epiweeks` are all required"
+            )
         # Set up request
         params = {
             "endpoint": "dengue_sensors",
@@ -489,7 +508,7 @@ def nowcast(locations, epiweeks):
         """Fetch Delphi's wILI nowcast."""
         # Check parameters
         if locations is None or epiweeks is None:
-            raise Exception("`locations` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "nowcast",
@@ -505,7 +524,7 @@ def dengue_nowcast(locations, epiweeks):
         """Fetch Delphi's dengue nowcast."""
         # Check parameters
         if locations is None or epiweeks is None:
-            raise Exception("`locations` and `epiweeks` are both required")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "dengue_nowcast",
@@ -541,12 +560,12 @@ def covidcast(
             signals = kwargs["signal"]
         # Check parameters
         if None in (data_source, signals, time_type, geo_type, time_values, geo_value):
-            raise Exception(
+            raise EpidataBadRequestException(
                 "`data_source`, `signals`, `time_type`, `geo_type`, "
                 "`time_values`, and `geo_value` are all required"
             )
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "endpoint": "covidcast",
@@ -589,7 +608,7 @@ def covid_hosp(states, dates, issues=None, as_of=None):
         """Fetch COVID hospitalization data."""
         # Check parameters
         if states is None or dates is None:
-            raise Exception("`states` and `dates` are both required")
+            raise EpidataBadRequestException("`states` and `dates` are both required")
         # Set up request
         params = {
             "endpoint": "covid_hosp",
@@ -609,7 +628,9 @@ def covid_hosp_facility(hospital_pks, collection_weeks, publication_dates=None):
         """Fetch COVID hospitalization data for specific facilities."""
         # Check parameters
         if hospital_pks is None or collection_weeks is None:
-            raise Exception("`hospital_pks` and `collection_weeks` are both required")
+            raise EpidataBadRequestException(
+                "`hospital_pks` and `collection_weeks` are both required"
+            )
         # Set up request
         params = {
             "source": "covid_hosp_facility",
@@ -638,7 +659,9 @@ def covid_hosp_facility_lookup(state=None, ccn=None, city=None, zip=None, fips_c
         elif fips_code is not None:
             params["fips_code"] = fips_code
         else:
-            raise Exception("one of `state`, `ccn`, `city`, `zip`, or `fips_code` is required")
+            raise EpidataBadRequestException(
+                "one of `state`, `ccn`, `city`, `zip`, or `fips_code` is required"
+            )
         # Make the API call
         return Epidata._request(params)
 
@@ -668,12 +691,12 @@ def covidcast_nowcast(
             geo_value,
             sensor_names,
         ):
-            raise Exception(
+            raise EpidataBadRequestException(
                 "`data_source`, `signals`, `sensor_names`, `time_type`, `geo_type`, "
                 "`time_values`, and `geo_value` are all required"
             )
         if issues is not None and lag is not None:
-            raise Exception("`issues` and `lag` are mutually exclusive")
+            raise EpidataBadRequestException(REGIONS_EPIWEEKS_REQUIRED)
         # Set up request
         params = {
             "source": "covidcast_nowcast",

src/client/packaging/pypi/delphi_epidata/__init__.py

@@ -1,4 +1,4 @@
 from .delphi_epidata import Epidata
 
-name = 'delphi_epidata'
-__version__ = '4.1.4'
+name = "delphi_epidata"
+__version__ = "4.1.4"