MAINT: Rename 'replace_object' with 'update_object' for clarity

sdafile/sda_file.py

@@ -397,8 +397,8 @@ def replace(self, label, data):
         self.remove(label)
         self.insert(label, data, attrs['Description'], attrs['Deflate'])
 
-    def replace_object(self, label, data):
-        """ Replace an existing object record.
+    def update_object(self, label, data):
+        """ Update an existing object record.
 
         Parameters
         ----------
@@ -409,9 +409,9 @@ def replace_object(self, label, data):
 
         Notes
         -----
-        This is more strict than **replace** in that the intention is to
-        replace an 'object' record while preserving the record type. The
-        simplest way to make use of this is to *extract* an object record,
+        This is more strict than **replace** in that the intention is to update
+        the contents of an 'object' record while preserving the record type.
+        The simplest way to make use of this is to *extract* an object record,
         replace some data, and then call this to update the stored record.
 
         """

sdafile/tests/test_sda_file.py

@@ -768,7 +768,7 @@ def test_probe(self):
             assert_array_equal(state['Deflate'], [0, 1])
 
 
-class TestSDAFileReplace(unittest.TestCase):
+class TestSDAFileReplaceUpdate(unittest.TestCase):
 
     def test_replace(self):
 
@@ -807,9 +807,9 @@ def test_replace_non_object(self):
             label = 'example A'
             data = sda_file.extract('example I')
             with self.assertRaises(ValueError):
-                sda_file.replace_object(label, data)
+                sda_file.update_object(label, data)
 
-    def test_replace_object_with_equivalent_record(self):
+    def test_update_object_with_equivalent_record(self):
 
         reference_path = data_path('SDAreference.sda')
         with temporary_file() as file_path:
@@ -824,7 +824,7 @@ def test_replace_object_with_equivalent_record(self):
             # Replace some stuff with the same type
             data = sda_file.extract(label)
             data['Parameter'] = np.arange(5)
-            sda_file.replace_object(label, data)
+            sda_file.update_object(label, data)
 
             extracted = sda_file.extract(label)
 
@@ -840,7 +840,7 @@ def test_replace_object_with_equivalent_record(self):
         self.assertEqual(len(extracted), 1)
         assert_equal(extracted['Parameter'], data['Parameter'])
 
-    def test_replace_object_with_inequivalent_record(self):
+    def test_update_object_with_inequivalent_record(self):
 
         reference_path = data_path('SDAreference.sda')
         with temporary_file() as file_path:
@@ -853,9 +853,9 @@ def test_replace_object_with_inequivalent_record(self):
             data = sda_file.extract(label)
             data['Parameter'] = 'hello world'
             with self.assertRaises(ValueError):
-                sda_file.replace_object(label, data)
+                sda_file.update_object(label, data)
 
-    def test_replace_object_with_non_record(self):
+    def test_update_object_with_non_record(self):
 
         reference_path = data_path('SDAreference.sda')
         with temporary_file() as file_path:
@@ -866,4 +866,4 @@ def test_replace_object_with_non_record(self):
 
             # Replace some stuff with a non-dictionary
             with self.assertRaises(ValueError):
-                sda_file.replace_object(label, 'hello')
+                sda_file.update_object(label, 'hello')