Merge pull request #154 from cadenmyers13/fitcontrib-dep

deprecate: Deprecate `getEquation` from `FitContribution` and `BaseBuilder`

Author: sbillinge

news/fitcontrib-dep.rst

@@ -0,0 +1,25 @@
+**Added:**
+
+* Added ``get_equation`` method to ``BaseBuilder``.
+* Added ``get_equation`` method to ``FitContribution``.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* Deprecated ``BaseBuilder.getEquation`` method for removal in 4.0.0.
+* Deprecated ``FitContributution.getEquation`` method for removal in 4.0.0.
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/srfit/equation/builder.py

@@ -53,12 +53,12 @@
 > # sin is defined in this module as an OperatorBuilder
 > sin = getBuilder("sin")
 > beq = A*sin(a*x)
-> eq = beq.getEquation()
+> eq = beq.get_equation()
 
 The equation builder can also handle scalar constants. Staring with the above
 setup:
 > beq2 = A*sin(a*x) + 3
-> eq2 = beq2.getEquation()
+> eq2 = beq2.get_equation()
 Here, we didn't have to wrap '3' in an ArgumentBuilder. Non scalars, constant
 or otherwise, must be wrapped as ArgumentBuilders in order to be used in this
 way.
@@ -86,6 +86,7 @@
 import diffpy.srfit.equation.literals as literals
 from diffpy.srfit.equation.equationmod import Equation
 from diffpy.srfit.equation.literals.literal import Literal
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
 
 __all__ = [
     "EquationFactory",
@@ -172,7 +173,7 @@ def makeEquation(
             lit = literals.Argument(value=beq, const=True)
             eq = Equation(name="", root=lit)
         else:
-            eq = beq.getEquation()
+            eq = beq.get_equation()
             self.equations.add(eq)
         return eq
 
@@ -404,6 +405,16 @@ def _get_undefined_args(self, eqstr):
 
 # End class EquationFactory
 
+base_basebuilder = "diffpy.srfit.equation.builder.BaseBuilder"
+removal_version = "4.0.0"
+
+getequation_dep_msg = build_deprecation_message(
+    base_basebuilder,
+    "getEquation",
+    "get_equation",
+    removal_version,
+)
+
 
 class BaseBuilder(object):
     """Class for building equations.
@@ -430,7 +441,7 @@ def __call__(self, *args):
         )
         raise TypeError(m)
 
-    def getEquation(self):
+    def get_equation(self):
         """Get the equation built by this object.
 
         The equation will given the name "_eq_<root>" where "<root>" is
@@ -441,6 +452,16 @@ def getEquation(self):
         eq = Equation(name, self.literal)
         return eq
 
+    @deprecated(getequation_dep_msg)
+    def getEquation(self):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.equation.builder.BaseBuilder.get_equation
+        instead.
+        """
+        return self.get_equation()
+
     def __eval_binary(self, other, OperatorClass, onleft=True):
         """Evaluate a binary function.
 

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -56,6 +56,13 @@
     removal_version,
 )
 
+getequation_dep_msg = build_deprecation_message(
+    base,
+    "getEquation",
+    "get_equation",
+    removal_version,
+)
+
 
 class FitContribution(ParameterSet):
     """FitContribution class.
@@ -304,7 +311,7 @@ def setEquation(self, eqstr, ns={}):
         self.set_equation(eqstr, ns=ns)
         return
 
-    def getEquation(self):
+    def get_equation(self):
         """Get math expression string for the active profile equation.
 
         Return normalized math expression or an empty string if profile
@@ -317,6 +324,16 @@ def getEquation(self):
             rv = getExpression(self._eq)
         return rv
 
+    @deprecated(getequation_dep_msg)
+    def getEquation(self):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitContribution.get_equation
+        instead.
+        """
+        return self.get_equation()
+
     def setResidualEquation(self, eqstr):
         """Set the residual equation for the FitContribution.
 

tests/test_builder.py

@@ -214,7 +214,7 @@ def testBuildEquation(noObserversInGlobalBuilders):
     x = numpy.arange(0, numpy.pi, 0.1)
 
     beq = A * sin(a * x)
-    eq = beq.getEquation()
+    eq = beq.get_equation()
 
     assert "a" in eq.argdict
     assert "A" in eq.argdict
@@ -235,7 +235,7 @@ def _f(a, b):
     b = builder.ArgumentBuilder(name="b", value=1)
 
     beq = sin(f(a, b))
-    eq = beq.getEquation()
+    eq = beq.get_equation()
     assert eq() == numpy.sin(_f(2, 1))
 
     # complex function
@@ -245,23 +245,23 @@ def _f(a, b):
     x = builder.ArgumentBuilder(name="x", value=_x, const=True)
     sigma = builder.ArgumentBuilder(name="sigma", value=0.1)
     beq = sqrt(e ** (-0.5 * (x / sigma) ** 2))
-    eq = beq.getEquation()
+    eq = beq.get_equation()
     assert numpy.allclose(eq(), numpy.sqrt(numpy.exp(-0.5 * (_x / 0.1) ** 2)))
 
     # Equation with Equation
     A = builder.ArgumentBuilder(name="A", value=2)
     B = builder.ArgumentBuilder(name="B", value=4)
     beq = A + B
-    eq = beq.getEquation()
+    eq = beq.get_equation()
     E = builder.wrapOperator("eq", eq)
-    eq2 = (2 * E).getEquation()
+    eq2 = (2 * E).get_equation()
     # Make sure these evaluate to the same thing
     assert eq.args == [A.literal, B.literal]
     assert 2 * eq() == eq2()
     # Pass new arguments to the equation
     C = builder.ArgumentBuilder(name="C", value=5)
     D = builder.ArgumentBuilder(name="D", value=6)
-    eq3 = (E(C, D) + 1).getEquation()
+    eq3 = (E(C, D) + 1).get_equation()
     assert 12 == eq3()
     # Pass old and new arguments to the equation
     # If things work right, A has been given the value of C in the last

tests/test_contribution.py

@@ -313,12 +313,22 @@ def test_set_equation(noObserversInGlobalBuilders):
 def test_getEquation(noObserversInGlobalBuilders):
     """Check getting the current profile simulation formula."""
     fc = FitContribution("test")
-    assert "" == fc.getEquation()
+    assert "" == fc.get_equation()
     fc.set_equation("A * sin(x + 5)")
     assert "(A * sin((x + 5)))" == fc.getEquation()
     assert noObserversInGlobalBuilders
     return
 
 
+def test_get_equation(noObserversInGlobalBuilders):
+    """Check getting the current profile simulation formula."""
+    fc = FitContribution("test")
+    assert "" == fc.get_equation()
+    fc.set_equation("A * sin(x + 5)")
+    assert "(A * sin((x + 5)))" == fc.get_equation()
+    assert noObserversInGlobalBuilders
+    return
+
+
 if __name__ == "__main__":
     unittest.main()