deprecate: addParameter, newParameter, and removeParameter deprecation

docs/source/extending.rst

@@ -74,9 +74,9 @@ atom object called ``SimpleAtom`` that has attributes ``x``, ``y`` and ``z``.
             zpar = ParameterAdapter("z", atom, attr = "z")
 
             # Add these to the parameter set
-            self.addParameter(xpar)
-            self.addParameter(ypar)
-            self.addParameter(zpar)
+            self.add_parameter(xpar)
+            self.add_parameter(ypar)
+            self.add_parameter(zpar)
 
             return
 
@@ -85,7 +85,7 @@ atom object called ``SimpleAtom`` that has attributes ``x``, ``y`` and ``z``.
 The ``x``, ``y`` and ``z`` attributes (specified by the ``attr`` keyword
 argument of ``ParameterAdapter``) of a ``SimpleAtom`` are wrapped as
 ``ParameterAdapter`` objects named `x`, `y`, and `z`.  They are then added to
-the ``SimpleAtomParSet`` using the ``addParameter`` method, which makes them
+the ``SimpleAtomParSet`` using the ``add_parameter`` method, which makes them
 accessible as attributes.
 
 If SimpleAtom did not have an attribute named ``x``, but rather accessor

news/addparameter-dep.rst

@@ -0,0 +1,26 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* ``ParameterSet.addParameter``, ``ParameterSet.newParameter`` and
+  ``ParameterSet.removeParameter`` are deprecated in favour of
+  ``add_parameter``, ``new_parameter`` and ``remove_parameter``. The old names
+  still work and warn, and will be removed in version 4.0.0.
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -196,9 +196,9 @@ def set_profile(self, profile, xname=None, yname=None, dyname=None):
         xpar = ParameterProxy(xname, self.profile.xpar)
         ypar = ParameterProxy(yname, self.profile.ypar)
         dypar = ParameterProxy(dyname, self.profile.dypar)
-        self.addParameter(xpar, check=False)
-        self.addParameter(ypar, check=False)
-        self.addParameter(dypar, check=False)
+        self.add_parameter(xpar, check=False)
+        self.add_parameter(ypar, check=False)
+        self.add_parameter(dypar, check=False)
 
         # If we have ProfileGenerators, set their Profiles.
         for gen in self._generators.values():
@@ -290,7 +290,7 @@ def set_equation(self, eqstr, ns={}):
         ----------
         eqstr : str
             A string representation of the equation. Any Parameter
-            registered by ``addParameter`` or ``set_profile``, or function
+            registered by ``add_parameter`` or ``set_profile``, or function
             registered by ``register_calculator``, ``register_function`` or
             ``register_string_function`` can be used in the equation
             by name. Other names will be turned into Parameters of this

src/diffpy/srfit/fitbase/parameterset.py

@@ -34,6 +34,18 @@
     base, "addParameterSet", "add_parameter_set", removal_version
 )
 
+addParameter_dep_msg = build_deprecation_message(
+    base, "addParameter", "add_parameter", removal_version
+)
+
+newParameter_dep_msg = build_deprecation_message(
+    base, "newParameter", "new_parameter", removal_version
+)
+
+removeParameter_dep_msg = build_deprecation_message(
+    base, "removeParameter", "remove_parameter", removal_version
+)
+
 removeParameterSet_dep_msg = build_deprecation_message(
     base, "removeParameterSet", "remove_parameter_set", removal_version
 )
@@ -99,9 +111,42 @@ def __init__(self, name):
         return
 
     # Alias Parameter accessors.
-    addParameter = RecipeOrganizer._add_parameter
-    newParameter = RecipeOrganizer._new_parameter
-    removeParameter = RecipeOrganizer._remove_parameter
+    add_parameter = RecipeOrganizer._add_parameter
+    new_parameter = RecipeOrganizer._new_parameter
+    remove_parameter = RecipeOrganizer._remove_parameter
+
+    @deprecated(addParameter_dep_msg)
+    def addParameter(self, parameter, check=True):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.parameterset.ParameterSet.add_parameter
+        instead.
+        """
+        return self.add_parameter(parameter, check)
+
+    @deprecated(newParameter_dep_msg)
+    def newParameter(self, name, value, check=True):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.parameterset.ParameterSet.new_parameter
+        instead.
+        """
+        return self.new_parameter(name, value, check)
+
+    @deprecated(removeParameter_dep_msg)
+    def removeParameter(self, parameter):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.parameterset.ParameterSet.remove_parameter
+        instead.
+        """
+        return self.remove_parameter(parameter)
 
     def add_parameter_set(self, parset):
         """Add a ParameterSet to the hierarchy.

src/diffpy/srfit/fitbase/profilegenerator.py

@@ -29,9 +29,9 @@ def __init__(self):
             # Initialize and give this a name
             ProfileGenerator.__init__(self, "g")
             # Add amplitude, center and width parameters
-            self.newParameter("amp", 0)
-            self.newParameter("center", 0)
-            self.newParameter("width", 0)
+            self.new_parameter("amp", 0)
+            self.new_parameter("center", 0)
+            self.new_parameter("width", 0)
         def __call__(self, x):
             a = self.amp.getValue()
             x0 = self.center.getValue()

src/diffpy/srfit/pdf/basepdfgenerator.py

@@ -122,7 +122,7 @@ def _set_calculator(self, calc):
         """
         self._calc = calc
         for pname in self.__class__._parnames:
-            self.addParameter(ParameterAdapter(pname, self._calc, attr=pname))
+            self.add_parameter(ParameterAdapter(pname, self._calc, attr=pname))
         self._process_metadata()
         return
 

src/diffpy/srfit/pdf/characteristicfunctions.py

@@ -654,14 +654,14 @@ def __init__(self, name, model):
         # Wrap normal parameters
         for parname in model.params:
             par = SASParameter(parname, model)
-            self.addParameter(par)
+            self.add_parameter(par)
 
         # Wrap dispersion parameters
         for parname in model.dispersion:
             name = parname + "_width"
             parname += ".width"
             par = SASParameter(name, model, parname)
-            self.addParameter(par)
+            self.add_parameter(par)
 
         return
 

src/diffpy/srfit/pdf/pdfcontribution.py

@@ -96,10 +96,10 @@ def __init__(self, name):
 
         # Need a parameter for the overall scale, in the case that this is a
         # multi-phase fit.
-        self.newParameter("scale", 1.0)
+        self.new_parameter("scale", 1.0)
         # Profile-related parameters that will be shared between the generators
-        self.newParameter("qdamp", 0)
-        self.newParameter("qbroad", 0)
+        self.new_parameter("qdamp", 0)
+        self.new_parameter("qbroad", 0)
         return
 
     # Data methods

src/diffpy/srfit/sas/sasgenerator.py

@@ -57,14 +57,14 @@ def __init__(self, name, model):
         # Wrap normal parameters
         for parname in model.params:
             par = SASParameter(parname, model)
-            self.addParameter(par)
+            self.add_parameter(par)
 
         # Wrap dispersion parameters
         for parname in model.dispersion:
             name = parname + "_width"
             parname += ".width"
             par = SASParameter(name, model, parname)
-            self.addParameter(par)
+            self.add_parameter(par)
 
         return
 

src/diffpy/srfit/structure/cctbxparset.py

@@ -70,19 +70,19 @@ def __init__(self, name, strups, idx):
         self.idx = idx
 
         # x, y, z, occupancy
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("x", None, self._xyzgetter(0), self._xyzsetter(0))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("y", None, self._xyzgetter(1), self._xyzsetter(1))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("z", None, self._xyzgetter(2), self._xyzsetter(2))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("occupancy", None, self._getocc, self._setocc)
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("Uiso", None, self._getuiso, self._setuiso)
         )
         return
@@ -163,26 +163,26 @@ def __init__(self, strups):
         self.strups = strups
         self._latpars = list(self.strups.stru.unit_cell().parameters())
 
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("a", None, self._latgetter(0), self._latsetter(0))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("b", None, self._latgetter(1), self._latsetter(1))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("c", None, self._latgetter(2), self._latsetter(2))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "alpha", None, self._latgetter(3), self._latsetter(3)
             )
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "beta", None, self._latgetter(4), self._latsetter(4)
             )
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "gamma", None, self._latgetter(5), self._latsetter(5)
             )

src/diffpy/srfit/structure/diffpyparset.py

@@ -102,52 +102,52 @@ def __init__(self, name, atom):
         self.atom = atom
         a = atom
         # x, y, z, occupancy
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("x", a, _xyzgetter(0), _xyzsetter(0))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("y", a, _xyzgetter(1), _xyzsetter(1))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("z", a, _xyzgetter(2), _xyzsetter(2))
         )
         occupancy = ParameterAdapter("occupancy", a, attr="occupancy")
-        self.addParameter(occupancy)
-        self.addParameter(ParameterProxy("occ", occupancy))
+        self.add_parameter(occupancy)
+        self.add_parameter(ParameterProxy("occ", occupancy))
         # U
-        self.addParameter(ParameterAdapter("U11", a, attr="U11"))
-        self.addParameter(ParameterAdapter("U22", a, attr="U22"))
-        self.addParameter(ParameterAdapter("U33", a, attr="U33"))
+        self.add_parameter(ParameterAdapter("U11", a, attr="U11"))
+        self.add_parameter(ParameterAdapter("U22", a, attr="U22"))
+        self.add_parameter(ParameterAdapter("U33", a, attr="U33"))
         U12 = ParameterAdapter("U12", a, attr="U12")
         U21 = ParameterProxy("U21", U12)
         U13 = ParameterAdapter("U13", a, attr="U13")
         U31 = ParameterProxy("U31", U13)
         U23 = ParameterAdapter("U23", a, attr="U23")
         U32 = ParameterProxy("U32", U23)
-        self.addParameter(U12)
-        self.addParameter(U21)
-        self.addParameter(U13)
-        self.addParameter(U31)
-        self.addParameter(U23)
-        self.addParameter(U32)
-        self.addParameter(ParameterAdapter("Uiso", a, attr="Uisoequiv"))
+        self.add_parameter(U12)
+        self.add_parameter(U21)
+        self.add_parameter(U13)
+        self.add_parameter(U31)
+        self.add_parameter(U23)
+        self.add_parameter(U32)
+        self.add_parameter(ParameterAdapter("Uiso", a, attr="Uisoequiv"))
         # B
-        self.addParameter(ParameterAdapter("B11", a, attr="B11"))
-        self.addParameter(ParameterAdapter("B22", a, attr="B22"))
-        self.addParameter(ParameterAdapter("B33", a, attr="B33"))
+        self.add_parameter(ParameterAdapter("B11", a, attr="B11"))
+        self.add_parameter(ParameterAdapter("B22", a, attr="B22"))
+        self.add_parameter(ParameterAdapter("B33", a, attr="B33"))
         B12 = ParameterAdapter("B12", a, attr="B12")
         B21 = ParameterProxy("B21", B12)
         B13 = ParameterAdapter("B13", a, attr="B13")
         B31 = ParameterProxy("B31", B13)
         B23 = ParameterAdapter("B23", a, attr="B23")
         B32 = ParameterProxy("B32", B23)
-        self.addParameter(B12)
-        self.addParameter(B21)
-        self.addParameter(B13)
-        self.addParameter(B31)
-        self.addParameter(B23)
-        self.addParameter(B32)
-        self.addParameter(ParameterAdapter("Biso", a, attr="Bisoequiv"))
+        self.add_parameter(B12)
+        self.add_parameter(B21)
+        self.add_parameter(B13)
+        self.add_parameter(B31)
+        self.add_parameter(B23)
+        self.add_parameter(B32)
+        self.add_parameter(ParameterAdapter("Biso", a, attr="Bisoequiv"))
         return
 
     def __repr__(self):
@@ -216,26 +216,26 @@ def __init__(self, lattice):
         self.angunits = "deg"
         self.lattice = lattice
         lat = lattice
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("a", lat, _latgetter("a"), _latsetter("a"))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("b", lat, _latgetter("b"), _latsetter("b"))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter("c", lat, _latgetter("c"), _latsetter("c"))
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "alpha", lat, _latgetter("alpha"), _latsetter("alpha")
             )
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "beta", lat, _latgetter("beta"), _latsetter("beta")
             )
         )
-        self.addParameter(
+        self.add_parameter(
             ParameterAdapter(
                 "gamma", lat, _latgetter("gamma"), _latsetter("gamma")
             )