Merge remote-tracking branch 'upstream/master' into async_timeout

asvetlov · asvetlov · commit 13844c066b49 · 2022-01-09T15:05:38.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,39 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 'v4.1.0'
+  hooks:
+  - id: check-merge-conflict
+    exclude: "rst$"
+- repo: https://github.com/asottile/yesqa
+  rev: v1.3.0
+  hooks:
+  - id: yesqa
+- repo: https://github.com/Zac-HD/shed
+  rev: 0.6.0  # 0.7 does not support Python 3.7
+  hooks:
+  - id: shed
+    args:
+    - --refactor
+    - --py37-plus
+    types_or:
+    - python
+    - markdown
+    - rst
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.1.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: fix-encoding-pragma
+    args: [--remove]
+  - id: check-yaml
+  - id: debug-statements
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+    language_version: python3
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.9.0
+  hooks:
+  - id: python-use-type-annotations
diff --git a/LICENSE b/LICENSE
@@ -199,4 +199,3 @@ Apache License
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-
diff --git a/Makefile b/Makefile
@@ -20,9 +20,17 @@ clean-test: ## remove test and coverage artifacts
 	rm -f .coverage
 	rm -fr htmlcov/
 
-lint: ## check style with flake8
-	flake8 pytest_asyncio tests
-	black --check --verbose pytest_asyncio tests
+lint:
+# CI env-var is set by GitHub actions
+ifdef CI
+	pre-commit run --all-files --show-diff-on-failure
+else
+	pre-commit run --all-files
+endif
 
 test:
 	pytest tests
+
+install:
+	pip install -U pre-commit
+	pre-commit install
diff --git a/README.rst b/README.rst
@@ -25,7 +25,7 @@ provides useful fixtures and markers to make testing easier.
     @pytest.mark.asyncio
     async def test_some_asyncio_code():
         res = await library.do_something()
-        assert b'expected result' == res
+        assert b"expected result" == res
 
 pytest-asyncio has been strongly influenced by pytest-tornado_.
 
@@ -139,9 +139,9 @@ Use ``pytest.mark.asyncio`` for this purpose.
 .. code-block:: python
 
     def test_http_client(event_loop):
-        url = 'http://httpbin.org/get'
+        url = "http://httpbin.org/get"
         resp = event_loop.run_until_complete(http_client(url))
-        assert b'HTTP/1.1 200 OK' in resp
+        assert b"HTTP/1.1 200 OK" in resp
 
 This fixture can be easily overridden in any of the standard pytest locations
 (e.g. directly in the test file, or in ``conftest.py``) to use a non-default
@@ -189,12 +189,14 @@ Asynchronous fixtures are defined just like ordinary pytest fixtures, except the
 
     import pytest_asyncio
 
+
     @pytest_asyncio.fixture
     async def async_gen_fixture():
         await asyncio.sleep(0.1)
-        yield 'a value'
+        yield "a value"
+
 
-    @pytest_asyncio.fixture(scope='module')
+    @pytest_asyncio.fixture(scope="module")
     async def async_fixture():
         return await asyncio.sleep(0.1)
 
@@ -227,11 +229,13 @@ Only test coroutines will be affected (by default, coroutines prefixed by
 .. code-block:: python
 
     import asyncio
+
     import pytest
 
     # All test coroutines will be treated as marked.
     pytestmark = pytest.mark.asyncio
 
+
     async def test_example(event_loop):
         """No marker!"""
         await asyncio.sleep(0, loop=event_loop)
@@ -259,6 +263,7 @@ Changelog
 - Fixed an issue when pytest-asyncio was used in combination with `flaky` or inherited asynchronous Hypothesis tests. `#178 <https://github.com/pytest-dev/pytest-asyncio/issues/178>`_ `#231 <https://github.com/pytest-dev/pytest-asyncio/issues/231>`_
 - Added `flaky <https://pypi.org/project/flaky/>`_ to test dependencies
 - Added ``unused_udp_port`` and ``unused_udp_port_factory`` fixtures (similar to ``unused_tcp_port`` and ``unused_tcp_port_factory`` counterparts. `#99 <https://github.com/pytest-dev/pytest-asyncio/issues/99>`_
+- Added the plugin modes: *strict*, *auto*, and *legacy*. See `documentation <https://github.com/pytest-dev/pytest-asyncio#modes>`_ for details. `#125 <https://github.com/pytest-dev/pytest-asyncio/issues/125>`_
 
 0.16.0 (2021-10-16)
 ~~~~~~~~~~~~~~~~~~~
diff --git a/pytest_asyncio/__init__.py b/pytest_asyncio/__init__.py
@@ -3,5 +3,4 @@
 
 from .plugin import fixture
 
-
 __all__ = ("fixture",)
diff --git a/pytest_asyncio/plugin.py b/pytest_asyncio/plugin.py
@@ -5,7 +5,6 @@
 import functools
 import inspect
 import socket
-import sys
 import warnings
 
 import pytest
@@ -17,7 +16,7 @@ class Mode(str, enum.Enum):
     LEGACY = "legacy"
 
 
-LEGACY_MODE = pytest.PytestDeprecationWarning(
+LEGACY_MODE = DeprecationWarning(
     "The 'asyncio_mode' default value will change to 'strict' in future, "
     "please explicitly use 'asyncio_mode=strict' or 'asyncio_mode=auto' "
     "in pytest configuration file."
@@ -128,21 +127,7 @@ def pytest_configure(config):
         "run using an asyncio event loop",
     )
     if _get_asyncio_mode(config) == Mode.LEGACY:
-        _issue_warning_captured(LEGACY_MODE, config.hook, stacklevel=1)
-
-
-def _issue_warning_captured(warning, hook, *, stacklevel=1):
-    # copy-paste of pytest internal _pytest.warnings._issue_warning_captured function
-    with warnings.catch_warnings(record=True) as records:
-        warnings.simplefilter("always", type(warning))
-        warnings.warn(LEGACY_MODE, stacklevel=stacklevel)
-    frame = sys._getframe(stacklevel - 1)
-    location = frame.f_code.co_filename, frame.f_lineno, frame.f_code.co_name
-    hook.pytest_warning_recorded.call_historic(
-        kwargs=dict(
-            warning_message=records[0], when="config", nodeid="", location=location
-        )
-    )
+        config.issue_config_time_warning(LEGACY_MODE, stacklevel=2)
 
 
 @pytest.mark.tryfirst
@@ -192,7 +177,8 @@ def pytest_fixture_post_finalizer(fixturedef, request):
     """Called after fixture teardown"""
     if fixturedef.argname == "event_loop":
         policy = asyncio.get_event_loop_policy()
-        policy.get_event_loop().close()  # Clean up existing loop to avoid ResourceWarnings
+        # Clean up existing loop to avoid ResourceWarnings
+        policy.get_event_loop().close()
         new_loop = policy.new_event_loop()  # Replace existing event loop
         # Ensure subsequent calls to get_event_loop() succeed
         policy.set_event_loop(new_loop)
@@ -240,7 +226,7 @@ def pytest_fixture_setup(fixturedef, request):
             )
             warnings.warn(
                 LEGACY_ASYNCIO_FIXTURE.format(name=name),
-                pytest.PytestDeprecationWarning,
+                DeprecationWarning,
             )
         else:
             # asyncio_mode is STRICT,
@@ -345,7 +331,8 @@ def pytest_pyfunc_call(pyfuncitem):
     """
     Pytest hook called before a test case is run.
 
-    Wraps marked tests in a synchronous function where the wrapped test coroutine is executed in an event loop.
+    Wraps marked tests in a synchronous function
+    where the wrapped test coroutine is executed in an event loop.
     """
     if "asyncio" in pyfuncitem.keywords:
         timeout = _get_timeout(pyfuncitem)
diff --git a/setup.cfg b/setup.cfg
@@ -15,4 +15,4 @@ filterwarnings = error
 license_file = LICENSE
 
 [flake8]
-ignore = E203, E501, W503
+max-line-length = 88
diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 import re
 from pathlib import Path
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 
 def find_version():
diff --git a/tests/async_fixtures/test_async_fixtures_with_finalizer.py b/tests/async_fixtures/test_async_fixtures_with_finalizer.py
@@ -46,7 +46,8 @@ def port_finalizer(finalizer):
         async def port_afinalizer():
             # await task using current loop retrieved from the event loop policy
             # RuntimeError is raised if task is created on a different loop.
-            # This can happen when pytest_fixture_setup does not set up the loop correctly,
+            # This can happen when pytest_fixture_setup
+            # does not set up the loop correctly,
             # for example when policy.set_event_loop() is called with a wrong argument
             await finalizer
 
diff --git a/tests/hypothesis/test_base.py b/tests/hypothesis/test_base.py
@@ -4,7 +4,6 @@
 import asyncio
 
 import pytest
-
 from hypothesis import given, strategies as st
 
 
diff --git a/tests/hypothesis/test_inherited_test.py b/tests/hypothesis/test_inherited_test.py
@@ -1,22 +1,20 @@
 import hypothesis.strategies as st
-from hypothesis import given
 import pytest
+from hypothesis import given
 
 
 class BaseClass:
     @pytest.mark.asyncio
     @given(value=st.integers())
     async def test_hypothesis(self, value: int) -> None:
-        assert True
+        pass
 
 
 class TestOne(BaseClass):
-    """During the first execution the Hypothesis test is wrapped in a synchronous function."""
-
-    pass
+    """During the first execution the Hypothesis test
+    is wrapped in a synchronous function."""
 
 
 class TestTwo(BaseClass):
-    """Execute the test a second time to ensure that the test receives a fresh event loop."""
-
-    pass
+    """Execute the test a second time to ensure that
+    the test receives a fresh event loop."""
diff --git a/tests/multiloop/conftest.py b/tests/multiloop/conftest.py
@@ -6,8 +6,6 @@
 class CustomSelectorLoop(asyncio.SelectorEventLoop):
     """A subclass with no overrides, just to test for presence."""
 
-    pass
-
 
 @pytest.fixture
 def event_loop():
diff --git a/tests/respect_event_loop_policy/test_respects_event_loop_policy.py b/tests/respect_event_loop_policy/test_respects_event_loop_policy.py
@@ -6,7 +6,8 @@
 
 @pytest.mark.asyncio
 async def test_uses_loop_provided_by_custom_policy():
-    """Asserts that test cases use the event loop provided by the custom event loop policy"""
+    """Asserts that test cases use the event loop
+    provided by the custom event loop policy"""
     assert type(asyncio.get_event_loop()).__name__ == "TestEventLoop"
 
 
diff --git a/tests/sessionloop/conftest.py b/tests/sessionloop/conftest.py
@@ -6,8 +6,6 @@
 class CustomSelectorLoopSession(asyncio.SelectorEventLoop):
     """A subclass with no overrides, just to test for presence."""
 
-    pass
-
 
 loop = CustomSelectorLoopSession()
 
diff --git a/tests/test_asyncio_fixture.py b/tests/test_asyncio_fixture.py
@@ -1,7 +1,9 @@
 import asyncio
-import pytest_asyncio
+
 import pytest
 
+import pytest_asyncio
+
 
 @pytest_asyncio.fixture
 async def fixture_bare():
diff --git a/tests/test_dependent_fixtures.py b/tests/test_dependent_fixtures.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import pytest
 
 
diff --git a/tests/test_flaky_integration.py b/tests/test_flaky_integration.py
@@ -1,17 +1,47 @@
 """Tests for the Flaky integration, which retries failed tests.
 """
-import asyncio
 
-import flaky
-import pytest
 
-_threshold = -1
+from textwrap import dedent
 
+pytest_plugins = "pytester"
 
-@flaky.flaky(3, 2)
-@pytest.mark.asyncio
-async def test_asyncio_flaky_thing_that_fails_then_succeeds():
-    global _threshold
-    await asyncio.sleep(0.1)
-    _threshold += 1
-    assert _threshold != 1
+
+def test_auto_mode_cmdline(pytester):
+    pytester.makepyfile(
+        dedent(
+            """\
+        import asyncio
+        import flaky
+        import pytest
+
+        _threshold = -1
+
+        @flaky.flaky(3, 2)
+        @pytest.mark.asyncio
+        async def test_asyncio_flaky_thing_that_fails_then_succeeds():
+            global _threshold
+            await asyncio.sleep(0.1)
+            _threshold += 1
+            assert _threshold != 1
+        """
+        )
+    )
+    # runpytest_subprocess() is required to don't pollute the output
+    # with flaky restart information
+    result = pytester.runpytest_subprocess()
+    result.assert_outcomes(passed=1)
+    result.stdout.fnmatch_lines(
+        [
+            "===Flaky Test Report===",
+            "test_asyncio_flaky_thing_that_fails_then_succeeds passed 1 "
+            "out of the required 2 times. Running test again until it passes 2 times.",
+            "test_asyncio_flaky_thing_that_fails_then_succeeds failed "
+            "(1 runs remaining out of 3).",
+            "	<class 'AssertionError'>",
+            "	assert 1 != 1",
+            "test_asyncio_flaky_thing_that_fails_then_succeeds passed 2 "
+            "out of the required 2 times. Success!",
+            "===End Flaky Test Report===",
+        ]
+    )
diff --git a/tests/test_simple.py b/tests/test_simple.py
diff --git a/tests/test_subprocess.py b/tests/test_subprocess.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,4 @@`
`3`	`3`
`4`	`4`	`from .plugin import fixture`
`5`	`5`
`6`		`-`
`7`	`6`	`__all__ = ("fixture",)`