saveResults deprecation

Author: cadenmyers13

docs/examples/simplepdf.py

@@ -83,7 +83,7 @@ def makeRecipe(ciffile, datname):
     # Generate, print and save the FitResults
     res = FitResults(recipe)
     res.print_results()
-    res.saveResults("nickel_example.res")
+    res.save_results("nickel_example.res")
 
     # Plot!
     plotResults(recipe)

src/diffpy/srfit/fitbase/fitresults.py

@@ -50,6 +50,13 @@
     removal_version,
 )
 
+saveResults_dep_msg = build_deprecation_message(
+    fitresults_base,
+    "saveResults",
+    "save_results",
+    removal_version,
+)
+
 
 class FitResults(object):
     """Class for processing, presenting and storing results of a fit.
@@ -345,7 +352,7 @@ def _calculate_constraint_uncertainties(self):
     def get_results_string(self, header="", footer="", update=False):
         """Format the results and return them in a string.
 
-        This function is called by print_results and saveResults. Overloading
+        This function is called by print_results and save_results. Overloading
         the formatting here will change all three functions.
 
         Parameters
@@ -573,7 +580,7 @@ def printResults(self, header="", footer="", update=False):
     def __str__(self):
         return self.get_results_string()
 
-    def saveResults(self, filename, header="", footer="", update=False):
+    def save_results(self, filename, header="", footer="", update=False):
         """Format and save the results.
 
         Parameters
@@ -601,6 +608,17 @@ def saveResults(self, filename, header="", footer="", update=False):
         f.close()
         return
 
+    @deprecated(saveResults_dep_msg)
+    def saveResults(self, filename, header="", footer="", update=False):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitResults.save_results
+        instead.
+        """
+        self.save_results(filename, header, footer, update)
+        return
+
 
 # End class FitResults
 

src/diffpy/srfit/fitbase/simplerecipe.py

@@ -65,6 +65,13 @@
     removal_version,
 )
 
+saveResults_dep_msg = build_deprecation_message(
+    base,
+    "saveResults",
+    "save_results",
+    removal_version,
+)
+
 
 class SimpleRecipe(FitRecipe):
     """SimpleRecipe class.
@@ -366,7 +373,7 @@ def printResults(self, header="", footer=""):
         self.print_results(header, footer)
         return
 
-    def saveResults(self, filename, header="", footer=""):
+    def save_results(self, filename, header="", footer=""):
         """Format and save the results.
 
         Parameters
@@ -378,7 +385,18 @@ def saveResults(self, filename, header="", footer=""):
         footer
             A footer to add to the output (default "")
         """
-        self.results.saveResults(filename, header, footer, True)
+        self.results.save_results(filename, header, footer, True)
+
+    @deprecated(saveResults_dep_msg)
+    def saveResults(self, filename, header="", footer=""):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.SimpleRecipe.save_results
+        instead.
+        """
+        self.save_results(filename, header, footer)
 
 
 # End class SimpleRecipe

tests/test_fitresults.py

@@ -121,6 +121,23 @@ def test_saveResults(build_recipe_one_contribution, tmp_path):
         assert expected_var in actual_results.strip()
 
 
+def test_save_results(build_recipe_one_contribution, tmp_path):
+    recipe = build_recipe_one_contribution
+    optimize_recipe(recipe)
+    results = FitResults(recipe)
+    actual_results_file = tmp_path / "fit_results.txt"
+    results.save_results(actual_results_file, header="My Custom header")
+    assert actual_results_file.exists()
+    with open(actual_results_file, "r") as res_file:
+        actual_results = res_file.read()
+    # Because slight variations in refinement, just check
+    # that the header of the results are the same.
+    assert expected_fitresults.strip() in actual_results.strip()
+    # check if the refined variables are in the results
+    for expected_var in expected_refined_variables:
+        assert expected_var in actual_results.strip()
+
+
 def testInitializeFromFileName(datafile):
     recipe = FitRecipe("recipe")
     recipe.create_new_variable("A", 0)