Deprecate pytest.inlineCallbacks and pytest.blockon, use pytest_twisted.*

Author: altendky

pytest_twisted.py

@@ -1,4 +1,6 @@
+import functools
 import inspect
+import warnings
 
 import decorator
 import greenlet
@@ -22,6 +24,25 @@ class _instances:
     reactor = None
 
 
+def _deprecate(deprecated, recommended):
+    def decorator(f):
+        @functools.wraps(f)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                '{deprecated} has been deprecated, use {recommended}'.format(
+                    deprecated=deprecated,
+                    recommended=recommended,
+                ),
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return f(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
 def blockon(d):
     if _config.external_reactor:
         return block_from_thread(d)
@@ -185,6 +206,13 @@ def pytest_addoption(parser):
 
 
 def pytest_configure(config):
-    pytest.inlineCallbacks = inlineCallbacks
-    pytest.blockon = blockon
+    pytest.inlineCallbacks = _deprecate(
+        deprecated='pytest.inlineCallbacks',
+        recommended='pytest_twisted.inlineCallbacks',
+    )(inlineCallbacks)
+    pytest.blockon = _deprecate(
+        deprecated='pytest.blockon',
+        recommended='pytest_twisted.blockon',
+    )(blockon)
+
     reactor_installers[config.getoption("reactor")]()

testing/test_basic.py

@@ -57,10 +57,73 @@ def test_inline_callbacks_in_pytest():
     assert hasattr(pytest, 'inlineCallbacks')
 
 
+def test_inline_callbacks_in_pytest_deprecation(testdir, cmd_opts):
+    test_file = """
+    import warnings
+
+    from twisted.internet import reactor, defer
+    import pytest
+    import pytest_twisted
+
+    warnings.simplefilter("always")
+
+    @pytest.mark.parametrize(
+        argnames='decorator, warning_count',
+        argvalues=[
+            [pytest.inlineCallbacks, 1],
+            [pytest_twisted.inlineCallbacks, 0],
+        ],
+    )
+    def test_inline_callbacks_in_pytest_deprecated(decorator, warning_count):
+        with warnings.catch_warnings(record=True) as w:
+            @decorator
+            def f():
+                yield 42
+
+        assert len(w) == warning_count
+    """
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+    assert_outcomes(rr, {"passed": 2})
+
+
 def test_blockon_in_pytest():
     assert hasattr(pytest, 'blockon')
 
 
+def test_blockon_in_pytest_deprecation(testdir, cmd_opts):
+    test_file = """
+    import warnings
+
+    from twisted.internet import reactor, defer
+    import pytest
+    import pytest_twisted
+
+    warnings.simplefilter("always")
+
+    @pytest.fixture(
+        scope="module",
+        params=[
+            [pytest.blockon, 1],
+            [pytest_twisted.blockon, 0],
+        ],
+    )
+    def foo(request):
+        d = defer.Deferred()
+        d.callback(None)
+        with warnings.catch_warnings(record=True) as w:
+            request.param[0](d)
+
+        return (w, request.param[1])
+
+    def test_succeed(foo):
+        assert len(foo[0]) == foo[1]
+    """
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+    assert_outcomes(rr, {"passed": 2})
+
+
 def test_fail_later(testdir, cmd_opts):
     test_file = """
     from twisted.internet import reactor, defer