Merge pull request #160 from cadenmyers13/fitresults-dep

sbillinge · web-flow · commit 72ed60ea2c20 · 2026-02-24T08:11:07.000-08:00
Deprecate: deprecate all methods of `FitResults`
diff --git a/docs/examples/coreshellnp.py b/docs/examples/coreshellnp.py
@@ -206,7 +206,7 @@ def main():
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/crystalpdf.py b/docs/examples/crystalpdf.py
@@ -168,7 +168,7 @@ def plotResults(recipe):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/crystalpdfall.py b/docs/examples/crystalpdfall.py
@@ -232,7 +232,7 @@ def plotResults(recipe):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/crystalpdfobjcryst.py b/docs/examples/crystalpdfobjcryst.py
@@ -121,7 +121,7 @@ def makeRecipe(ciffile, datname):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/crystalpdftwodata.py b/docs/examples/crystalpdftwodata.py
@@ -188,7 +188,7 @@ def plotResults(recipe):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/crystalpdftwophase.py b/docs/examples/crystalpdftwophase.py
@@ -179,7 +179,7 @@ def plotResults(recipe):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/debyemodel.py b/docs/examples/debyemodel.py
@@ -193,7 +193,7 @@ def main():
     res = FitResults(recipe)
 
     # Print the results
-    res.printResults()
+    res.print_results()
 
     # Plot the results
     plotResults(recipe)
diff --git a/docs/examples/debyemodelII.py b/docs/examples/debyemodelII.py
@@ -146,7 +146,7 @@ def main():
     res = FitResults(recipe)
 
     # Print the results
-    res.printResults()
+    res.print_results()
 
     # Plot the results
     plotResults(recipe)
diff --git a/docs/examples/ellipsoidsas.py b/docs/examples/ellipsoidsas.py
@@ -122,7 +122,7 @@ def plotResults(recipe):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/gaussianrecipe.py b/docs/examples/gaussianrecipe.py
@@ -73,7 +73,7 @@ def main():
     res = FitResults(recipe)
 
     # Print the results.
-    res.printResults()
+    res.print_results()
 
     # Plot the results.
     plotResults(recipe)
diff --git a/docs/examples/interface.py b/docs/examples/interface.py
@@ -63,7 +63,7 @@ def main():
 
     res = FitResults(r)
     # Print the results.
-    res.printResults()
+    res.print_results()
     # Plot the results.
     from gaussianrecipe import plotResults
 
diff --git a/docs/examples/npintensity.py b/docs/examples/npintensity.py
@@ -326,7 +326,7 @@ def main():
     rescount = recipe.fithooks[0].count
     calcount = recipe.bucky.I.count
     footer = "iofq called %i%% of the time" % int(100.0 * calcount / rescount)
-    res.printResults(footer=footer)
+    res.print_results(footer=footer)
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/npintensityII.py b/docs/examples/npintensityII.py
@@ -264,7 +264,7 @@ def main():
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/nppdfcrystal.py b/docs/examples/nppdfcrystal.py
@@ -122,7 +122,7 @@ def plotResults(recipe):
     scipyOptimize(recipe)
 
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     plotResults(recipe)
 
diff --git a/docs/examples/nppdfobjcryst.py b/docs/examples/nppdfobjcryst.py
@@ -147,7 +147,7 @@ def main():
 
     # Print results
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot results
     plotResults(recipe)
diff --git a/docs/examples/nppdfsas.py b/docs/examples/nppdfsas.py
@@ -188,7 +188,7 @@ def plotResults(recipe):
     fitRecipe(recipe)
 
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     plotResults(recipe)
 
diff --git a/docs/examples/simplepdf.py b/docs/examples/simplepdf.py
@@ -82,8 +82,8 @@ def makeRecipe(ciffile, datname):
 
     # Generate, print and save the FitResults
     res = FitResults(recipe)
-    res.printResults()
-    res.saveResults("nickel_example.res")
+    res.print_results()
+    res.save_results("nickel_example.res")
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/simplepdftwophase.py b/docs/examples/simplepdftwophase.py
@@ -114,7 +114,7 @@ def makeRecipe(niciffile, siciffile, datname):
 
     # Generate and print the FitResults
     res = FitResults(recipe)
-    res.printResults()
+    res.print_results()
 
     # Plot!
     plotResults(recipe)
diff --git a/docs/examples/simplerecipe.py b/docs/examples/simplerecipe.py
@@ -51,7 +51,7 @@ def main():
     leastsq(recipe.residual, recipe.values)
 
     # Print the results
-    recipe.printResults()
+    recipe.print_results()
 
     return
 
diff --git a/docs/examples/threedoublepeaks.py b/docs/examples/threedoublepeaks.py
@@ -251,7 +251,7 @@ def steerFit(recipe):
     res = FitResults(recipe)
 
     # Print the results
-    res.printResults()
+    res.print_results()
 
     # Plot the results
     plotResults(recipe)
diff --git a/news/fitresults-dep.rst b/news/fitresults-dep.rst
@@ -0,0 +1,27 @@
+**Added:**
+
+* Added ``save_results`` method to ``FitResults``.
+* Added ``print_results`` method to ``FitResults``.
+* Added ``get_results_string`` method to ``FitResults``.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* Deprecated ``saveResults`` method for removal in 4.0.0.
+* Deprecated ``printResults`` method for removal in 4.0.0.
+* Deprecated ``formatResults`` method for removal in 4.0.0.
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/src/diffpy/srfit/fitbase/fitresults.py b/src/diffpy/srfit/fitbase/fitresults.py
@@ -31,6 +31,31 @@
 from diffpy.srfit.util import _DASHEDLINE
 from diffpy.srfit.util import sortKeyForNumericString as numstr
 from diffpy.srfit.util.inpututils import inputToString
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
+
+fitresults_base = "diffpy.srfit.fitbase.FitResults"
+removal_version = "4.0.0"
+
+formatResults_dep_msg = build_deprecation_message(
+    fitresults_base,
+    "formatResults",
+    "get_results_string",
+    removal_version,
+)
+
+printResults_dep_msg = build_deprecation_message(
+    fitresults_base,
+    "printResults",
+    "print_results",
+    removal_version,
+)
+
+saveResults_dep_msg = build_deprecation_message(
+    fitresults_base,
+    "saveResults",
+    "save_results",
+    removal_version,
+)
 
 
 class FitResults(object):
@@ -324,24 +349,24 @@ def _calculate_constraint_uncertainties(self):
             self.conunc.append(sig2c**0.5)
         return
 
-    def formatResults(self, header="", footer="", update=False):
+    def get_results_string(self, header="", footer="", update=False):
         """Format the results and return them in a string.
 
-        This function is called by printResults and saveResults. Overloading
+        This function is called by print_results and save_results. Overloading
         the formatting here will change all three functions.
 
-        Attributes
+        Parameters
         ----------
-        header
-            A header to add to the output (default "")
-        footer
-            A footer to add to the output (default "")
-        update
-            Flag indicating whether to call update() (default False).
+        header : str
+            The header to add to the output (default "")
+        footer : str
+            The footer to add to the output (default "")
+        update : bool
+            The flag indicating whether to call update() (default False).
 
         Returns
         -------
-        out
+        out : str
             a string containing the formatted results.
         """
         if update:
@@ -516,7 +541,17 @@ def formatResults(self, header="", footer="", update=False):
         out = "\n".join(lines) + "\n"
         return out
 
-    def printResults(self, header="", footer="", update=False):
+    @deprecated(formatResults_dep_msg)
+    def formatResults(self, header="", footer="", update=False):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitResults.get_results_string
+        instead.
+        """
+        return self.get_results_string(header, footer, update)
+
+    def print_results(self, header="", footer="", update=False):
         """Format and print the results.
 
         Parameters
@@ -528,13 +563,24 @@ def printResults(self, header="", footer="", update=False):
         update
             Flag indicating whether to call update() (default False).
         """
-        print(self.formatResults(header, footer, update).rstrip())
+        print(self.get_results_string(header, footer, update).rstrip())
+        return
+
+    @deprecated(printResults_dep_msg)
+    def printResults(self, header="", footer="", update=False):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitResults.print_results
+        instead.
+        """
+        self.print_results(header, footer, update)
         return
 
     def __str__(self):
-        return self.formatResults()
+        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
@@ -556,12 +602,23 @@ def saveResults(self, filename, header="", footer="", update=False):
         myheader += "produced by " + getuser() + "\n"
         header = myheader + header
 
-        res = self.formatResults(header, footer, update)
+        res = self.get_results_string(header, footer, update)
         f = open(filename, "w")
         f.write(res)
         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
 
diff --git a/src/diffpy/srfit/fitbase/simplerecipe.py b/src/diffpy/srfit/fitbase/simplerecipe.py
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/test_fitresults.py b/tests/test_fitresults.py
