change default value 'NA' to empty string. Rename function num_funcs to size.

Author: gabrielaznar

climada/entity/impact_funcs/impact_func_set.py

@@ -83,10 +83,10 @@ def add_func(self, func):
         if not isinstance(func, ImpactFunc):
             LOGGER.error("Input value is not of type ImpactFunc.")
             raise ValueError
-        if func.haz_type == 'NA':
+        if not func.haz_type:
             LOGGER.error("Input ImpactFunc's hazard type not set.")
             raise ValueError
-        if func.id == 'NA':
+        if not func.id:
             LOGGER.error("Input ImpactFunc's id not set.")
             raise ValueError
         if func.haz_type not in self._data:
@@ -193,7 +193,7 @@ def get_func(self, haz_type=None, fun_id=None):
         else:
             return self._data
 
-    def num_funcs(self, haz_type=None, fun_id=None):
+    def size(self, haz_type=None, fun_id=None):
         """Get number of impact functions contained with input hazard type and
         /or id. If no input provided, get total number of impact functions.
 
@@ -217,11 +217,11 @@ def check(self):
         """
         for key_haz, vul_dict in self._data.items():
             for fun_id, vul in vul_dict.items():
-                if (fun_id != vul.id) | (fun_id == 'NA'):
+                if (fun_id != vul.id) | (fun_id == ''):
                     LOGGER.error("Wrong ImpactFunc.id: %s != %s.", fun_id, \
                                  vul.id)
                     raise ValueError
-                if (key_haz != vul.haz_type) | (key_haz == 'NA'):
+                if (key_haz != vul.haz_type) | (key_haz == ''):
                     LOGGER.error("Wrong ImpactFunc.haz_type: %s != %s.",\
                                  key_haz, vul.haz_type)
                     raise ValueError
@@ -260,7 +260,7 @@ def append(self, impact_funcs):
             ValueError
         """
         impact_funcs.check()
-        if self.num_funcs() == 0:
+        if self.size() == 0:
             self.__dict__ = impact_funcs.__dict__.copy()
             return
 
@@ -282,7 +282,7 @@ def plot(self, haz_type=None, fun_id=None):
         Returns:
             matplotlib.figure.Figure, [matplotlib.axes._subplots.AxesSubplot]
         """
-        num_plts = self.num_funcs(haz_type, fun_id)
+        num_plts = self.size(haz_type, fun_id)
         # Select all hazard types to plot
         if haz_type is not None:
             hazards = [haz_type]

climada/entity/impact_funcs/test/test_imp_fun_set.py

@@ -193,52 +193,52 @@ def test_get_func_wrong_error(self):
         imp_fun.add_func(vulner_1)
         self.assertEqual([], imp_fun.get_func('TC'))
 
-    def test_num_funcs_pass(self):
-        """Test num_funcs function."""
+    def test_size_pass(self):
+        """Test size function."""
         imp_fun = ImpactFuncSet()
-        self.assertEqual(0, imp_fun.num_funcs())
+        self.assertEqual(0, imp_fun.size())
 
         vulner_1 = ImpactFunc()
         vulner_1.haz_type = 'WS'
         vulner_1.id = 56
         imp_fun.add_func(vulner_1)
-        self.assertEqual(1, imp_fun.num_funcs())
-        self.assertEqual(1, imp_fun.num_funcs('WS', 56))
-        self.assertEqual(1, imp_fun.num_funcs('WS'))
-        self.assertEqual(1, imp_fun.num_funcs(fun_id=56))
+        self.assertEqual(1, imp_fun.size())
+        self.assertEqual(1, imp_fun.size('WS', 56))
+        self.assertEqual(1, imp_fun.size('WS'))
+        self.assertEqual(1, imp_fun.size(fun_id=56))
         imp_fun.add_func(vulner_1)
-        self.assertEqual(1, imp_fun.num_funcs())
-        self.assertEqual(1, imp_fun.num_funcs('WS', 56))
-        self.assertEqual(1, imp_fun.num_funcs('WS'))
-        self.assertEqual(1, imp_fun.num_funcs(fun_id=56))
+        self.assertEqual(1, imp_fun.size())
+        self.assertEqual(1, imp_fun.size('WS', 56))
+        self.assertEqual(1, imp_fun.size('WS'))
+        self.assertEqual(1, imp_fun.size(fun_id=56))
 
         vulner_2 = ImpactFunc()
         vulner_2.haz_type = 'WS'
         vulner_2.id = 5
         imp_fun.add_func(vulner_2)
-        self.assertEqual(2, imp_fun.num_funcs())
-        self.assertEqual(1, imp_fun.num_funcs('WS', 56))
-        self.assertEqual(2, imp_fun.num_funcs('WS'))
-        self.assertEqual(1, imp_fun.num_funcs(fun_id=56))
-        self.assertEqual(1, imp_fun.num_funcs(fun_id=5))
+        self.assertEqual(2, imp_fun.size())
+        self.assertEqual(1, imp_fun.size('WS', 56))
+        self.assertEqual(2, imp_fun.size('WS'))
+        self.assertEqual(1, imp_fun.size(fun_id=56))
+        self.assertEqual(1, imp_fun.size(fun_id=5))
 
         vulner_3 = ImpactFunc()
         vulner_3.haz_type = 'TC'
         vulner_3.id = 5
         imp_fun.add_func(vulner_3)
-        self.assertEqual(3, imp_fun.num_funcs())
-        self.assertEqual(1, imp_fun.num_funcs('TC', 5))
-        self.assertEqual(2, imp_fun.num_funcs('WS'))
-        self.assertEqual(1, imp_fun.num_funcs('TC'))
-        self.assertEqual(1, imp_fun.num_funcs(fun_id=56))
-        self.assertEqual(2, imp_fun.num_funcs(fun_id=5))
-
-    def test_num_funcs_wrong_zero(self):
-        """Test num_funcs method with wrong inputs."""
+        self.assertEqual(3, imp_fun.size())
+        self.assertEqual(1, imp_fun.size('TC', 5))
+        self.assertEqual(2, imp_fun.size('WS'))
+        self.assertEqual(1, imp_fun.size('TC'))
+        self.assertEqual(1, imp_fun.size(fun_id=56))
+        self.assertEqual(2, imp_fun.size(fun_id=5))
+
+    def test_size_wrong_zero(self):
+        """Test size method with wrong inputs."""
         imp_fun = ImpactFuncSet()
-        self.assertEqual(0, imp_fun.num_funcs('TC'))
-        self.assertEqual(0, imp_fun.num_funcs('TC', 3))
-        self.assertEqual(0, imp_fun.num_funcs(fun_id=3))
+        self.assertEqual(0, imp_fun.size('TC'))
+        self.assertEqual(0, imp_fun.size('TC', 3))
+        self.assertEqual(0, imp_fun.size(fun_id=3))
 
     def test_add_func_pass(self):
         """Test add_func adds ImpactFunc to ImpactFuncSet correctly."""
@@ -352,9 +352,9 @@ def test_append_to_empty_same(self):
         imp_fun.append(imp_fun_add)
         imp_fun.check()
 
-        self.assertEqual(imp_fun.num_funcs(), 3)
-        self.assertEqual(imp_fun.num_funcs('TC'), 2)
-        self.assertEqual(imp_fun.num_funcs('FL'), 1)
+        self.assertEqual(imp_fun.size(), 3)
+        self.assertEqual(imp_fun.size('TC'), 2)
+        self.assertEqual(imp_fun.size('FL'), 1)
         self.assertEqual(imp_fun.tag.file_name, imp_fun_add.tag.file_name)
         self.assertEqual(imp_fun.tag.description, imp_fun_add.tag.description)
 
@@ -372,8 +372,8 @@ def test_append_equal_same(self):
         imp_fun.append(imp_fun_add)
         imp_fun.check()
 
-        self.assertEqual(imp_fun.num_funcs(), 1)
-        self.assertEqual(imp_fun.num_funcs('TC'), 1)
+        self.assertEqual(imp_fun.size(), 1)
+        self.assertEqual(imp_fun.size('TC'), 1)
 
     def test_append_different_append(self):
         """Append ImpactFuncSet with same and new values. The vulnerabilities
@@ -413,10 +413,10 @@ def test_append_different_append(self):
         imp_fun.append(imp_fun_add)
         imp_fun.check()
 
-        self.assertEqual(imp_fun.num_funcs(), 4)
-        self.assertEqual(imp_fun.num_funcs('TC'), 2)
-        self.assertEqual(imp_fun.num_funcs('FL'), 1)
-        self.assertEqual(imp_fun.num_funcs('WS'), 1)      
+        self.assertEqual(imp_fun.size(), 4)
+        self.assertEqual(imp_fun.size('TC'), 2)
+        self.assertEqual(imp_fun.size('FL'), 1)
+        self.assertEqual(imp_fun.size('WS'), 1)      
 
 class TestReadParallel(unittest.TestCase):
     """Check read function with several files"""
@@ -427,7 +427,7 @@ def test_read_two_pass(self):
         imp_funcs = ImpactFuncSet([ENT_TEMPLATE_XLS, ENT_TEMPLATE_XLS], descriptions)
         self.assertEqual(imp_funcs.tag.file_name, ENT_TEMPLATE_XLS)
         self.assertEqual(imp_funcs.tag.description, 'desc1 + desc2')
-        self.assertEqual(imp_funcs.num_funcs(), 11)
+        self.assertEqual(imp_funcs.size(), 11)
 
 # Execute Tests
 TESTS = unittest.TestLoader().loadTestsFromTestCase(TestContainer)