unrestrain deprecation

Author: cadenmyers13

src/diffpy/srfit/fitbase/recipeorganizer.py

@@ -146,6 +146,13 @@
     removal_version,
 )
 
+unrestrain_deprecation_msg = build_deprecation_message(
+    recipeorganizer_base,
+    "unrestrain",
+    "remove_restraint",
+    removal_version,
+)
+
 
 class RecipeContainer(Observable, Configurable, Validatable):
     """Base class for organizing pieces of a FitRecipe.
@@ -1231,13 +1238,13 @@ def addRestraint(self, res):
         self.register_restraint(res)
         return
 
-    def unrestrain(self, *ress):
+    def remove_restraint(self, *ress):
         """Remove a Restraint from the RecipeOrganizer.
 
         Attributes
         ----------
-        *ress
-            Restraints returned from the 'restrain' method or added
+        *ress :
+            The Restraints returned from the 'add_restraint' method or added
             with the 'register_restraint' method.
         """
         update = False
@@ -1253,6 +1260,18 @@ def unrestrain(self, *ress):
 
         return
 
+    @deprecated(unrestrain_deprecation_msg)
+    def unrestrain(self, *ress):
+        """This function has been deprecated and will be removed in
+        version 4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.recipeorganizer.RecipeOrganizer.remove_restraint
+        instead.
+        """
+        self.remove_restraint(*ress)
+        return
+
     def clearRestraints(self, recurse=False):
         """Clear all restraints.
 
@@ -1262,7 +1281,7 @@ def clearRestraints(self, recurse=False):
             Recurse into managed objects and clear all restraints
             found there as well.
         """
-        self.unrestrain(*self._restraints)
+        self.remove_restraint(*self._restraints)
         if recurse:
             for msg in filter(_has_clear_restraints, self._iter_managed()):
                 msg.clearRestraints(recurse)

tests/test_fitrecipe.py

@@ -247,7 +247,7 @@ def testResidual(self):
         self.assertAlmostEqual(chi2, dot(res, res))
 
         # Remove the restraint and variable
-        self.recipe.unrestrain(r1)
+        self.recipe.remove_restraint(r1)
         self.recipe.delete_variable(self.recipe.Avar)
         self.recipe._ready = False
         res = self.recipe.residual()
@@ -275,7 +275,7 @@ def testResidual(self):
         self.assertAlmostEqual(chi2, dot(res, res))
 
         # Remove those
-        self.fitcontribution.unrestrain(r1)
+        self.fitcontribution.remove_restraint(r1)
         self.recipe._ready = False
         self.fitcontribution.unconstrain(self.fitcontribution.c)
         self.fitcontribution.c.set_value(0)

tests/test_recipeorganizer.py

@@ -342,7 +342,7 @@ def test_add_restraint(self):
         self.assertEqual(1, len(self.m._restraints))
         p2.set_value(10)
         self.assertEqual(1, r.penalty())
-        self.m.unrestrain(r)
+        self.m.remove_restraint(r)
         self.assertEqual(0, len(self.m._restraints))
 
         r = self.m.restrain(p1, ub=10)