Merge branch 'master' into update-copyright

Author: altendky

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  pull_request:
+    branches: 
+      - "*"
+
+jobs:
+  test:
+    name: ${{ matrix.os.name }} ${{ matrix.python.name }} ${{ matrix.reactor.name }}
+    runs-on: ${{ matrix.os.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - name: Linux
+            runs-on: ubuntu-latest
+          - name: Windows
+            runs-on: windows-latest
+          - name: macOS
+            runs-on: macos-latest
+        python:
+          - name: CPython 2.7
+            tox: py27
+            action: 2.7
+          - name: CPython 3.5
+            tox: py35
+            action: 3.5
+          - name: CPython 3.6
+            tox: py36
+            action: 3.6
+          - name: CPython 3.7
+            tox: py37
+            action: 3.7
+          - name: CPython 3.8
+            tox: py38
+            action: 3.8
+        reactor:
+          - name: default
+            tox: default
+          - name: Qt5
+            tox: qt5
+          - name: asyncio
+            tox: asyncio
+        exclude:
+          - python:
+              tox: py27
+            reactor:
+              tox: qt5
+          - python:
+              tox: py27
+            reactor:
+              tox: asyncio
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up ${{ matrix.python.name }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python.action }}
+          architecture: x64
+      - name: Install
+        run: |
+          pip install tox
+      - name: Test
+        run: |
+          tox -v -e "${{ matrix.python.tox }}-${{ matrix.reactor.tox }}reactor"
+  linting:
+    name: Linting
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python:
+          - short: 37
+            dotted: 3.7
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python.dotted }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python.dotted }}
+          architecture: x64
+      - name: Install
+        run: |
+          pip install tox
+      - name: Test
+        run: |
+          tox -v -e linting

.travis.yml

@@ -8,6 +8,9 @@ matrix:
     - python: 3.7
       dist: xenial
       sudo: true
+    - python: 3.8
+      dist: xenial
+      sudo: true
 
 addons:
   apt:

README.rst

@@ -18,6 +18,59 @@ which uses the twisted framework. test functions can return Deferred
 objects and pytest will wait for their completion with this plugin.
 
 
+NOTICE: Python 3.8 with asyncio support
+=======================================
+
+In Python 3.8, asyncio changed the default loop implementation to use
+their proactor.  The proactor does not implement some methods used by
+Twisted's asyncio support.  The result is a ``NotImplementedError``
+exception such as below.
+
+.. code-block:: pytb
+
+    <snip>
+      File "c:\projects\pytest-twisted\.tox\py38-asyncioreactor\lib\site-packages\twisted\internet\asyncioreactor.py", line 320, in install
+        reactor = AsyncioSelectorReactor(eventloop)
+      File "c:\projects\pytest-twisted\.tox\py38-asyncioreactor\lib\site-packages\twisted\internet\asyncioreactor.py", line 69, in __init__
+        super().__init__()
+      File "c:\projects\pytest-twisted\.tox\py38-asyncioreactor\lib\site-packages\twisted\internet\base.py", line 571, in __init__
+        self.installWaker()
+      File "c:\projects\pytest-twisted\.tox\py38-asyncioreactor\lib\site-packages\twisted\internet\posixbase.py", line 286, in installWaker
+        self.addReader(self.waker)
+      File "c:\projects\pytest-twisted\.tox\py38-asyncioreactor\lib\site-packages\twisted\internet\asyncioreactor.py", line 151, in addReader
+        self._asyncioEventloop.add_reader(fd, callWithLogger, reader,
+      File "C:\Python38-x64\Lib\asyncio\events.py", line 501, in add_reader
+        raise NotImplementedError
+    NotImplementedError
+
+The previous default, the selector loop, still works but you have to
+explicitly set it and do so early. The following ``conftest.py`` is provided
+for reference.
+
+.. code-block:: python3
+
+    import sys
+
+    import pytest
+    import pytest_twisted
+
+
+    @pytest.hookimpl(tryfirst=True)
+    def pytest_configure(config):
+        # https://twistedmatrix.com/trac/ticket/9766
+        # https://github.com/pytest-dev/pytest-twisted/issues/80
+
+        if (
+            config.getoption("reactor", "default") == "asyncio"
+            and sys.platform == 'win32'
+            and sys.version_info >= (3, 8)
+        ):
+            import asyncio
+
+            selector_policy = asyncio.WindowsSelectorEventLoopPolicy()
+            asyncio.set_event_loop_policy(selector_policy)
+
+
 Python 2 support plans
 ======================
 

appveyor.yml

@@ -8,24 +8,30 @@ environment:
     - TOXENV: py27-defaultreactor
       PYTHON: "C:\\Python27-x64"
 
-    - TOXENV: py35-defaultreactor, win-py35-qt5reactor, py35-asyncioreactor
+    - TOXENV: py35-defaultreactor, py35-qt5reactor, py35-asyncioreactor
       PYTHON: "C:\\Python35"
 
-    - TOXENV: py35-defaultreactor, win-py35-qt5reactor, py35-asyncioreactor
+    - TOXENV: py35-defaultreactor, py35-qt5reactor, py35-asyncioreactor
       PYTHON: "C:\\Python35-x64"
 
-    - TOXENV: py36-defaultreactor, win-py36-qt5reactor, py36-asyncioreactor
+    - TOXENV: py36-defaultreactor, py36-qt5reactor, py36-asyncioreactor
       PYTHON: "C:\\Python36"
 
-    - TOXENV: py36-defaultreactor, win-py36-qt5reactor, py36-asyncioreactor
+    - TOXENV: py36-defaultreactor, py36-qt5reactor, py36-asyncioreactor
       PYTHON: "C:\\Python36-x64"
 
-    - TOXENV: py37-defaultreactor, win-py37-qt5reactor, py37-asyncioreactor
+    - TOXENV: py37-defaultreactor, py37-qt5reactor, py37-asyncioreactor
       PYTHON: "C:\\Python37"
 
-    - TOXENV: py37-defaultreactor, win-py37-qt5reactor, py37-asyncioreactor
+    - TOXENV: py37-defaultreactor, py37-qt5reactor, py37-asyncioreactor
       PYTHON: "C:\\Python37-x64"
 
+    - TOXENV: py38-defaultreactor, py38-qt5reactor, py38-asyncioreactor
+      PYTHON: "C:\\Python38"
+
+    - TOXENV: py38-defaultreactor, py38-qt5reactor, py38-asyncioreactor
+      PYTHON: "C:\\Python38-x64"
+
 install:
   # https://github.com/pypa/virtualenv/issues/1050
   - pip install -U git+https://github.com/pypa/virtualenv@e8163e83a92c9098f51d390289323232ece15e3b

pytest_twisted.py

@@ -1,5 +1,6 @@
 import functools
 import inspect
+import sys
 import warnings
 
 import decorator
@@ -326,3 +327,18 @@ def pytest_configure(config):
     )(blockon)
 
     reactor_installers[config.getoption("reactor")]()
+
+
+def _use_asyncio_selector_if_required(config):
+    # https://twistedmatrix.com/trac/ticket/9766
+    # https://github.com/pytest-dev/pytest-twisted/issues/80
+
+    if (
+        config.getoption("reactor", "default") == "asyncio"
+        and sys.platform == 'win32'
+        and sys.version_info >= (3, 8)
+    ):
+        import asyncio
+
+        selector_policy = asyncio.WindowsSelectorEventLoopPolicy()
+        asyncio.set_event_loop_policy(selector_policy)

setup.py

@@ -28,6 +28,7 @@
         "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
     ],
     entry_points={"pytest11": ["twisted = pytest_twisted"]},
 )

testing/conftest.py

@@ -1 +1,10 @@
+import pytest
+import pytest_twisted
+
+
 pytest_plugins = "_pytest.pytester"
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_configure(config):
+    pytest_twisted._use_asyncio_selector_if_required(config=config)

testing/test_basic.py

@@ -49,6 +49,19 @@ def format_run_result_output_for_assert(run_result):
     )
 
 
+@pytest.fixture(name="default_conftest", autouse=True)
+def _default_conftest(testdir):
+    testdir.makeconftest(textwrap.dedent("""
+    import pytest
+    import pytest_twisted
+
+
+    @pytest.hookimpl(tryfirst=True)
+    def pytest_configure(config):
+        pytest_twisted._use_asyncio_selector_if_required(config=config)
+    """))
+
+
 def skip_if_reactor_not(request, expected_reactor):
     actual_reactor = request.config.getoption("reactor", "default")
     if actual_reactor != expected_reactor:
@@ -334,7 +347,10 @@ def test_async_fixture(testdir, cmd_opts):
     import pytest
     import pytest_twisted
 
-    @pytest_twisted.async_fixture(scope="function", params=["fs", "imap", "web"])
+    @pytest_twisted.async_fixture(
+        scope="function",
+        params=["fs", "imap", "web"],
+    )
     @pytest.mark.redgreenblue
     async def foo(request):
         d1, d2 = defer.Deferred(), defer.Deferred()
@@ -627,10 +643,14 @@ def main():
 def test_blockon_in_hook_with_asyncio(testdir, cmd_opts, request):
     skip_if_reactor_not(request, "asyncio")
     conftest_file = """
+    import pytest
     import pytest_twisted as pt
     from twisted.internet import defer
 
+    @pytest.hookimpl(tryfirst=True)
     def pytest_configure(config):
+        pt._use_asyncio_selector_if_required(config=config)
+
         pt.init_asyncio_reactor()
         d = defer.Deferred()
 
@@ -656,6 +676,14 @@ def test_succeed():
 def test_wrong_reactor_with_asyncio(testdir, cmd_opts, request):
     skip_if_reactor_not(request, "asyncio")
     conftest_file = """
+    import pytest
+    import pytest_twisted
+
+
+    @pytest.hookimpl(tryfirst=True)
+    def pytest_configure(config):
+        pytest_twisted._use_asyncio_selector_if_required(config=config)
+
     def pytest_addhooks():
         import twisted.internet.default
         twisted.internet.default.install()

tox.ini

@@ -1,20 +1,20 @@
 [tox]
 envlist=
-    py{27,35}-defaultreactor
-    py{35,36,37}-{default,qt5,asyncio}reactor
-    win-py{35,36,37}-qt5reactor
+    py27-defaultreactor
+    py{35,36,37,38}-{default,qt5,asyncio}reactor
+    py{35,36,37,38}-qt5reactor
     linting
 
 [testenv]
 deps=
     greenlet
     pytest
     twisted
+    pywin32; sys_platform == 'win32'
     qt5reactor: pytest-qt
     qt5reactor: qt5reactor
     qt5reactor: pytest-xvfb
     qt5reactor: pyqt5
-    win: pywin32
 commands=
     defaultreactor: pytest --reactor=default
     qt5reactor: pytest --reactor=qt5reactor