Update consistency between cmd and script, and for the wiki pages. Add additional checks for parameters

Author: Lyetenth

firststreet/__main__.py

@@ -177,13 +177,47 @@
                                                extra_param=argument.extra_param)
 
         elif argument.product == 'tile.get_probability_depth':
+            if not argument.year:
+                logging.error("get_probability_depth is missing the year argument")
+                sys.exit()
+
+            try:
+                int(argument.year)
+            except ValueError:
+                logging.error("The year argument could not be converted to an int. "
+                              "Provided argument: {}".format(argument.year))
+                sys.exit()
+
+            if not argument.return_period:
+                logging.error("get_probability_depth is missing the return_period argument")
+                sys.exit()
+
+            try:
+                int(argument.return_period)
+            except ValueError:
+                logging.error("The return_period argument could not be converted to an int. "
+                              "Provided argument: {}".format(argument.return_period))
+                sys.exit()
+
             fs.tile.get_probability_depth(year=int(argument.year),
                                           return_period=int(argument.return_period),
                                           search_items=search_items,
                                           output_dir=argument.output_dir,
                                           image=True)
 
         elif argument.product == 'tile.get_historic_event':
+
+            if not argument.event_id:
+                logging.error("get_probability_depth is missing the event_id argument")
+                sys.exit()
+
+            try:
+                int(argument.event_id)
+            except ValueError:
+                logging.error("The event_id argument could not be converted to an int. "
+                              "Provided argument: {}".format(argument.event_id))
+                sys.exit()
+
             fs.tile.get_historic_event(event_id=int(argument.event_id),
                                        search_items=search_items,
                                        output_dir=argument.output_dir,

firststreet/api/api.py

@@ -43,35 +43,42 @@ def call_api(self, search_item, product, product_subtype, location=None, tile_pr
         Returns:
             A list of JSON responses
         """
-        # Not a list. This means it's a file
+
+        # Not a list. This means it's should be a file
         if not isinstance(search_item, list):
 
             # Check if it's a file
-            if isinstance(search_item, str):
-                if os.path.isfile(search_item):
+            if isinstance(search_item, str) and os.path.isfile(search_item):
 
-                    # Get search items from file
-                    search_item = read_search_items_from_file(search_item)
+                # Get search items from file
+                search_item = read_search_items_from_file(search_item)
+
+            else:
+                raise InvalidArgument("File provided is not a list or a valid file. "
+                                      "Please check the file name and path. '{}'".format(str(search_item)))
+
+        else:
+
+            # Check tile product
+            if tile_product:
+                if not all(isinstance(t, tuple) for t in search_item):
+                    raise TypeError("Input must be a list of coordinates in a tuple of (z, x, y). "
+                                    "Provided Arg: {}".format(search_item))
+
+                if not all(isinstance(coord, int) for t in search_item for coord in t):
+                    raise TypeError("Each coordinate in the tuple must be an integer. Provided Arg: {}".format(search_item))
+
+                if not all(0 < t[0] <= 18 for t in search_item):
+                    raise TypeError("Max zoom is 18. Provided Arg: {}".format(search_item))
 
-                else:
-                    raise InvalidArgument("File provided is not a valid file. "
-                                          "Please check the file name and path. '{}'".format(str(search_item)))
-
-            # # Check tuple
-            # elif tile_product and not os.path.isfile(search_item):
-            #     if not all(isinstance(t, tuple) for t in search_item):
-            #         raise TypeError("Input must be a list of coordinates in a tuple of (z, x, y). "
-            #                         "Provided Arg: {}".format(search_item))
-            #
-            #     if not all(isinstance(coord, int) for t in search_item for coord in t):
-            #         raise TypeError("Each coordinate in the tuple must be an integer. Provided Arg: {}".format(search_item))
-            #
-            #     if not all(0 < t[0] <= 18 for t in search_item):
-            #         raise TypeError("Max zoom is 18. Provided Arg: {}".format(search_item))
-            #
             # else:
-            #     raise InvalidArgument("File provided is not a list or a valid file. "
-            #                           "Please check the file name and path. '{}'".format(str(search_item)))
+
+        # Ensure for historic and adaptation the search items are EventIDs or AdaptationIDs
+        if ((product == "adaptation" and product_subtype == "detail") or
+            (product == "historic" and product_subtype == "event")) and \
+            not all(isinstance(t, int) for t in search_item):
+            raise TypeError("Input must be an integer for this product. "
+                            "Provided Arg: {}".format(search_item))
 
         # No items found
         if not search_item:

firststreet/api/csv_format.py

@@ -203,7 +203,7 @@ def format_adaptation_summary(data):
     df = pd.json_normalize([vars(o) for o in data]).explode('adaptation').reset_index(drop=True)
     df['fsid'] = df['fsid'].apply(str)
     df['adaptation'] = df['adaptation'].astype('Int64').apply(str)
-    return df[['fsid', 'valid_id', 'adaptation', 'properties']]
+    return df[['fsid', 'valid_id', 'adaptation']]
 
 
 def format_adaptation_summary_detail(data):
@@ -904,7 +904,7 @@ def format_location_detail_county(data):
     """
     df = pd.DataFrame([vars(o) for o in data]).explode('city').explode('zcta') \
         .explode('cd').reset_index(drop=True)
-    df.rename(columns={'fsid': 'fsid_placeholder'}, inplace=True)
+    df.rename(columns={'fsid': 'fsid_placeholder', 'name': 'name_placeholder'}, inplace=True)
 
     if not df['city'].isna().values.all():
         df = pd.concat([df.drop(['city'], axis=1), df['city'].apply(pd.Series)], axis=1)
@@ -938,15 +938,15 @@ def format_location_detail_county(data):
         df['state_fips'] = pd.NA
         df['state_name'] = pd.NA
 
-    df.rename(columns={'fsid_placeholder': 'fsid'}, inplace=True)
+    df.rename(columns={'fsid_placeholder': 'fsid', 'name_placeholder': 'name'}, inplace=True)
     df['fsid'] = df['fsid'].apply(str)
     df['city_fips'] = df['city_fips'].astype('Int64').apply(str)
     df['zipCode'] = df['zipCode'].astype('Int64').apply(str)
     df['cd_fips'] = df['cd_fips'].astype('Int64').apply(str)
     df['state_fips'] = df['state_fips'].astype('Int64').apply(str).apply(lambda x: x.zfill(2))
     df['geometry'] = df['geometry'].apply(get_geom_center)
     df = pd.concat([df.drop(['geometry'], axis=1), df['geometry'].apply(pd.Series)], axis=1)
-    return df[['fsid', 'valid_id', 'city_fips', 'city_name', 'zipCode', 'fips', 'isCoastal', 'cd_fips',
+    return df[['fsid', 'valid_id', 'name', 'isCoastal', 'city_fips', 'city_name', 'zipCode', 'fips', 'cd_fips',
                'cd_name', 'state_fips', 'state_name', 'latitude', 'longitude']]
 
 

firststreet/http_util.py

@@ -13,7 +13,6 @@
 import ssl
 import certifi
 from asyncio_throttle import Throttler
-from itertools import islice
 
 # Internal Imports
 import firststreet.errors as e
@@ -102,6 +101,7 @@ async def execute(self, endpoint, session, throttler):
         Raises:
             _network_error: if an error occurs
         """
+
         headers = self.options.get('headers')
 
         # Retry loop

setup.py

@@ -11,7 +11,7 @@
 
 setup(
     name='fsf-api-access_python',
-    version='2.1.2',
+    version='2.2.0',
     description='A Python API Access Client for the First Street Foundation API',
     url='https://github.com/FirstStreet/fsf_api_access_python',
     project_urls={

tests/api/test_tiles.py

@@ -19,51 +19,51 @@ class TestProbabilityTiles:
 
     def test_empty(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=[])
+            fs.tile.get_probability_depth(year=2050, return_period=5, search_items=[])
 
     def test_wrong_coord_type(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=(12, 942, 1715))
+            fs.tile.get_probability_depth(year=2050, return_period=5, search_items=(12, 942, 1715))
 
     def test_wrong_coord_tuple_type(self):
         with pytest.raises(TypeError):
-            fs.tile.get_probability_depth(year=2050, return_period=500, coordinate=[500])
+            fs.tile.get_probability_depth(year=2050, return_period=500, search_items=[500])
 
     def test_invalid(self):
         coord = [(1, 1, 1)]
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=coord)
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=coord)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         assert tile[0].image is None
         assert tile[0].valid_id is False
 
     def test_wrong_year_type(self):
         with pytest.raises(TypeError):
-            fs.tile.get_probability_depth(year="year", return_period=5, coordinate=[(12, 942, 1715)])
+            fs.tile.get_probability_depth(year="year", return_period=5, search_items=[(12, 942, 1715)])
 
     def test_wrong_return_period_type(self):
         with pytest.raises(TypeError):
-            fs.tile.get_probability_depth(year=2050, return_period="rp", coordinate=[(12, 942, 1715)])
+            fs.tile.get_probability_depth(year=2050, return_period="rp", search_items=[(12, 942, 1715)])
 
     def test_bad_year(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_probability_depth(year=1000, return_period=5, coordinate=[(12, 942, 1715)])
+            fs.tile.get_probability_depth(year=1000, return_period=5, search_items=[(12, 942, 1715)])
 
     def test_bad_return_period(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_probability_depth(year=1000, return_period=5, coordinate=[(12, 942, 1715)])
+            fs.tile.get_probability_depth(year=1000, return_period=5, search_items=[(12, 942, 1715)])
 
     def test_single(self):
         coord = [(12, 942, 1715)]
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=coord)
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=coord)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         assert tile[0].image is not None
         assert tile[0].valid_id is True
 
     def test_multiple(self):
         coord = [(12, 942, 1715), (17, 30990, 54379)]
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=coord)
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=coord)
         assert len(tile) == 2
         tile.sort(key=lambda x: x.coordinate)
         assert tile[0].coordinate == coord[0]
@@ -75,15 +75,15 @@ def test_multiple(self):
 
     def test_single_image(self):
         coord = [(12, 942, 1715)]
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=coord, image=True)
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=coord, image=True)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         assert tile[0].image is not None
         assert tile[0].valid_id is True
 
     def test_mixed_invalid(self):
         coord = [(12, 942, 1715), (1, 1, 1)]
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=coord)
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=coord)
         assert len(tile) == 2
         tile.sort(key=lambda x: x.coordinate, reverse=True)
         assert tile[0].coordinate == coord[0]
@@ -94,7 +94,7 @@ def test_mixed_invalid(self):
         assert tile[1].valid_id is False
 
     def test_one_of_each(self):
-        tile = fs.tile.get_probability_depth(year=2050, return_period=5, coordinate=[(12, 942, 1715)])
+        tile = fs.tile.get_probability_depth(year=2050, return_period=5, search_items=[(12, 942, 1715)])
         assert len(tile) == 1
         assert tile[0].valid_id is True
         assert tile[0].coordinate == (12, 942, 1715)
@@ -107,41 +107,41 @@ class TestHistoricTiles:
 
     def test_empty(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_historic_event(event_id=2, coordinate=[])
+            fs.tile.get_historic_event(event_id=2, search_items=[])
 
     def test_wrong_coord_type(self):
         with pytest.raises(InvalidArgument):
-            fs.tile.get_historic_event(event_id=2, coordinate=(12, 942, 1715))
+            fs.tile.get_historic_event(event_id=2, search_items=(12, 942, 1715))
 
     def test_invalid(self):
         coord = [(12, 1, 1)]
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=coord)
+        tile = fs.tile.get_historic_event(event_id=2, search_items=coord)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         # No way to test if image is bad
 
     def test_wrong_event_id_type(self):
         with pytest.raises(TypeError):
-            fs.tile.get_historic_event(event_id="event_id", coordinate=[(12, 942, 1715)])
+            fs.tile.get_historic_event(event_id="event_id", search_items=[(12, 942, 1715)])
 
     def test_bad_event(self):
         coord = [(12, 942, 1715)]
-        tile = fs.tile.get_historic_event(event_id=99999, coordinate=coord)
+        tile = fs.tile.get_historic_event(event_id=99999, search_items=coord)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         # No way to test if image is bad
 
     def test_single(self):
         coord = [(12, 942, 1715)]
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=coord)
+        tile = fs.tile.get_historic_event(event_id=2, search_items=coord)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         assert tile[0].image is not None
         assert tile[0].valid_id is True
 
     def test_multiple(self):
         coord = [(12, 942, 1715), (17, 30990, 54379)]
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=coord)
+        tile = fs.tile.get_historic_event(event_id=2, search_items=coord)
         assert len(tile) == 2
         tile.sort(key=lambda x: x.coordinate)
         assert tile[0].coordinate == coord[0]
@@ -153,15 +153,15 @@ def test_multiple(self):
 
     def test_single_image(self):
         coord = [(12, 942, 1715)]
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=coord, image=True)
+        tile = fs.tile.get_historic_event(event_id=2, search_items=coord, image=True)
         assert len(tile) == 1
         assert tile[0].coordinate == coord[0]
         assert tile[0].image is not None
         assert tile[0].valid_id is True
 
     def test_mixed_invalid(self):
         coord = [(12, 942, 1715), (2, 1, 1)]
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=coord)
+        tile = fs.tile.get_historic_event(event_id=2, search_items=coord)
         assert len(tile) == 2
         tile.sort(key=lambda x: x.coordinate, reverse=True)
         assert tile[0].coordinate == coord[0]
@@ -171,7 +171,7 @@ def test_mixed_invalid(self):
         # No way to test if image is bad
 
     def test_one_of_each(self):
-        tile = fs.tile.get_historic_event(event_id=2, coordinate=[(12, 942, 1715)])
+        tile = fs.tile.get_historic_event(event_id=2, search_items=[(12, 942, 1715)])
         assert len(tile) == 1
         assert tile[0].valid_id is True
         assert tile[0].coordinate == (12, 942, 1715)