Add ability to ignore invalid ids

bls/api.py

@@ -7,6 +7,7 @@
 import collections
 import datetime
 import logging
+import warnings
 
 
 import os
@@ -134,6 +135,7 @@ def get_series(
     startyear: Optional[Union[str, int, float]] = None,
     endyear: Optional[Union[str, int, float]] = None,
     key: Optional[str] = None,
+    errors: str = "raise"
 ) -> pd.DataFrame:
     """
     Retrieve one or more series from BLS. Note that only ten years may be
@@ -144,11 +146,28 @@ def get_series(
         years before the endyear
     :endyear: The last year for which to retrieve data. Defaults to ten years
         after the startyear, if given, or else the current year
+    :errors: {"ignore", "raise"}, default "raise"
+        If "ignore", suppress error and only existing series are returned.
     :returns: a pandas DataFrame object with each series as a column and each
         monthly observation as a row. If only one series is requested, a pandas
         Series object is returned instead of a DataFrame.
     """
     results = get_json_series(series, startyear, endyear, key)
-    df = pd.DataFrame({result["seriesID"]: parse_series(result) for result in results})
+    # Parse out invalid seriesID(s)
+    invalid_ids = [res["seriesID"] for res in results if not res["data"]]
+    if errors == "raise" and invalid_ids:
+        raise ValueError(
+            "No data received for series {}! Are your parameters correct?"
+            .format(invalid_ids)
+        )
+    if invalid_ids:
+        warnings.warn(
+            "No data received for series {}! Are your parameters correct?"
+            .format(invalid_ids)
+        )
+    df = pd.DataFrame({
+        result["seriesID"]: parse_series(result)
+        for result in results if result["seriesID"] not in invalid_ids
+    })
     df = df.applymap(float)
-    return df[series].sort_index()
+    return df[df.columns].sort_index()

tests/test_api.py

@@ -14,7 +14,12 @@ def nokey():
 
 
 def test_monthly_value():
-    assert bls.get_series("LNS14000000", startyear=1948, endyear=1948)["1948-01"] == 3.4
+    assert (
+        bls.get_series("LNS14000000", startyear=1948, endyear=1948)["1948-01"].iloc[0][
+            0
+        ]
+        == 3.4
+    )
 
 
 def test_monthly_value_multiple():
@@ -27,14 +32,18 @@ def test_monthly_value_multiple():
 
 def test_quarterly_value():
     assert (
-        bls.get_series("CIU2020000000000A", startyear=2001, endyear=2001)["2001-Q1"]
+        bls.get_series("CIU2020000000000A", startyear=2001, endyear=2001)[
+            "2001-Q1"
+        ].iloc[0][0]
         == 3.8
     )
 
 
 def test_annual_value():
     assert (
-        bls.get_series("TUU10100AA01000007", startyear=2009, endyear=2009)["2009"]
+        bls.get_series("TUU10100AA01000007", startyear=2009, endyear=2009)["2009"].iloc[
+            0
+        ][0]
         == 148720
     )
 
@@ -72,3 +81,10 @@ def test_error_no_key_too_many_years(nokey):
 def test_error_no_data():
     with pytest.raises(ValueError):
         bls.get_series("LNS14000000", startyear=1900, endyear=1900)
+
+
+def test_warning_and_not_valuerror_when_errors_set_to_ignore():
+    with pytest.warns(UserWarning):
+        bls.get_series(
+            ["LNS14000000", "INVALID_SERIESID"], endyear=2018, errors="ignore"
+        )