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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
|
from __future__ import annotations
import asyncio
import inspect
import random
import warnings
from typing import Any, Generic, TypeVar
from unittest import mock
import pytest
from web_poet.utils import (
_create_deprecated_class,
cached_method,
ensure_awaitable,
get_generic_param,
)
class SomeBaseClass:
pass
class NewName(SomeBaseClass):
pass
def _mywarnings(w):
return [x for x in w if x.category is DeprecationWarning]
def test_no_warning_on_definition() -> None:
with warnings.catch_warnings(record=True) as w:
_create_deprecated_class("Deprecated", NewName)
w = _mywarnings(w)
assert w == []
def test_subclassing_warning_message() -> None:
# https://github.com/python/mypy/issues/2477#issuecomment-262734005
# Annotating it with Any helps prevent mypy issues for dynamic classes
Deprecated: Any = _create_deprecated_class("Deprecated", NewName)
with warnings.catch_warnings(record=True) as w:
class UserClass(Deprecated):
pass
w = _mywarnings(w)
assert len(w) == 1
expected = (
f"{__name__}.{UserClass.__qualname__} inherits from deprecated class "
f"{__name__}.Deprecated, please inherit from {__name__}.NewName. "
f"(warning only on first subclass, there may be others)"
)
assert str(w[0].message) == expected
assert w[0].lineno == inspect.getsourcelines(UserClass)[1]
def test_custom_class_paths() -> None:
Deprecated: Any = _create_deprecated_class(
"Deprecated",
NewName,
new_class_path="foo.NewClass",
old_class_path="bar.OldClass",
)
with warnings.catch_warnings(record=True) as w:
class UserClass(Deprecated):
pass
_ = Deprecated()
w = _mywarnings(w)
assert len(w) == 2
assert "foo.NewClass" in str(w[0].message)
assert "bar.OldClass" in str(w[0].message)
assert "foo.NewClass" in str(w[1].message)
assert "bar.OldClass" in str(w[1].message)
def test_subclassing_warns_only_on_direct_childs() -> None:
Deprecated: Any = _create_deprecated_class("Deprecated", NewName, warn_once=False)
with warnings.catch_warnings(record=True) as w:
class UserClass(Deprecated):
pass
class NoWarnOnMe(UserClass):
pass
w = _mywarnings(w)
assert len(w) == 1
assert "UserClass" in str(w[0].message)
def test_subclassing_warns_once_by_default() -> None:
Deprecated: Any = _create_deprecated_class("Deprecated", NewName)
with warnings.catch_warnings(record=True) as w:
class UserClass(Deprecated):
pass
class FooClass(Deprecated):
pass
class BarClass(Deprecated):
pass
w = _mywarnings(w)
assert len(w) == 1
assert "UserClass" in str(w[0].message)
def test_warning_on_instance() -> None:
Deprecated: Any = _create_deprecated_class("Deprecated", NewName)
# ignore subclassing warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
class UserClass(Deprecated):
pass
with warnings.catch_warnings(record=True) as w:
_, lineno = Deprecated(), inspect.getlineno(inspect.currentframe()) # type: ignore[arg-type]
_ = UserClass() # subclass instances don't warn
w = _mywarnings(w)
assert len(w) == 1
expected = (
f"{__name__}.Deprecated is deprecated, instantiate {__name__}.NewName instead."
)
assert str(w[0].message) == expected
assert w[0].lineno == lineno
def test_warning_auto_message() -> None:
with warnings.catch_warnings(record=True) as w:
Deprecated: Any = _create_deprecated_class("Deprecated", NewName)
class UserClass2(Deprecated):
pass
msg = str(w[0].message)
assert f"{__name__}.NewName" in msg
assert f"{__name__}.Deprecated" in msg
def test_issubclass() -> None:
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
DeprecatedName: Any = _create_deprecated_class("DeprecatedName", NewName)
class UpdatedUserClass1(NewName):
pass
class UpdatedUserClass1a(NewName):
pass
class OutdatedUserClass1(DeprecatedName):
pass
class OutdatedUserClass1a(DeprecatedName):
pass
class UnrelatedClass:
pass
class OldStyleClass:
pass
assert issubclass(UpdatedUserClass1, NewName)
assert issubclass(UpdatedUserClass1a, NewName)
assert issubclass(UpdatedUserClass1, DeprecatedName)
assert issubclass(UpdatedUserClass1a, DeprecatedName)
assert issubclass(OutdatedUserClass1, DeprecatedName)
assert not issubclass(UnrelatedClass, DeprecatedName)
assert not issubclass(OldStyleClass, DeprecatedName)
assert not issubclass(OldStyleClass, DeprecatedName)
assert not issubclass(OutdatedUserClass1, OutdatedUserClass1a)
assert not issubclass(OutdatedUserClass1a, OutdatedUserClass1)
with pytest.raises(TypeError):
issubclass(object(), DeprecatedName) # type: ignore[arg-type]
def test_isinstance() -> None:
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
DeprecatedName: Any = _create_deprecated_class("DeprecatedName", NewName)
class UpdatedUserClass2(NewName):
pass
class UpdatedUserClass2a(NewName):
pass
class OutdatedUserClass2(DeprecatedName):
pass
class OutdatedUserClass2a(DeprecatedName):
pass
class UnrelatedClass:
pass
class OldStyleClass:
pass
assert isinstance(UpdatedUserClass2(), NewName)
assert isinstance(UpdatedUserClass2a(), NewName)
assert isinstance(UpdatedUserClass2(), DeprecatedName)
assert isinstance(UpdatedUserClass2a(), DeprecatedName)
assert isinstance(OutdatedUserClass2(), DeprecatedName)
assert isinstance(OutdatedUserClass2a(), DeprecatedName)
assert not isinstance(OutdatedUserClass2a(), OutdatedUserClass2)
assert not isinstance(OutdatedUserClass2(), OutdatedUserClass2a)
assert not isinstance(UnrelatedClass(), DeprecatedName)
assert not isinstance(OldStyleClass(), DeprecatedName)
def test_clsdict() -> None:
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
Deprecated: Any = _create_deprecated_class(
"Deprecated", NewName, {"foo": "bar"}
)
assert Deprecated.foo == "bar"
def test_deprecate_a_class_with_custom_metaclass() -> None:
Meta1 = type("Meta1", (type,), {})
New = Meta1("New", (), {})
_create_deprecated_class("Deprecated", New)
def test_deprecate_subclass_of_deprecated_class() -> None:
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
Deprecated: Any = _create_deprecated_class("Deprecated", NewName)
AlsoDeprecated: Any = _create_deprecated_class(
"AlsoDeprecated", Deprecated, new_class_path="foo.Bar"
)
w = _mywarnings(w)
assert len(w) == 0, str(map(str, w))
with warnings.catch_warnings(record=True) as w:
AlsoDeprecated()
class UserClass(AlsoDeprecated):
pass
w = _mywarnings(w)
assert len(w) == 2
assert "AlsoDeprecated" in str(w[0].message)
assert "foo.Bar" in str(w[0].message)
assert "AlsoDeprecated" in str(w[1].message)
assert "foo.Bar" in str(w[1].message)
def test_inspect_stack() -> None:
with (
mock.patch("inspect.stack", side_effect=IndexError),
warnings.catch_warnings(record=True) as w,
):
DeprecatedName: Any = _create_deprecated_class("DeprecatedName", NewName)
class SubClass(DeprecatedName):
pass
assert "Error detecting parent module" in str(w[0].message)
@pytest.mark.asyncio
async def test_ensure_awaitable_sync() -> None:
assert await ensure_awaitable(5) == 5
def foo():
return 42
assert await ensure_awaitable(foo()) == 42
@pytest.mark.asyncio
async def test_ensure_awaitable_async() -> None:
async def foo():
return 42
assert await ensure_awaitable(foo()) == 42
async def bar():
await asyncio.sleep(0.01)
return 42
assert await ensure_awaitable(bar()) == 42
def test_cached_method_basic() -> None:
class Foo:
n_called = 0
def __init__(self, name):
self.name = name
@cached_method
def meth(self):
self.n_called += 1
return self.n_called, self.name
foo = Foo("first")
assert foo.meth() == (1, "first")
assert foo.meth() == (1, "first")
bar = Foo("second")
assert bar.meth() == (1, "second")
assert bar.meth() == (1, "second")
@pytest.mark.asyncio
async def test_cached_method_async() -> None:
class Foo:
n_called = 0
def __init__(self, name):
self.name = name
@cached_method
async def meth(self):
self.n_called += 1
return self.n_called, self.name
foo = Foo("first")
assert await foo.meth() == (1, "first")
assert await foo.meth() == (1, "first")
bar = Foo("second")
assert await bar.meth() == (1, "second")
assert await bar.meth() == (1, "second")
def test_cached_method_argument() -> None:
class Foo:
n_called = 0
def __init__(self, name):
self.name = name
@cached_method
def meth(self, x):
self.n_called += 1
return self.n_called, self.name, x
foo = Foo("first")
assert foo.meth(5) == (1, "first", 5)
assert foo.meth(5) == (1, "first", 5)
assert foo.meth(6) == (2, "first", 6)
assert foo.meth(6) == (2, "first", 6)
@pytest.mark.asyncio
async def test_cached_method_argument_async() -> None:
class Foo:
n_called = 0
def __init__(self, name):
self.name = name
@cached_method
async def meth(self, x):
self.n_called += 1
return self.n_called, self.name, x
foo = Foo("first")
assert await foo.meth(5) == (1, "first", 5)
assert await foo.meth(5) == (1, "first", 5)
assert await foo.meth(6) == (2, "first", 6)
assert await foo.meth(6) == (2, "first", 6)
def test_cached_method_unhashable() -> None:
class Foo(list):
n_called = 0
@cached_method
def meth(self):
self.n_called += 1
return self.n_called
foo = Foo()
assert foo.meth() == 1
assert foo.meth() == 1
@pytest.mark.asyncio
async def test_cached_method_unhashable_async() -> None:
class Foo(list):
n_called = 0
@cached_method
async def meth(self):
self.n_called += 1
return self.n_called
foo = Foo()
assert await foo.meth() == 1
assert await foo.meth() == 1
def test_cached_method_exception() -> None:
class Error(Exception):
pass
class Foo(list):
n_called = 0
@cached_method
def meth(self):
self.n_called += 1
raise Error
foo = Foo()
for idx in range(2):
with pytest.raises(Error):
foo.meth()
assert foo.n_called == idx + 1
@pytest.mark.asyncio
async def test_cached_method_exception_async() -> None:
class Error(Exception):
pass
class Foo(list):
n_called = 0
@cached_method
async def meth(self):
self.n_called += 1
raise Error
foo = Foo()
for idx in range(2):
with pytest.raises(Error):
await foo.meth()
assert foo.n_called == idx + 1
@pytest.mark.asyncio
async def test_cached_method_async_race() -> None:
class Foo:
_n_called = 0
@cached_method
async def n_called(self):
await asyncio.sleep(random.randint(0, 10) / 100.0)
self._n_called += 1
return self._n_called
foo = Foo()
results = await asyncio.gather(
foo.n_called(),
foo.n_called(),
foo.n_called(),
foo.n_called(),
foo.n_called(),
)
assert results == [1, 1, 1, 1, 1]
ItemT = TypeVar("ItemT")
class Item:
pass
class Item2:
pass
class MyGeneric(Generic[ItemT]):
pass
class MyGeneric2(Generic[ItemT]):
pass
class Base(MyGeneric[ItemT]):
pass
class BaseSpecialized(MyGeneric[Item]):
pass
class BaseAny(MyGeneric):
pass
class Derived(Base):
pass
class Specialized(BaseSpecialized):
pass
class SpecializedAdditionalClass(BaseSpecialized, Item2):
pass
class SpecializedTwice(BaseSpecialized, Base[Item2]):
pass
class SpecializedTwoGenerics(MyGeneric2[Item2], BaseSpecialized):
pass
@pytest.mark.parametrize(
("cls", "param"),
[
(MyGeneric, None),
(Base, None),
(BaseAny, None),
(Derived, None),
(BaseSpecialized, Item),
(Specialized, Item),
(SpecializedAdditionalClass, Item),
(SpecializedTwice, Item2),
(SpecializedTwoGenerics, Item),
],
)
def test_get_generic_param(cls, param) -> None:
assert get_generic_param(cls, expected=MyGeneric) == param
|