add deprecated warnings

Smit-create · Smit-create · commit c9ede553f839 · 2020-05-06T12:03:44.000+05:30
diff --git a/sympy/stats/rv.py b/sympy/stats/rv.py
@@ -26,6 +26,7 @@
 from sympy.sets.sets import FiniteSet, ProductSet, Intersection
 from sympy.solvers.solveset import solveset
 from sympy.external import import_module
+from sympy.utilities.exceptions import SymPyDeprecationWarning
 
 
 x = Symbol('x')
@@ -1063,6 +1064,12 @@ def sample(expr, condition=None, size=(1,), library='scipy', numsamples=1,
     >>> [sam in N.pspace.domain.set for sam in samp_list] # doctest: +SKIP
     [True, True, True, True]
 
+    Returns
+    =======
+
+    sample: iterator object
+        iterator object containing the sample/samples of given expr
+
     """
     return sample_iter(expr, condition, size=size, library=library,
                                                         numsamples=numsamples)
@@ -1142,6 +1149,12 @@ def sample_iter(expr, condition=None, size=(1,), library='scipy',
     >>> list(iterator) # doctest: +SKIP
     [12, 4, 7]
 
+    Returns
+    =======
+
+    sample_iter: iterator object
+        iterator object containing the sample/samples of given expr
+
     See Also
     ========
 
@@ -1186,6 +1199,30 @@ def return_generator():
             count += 1
     return return_generator()
 
+def sample_iter_lambdify(expr, condition=None, size=(1,), numsamples=S.Infinity,
+                                                                    **kwargs):
+    SymPyDeprecationWarning(
+        feature='sample_iter_lambdify',
+        useinstead='sample_iter',
+        issue=19061,
+        deprecated_since_version=1.6,
+    ).warn()
+
+    return sample_iter(expr, condition=condition, size=size, numsamples=numsamples,
+                                                                        **kwargs)
+
+def sample_iter_subs(expr, condition=None, size=(1,), numsamples=S.Infinity,
+                                                                    **kwargs):
+    SymPyDeprecationWarning(
+        feature='sample_iter_subs',
+        useinstead='sample_iter',
+        issue=19061,
+        deprecated_since_version=1.6,
+    ).warn()
+
+    return sample_iter(expr, condition=condition, size=size, numsamples=numsamples,
+                                                                        **kwargs)
+
 
 def sampling_P(condition, given_condition=None, library='scipy', numsamples=1,
                                                     evalf=True, **kwargs):
diff --git a/sympy/stats/tests/test_rv.py b/sympy/stats/tests/test_rv.py
@@ -7,8 +7,8 @@
         random_symbols, sample, Geometric, factorial_moment, Binomial, Hypergeometric,
         DiscreteUniform, Poisson, characteristic_function, moment_generating_function)
 from sympy.stats.rv import (IndependentProductPSpace, rs_swap, Density, NamedArgsMixin,
-        RandomSymbol, sample_iter, PSpace)
-from sympy.testing.pytest import raises, skip, XFAIL
+        RandomSymbol, sample_iter, PSpace, sample_iter_subs, sample_iter_lambdify)
+from sympy.testing.pytest import raises, skip, XFAIL, warns_deprecated_sympy
 from sympy.external import import_module
 from sympy.core.numbers import comp
 from sympy.stats.frv_types import BernoulliDistribution
@@ -104,7 +104,9 @@ def is_iterator(obj):
             return True
         else:
             return False
-
+    with warns_deprecated_sympy():
+        sample_iter_subs(expr)
+        sample_iter_lambdify(expr)
     assert is_iterator(iterator)
     assert is_iterator(iterator2)
     assert is_iterator(iterator3)
