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
|
import unittest
from types import MappingProxyType
from unittest import mock
from itemadapter.utils import get_field_meta_from_class
from tests import (
AttrsItem,
DataClassItem,
PydanticModel,
PydanticV1Model,
ScrapyItem,
ScrapySubclassedItem,
clear_itemadapter_imports,
make_mock_import,
)
class ScrapyItemTestCase(unittest.TestCase):
def test_false(self):
from itemadapter.adapter import ScrapyItemAdapter
self.assertFalse(ScrapyItemAdapter.is_item(int))
self.assertFalse(ScrapyItemAdapter.is_item(sum))
self.assertFalse(ScrapyItemAdapter.is_item(1234))
self.assertFalse(ScrapyItemAdapter.is_item(object()))
self.assertFalse(ScrapyItemAdapter.is_item(DataClassItem()))
self.assertFalse(ScrapyItemAdapter.is_item("a string"))
self.assertFalse(ScrapyItemAdapter.is_item(b"some bytes"))
self.assertFalse(ScrapyItemAdapter.is_item({"a": "dict"}))
self.assertFalse(ScrapyItemAdapter.is_item(["a", "list"]))
self.assertFalse(ScrapyItemAdapter.is_item(("a", "tuple")))
self.assertFalse(ScrapyItemAdapter.is_item({"a", "set"}))
self.assertFalse(ScrapyItemAdapter.is_item(ScrapySubclassedItem))
try:
import attrs # noqa: F401 # pylint: disable=unused-import
except ImportError:
pass
else:
self.assertFalse(ScrapyItemAdapter.is_item(AttrsItem()))
if PydanticModel is not None:
self.assertFalse(ScrapyItemAdapter.is_item(PydanticModel()))
if PydanticV1Model is not None:
self.assertFalse(ScrapyItemAdapter.is_item(PydanticV1Model()))
@unittest.skipIf(not ScrapySubclassedItem, "scrapy module is not available")
@mock.patch("builtins.__import__", make_mock_import("scrapy"))
def test_module_import_error(self):
with clear_itemadapter_imports():
from itemadapter.adapter import ScrapyItemAdapter
self.assertFalse(
ScrapyItemAdapter.is_item(ScrapySubclassedItem(name="asdf", value=1234))
)
with self.assertRaises(
TypeError, msg="ScrapySubclassedItem is not a valid item class"
):
get_field_meta_from_class(ScrapySubclassedItem, "name")
@unittest.skipIf(not ScrapySubclassedItem, "scrapy module is not available")
@mock.patch("itemadapter.adapter._scrapy_item_classes", ())
def test_module_not_available(self):
from itemadapter.adapter import ScrapyItemAdapter
self.assertFalse(ScrapyItemAdapter.is_item(ScrapySubclassedItem(name="asdf", value=1234)))
with self.assertRaises(TypeError, msg="ScrapySubclassedItem is not a valid item class"):
get_field_meta_from_class(ScrapySubclassedItem, "name")
@unittest.skipIf(not ScrapySubclassedItem, "scrapy module is not available")
def test_true(self):
from itemadapter.adapter import ScrapyItemAdapter
self.assertTrue(ScrapyItemAdapter.is_item(ScrapyItem()))
self.assertTrue(ScrapyItemAdapter.is_item(ScrapySubclassedItem()))
self.assertTrue(ScrapyItemAdapter.is_item(ScrapySubclassedItem(name="asdf", value=1234)))
# field metadata
self.assertEqual(
get_field_meta_from_class(ScrapySubclassedItem, "name"),
MappingProxyType({"serializer": str}),
)
self.assertEqual(
get_field_meta_from_class(ScrapySubclassedItem, "value"),
MappingProxyType({"serializer": int}),
)
try:
import scrapy
except ImportError:
scrapy = None
class ScrapyDeprecatedBaseItemTestCase(unittest.TestCase):
"""Tests for deprecated classes. These will go away once the upstream classes are removed."""
@unittest.skipIf(
scrapy is None or not hasattr(scrapy.item, "_BaseItem"),
"scrapy.item._BaseItem not available",
)
def test_deprecated_underscore_baseitem(self):
from itemadapter.adapter import ScrapyItemAdapter
class SubClassed_BaseItem(scrapy.item._BaseItem):
pass
self.assertTrue(ScrapyItemAdapter.is_item(scrapy.item._BaseItem()))
self.assertTrue(ScrapyItemAdapter.is_item(SubClassed_BaseItem()))
@unittest.skipIf(
scrapy is None or not hasattr(scrapy.item, "BaseItem"),
"scrapy.item.BaseItem not available",
)
def test_deprecated_baseitem(self):
from itemadapter.adapter import ScrapyItemAdapter
class SubClassedBaseItem(scrapy.item.BaseItem):
pass
self.assertTrue(ScrapyItemAdapter.is_item(scrapy.item.BaseItem()))
self.assertTrue(ScrapyItemAdapter.is_item(SubClassedBaseItem()))
@unittest.skipIf(scrapy is None, "scrapy module is not available")
def test_removed_baseitem(self):
"""Mock the scrapy.item module so it does not contain the deprecated _BaseItem class."""
from itemadapter.adapter import ScrapyItemAdapter
class MockItemModule:
Item = ScrapyItem
with mock.patch("scrapy.item", MockItemModule):
self.assertFalse(ScrapyItemAdapter.is_item({}))
self.assertEqual(
get_field_meta_from_class(ScrapySubclassedItem, "name"),
MappingProxyType({"serializer": str}),
)
self.assertEqual(
get_field_meta_from_class(ScrapySubclassedItem, "value"),
MappingProxyType({"serializer": int}),
)
|