dep: getValue deprecation in favor of snake case

docs/source/extending.rst

@@ -97,7 +97,7 @@ used as::
 
 Note that the *unbound* methods are used. The names ``getter`` and ``setter``
 describe how the accessor attributes are used to access the value of the
-parameter. When ``xpar.getValue()`` is called, it redirects to
+parameter. When ``xpar.get_value()`` is called, it redirects to
 ``SimpleAtom.getX(atom)``.
 
 If instead ``SimpleAtom`` had methods called ``get`` and ``set`` that take as
@@ -107,7 +107,7 @@ can be adapted as::
     xpar = ParameterAdapter("x", atom, getter = SimpleAtom.get,
             setter = SimpleAtom.set, attr = "x")
 
-Thus, when ``xpar.getValue()`` is called, it in turn calls
+Thus, when ``xpar.get_value()`` is called, it in turn calls
 ``SimpleAtom.get(atom, "x")``. ``xpar.set_value(value)`` calls
 ``SimpleAtom.set(atom, "x", value)``.
 

news/getvalue-dep.rst

@@ -0,0 +1,25 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* ``getValue`` is deprecated in favour of ``get_value`` on ``Parameter`` and on
+  the ``Literal`` hierarchy (``Argument``, ``Operator``, ``Equation``). The old
+  name still works and warns, and will be removed in version 4.0.0.
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/srfit/equation/equationmod.py

@@ -81,7 +81,7 @@ class Equation(Operator):
     _value
         The value of the Operator.
     value
-        Property for 'getValue'.
+        Property for 'get_value'.
     """
 
     # define abstract attributes from the Operator base.
@@ -201,7 +201,7 @@ def __call__(self, *args, **kw):
                 raise ValueError("No argument named '%s' here" % name)
             arg.set_value(val)
 
-        self._value = self.root.getValue()
+        self._value = self.root.get_value()
         return self._value
 
     def swap(self, oldlit, newlit):

src/diffpy/srfit/equation/literals/abcs.py

@@ -31,7 +31,7 @@ def identify(self, visitor):
         pass
 
     @abstractmethod
-    def getValue(self):
+    def get_value(self):
         """Return the value of the literal."""
         pass
 

src/diffpy/srfit/equation/literals/argument.py

@@ -39,7 +39,7 @@ class Argument(Literal, ArgumentABC):
     _value
         The value of the Argument. Modified with 'set_value'.
     value
-        Property for 'getValue' and 'set_value'.
+        Property for 'get_value' and 'set_value'.
     """
 
     const = None
@@ -55,7 +55,7 @@ def identify(self, visitor):
         """Identify self to a visitor."""
         return visitor.onArgument(self)
 
-    def getValue(self):
+    def get_value(self):
         """Get the value of this Literal."""
         return self._value
 
@@ -77,7 +77,7 @@ def set_value(self, val):
         return
 
     value = property(
-        lambda self: self.getValue(), lambda self, val: self.set_value(val)
+        lambda self: self.get_value(), lambda self, val: self.set_value(val)
     )
 
 

src/diffpy/srfit/equation/literals/literal.py

@@ -23,6 +23,13 @@
 
 from diffpy.srfit.equation.literals.abcs import LiteralABC
 from diffpy.srfit.util.observable import Observable
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
+
+literal_base = "diffpy.srfit.equation.literals.Literal"
+removal_version = "4.0.0"
+getValue_dep_msg = build_deprecation_message(
+    literal_base, "getValue", "get_value", removal_version
+)
 
 
 class Literal(Observable, LiteralABC):
@@ -49,10 +56,20 @@ def __init__(self, name=None):
             self.name = name
         return
 
-    def getValue(self):
+    def get_value(self):
         """Get the value of the Literal."""
         raise NotImplementedError("Define in derived class")
 
+    @deprecated(getValue_dep_msg)
+    def getValue(self):
+        """This function has been deprecated and will be removed in
+        version 4.0.0.
+
+        Please use diffpy.srfit.equation.literals.Literal.get_value
+        instead.
+        """
+        return self.get_value()
+
     def identify(self, visitor):
         """Identify self to a visitor."""
         m = "'%s' must override 'identify'" % self.__class__.__name__

src/diffpy/srfit/equation/literals/operators.py

@@ -119,14 +119,14 @@ def addLiteral(self, literal):
         self._flush(other=(self,))
         return
 
-    def getValue(self):
+    def get_value(self):
         """Get or evaluate the value of the operator."""
         if self._value is None:
             vals = [arg.value for arg in self.args]
             self._value = self.operation(*vals)
         return self._value
 
-    value = property(lambda self: self.getValue())
+    value = property(lambda self: self.get_value())
 
     def _loop_check(self, literal):
         """Check if a literal causes self-reference."""

src/diffpy/srfit/fitbase/calculator.py

@@ -72,7 +72,7 @@ class Calculator(Operator, ParameterSet):
     _value
         The value of the Operator.
     value
-        Property for 'getValue'.
+        Property for 'get_value'.
 
     Properties
     ----------

src/diffpy/srfit/fitbase/fitrecipe.py

@@ -669,7 +669,7 @@ def __verify_parameters(self):
         badpars = []
         for par in self.iterate_over_parameters():
             try:
-                par.getValue()
+                par.get_value()
             except ValueError:
                 badpars.append(par)
 
@@ -1246,9 +1246,9 @@ def add_constraint(self, par, con, ns={}):
         # This will pass the value of a constrained parameter to the initial
         # value of a parameter constraint.
         if con in self._parameters.values():
-            val = con.getValue()
+            val = con.get_value()
             if val is None:
-                val = par.getValue()
+                val = par.get_value()
                 con.set_value(val)
 
         if par in self._parameters.values():
@@ -1483,7 +1483,7 @@ def initialize_recipe_with_results(self, results, verbose=True):
             print("Parameters set in FitRecipe:")
             print("=" * 30)
             set_parameters_dict = {
-                param.name: param.getValue()
+                param.name: param.get_value()
                 for param in self._parameters.values()
             }
             self._pretty_print_results_dict(set_parameters_dict)

src/diffpy/srfit/fitbase/fitresults.py

@@ -228,7 +228,7 @@ def update(self):
 
         # Store the constraint information
         self.connames = [con.par.name for con in recipe._oconstraints]
-        self.convals = [con.par.getValue() for con in recipe._oconstraints]
+        self.convals = [con.par.get_value() for con in recipe._oconstraints]
 
         if self.varnames:
             # Calculate the covariance
@@ -314,17 +314,17 @@ def _calculate_jacobian(self):
             cond = []
             for con in recipe._oconstraints:
                 con.update()
-                cond.append(con.par.getValue())
+                cond.append(con.par.get_value())
 
             pvals[k] = v - h
             rk -= self.recipe.residual(pvals)
 
             # FIXME - constraints are used for vectors as well!
             for i, con in enumerate(recipe._oconstraints):
                 con.update()
-                val = con.par.getValue()
+                val = con.par.get_value()
                 if numpy.isscalar(val):
-                    cond[i] -= con.par.getValue()
+                    cond[i] -= con.par.get_value()
                     cond[i] /= 2 * h
                 else:
                     cond[i] = 0.0

src/diffpy/srfit/fitbase/parameter.py

@@ -42,6 +42,10 @@
     parameter_base, "setValue", "set_value", removal_version
 )
 
+getValue_dep_msg = build_deprecation_message(
+    parameter_base, "getValue", "get_value", removal_version
+)
+
 setConst_dep_msg = build_deprecation_message(
     parameter_base, "setConst", "set_constant", removal_version
 )
@@ -67,7 +71,7 @@ class Parameter(_parameter_interface, Argument, Validatable):
     _value
         The value of the Parameter. Modified with ``set_value``.
     value
-        Property for ``getValue`` and ``set_value``.
+        Property for ``get_value`` and ``set_value``.
     constrained
         A flag indicating if the Parameter is constrained
         (default False).
@@ -118,6 +122,15 @@ def set_value(self, val):
         Argument.set_value(self, val)
         return self
 
+    @deprecated(getValue_dep_msg)
+    def getValue(self):
+        """This function has been deprecated and will be removed in
+        version 4.0.0.
+
+        Please use diffpy.srfit.fitbase.Parameter.get_value instead.
+        """
+        return self.get_value()
+
     @deprecated(setValue_dep_msg)
     def setValue(self, val):
         """This function has been deprecated and will be removed in
@@ -209,7 +222,7 @@ def bound_window(self, lower_radius=0, upper_radius=None):
         Parameter
             Return self so that mutators can be chained.
         """
-        val = self.getValue()
+        val = self.get_value()
         lower_bound = val - lower_radius
         if upper_radius is None:
             upper_radius = lower_radius
@@ -317,9 +330,9 @@ def _observers(self):
     def set_value(self, val):
         return self.par.set_value(val)
 
-    @wraps(Parameter.getValue)
-    def getValue(self):
-        return self.par.getValue()
+    @wraps(Parameter.get_value)
+    def get_value(self):
+        return self.par.get_value()
 
     @wraps(Parameter.set_constant)
     def set_constant(self, const=True, value=None):
@@ -355,7 +368,7 @@ def _validate(self):
 class ParameterAdapter(Parameter):
     """An adapter for parameter-like objects.
 
-    This class wraps an object as a Parameter. The getValue and
+    This class wraps an object as a Parameter. The get_value and
     set_value methods defer to the data of the wrapped object.
     """
 
@@ -415,11 +428,11 @@ def __init__(self, name, obj, getter=None, setter=None, attr=None):
             else:
                 self.setter = bind2nd(setter, self.attr)
 
-        value = self.getValue()
+        value = self.get_value()
         Parameter.__init__(self, name, value)
         return
 
-    def getValue(self):
+    def get_value(self):
         """Get the value of the Parameter.
 
         Returns
@@ -442,7 +455,7 @@ def set_value(self, value):
         ParameterAdapter
             Return self so that mutators can be chained.
         """
-        if value != self.getValue():
+        if value != self.get_value():
             self.setter(self.obj, value)
             self.notify()
         return self

src/diffpy/srfit/fitbase/profile.py

@@ -133,19 +133,19 @@ def __init__(self):
 
     # We want x, y, ycalc and dy to stay in-sync with xpar, ypar and dypar
     x = property(
-        lambda self: self.xpar.getValue(),
+        lambda self: self.xpar.get_value(),
         lambda self, val: self.xpar.set_value(val),
     )
     y = property(
-        lambda self: self.ypar.getValue(),
+        lambda self: self.ypar.get_value(),
         lambda self, val: self.ypar.set_value(val),
     )
     dy = property(
-        lambda self: self.dypar.getValue(),
+        lambda self: self.dypar.get_value(),
         lambda self, val: self.dypar.set_value(val),
     )
     ycalc = property(
-        lambda self: self.ycpar.getValue(),
+        lambda self: self.ycpar.get_value(),
         lambda self, val: self.ycpar.set_value(val),
     )
 

src/diffpy/srfit/fitbase/profilegenerator.py

@@ -33,9 +33,9 @@ def __init__(self):
             self.newParameter("center", 0)
             self.newParameter("width", 0)
         def __call__(self, x):
-            a = self.amp.getValue()
-            x0 = self.center.getValue()
-            w = self.width.getValue()
+            a = self.amp.get_value()
+            x0 = self.center.get_value()
+            w = self.width.get_value()
             return a * exp(-0.5*((x-x0)/w)**2)
 
 More examples can be found in the example directory of the
@@ -105,7 +105,7 @@ class ProfileGenerator(Operator, ParameterSet):
     _value
         The value of the Operator.
     value
-        Property for 'getValue'.
+        Property for 'get_value'.
 
     Properties
     ----------

src/diffpy/srfit/sas/sasparameter.py

@@ -35,7 +35,7 @@ class SASParameter(Parameter):
     _value
         The value of the Parameter. Modified with 'set_value'.
     value
-        Property for 'getValue' and 'set_value'.
+        Property for 'get_value' and 'set_value'.
     constrained
         A flag indicating if the Parameter is constrained
         (default False).
@@ -68,14 +68,14 @@ def __init__(self, name, model, parname=None):
         Parameter.__init__(self, name, val)
         return
 
-    def getValue(self):
+    def get_value(self):
         """Get the value of the Parameter."""
         value = self._model.getParam(self._parname)
         return value
 
     def set_value(self, value):
         """Set the value of the Parameter."""
-        if value != self.getValue():
+        if value != self.get_value():
             self._model.setParam(self._parname, value)
             self.notify()
         return self