mirror of https://github.com/scrapy/scrapy.git
297 lines
9.6 KiB
Python
297 lines
9.6 KiB
Python
import inspect
|
|
import warnings
|
|
from unittest import mock
|
|
from warnings import WarningMessage
|
|
|
|
import pytest
|
|
|
|
from scrapy.exceptions import ScrapyDeprecationWarning
|
|
from scrapy.utils.deprecate import create_deprecated_class, update_classpath
|
|
|
|
|
|
class MyWarning(UserWarning):
|
|
pass
|
|
|
|
|
|
class SomeBaseClass:
|
|
pass
|
|
|
|
|
|
class NewName(SomeBaseClass):
|
|
pass
|
|
|
|
|
|
class TestWarnWhenSubclassed:
|
|
def _mywarnings(self, w: list[WarningMessage]) -> list[WarningMessage]:
|
|
return [x for x in w if x.category is MyWarning]
|
|
|
|
def test_no_warning_on_definition(self):
|
|
with warnings.catch_warnings(record=True) as w:
|
|
create_deprecated_class("Deprecated", NewName)
|
|
|
|
w = self._mywarnings(w)
|
|
assert w == []
|
|
|
|
def test_subclassing_warning_message(self):
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated", NewName, warn_category=MyWarning
|
|
)
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
|
|
class UserClass(Deprecated):
|
|
pass
|
|
|
|
w = self._mywarnings(w)
|
|
assert len(w) == 1
|
|
assert (
|
|
str(w[0].message) == "tests.test_utils_deprecate.UserClass inherits from "
|
|
"deprecated class tests.test_utils_deprecate.Deprecated, "
|
|
"please inherit from tests.test_utils_deprecate.NewName."
|
|
" (warning only on first subclass, there may be others)"
|
|
)
|
|
assert w[0].lineno == inspect.getsourcelines(UserClass)[1]
|
|
|
|
def test_custom_class_paths(self):
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated",
|
|
NewName,
|
|
new_class_path="foo.NewClass",
|
|
old_class_path="bar.OldClass",
|
|
warn_category=MyWarning,
|
|
)
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
|
|
class UserClass(Deprecated):
|
|
pass
|
|
|
|
_ = Deprecated()
|
|
|
|
w = self._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_children(self):
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated", NewName, warn_once=False, warn_category=MyWarning
|
|
)
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
|
|
class UserClass(Deprecated):
|
|
pass
|
|
|
|
class NoWarnOnMe(UserClass):
|
|
pass
|
|
|
|
w = self._mywarnings(w)
|
|
assert len(w) == 1
|
|
assert "UserClass" in str(w[0].message)
|
|
|
|
def test_subclassing_warns_once_by_default(self):
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated", NewName, warn_category=MyWarning
|
|
)
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
|
|
class UserClass(Deprecated):
|
|
pass
|
|
|
|
class FooClass(Deprecated):
|
|
pass
|
|
|
|
class BarClass(Deprecated):
|
|
pass
|
|
|
|
w = self._mywarnings(w)
|
|
assert len(w) == 1
|
|
assert "UserClass" in str(w[0].message)
|
|
|
|
def test_warning_on_instance(self):
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated", NewName, warn_category=MyWarning
|
|
)
|
|
|
|
# ignore subclassing warnings
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter("ignore", MyWarning)
|
|
|
|
class UserClass(Deprecated):
|
|
pass
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
_, lineno = Deprecated(), inspect.getlineno(inspect.currentframe())
|
|
_ = UserClass() # subclass instances don't warn
|
|
|
|
w = self._mywarnings(w)
|
|
assert len(w) == 1
|
|
assert (
|
|
str(w[0].message) == "tests.test_utils_deprecate.Deprecated is deprecated, "
|
|
"instantiate tests.test_utils_deprecate.NewName instead."
|
|
)
|
|
assert w[0].lineno == lineno
|
|
|
|
def test_warning_auto_message(self):
|
|
with warnings.catch_warnings(record=True) as w:
|
|
Deprecated = create_deprecated_class("Deprecated", NewName)
|
|
|
|
class UserClass2(Deprecated):
|
|
pass
|
|
|
|
msg = str(w[0].message)
|
|
assert "tests.test_utils_deprecate.NewName" in msg
|
|
assert "tests.test_utils_deprecate.Deprecated" in msg
|
|
|
|
def test_issubclass(self):
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter("ignore", ScrapyDeprecationWarning)
|
|
DeprecatedName = create_deprecated_class("DeprecatedName", NewName)
|
|
|
|
class UpdatedUserClass1(NewName):
|
|
pass
|
|
|
|
class UpdatedUserClass1a(NewName):
|
|
pass
|
|
|
|
class OutdatedUserClass1(DeprecatedName):
|
|
pass
|
|
|
|
class OutdatedUserClass1a(DeprecatedName):
|
|
pass
|
|
|
|
class UnrelatedClass:
|
|
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(OutdatedUserClass1, OutdatedUserClass1a)
|
|
assert not issubclass(OutdatedUserClass1a, OutdatedUserClass1)
|
|
|
|
with pytest.raises(TypeError):
|
|
issubclass(object(), DeprecatedName)
|
|
|
|
def test_isinstance(self):
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter("ignore", ScrapyDeprecationWarning)
|
|
DeprecatedName = create_deprecated_class("DeprecatedName", NewName)
|
|
|
|
class UpdatedUserClass2(NewName):
|
|
pass
|
|
|
|
class UpdatedUserClass2a(NewName):
|
|
pass
|
|
|
|
class OutdatedUserClass2(DeprecatedName):
|
|
pass
|
|
|
|
class OutdatedUserClass2a(DeprecatedName):
|
|
pass
|
|
|
|
class UnrelatedClass:
|
|
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)
|
|
|
|
def test_clsdict(self):
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter("ignore", ScrapyDeprecationWarning)
|
|
Deprecated = create_deprecated_class("Deprecated", NewName, {"foo": "bar"})
|
|
|
|
assert Deprecated.foo == "bar"
|
|
|
|
def test_deprecate_a_class_with_custom_metaclass(self):
|
|
Meta1 = type("Meta1", (type,), {})
|
|
New = Meta1("New", (), {})
|
|
create_deprecated_class("Deprecated", New)
|
|
|
|
def test_deprecate_subclass_of_deprecated_class(self):
|
|
with warnings.catch_warnings(record=True) as w:
|
|
warnings.simplefilter("always")
|
|
Deprecated = create_deprecated_class(
|
|
"Deprecated", NewName, warn_category=MyWarning
|
|
)
|
|
AlsoDeprecated = create_deprecated_class(
|
|
"AlsoDeprecated",
|
|
Deprecated,
|
|
new_class_path="foo.Bar",
|
|
warn_category=MyWarning,
|
|
)
|
|
|
|
w = self._mywarnings(w)
|
|
assert len(w) == 0, [str(warning) for warning in w]
|
|
|
|
with warnings.catch_warnings(record=True) as w:
|
|
AlsoDeprecated()
|
|
|
|
class UserClass(AlsoDeprecated):
|
|
pass
|
|
|
|
w = self._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(self):
|
|
with (
|
|
mock.patch("inspect.stack", side_effect=IndexError),
|
|
warnings.catch_warnings(record=True) as w,
|
|
):
|
|
DeprecatedName = create_deprecated_class("DeprecatedName", NewName)
|
|
|
|
class SubClass(DeprecatedName):
|
|
pass
|
|
|
|
assert "Error detecting parent module" in str(w[0].message)
|
|
|
|
|
|
@mock.patch(
|
|
"scrapy.utils.deprecate.DEPRECATION_RULES",
|
|
[
|
|
("scrapy.contrib.pipeline.", "scrapy.pipelines."),
|
|
("scrapy.contrib.", "scrapy.extensions."),
|
|
],
|
|
)
|
|
class TestUpdateClassPath:
|
|
def test_old_path_gets_fixed(self):
|
|
with warnings.catch_warnings(record=True) as w:
|
|
output = update_classpath("scrapy.contrib.debug.Debug")
|
|
assert output == "scrapy.extensions.debug.Debug"
|
|
assert len(w) == 1
|
|
assert "scrapy.contrib.debug.Debug" in str(w[0].message)
|
|
assert "scrapy.extensions.debug.Debug" in str(w[0].message)
|
|
|
|
def test_sorted_replacement(self):
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter("ignore", ScrapyDeprecationWarning)
|
|
output = update_classpath("scrapy.contrib.pipeline.Pipeline")
|
|
assert output == "scrapy.pipelines.Pipeline"
|
|
|
|
def test_unmatched_path_stays_the_same(self):
|
|
with warnings.catch_warnings(record=True) as w:
|
|
output = update_classpath("scrapy.unmatched.Path")
|
|
assert output == "scrapy.unmatched.Path"
|
|
assert len(w) == 0
|
|
|
|
def test_returns_nonstring(self):
|
|
for notastring in [None, True, [1, 2, 3], object()]:
|
|
assert update_classpath(notastring) == notastring
|