rename function from check_X to assert_X

Author: mfeurer

openml/flows/__init__.py

@@ -1,6 +1,6 @@
 from .flow import OpenMLFlow
 from .sklearn_converter import sklearn_to_flow, flow_to_sklearn
-from .functions import get_flow, list_flows, flow_exists, check_flows_equal
+from .functions import get_flow, list_flows, flow_exists, assert_flows_equal
 
 __all__ = ['OpenMLFlow', 'create_flow_from_model', 'get_flow', 'list_flows',
            'sklearn_to_flow', 'flow_to_sklearn', 'flow_exists']

openml/flows/flow.py

@@ -358,4 +358,4 @@ def _check_flow(flow):
     import openml.flows.functions
 
     flow_copy = openml.flows.functions.get_flow(flow.flow_id)
-    openml.flows.functions.check_flows_equal(flow, flow_copy)
+    openml.flows.functions.assert_flows_equal(flow, flow_copy)

openml/flows/functions.py

@@ -130,7 +130,7 @@ def _list_flows(api_call):
     return flows
 
 
-def check_flows_equal(flow1, flow2):
+def assert_flows_equal(flow1, flow2):
     """Check equality of two flows.
 
     Two flows are equal if their all keys which are not set by the server
@@ -164,7 +164,7 @@ def check_flows_equal(flow1, flow2):
                 if not name in attr2:
                     raise ValueError('Component %s only available in '
                                      'argument2, but not in argument1.' % name)
-                check_flows_equal(attr1[name], attr2[name])
+                assert_flows_equal(attr1[name], attr2[name])
 
         else:
             if attr1 != attr2:

tests/test_flows/test_flow.py

@@ -98,7 +98,7 @@ def test_to_xml_from_xml(self):
         new_flow = openml.flows.OpenMLFlow._from_dict(xml_dict)
 
         # Would raise exception if they are not legal
-        openml.flows.functions.check_flows_equal(new_flow, flow)
+        openml.flows.functions.assert_flows_equal(new_flow, flow)
         self.assertIsNot(new_flow, flow)
 
     def test_publish_flow(self):
@@ -260,7 +260,7 @@ def test_sklearn_to_upload_to_flow(self):
         self.assertEqual(server_xml, local_xml)
 
         # Would raise exception if they are not equal!
-        openml.flows.functions.check_flows_equal(new_flow, flow)
+        openml.flows.functions.assert_flows_equal(new_flow, flow)
         self.assertIsNot(new_flow, flow)
 
         fixture_name = '%ssklearn.model_selection._search.RandomizedSearchCV(' \

tests/test_flows/test_flow_functions.py

@@ -58,7 +58,7 @@ def test_are_flows_equal(self):
                                        custom_name='Test')
 
         # Test most important values that can be set by a user
-        openml.flows.functions.check_flows_equal(flow, flow)
+        openml.flows.functions.assert_flows_equal(flow, flow)
         for attribute, new_value in [('name', 'Tes'),
                                      ('description', 'Test flo'),
                                      ('external_version', '2'),
@@ -70,11 +70,11 @@ def test_are_flows_equal(self):
             new_flow = copy.deepcopy(flow)
             setattr(new_flow, attribute, new_value)
             self.assertNotEqual(getattr(flow, attribute), getattr(new_flow, attribute))
-            self.assertRaises(ValueError, openml.flows.functions.check_flows_equal,
+            self.assertRaises(ValueError, openml.flows.functions.assert_flows_equal,
                               flow, new_flow)
 
         # Test that the API ignores several keys when comparing flows
-        openml.flows.functions.check_flows_equal(flow, flow)
+        openml.flows.functions.assert_flows_equal(flow, flow)
         for attribute, new_value in [('flow_id', 1),
                                      ('uploader', 1),
                                      ('version', 1),
@@ -86,27 +86,27 @@ def test_are_flows_equal(self):
             new_flow = copy.deepcopy(flow)
             setattr(new_flow, attribute, new_value)
             self.assertNotEqual(getattr(flow, attribute), getattr(new_flow, attribute))
-            openml.flows.functions.check_flows_equal(flow, new_flow)
+            openml.flows.functions.assert_flows_equal(flow, new_flow)
 
         # Now test for parameters
         flow.parameters['abc'] = 1.0
         flow.parameters['def'] = 2.0
-        openml.flows.functions.check_flows_equal(flow, flow)
+        openml.flows.functions.assert_flows_equal(flow, flow)
         new_flow = copy.deepcopy(flow)
         new_flow.parameters['abc'] = 3.0
-        self.assertRaises(ValueError, openml.flows.functions.check_flows_equal,
+        self.assertRaises(ValueError, openml.flows.functions.assert_flows_equal,
                           flow, new_flow)
 
         # Now test for components (subflows)
         parent_flow = copy.deepcopy(flow)
         subflow = copy.deepcopy(flow)
         parent_flow.components['subflow'] = subflow
-        openml.flows.functions.check_flows_equal(parent_flow, parent_flow)
+        openml.flows.functions.assert_flows_equal(parent_flow, parent_flow)
         self.assertRaises(ValueError,
-                          openml.flows.functions.check_flows_equal,
+                          openml.flows.functions.assert_flows_equal,
                           parent_flow, subflow)
         new_flow = copy.deepcopy(parent_flow)
         new_flow.components['subflow'].name = 'Subflow name'
         self.assertRaises(ValueError,
-                          openml.flows.functions.check_flows_equal,
+                          openml.flows.functions.assert_flows_equal,
                           parent_flow, new_flow)

tests/test_flows/test_sklearn.py

@@ -25,7 +25,7 @@
 import sklearn.tree
 
 from openml.flows import OpenMLFlow, sklearn_to_flow, flow_to_sklearn
-from openml.flows.functions import check_flows_equal
+from openml.flows.functions import assert_flows_equal
 from openml.flows.sklearn_converter import _format_external_version, _check_dependencies
 from openml.exceptions import PyOpenMLError
 
@@ -295,7 +295,7 @@ def test_serialize_complex_flow(self):
         serialized2 = sklearn_to_flow(deserialized)
         self.assertNotEqual(rs, deserialized)
         # Would raise an exception if the flows would be unequal
-        check_flows_equal(serialized, serialized2)
+        assert_flows_equal(serialized, serialized2)
 
     def test_serialize_type(self):
         supported_types = [float, np.float, np.float32, np.float64,