Updated test_descriptions.py to better test updateOptions and replace…

…Options methods in ModelDescription.
perwin · Jun 6, 2020 · 80f5b1f · 80f5b1f
1 parent 8c98133
commit 80f5b1f
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 7 deletions.
diff --git a/new_notes_and_todo_for_python-wrapper_code.txt b/new_notes_and_todo_for_python-wrapper_code.txt
@@ -183,7 +183,8 @@ bootstrap resampling) in process
 
     [ ] Add test of replaceOptions method (ModelDescription)
     [ ] Add test of replaceOptions method (SimpleModelDescription)
-    [ ] Add test of nParameters value (SimpleModelDescription)
+        [ ] Write test
+    [X] Add test of nParameters value (SimpleModelDescription)
 
 [X] Add ability to get list of image-function names
     -- instantiate a list of string when module is imported?

diff --git a/pyimfit/descriptions.py b/pyimfit/descriptions.py
@@ -773,7 +773,9 @@ def updateOptions( self, optionsDict: Dict[str,float] ):
 
     def replaceOptions( self, optionsDict: Dict[str,float] ):
         """
-        Replaces the current image-descriptions dict.
+        Replaces the current image-descriptions dict. This differs from updateOptions()
+        in that it will completely replace the current image-descriptions dict,
+        discarding any key-value pairs with keys not in the replacement dict.
 
 
         Parameters

diff --git a/pyimfit/tests/test_descriptions.py b/pyimfit/tests/test_descriptions.py
@@ -360,15 +360,29 @@ def test_ModelDescription_getParamLimits( self ):
         pLimits = modeldesc1.getParameterLimits()
         assert pLimits == [None,(180.0,220.0), None, (0.1,0.8), (10.0,1e3), (5.0,20.0)]
 
-    def testModelDescription_get_and_set_options( self ):
+    def testModelDescription_updateOptions( self ):
         modeldesc1 = ModelDescription(self.fsetList)
 
         assert {} == modeldesc1.optionsDict
-        optionsDict = {"GAIN": 4.5, "READNOISE": 0.9}
-        modeldesc1.updateOptions(optionsDict)
-        assert optionsDict == modeldesc1.optionsDict
-        optionsDict2 = {"GAIN": 10.5, "READNOISE": 0.9, "ORIGINAL_SKY": 45.01}
+        optionsDict1 = {"GAIN": 10.5, "READNOISE": 0.9, "ORIGINAL_SKY": 45.01}
+        modeldesc1.updateOptions(optionsDict1)
+        assert optionsDict1 == modeldesc1.optionsDict
+        # the following should *replace* the old GAIN and READNOISE values,
+        # but leave the ORIGINAL_SKY value unchanged
+        optionsDict2 = {"GAIN": 4.5, "READNOISE": 0.95}
         modeldesc1.updateOptions(optionsDict2)
+        refDict = {"GAIN": 4.5, "READNOISE": 0.95, "ORIGINAL_SKY": 45.01}
+        assert refDict == modeldesc1.optionsDict
+
+    def testModelDescription_replaceOtions( self ):
+        modeldesc1 = ModelDescription(self.fsetList)
+
+        assert {} == modeldesc1.optionsDict
+        optionsDict1 = {"GAIN": 10.5, "READNOISE": 0.9, "ORIGINAL_SKY": 45.01}
+        modeldesc1.replaceOptions(optionsDict1)
+        assert optionsDict1 == modeldesc1.optionsDict
+        optionsDict2 = {"GAIN": 4.5, "READNOISE": 0.9}
+        modeldesc1.replaceOptions(optionsDict2)
         assert optionsDict2 == modeldesc1.optionsDict
 
     def test_ModelDescription_load_from_file( self ):