delate code type arg and other

Author: NicolasColombi

CHANGELOG.md

@@ -71,7 +71,7 @@ Removed:
 
 ### Added
 
-- `climada.entity.impact_funcs.trop_cyclone.ImpfSetTropCyclone.get_countries_per_region` function [#1034](https://github.com/CLIMADA-project/climada_python/pull/1034)
+- `climada.entity.impact_funcs.trop_cyclone.ImpfSetTropCyclone.get_impf_id_regions_per_countries` function [#1034](https://github.com/CLIMADA-project/climada_python/pull/1034)
 - `climada.hazard.tc_tracks.TCTracks.subset_years` function [#1023](https://github.com/CLIMADA-project/climada_python/pull/1023)
 - `climada.hazard.tc_tracks.TCTracks.from_FAST` function, add Australia basin (AU) [#993](https://github.com/CLIMADA-project/climada_python/pull/993)
 - Add `osm-flex` package to CLIMADA core [#981](https://github.com/CLIMADA-project/climada_python/pull/981)

climada/entity/impact_funcs/test/test_tc.py

@@ -168,46 +168,28 @@ def test_get_countries_per_region(self):
         self.assertListEqual(out[2], [124, 840])
         self.assertListEqual(out[3], ["CAN", "USA"])
 
-    def test_get_region_per_countries(self):
+    def test_get_imf_id_regions_per_countries(self):
         """Test get_impf_id_regions_per_countries()"""
         ifs = ImpfSetTropCyclone()
-        out = ifs.get_impf_id_regions_per_countries(
-            countries=["CHE"], code_type="ISO3A"
-        )
-        self.assertEqual(out[0][0], 10)
-        self.assertEqual(out[1][0], "ROW")
-        self.assertEqual(out[2][0], "Rest of The World")
-        out = ifs.get_impf_id_regions_per_countries(countries=[756], code_type="ISO3N")
-        self.assertEqual(out[0][0], 10)
-        self.assertEqual(out[1][0], "ROW")
-        self.assertEqual(out[2][0], "Rest of The World")
-        with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
-                countries=["SWE"], code_type="invalid_code"
-            )
-        self.assertEqual(
-            str(context.exception), "code_type must be either 'iso3a' or 'iso3n'"
-        )
-        with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
-                countries=["SWE", 840], code_type="ISO3A"
-            )
-        self.assertEqual(
-            str(context.exception), "All elements in the list must be of the same type."
-        )
-        with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
-                countries=[840, 124], code_type="ISO3A"
-            )
-        self.assertEqual(
-            str(context.exception), "ISO3A code type cannot have integer values."
+        impf_id_reg_id_reg_name = ifs.get_impf_id_regions_per_countries(
+            countries=["CHE"]
         )
+
+        # the first element of impf_id_reg_id_reg_name [0] is the impact function id,
+        # the second [1] is the region id, the third [2] is the region name.
+        self.assertEqual(impf_id_reg_id_reg_name[0][0], 10)
+        self.assertEqual(impf_id_reg_id_reg_name[1][0], "ROW")
+        self.assertEqual(impf_id_reg_id_reg_name[2][0], "Rest of The World")
+        out = ifs.get_impf_id_regions_per_countries(countries=[756])
+        self.assertEqual(impf_id_reg_id_reg_name[0][0], 10)
+        self.assertEqual(impf_id_reg_id_reg_name[1][0], "ROW")
+        self.assertEqual(impf_id_reg_id_reg_name[2][0], "Rest of The World")
+
         with self.assertRaises(ValueError) as context:
-            ImpfSetTropCyclone.get_impf_id_regions_per_countries(
-                countries=["MEX"], code_type="ISO3N"
-            )
+            ImpfSetTropCyclone.get_impf_id_regions_per_countries(countries=[3.22])
         self.assertEqual(
-            str(context.exception), "ISO3N code type cannot have string values."
+            str(context.exception),
+            "The element 3.22 is neither in ISO3A nor ISO3N format",
         )
 
 

climada/entity/impact_funcs/trop_cyclone.py

@@ -37,7 +37,7 @@
 
 class CountryCode(Enum):
     """
-    Enum class that links ISO country codes (both iso3a and iso3n) to specific regions and
+    Enum class that links ISO country codes (both ISO3A and ISO3N) to specific regions and
     associated impact function IDs.
 
     Attributes
@@ -458,22 +458,18 @@ def get_countries_per_region(region=None):
         )
 
     @staticmethod
-    def get_impf_id_regions_per_countries(
-        countries: list = None, code_type: str = "ISO3A"
-    ) -> tuple:
+    def get_impf_id_regions_per_countries(countries: list = None) -> tuple:
         """Return the impact function id and the region corresponding to a list of countries,
         or a single country.
 
         Parameters:
         -----------
         countries : list
             List containing the ISO codes of the country, which should be either
-            in string format if the code is "ISO3A" or an integer if "ISO3N", see code_type below.
-        code_type : str
-            Either "ISO3A" or "ISO3N". "ISO3A" stands for "ISO 3166-1 alpha-3" which is a
-            three-letter country code, "ISO3N" stands for "ISO 3166-1 numeric" which is a
-            three-digit country code, the numeric version of "ISO3A". For example, for Switzerland:
-            the "ISO3A" code is "CHE" and the "ISO3N" is 756.
+            in string format if the code is "ISO 3166-1 alpha-3" or an integer if the code is
+            "ISO 3166-1 numeric", which is a three-digit country code, the numeric version of
+            "ISO 3166-1 alpha-3". For example, for Switzerland: the "ISO 3166-1 alpha-3" code is
+            "CHE" and the "ISO 3166-1 numeric" is 756.
 
         Returns:
         --------
@@ -487,23 +483,25 @@ def get_impf_id_regions_per_countries(
             List of the regions names. Example: "Caribbean and Mexico", "USA and Canada", ...
         """
 
-        if code_type not in {"ISO3A", "ISO3N"}:
-            raise ValueError("code_type must be either 'iso3a' or 'iso3n'")
-        elif not all(isinstance(country, type(countries[0])) for country in countries):
-            raise ValueError("All elements in the list must be of the same type.")
-        elif code_type == "ISO3A" and isinstance((countries[0]), int):
-            raise ValueError("ISO3A code type cannot have integer values.")
-        elif code_type == "ISO3N" and isinstance((countries[0]), str):
-            raise ValueError("ISO3N code type cannot have string values.")
-
-        region_country_dict = getattr(CountryCode, code_type).value
         # Find region
-        regions_ids = [
-            region_id
-            for country in countries
-            for region_id, countr_in_region_id in region_country_dict.items()
-            if country in countr_in_region_id
-        ]
+        regions_ids = []
+        for country in countries:
+
+            if isinstance(country, str):
+                code_type = "ISO3A"
+            elif isinstance(country, int):
+                code_type = "ISO3N"
+            else:
+                raise ValueError(
+                    f"The element {country} is neither in ISO3A nor ISO3N format"
+                )
+
+            region_country_dict = getattr(CountryCode, code_type).value
+
+            for region_id, countr_in_region_id in region_country_dict.items():
+                if country in countr_in_region_id:
+                    regions_ids.append(region_id)
+
         # Find impact function id
         impf_ids = [CountryCode.IMPF_ID.value[region] for region in regions_ids]
         regions_name = [CountryCode.REGION_NAME.value[region] for region in regions_ids]