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
|
from __future__ import annotations
import sys
from collections.abc import AsyncGenerator, Generator
from contextlib import (
AbstractContextManager,
AsyncExitStack,
ExitStack,
asynccontextmanager,
contextmanager,
)
if sys.version_info >= (3, 11):
from typing import Self
else:
from typing_extensions import Self
import pytest
from anyio import AsyncContextManagerMixin, ContextManagerMixin
class DummyContextManager(ContextManagerMixin):
def __init__(self, handle_exc: bool = False) -> None:
self.started = False
self.finished = False
self.handle_exc = handle_exc
@contextmanager
def __contextmanager__(self) -> Generator[Self]:
self.started = True
try:
yield self
except RuntimeError:
if not self.handle_exc:
raise
self.finished = True
class DummyAsyncContextManager(AsyncContextManagerMixin):
def __init__(self, handle_exc: bool = False) -> None:
self.started = False
self.finished = False
self.handle_exc = handle_exc
@asynccontextmanager
async def __asynccontextmanager__(self) -> AsyncGenerator[Self]:
self.started = True
try:
yield self
except RuntimeError:
if not self.handle_exc:
raise
self.finished = True
class TestContextManagerMixin:
def test_contextmanager(self) -> None:
with DummyContextManager() as cm:
assert cm.started
assert not cm.finished
assert cm.finished
@pytest.mark.parametrize("handle_exc", [True, False])
def test_exception(self, handle_exc: bool) -> None:
with ExitStack() as stack:
if not handle_exc:
stack.enter_context(pytest.raises(RuntimeError, match="^foo$"))
cm = stack.enter_context(DummyContextManager(handle_exc))
raise RuntimeError("foo")
assert cm.started
assert cm.finished == handle_exc
def test_return_bad_type(self) -> None:
class BadContextManager(ContextManagerMixin):
def __contextmanager__(self) -> AbstractContextManager[None]:
return None # type: ignore[return-value]
with pytest.raises(TypeError, match="did not return a context manager"):
with BadContextManager():
pass
def test_return_generator(self) -> None:
class BadContextManager(ContextManagerMixin):
def __contextmanager__(self): # type: ignore[no-untyped-def]
yield self
with pytest.raises(TypeError, match="returned a generator"):
with BadContextManager():
pass
def test_return_self(self) -> None:
class BadContextManager(ContextManagerMixin):
def __contextmanager__(self): # type: ignore[no-untyped-def]
return self
with pytest.raises(TypeError, match="returned self"):
with BadContextManager():
pass
def test_enter_twice(self) -> None:
with DummyContextManager() as cm:
with pytest.raises(
RuntimeError,
match="^this DummyContextManager has already been entered$",
):
with cm:
pass
def test_exit_before_enter(self) -> None:
cm = DummyContextManager()
with pytest.raises(
RuntimeError, match="^this DummyContextManager has not been entered yet$"
):
cm.__exit__(None, None, None)
def test_call_superclass_method(self) -> None:
class InheritedContextManager(DummyContextManager):
def __init__(self, handle_exc: bool = False) -> None:
super().__init__(handle_exc)
self.child_started = False
self.child_finished = False
@contextmanager
def __contextmanager__(self) -> Generator[Self]:
self.child_started = True
with super().__contextmanager__():
assert self.started
try:
yield self
except RuntimeError:
if not self.handle_exc:
raise
assert self.finished
self.child_finished = True
with InheritedContextManager() as cm:
assert cm.started
assert not cm.finished
assert cm.child_started
assert not cm.child_finished
assert cm.finished
assert cm.child_finished
class TestAsyncContextManagerMixin:
async def test_contextmanager(self) -> None:
async with DummyAsyncContextManager() as cm:
assert cm.started
assert not cm.finished
assert cm.finished
@pytest.mark.parametrize("handle_exc", [True, False])
async def test_exception(self, handle_exc: bool) -> None:
async with AsyncExitStack() as stack:
if not handle_exc:
stack.enter_context(pytest.raises(RuntimeError, match="^foo$"))
cm = await stack.enter_async_context(DummyAsyncContextManager(handle_exc))
raise RuntimeError("foo")
assert cm.started
assert cm.finished == handle_exc
async def test_return_bad_type(self) -> None:
class BadContextManager(AsyncContextManagerMixin):
def __asynccontextmanager__(self): # type: ignore[no-untyped-def]
return None
with pytest.raises(TypeError, match="did not return an async context manager"):
async with BadContextManager():
pass
async def test_return_async_generator(self) -> None:
class BadContextManager(AsyncContextManagerMixin):
async def __asynccontextmanager__(self): # type: ignore[no-untyped-def]
yield self
with pytest.raises(TypeError, match="returned an async generator"):
async with BadContextManager():
pass
async def test_return_self(self) -> None:
class BadContextManager(AsyncContextManagerMixin):
def __asynccontextmanager__(self): # type: ignore[no-untyped-def]
return self
with pytest.raises(TypeError, match="returned self"):
async with BadContextManager():
pass
async def test_return_coroutine(self) -> None:
class BadContextManager(AsyncContextManagerMixin):
async def __asynccontextmanager__(self): # type: ignore[no-untyped-def]
return self
with pytest.raises(TypeError, match="returned a coroutine object instead of"):
async with BadContextManager():
pass
async def test_enter_twice(self) -> None:
async with DummyAsyncContextManager() as cm:
with pytest.raises(
RuntimeError,
match="^this DummyAsyncContextManager has already been entered$",
):
async with cm:
pass
async def test_exit_before_enter(self) -> None:
cm = DummyAsyncContextManager()
with pytest.raises(
RuntimeError,
match="^this DummyAsyncContextManager has not been entered yet$",
):
await cm.__aexit__(None, None, None)
async def test_call_superclass_method(self) -> None:
class InheritedAsyncContextManager(DummyAsyncContextManager):
def __init__(self, handle_exc: bool = False) -> None:
super().__init__(handle_exc)
self.child_started = False
self.child_finished = False
@asynccontextmanager
async def __asynccontextmanager__(self) -> AsyncGenerator[Self]:
self.child_started = True
async with super().__asynccontextmanager__():
assert self.started
try:
yield self
except RuntimeError:
if not self.handle_exc:
raise
assert self.finished
self.child_finished = True
async with InheritedAsyncContextManager() as cm:
assert cm.started
assert not cm.finished
assert cm.child_started
assert not cm.child_finished
assert cm.finished
assert cm.child_finished
|