Fix bug where the ini configuration isn't respected

Fixes #21

Author: delfick

alt_pytest_asyncio/plugin.py

@@ -22,7 +22,7 @@ def pytest_addoption(parser: pytest.Parser) -> None:
         "alt-pytest-asyncio", description="Alternative asyncio pytest plugin options"
     )
     group.addoption("--default-async-timeout", type=float, dest="default_async_timeout", help=desc)
-    parser.addini("default_async_timeout", desc, default=5)
+    parser.addini("default_async_timeout", desc)
 
 
 class _ManagedLoop(contextlib.AbstractContextManager[None]):
@@ -179,9 +179,14 @@ def set_timeout_seconds(self, timeout: float) -> NoReturn:
 
 @pytest.fixture(scope="session")
 def session_default_async_timeout(pytestconfig: pytest.Config) -> float:
-    timeout = pytestconfig.option.default_async_timeout
+    timeout = pytestconfig.getini("default_async_timeout")
+
+    if not timeout:
+        timeout = pytestconfig.option.default_async_timeout
+
     if timeout is None:
         timeout = 5
+
     return float(timeout)
 
 

docs/index.rst

@@ -25,6 +25,11 @@ generator fixtures.
 Changelog
 ---------
 
+.. _release-0.9.1:
+
+0.9.1 - TBD
+    * Made the plugin take into account pytest.ini for setting the default async timeout
+
 .. _release-0.9.0:
 
 0.9.0 - 20 October 2024

helpers/alt_pytest_asyncio_test_driver/examples/example_cli_timeout/__init__.py

@@ -0,0 +1,5 @@
+=======* FAILURES ====*
+_______* test_outside_cli_timeout ____*
+E   AssertionError: Took too long to complete: */example_cli_timeout/test_timeouts.py:13 (timeout=0.09)
+=======* short test summary info ====*
+=======* 1 failed, 1 passed in * ====*

helpers/alt_pytest_asyncio_test_driver/examples/example_cli_timeout/expected

@@ -0,0 +1,14 @@
+import asyncio
+
+import alt_pytest_asyncio
+
+AsyncTimeout = alt_pytest_asyncio.protocols.AsyncTimeout
+
+
+async def test_within_cli_timeout(async_timeout: AsyncTimeout) -> None:
+    await asyncio.sleep(0.03)
+
+
+# Note that there is a bit in the tests_examples.py that sets the timeout with the cli
+async def test_outside_cli_timeout(async_timeout: AsyncTimeout) -> None:
+    await asyncio.sleep(0.1)

helpers/alt_pytest_asyncio_test_driver/examples/example_cli_timeout/test_timeouts.py

@@ -0,0 +1,5 @@
+=======* FAILURES ====*
+_______* test_outside_ini_timeout ____*
+E   AssertionError: Took too long to complete: */example_ini_timeout/test_timeouts.py:12 (timeout=0.07)
+=======* short test summary info ====*
+=======* 1 failed, 1 passed in * ====*

helpers/alt_pytest_asyncio_test_driver/examples/example_ini_timeout/__init__.py

@@ -0,0 +1,2 @@
+[pytest]
+default_async_timeout = 0.07

helpers/alt_pytest_asyncio_test_driver/examples/example_ini_timeout/expected

@@ -0,0 +1,13 @@
+import asyncio
+
+import alt_pytest_asyncio
+
+AsyncTimeout = alt_pytest_asyncio.protocols.AsyncTimeout
+
+
+async def test_within_ini_timeout(async_timeout: AsyncTimeout) -> None:
+    await asyncio.sleep(0.03)
+
+
+async def test_outside_ini_timeout(async_timeout: AsyncTimeout) -> None:
+    await asyncio.sleep(0.1)

helpers/alt_pytest_asyncio_test_driver/examples/example_ini_timeout/pytest.ini

@@ -81,7 +81,16 @@ async def test_shows_correctly_for_failing_fixtures(name: str, pytester: pytest.
     with importlib.resources.as_file(examples) as examples_path:
         shutil.copytree(examples_path, pytester.path / name)
 
-    result = pytester.runpytest_subprocess("--tb", "short", "-p", "alt_pytest_asyncio.enable")
+    if (pytester.path / name / "pytest.ini").exists():
+        (pytester.path / name / "pytest.ini").rename(pytester.path / "pytest.ini")
+
+    timeout_args: list[str] = []
+    if name == "example_cli_timeout":
+        timeout_args.extend(["--default-async-timeout", "0.09"])
+
+    result = pytester.runpytest_subprocess(
+        "--tb", "short", "-p", "alt_pytest_asyncio.enable", *timeout_args
+    )
     assert not result.errlines
 
     lines: int | list[str] = 0