1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
|
from __future__ import annotations
from textwrap import dedent
from pytest import Pytester
def test_asyncio_mark_provides_package_scoped_loop_strict_mode(pytester: Pytester):
package_name = pytester.path.name
subpackage_name = "subpkg"
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
shared_module=dedent(
"""\
import asyncio
loop: asyncio.AbstractEventLoop = None
"""
),
test_module_one=dedent(
f"""\
import asyncio
import pytest
from {package_name} import shared_module
@pytest.mark.asyncio(loop_scope="package")
async def test_remember_loop():
shared_module.loop = asyncio.get_running_loop()
"""
),
test_module_two=dedent(
f"""\
import asyncio
import pytest
from {package_name} import shared_module
pytestmark = pytest.mark.asyncio(loop_scope="package")
async def test_this_runs_in_same_loop():
assert asyncio.get_running_loop() is shared_module.loop
class TestClassA:
async def test_this_runs_in_same_loop(self):
assert asyncio.get_running_loop() is shared_module.loop
"""
),
)
subpkg = pytester.mkpydir(subpackage_name)
subpkg.joinpath("__init__.py").touch()
subpkg.joinpath("test_subpkg.py").write_text(
dedent(
f"""\
import asyncio
import pytest
from {package_name} import shared_module
pytestmark = pytest.mark.asyncio(loop_scope="package")
async def test_subpackage_runs_in_different_loop():
assert asyncio.get_running_loop() is not shared_module.loop
"""
)
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=4)
def test_raise_when_event_loop_fixture_is_requested_in_addition_to_scoped_loop(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_raises=dedent(
"""\
import asyncio
import pytest
@pytest.mark.asyncio(loop_scope="package")
async def test_remember_loop(event_loop):
pass
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(errors=1)
result.stdout.fnmatch_lines("*MultipleEventLoopsRequestedError: *")
def test_asyncio_mark_respects_the_loop_policy(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
conftest=dedent(
"""\
import pytest
from .custom_policy import CustomEventLoopPolicy
@pytest.fixture(scope="package")
def event_loop_policy():
return CustomEventLoopPolicy()
"""
),
custom_policy=dedent(
"""\
import asyncio
class CustomEventLoopPolicy(asyncio.DefaultEventLoopPolicy):
pass
"""
),
test_uses_custom_policy=dedent(
"""\
import asyncio
import pytest
from .custom_policy import CustomEventLoopPolicy
pytestmark = pytest.mark.asyncio(loop_scope="package")
async def test_uses_custom_event_loop_policy():
assert isinstance(
asyncio.get_event_loop_policy(),
CustomEventLoopPolicy,
)
"""
),
test_also_uses_custom_policy=dedent(
"""\
import asyncio
import pytest
from .custom_policy import CustomEventLoopPolicy
pytestmark = pytest.mark.asyncio(loop_scope="package")
async def test_also_uses_custom_event_loop_policy():
assert isinstance(
asyncio.get_event_loop_policy(),
CustomEventLoopPolicy,
)
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=2)
def test_asyncio_mark_respects_parametrized_loop_policies(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_parametrization=dedent(
"""\
import asyncio
import pytest
pytestmark = pytest.mark.asyncio(loop_scope="package")
@pytest.fixture(
scope="package",
params=[
asyncio.DefaultEventLoopPolicy(),
asyncio.DefaultEventLoopPolicy(),
],
)
def event_loop_policy(request):
return request.param
async def test_parametrized_loop():
pass
"""
),
)
result = pytester.runpytest_subprocess("--asyncio-mode=strict")
result.assert_outcomes(passed=2)
def test_asyncio_mark_provides_package_scoped_loop_to_fixtures(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
package_name = pytester.path.name
pytester.makepyfile(
__init__="",
conftest=dedent(
f"""\
import asyncio
import pytest_asyncio
from {package_name} import shared_module
@pytest_asyncio.fixture(loop_scope="package", scope="package")
async def my_fixture():
shared_module.loop = asyncio.get_running_loop()
"""
),
shared_module=dedent(
"""\
import asyncio
loop: asyncio.AbstractEventLoop = None
"""
),
test_fixture_runs_in_scoped_loop=dedent(
f"""\
import asyncio
import pytest
import pytest_asyncio
from {package_name} import shared_module
pytestmark = pytest.mark.asyncio(loop_scope="package")
async def test_runs_in_same_loop_as_fixture(my_fixture):
assert asyncio.get_running_loop() is shared_module.loop
"""
),
)
result = pytester.runpytest_subprocess("--asyncio-mode=strict")
result.assert_outcomes(passed=1)
def test_asyncio_mark_allows_combining_package_scoped_fixture_with_module_scoped_test(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_mixed_scopes=dedent(
"""\
import asyncio
import pytest
import pytest_asyncio
loop: asyncio.AbstractEventLoop
@pytest_asyncio.fixture(loop_scope="package", scope="package")
async def async_fixture():
global loop
loop = asyncio.get_running_loop()
@pytest.mark.asyncio(loop_scope="module")
async def test_runs_in_different_loop_as_fixture(async_fixture):
global loop
assert asyncio.get_running_loop() is not loop
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=1)
def test_asyncio_mark_allows_combining_package_scoped_fixture_with_class_scoped_test(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_mixed_scopes=dedent(
"""\
import asyncio
import pytest
import pytest_asyncio
loop: asyncio.AbstractEventLoop
@pytest_asyncio.fixture(loop_scope="package", scope="package")
async def async_fixture():
global loop
loop = asyncio.get_running_loop()
@pytest.mark.asyncio(loop_scope="class")
class TestMixedScopes:
async def test_runs_in_different_loop_as_fixture(self, async_fixture):
global loop
assert asyncio.get_running_loop() is not loop
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=1)
def test_asyncio_mark_allows_combining_package_scoped_fixture_with_function_scoped_test(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_mixed_scopes=dedent(
"""\
import asyncio
import pytest
import pytest_asyncio
loop: asyncio.AbstractEventLoop
@pytest_asyncio.fixture(loop_scope="package", scope="package")
async def async_fixture():
global loop
loop = asyncio.get_running_loop()
@pytest.mark.asyncio
async def test_runs_in_different_loop_as_fixture(async_fixture):
global loop
assert asyncio.get_running_loop() is not loop
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=1)
def test_asyncio_mark_handles_missing_event_loop_triggered_by_fixture(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_loop_is_none=dedent(
"""\
import pytest
import asyncio
@pytest.fixture(scope="package")
def sets_event_loop_to_none():
# asyncio.run() creates a new event loop without closing the existing
# one. For any test, but the first one, this leads to a ResourceWarning
# when the discarded loop is destroyed by the garbage collector.
# We close the current loop to avoid this
try:
asyncio.get_event_loop().close()
except RuntimeError:
pass
return asyncio.run(asyncio.sleep(0))
# asyncio.run() sets the current event loop to None when finished
@pytest.mark.asyncio(loop_scope="package")
# parametrization may impact fixture ordering
@pytest.mark.parametrize("n", (0, 1))
async def test_does_not_fail(sets_event_loop_to_none, n):
pass
"""
),
)
result = pytester.runpytest("--asyncio-mode=strict")
result.assert_outcomes(passed=2)
def test_standalone_test_does_not_trigger_warning_about_no_current_event_loop_being_set(
pytester: Pytester,
):
pytester.makeini("[pytest]\nasyncio_default_fixture_loop_scope = function")
pytester.makepyfile(
__init__="",
test_module=dedent(
"""\
import pytest
@pytest.mark.asyncio(loop_scope="package")
async def test_anything():
pass
"""
),
)
result = pytester.runpytest_subprocess("--asyncio-mode=strict")
result.assert_outcomes(warnings=0, passed=1)
|