Merge pull request #59 from altendky/58-altendky-deprecate_things_in_pytest_namespace

[58] Deprecate pytest.inlineCallbacks and pytest.blockon, use pytest_twisted.*

Author: altendky

README.rst

@@ -98,7 +98,16 @@ corotwine work with pytest-twisted::
       protocol.MAIN = twisted_greenlet
 
 
-That's all.
+That's (almost) all.
+
+============
+Deprecations
+============
+
+``pytest.blockon``
+    Use ``pytest_twisted.blockon``
+``pytest.inlineCallbacks``
+    Use ``pytest_twisted.inlineCallbacks``
 
 
 .. |PyPI| image:: https://img.shields.io/pypi/v/pytest-twisted.svg

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,82 @@ def test_inline_callbacks_in_pytest():
     assert hasattr(pytest, 'inlineCallbacks')
 
 
+@pytest.mark.parametrize(
+    'decorator, should_warn',
+    (
+        ('pytest.inlineCallbacks', True),
+        ('pytest_twisted.inlineCallbacks', False),
+    ),
+)
+def test_inline_callbacks_in_pytest_deprecation(
+        testdir,
+        cmd_opts,
+        decorator,
+        should_warn,
+):
+    import_path, _, _ = decorator.rpartition('.')
+    test_file = """
+    import {import_path}
+
+    def test_deprecation():
+        @{decorator}
+        def f():
+            yield 42
+    """.format(import_path=import_path, decorator=decorator)
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+
+    expected_outcomes = {"passed": 1}
+    if should_warn:
+        expected_outcomes["warnings"] = 1
+
+    assert_outcomes(rr, expected_outcomes)
+
+
 def test_blockon_in_pytest():
     assert hasattr(pytest, 'blockon')
 
 
+@pytest.mark.parametrize(
+    'function, should_warn',
+    (
+        ('pytest.blockon', True),
+        ('pytest_twisted.blockon', False),
+    ),
+)
+def test_blockon_in_pytest_deprecation(
+        testdir,
+        cmd_opts,
+        function,
+        should_warn,
+):
+    import_path, _, _ = function.rpartition('.')
+    test_file = """
+    import warnings
+
+    from twisted.internet import reactor, defer
+    import pytest
+    import {import_path}
+
+    @pytest.fixture
+    def foo(request):
+        d = defer.Deferred()
+        d.callback(None)
+        {function}(d)
+
+    def test_succeed(foo):
+        pass
+    """.format(import_path=import_path, function=function)
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+
+    expected_outcomes = {"passed": 1}
+    if should_warn:
+        expected_outcomes["warnings"] = 1
+
+    assert_outcomes(rr, expected_outcomes)
+
+
 def test_fail_later(testdir, cmd_opts):
     test_file = """
     from twisted.internet import reactor, defer