Merge branch 'master' into 35-altendky-tidy_async_await_fixtures

Author: altendky

.travis.yml

@@ -3,7 +3,6 @@ language: python
 matrix:
   include:
     - python: 2.7
-    - python: 3.4
     - python: 3.5
     - python: 3.6
     - python: 3.7

CONTRIBUTING.rst

@@ -8,15 +8,26 @@ What it takes to add a new reactor:
 
 * In ``testing/test_basic.py``
 
-  * Add ``test_blockon_in_hook_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
-  * Add ``test_wrong_reactor_with_foo()`` decorated by ``@skip_if_reactor_not('foo')``
+  * Add ``test_blockon_in_hook_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line
+  * Add ``test_wrong_reactor_with_foo()`` with ``skip_if_reactor_not('foo')`` as the first line
 
 * In ``tox.ini``
 
   * Adjust ``envlist`` to include the ``fooreactor`` factor for the appropriate versions of Python
   * Add conditional ``deps`` for the new reactor such as ``foo: foobar`` to the appropriate test environments
-  * Add the conditional assignment ``foo: reactor_option=foo`` to ``setenv`` in the appropriate test environments
+  * Add ``fooreactor: pytest --reactor=foo`` to the commands list
 
 * In ``.travis.yml``
 
   * Consider any extra system packages which may be required
+
+* In ``appveyor.yml``
+
+  * Add the new reactor environment to the ``TOXENV`` for each relevant Python
+  
+Reference reactor additions:
+  * `asyncio`_
+  * `qt5reactor`_
+
+.. _`asyncio`: https://github.com/pytest-dev/pytest-twisted/pull/63
+.. _`qt5reactor`: https://github.com/pytest-dev/pytest-twisted/pull/16

README.rst

@@ -7,8 +7,8 @@ pytest-twisted - test twisted code with pytest
 |PyPI| |Pythons| |Travis| |AppVeyor| |Black|
 
 :Authors: Ralf Schmitt, Kyle Altendorf, Victor Titor
-:Version: 1.8
-:Date:    2018-05-01
+:Version: 1.11
+:Date:    2019-08-20
 :Download: https://pypi.python.org/pypi/pytest-twisted#downloads
 :Code: https://github.com/pytest-dev/pytest-twisted
 
@@ -33,11 +33,9 @@ The plugin is available after installation and can be disabled using
 By default ``twisted.internet.default`` is used to install the reactor.
 This creates the same reactor that ``import twisted.internet.reactor``
 would.  Alternative reactors can be specified using the ``--reactor``
-option.
-
-Presently only ``qt5reactor`` is supported for use with ``pyqt5``
-and ``pytest-qt``. This `guide`_ describes how to add support for
-a new reactor.
+option.  This presently supports ``qt5reactor`` for use with ``pyqt5``
+and ``pytest-qt`` as well as ``asyncio``. This `guide`_ describes how to add
+support for a new reactor.
 
 The reactor is automatically created prior to the first test but can
 be explicitly installed earlier by calling
@@ -53,7 +51,7 @@ is to ``import pytest_twisted as pt``.
 inlineCallbacks
 ===============
 Using ``twisted.internet.defer.inlineCallbacks`` as a decorator for test
-functions, which take funcargs, does not work. Please use
+functions, which use fixtures, does not work. Please use
 ``pytest_twisted.inlineCallbacks`` instead::
 
   @pytest_twisted.inlineCallbacks
@@ -65,7 +63,7 @@ functions, which take funcargs, does not work. Please use
 ensureDeferred
 ==============
 Using ``twisted.internet.defer.ensureDeferred`` as a decorator for test
-functions, which take funcargs, does not work. Please use
+functions, which use fixtures, does not work. Please use
 ``pytest_twisted.ensureDeferred`` instead::
 
   @pytest_twisted.ensureDeferred
@@ -105,7 +103,7 @@ The twisted greenlet
 ====================
 Some libraries (e.g. corotwine) need to know the greenlet, which is
 running the twisted reactor. It's available from the
-``twisted_greenlet`` funcarg. The following code can be used to make
+``twisted_greenlet`` fixture. The following code can be used to make
 corotwine work with pytest-twisted::
 
   @pytest.fixture(scope="session", autouse=True)
@@ -116,10 +114,14 @@ corotwine work with pytest-twisted::
 
 That's (almost) all.
 
-============
+
 Deprecations
 ============
 
+----
+v1.9
+----
+
 ``pytest.blockon``
     Use ``pytest_twisted.blockon``
 ``pytest.inlineCallbacks``

appveyor.yml

@@ -8,28 +8,22 @@ environment:
     - TOXENV: py27-defaultreactor
       PYTHON: "C:\\Python27-x64"
 
-    - TOXENV: py34-defaultreactor
-      PYTHON: "C:\\Python34"
-
-    - TOXENV: py34-defaultreactor
-      PYTHON: "C:\\Python34-x64"
-
-    - TOXENV: py35-defaultreactor, win-py35-qt5reactor
+    - TOXENV: py35-defaultreactor, win-py35-qt5reactor, py35-asyncioreactor
       PYTHON: "C:\\Python35"
 
-    - TOXENV: py35-defaultreactor, win-py35-qt5reactor
+    - TOXENV: py35-defaultreactor, win-py35-qt5reactor, py35-asyncioreactor
       PYTHON: "C:\\Python35-x64"
 
-    - TOXENV: py36-defaultreactor, win-py36-qt5reactor
+    - TOXENV: py36-defaultreactor, win-py36-qt5reactor, py36-asyncioreactor
       PYTHON: "C:\\Python36"
 
-    - TOXENV: py36-defaultreactor, win-py36-qt5reactor
+    - TOXENV: py36-defaultreactor, win-py36-qt5reactor, py36-asyncioreactor
       PYTHON: "C:\\Python36-x64"
 
-    - TOXENV: py37-defaultreactor, win-py37-qt5reactor
+    - TOXENV: py37-defaultreactor, win-py37-qt5reactor, py37-asyncioreactor
       PYTHON: "C:\\Python37"
 
-    - TOXENV: py37-defaultreactor, win-py37-qt5reactor
+    - TOXENV: py37-defaultreactor, win-py37-qt5reactor, py37-asyncioreactor
       PYTHON: "C:\\Python37-x64"
 
 install:

pytest_twisted.py

@@ -174,53 +174,50 @@ def decorator(f):
 def _pytest_pyfunc_call(pyfuncitem):
     testfunction = pyfuncitem.obj
     async_generators = []
-    if pyfuncitem._isyieldedfunction():
-        defer.returnValue(testfunction(*pyfuncitem._args))
-    else:
-        funcargs = pyfuncitem.funcargs
-        if hasattr(pyfuncitem, "_fixtureinfo"):
-            testargs = {}
-            for arg in pyfuncitem._fixtureinfo.argnames:
-                if isinstance(funcargs[arg], _CoroutineWrapper):
-                    wrapper = funcargs[arg]
-
-                    if wrapper.mark == 'async_fixture':
-                        arg_value = yield defer.ensureDeferred(
-                            wrapper.coroutine
-                        )
-                    elif wrapper.mark == 'async_yield_fixture':
-                        async_generators.append((arg, wrapper))
-                        arg_value = yield defer.ensureDeferred(
-                            wrapper.coroutine.__anext__(),
-                        )
-                    else:
-                        raise UnrecognizedCoroutineMarkError.from_mark(
-                            mark=wrapper.mark,
-                        )
+    funcargs = pyfuncitem.funcargs
+    if hasattr(pyfuncitem, "_fixtureinfo"):
+        testargs = {}
+        for arg in pyfuncitem._fixtureinfo.argnames:
+            if isinstance(funcargs[arg], _CoroutineWrapper):
+                wrapper = funcargs[arg]
+
+                if wrapper.mark == 'async_fixture':
+                    arg_value = yield defer.ensureDeferred(
+                        wrapper.coroutine
+                    )
+                elif wrapper.mark == 'async_yield_fixture':
+                    async_generators.append((arg, wrapper))
+                    arg_value = yield defer.ensureDeferred(
+                        wrapper.coroutine.__anext__(),
+                    )
                 else:
-                    arg_value = funcargs[arg]
+                    raise UnrecognizedCoroutineMarkError.from_mark(
+                        mark=wrapper.mark,
+                    )
+            else:
+                arg_value = funcargs[arg]
+
+            testargs[arg] = arg_value
+    else:
+        testargs = funcargs
+    result = yield testfunction(**testargs)
 
-                testargs[arg] = arg_value
+    async_generator_deferreds = [
+        (arg, defer.ensureDeferred(g.coroutine.__anext__()))
+        for arg, g in reversed(async_generators)
+    ]
+
+    for arg, d in async_generator_deferreds:
+        try:
+            yield d
+        except StopAsyncIteration:
+            continue
         else:
-            testargs = funcargs
-        result = yield testfunction(**testargs)
-
-        async_generator_deferreds = [
-            (arg, defer.ensureDeferred(g.coroutine.__anext__()))
-            for arg, g in reversed(async_generators)
-        ]
-
-        for arg, d in async_generator_deferreds:
-            try:
-                yield d
-            except StopAsyncIteration:
-                continue
-            else:
-                raise AsyncGeneratorFixtureDidNotStopError.from_generator(
-                    generator=arg,
-                )
+            raise AsyncGeneratorFixtureDidNotStopError.from_generator(
+                generator=arg,
+            )
 
-        defer.returnValue(result)
+    defer.returnValue(result)
 
 
 def pytest_pyfunc_call(pyfuncitem):
@@ -274,9 +271,19 @@ def init_qt5_reactor():
     )
 
 
+def init_asyncio_reactor():
+    from twisted.internet import asyncioreactor
+
+    _install_reactor(
+        reactor_installer=asyncioreactor.install,
+        reactor_type=asyncioreactor.AsyncioSelectorReactor,
+    )
+
+
 reactor_installers = {
     "default": init_default_reactor,
     "qt5reactor": init_qt5_reactor,
+    "asyncio": init_asyncio_reactor,
 }
 
 

setup.py

@@ -5,9 +5,10 @@
 
 setup(
     name="pytest-twisted",
-    version="1.8",
+    version="1.11",
     description="A twisted plugin for py.test.",
     long_description=long_description,
+    long_description_content_type="text/x-rst",
     author="Ralf Schmitt, Kyle Altendorf, Victor Titor",
     author_email="[email protected]",
     url="https://github.com/pytest-dev/pytest-twisted",
@@ -24,7 +25,6 @@
         "Programming Language :: Python :: 2",
         "Programming Language :: Python :: 2.7",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
         "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",

testing/test_basic.py

@@ -3,8 +3,6 @@
 
 import pytest
 
-import pytest_twisted
-
 
 # https://docs.python.org/3/whatsnew/3.5.html#pep-492-coroutines-with-async-and-await-syntax
 ASYNC_AWAIT = sys.version_info >= (3, 5)
@@ -41,7 +39,9 @@ def format_run_result_output_for_assert(run_result):
 def skip_if_reactor_not(request, expected_reactor):
     actual_reactor = request.config.getoption("reactor", "default")
     if actual_reactor != expected_reactor:
-        pytest.skip("reactor is {} not {}".format(actual_reactor, expected_reactor))
+        pytest.skip(
+            "reactor is {} not {}".format(actual_reactor, expected_reactor),
+        )
 
 
 def skip_if_no_async_await():
@@ -609,3 +609,49 @@ def main():
     assert_outcomes(rr, {"passed": 1, "failed": 1})
     # test embedded mode:
     assert testdir.run(sys.executable, "runner.py").ret == 0
+
+
+def test_blockon_in_hook_with_asyncio(testdir, cmd_opts, request):
+    skip_if_reactor_not(request, "asyncio")
+    conftest_file = """
+    import pytest_twisted as pt
+    from twisted.internet import defer
+
+    def pytest_configure(config):
+        pt.init_asyncio_reactor()
+        d = defer.Deferred()
+
+        from twisted.internet import reactor
+
+        reactor.callLater(0.01, d.callback, 1)
+        pt.blockon(d)
+    """
+    testdir.makeconftest(conftest_file)
+    test_file = """
+    from twisted.internet import reactor, defer
+
+    def test_succeed():
+        d = defer.Deferred()
+        reactor.callLater(0.01, d.callback, 1)
+        return d
+    """
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+    assert_outcomes(rr, {"passed": 1})
+
+
+def test_wrong_reactor_with_asyncio(testdir, cmd_opts, request):
+    skip_if_reactor_not(request, "asyncio")
+    conftest_file = """
+    def pytest_addhooks():
+        import twisted.internet.default
+        twisted.internet.default.install()
+    """
+    testdir.makeconftest(conftest_file)
+    test_file = """
+    def test_succeed():
+        pass
+    """
+    testdir.makepyfile(test_file)
+    rr = testdir.run(sys.executable, "-m", "pytest", "-v", *cmd_opts)
+    assert "WrongReactorAlreadyInstalledError" in rr.stderr.str()

tox.ini

@@ -1,7 +1,7 @@
 [tox]
 envlist=
-    py{27,34}-defaultreactor
-    py{35,36,37}-{default,qt5}reactor
+    py{27,35}-defaultreactor
+    py{35,36,37}-{default,qt5,asyncio}reactor
     win-py{35,36,37}-qt5reactor
     linting
 
@@ -18,6 +18,7 @@ deps=
 commands=
     defaultreactor: pytest --reactor=default
     qt5reactor: pytest --reactor=qt5reactor
+    asyncioreactor: pytest --reactor=asyncio
 sitepackages=False
 
 [testenv:linting]