setWeight deprecation

Author: cadenmyers13

docs/examples/npintensityII.py

@@ -248,17 +248,17 @@ def main():
     # fit.
     recipe.fix("all")
     recipe.free("bcoeffs1")
-    recipe.setWeight(recipe.bucky2, 0)
+    recipe.set_weight(recipe.bucky2, 0)
     scipyOptimize(recipe)
     # Now do the same for the second background
     recipe.fix("all")
     recipe.free("bcoeffs1")
-    recipe.setWeight(recipe.bucky2, 1)
-    recipe.setWeight(recipe.bucky1, 0)
+    recipe.set_weight(recipe.bucky2, 1)
+    recipe.set_weight(recipe.bucky1, 0)
     scipyOptimize(recipe)
     # Now refine everything with the structure parameters included
     recipe.free("all")
-    recipe.setWeight(recipe.bucky1, 1)
+    recipe.set_weight(recipe.bucky1, 1)
     scipyOptimize(recipe)
 
     # Generate and print the FitResults

docs/examples/nppdfsas.py

@@ -122,23 +122,23 @@ def fitRecipe(recipe):
     """We refine in stages to help the refinement converge."""
 
     # Tune SAS.
-    recipe.setWeight(recipe.pdf, 0)
+    recipe.set_weight(recipe.pdf, 0)
     recipe.fix("all")
     recipe.free("radius_a", "radius_b", iqscale=1e8)
     recipe.constrain("radius_b", "radius_a")
     scipyOptimize(recipe)
     recipe.unconstrain("radius_b")
 
     # Tune PDF
-    recipe.setWeight(recipe.pdf, 1)
-    recipe.setWeight(recipe.sas, 0)
+    recipe.set_weight(recipe.pdf, 1)
+    recipe.set_weight(recipe.sas, 0)
     recipe.fix("all")
     recipe.free("a", "Biso_0", "scale", "delta2")
     scipyOptimize(recipe)
 
     # Tune all
-    recipe.setWeight(recipe.pdf, 1)
-    recipe.setWeight(recipe.sas, 1)
+    recipe.set_weight(recipe.pdf, 1)
+    recipe.set_weight(recipe.sas, 1)
     recipe.free("all")
     scipyOptimize(recipe)
 

src/diffpy/srfit/fitbase/fitrecipe.py

@@ -71,6 +71,10 @@
     base, "clearFitHooks", "clear_fit_hooks", removal_version
 )
 
+setweight_dep_msg = build_deprecation_message(
+    base, "setWeight", "set_weight", removal_version
+)
+
 
 class FitRecipe(_fitrecipe_interface, RecipeOrganizer):
     """FitRecipe class.
@@ -326,12 +330,21 @@ def addContribution(self, con, weight=1.0):
         self.add_contribution(con, weight)
         return
 
-    def setWeight(self, con, weight):
+    def set_weight(self, con, weight):
         """Set the weight of a FitContribution."""
         idx = list(self._contributions.values()).index(con)
         self._weights[idx] = weight
         return
 
+    @deprecated(setweight_dep_msg)
+    def setWeight(self, con, weight):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitRecipe.set_weight instead."""
+        self.set_weight(con, weight)
+        return
+
     def addParameterSet(self, parset):
         """Add a ParameterSet to the hierarchy.