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
|
from __future__ import annotations
import unittest
from collections.abc import KeysView
from types import MappingProxyType
from itemadapter.adapter import ItemAdapter, PydanticAdapter
from tests import (
AttrsItem,
AttrsItemEmpty,
AttrsItemJsonSchema,
AttrsItemNested,
AttrsItemSubclassed,
AttrsItemWithoutInit,
DataClassItem,
DataClassItemEmpty,
DataClassItemJsonSchema,
DataClassItemNested,
DataClassItemSubclassed,
DataClassWithoutInit,
PydanticModel,
PydanticModelEmpty,
PydanticModelJsonSchema,
PydanticModelNested,
PydanticModelSubclassed,
PydanticV1Model,
PydanticV1ModelEmpty,
PydanticV1ModelJsonSchema,
PydanticV1ModelNested,
PydanticV1ModelSubclassed,
ScrapySubclassedItem,
ScrapySubclassedItemEmpty,
ScrapySubclassedItemJsonSchema,
ScrapySubclassedItemNested,
ScrapySubclassedItemSubclassed,
SetList,
)
class ItemAdapterReprTestCase(unittest.TestCase):
def test_repr_dict(self):
item = {"name": "asdf", "value": 1234}
adapter = ItemAdapter(item)
self.assertEqual(repr(adapter), "<ItemAdapter for dict(name='asdf', value=1234)>")
@unittest.skipIf(not ScrapySubclassedItem, "scrapy module is not available")
def test_repr_scrapy_item(self):
item = ScrapySubclassedItem(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(
repr(adapter),
"<ItemAdapter for ScrapySubclassedItem(name='asdf', value=1234)>",
)
@unittest.skipIf(not DataClassItem, "dataclasses module is not available")
def test_repr_dataclass(self):
item = DataClassItem(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(
repr(adapter),
"<ItemAdapter for DataClassItem(name='asdf', value=1234)>",
)
@unittest.skipIf(not DataClassWithoutInit, "dataclasses module is not available")
def test_repr_dataclass_init_false(self):
item = DataClassWithoutInit()
adapter = ItemAdapter(item)
self.assertEqual(repr(adapter), "<ItemAdapter for DataClassWithoutInit()>")
adapter["name"] = "set after init"
self.assertEqual(
repr(adapter),
"<ItemAdapter for DataClassWithoutInit(name='set after init')>",
)
@unittest.skipIf(not AttrsItem, "attrs module is not available")
def test_repr_attrs(self):
item = AttrsItem(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(
repr(adapter),
"<ItemAdapter for AttrsItem(name='asdf', value=1234)>",
)
@unittest.skipIf(not AttrsItemWithoutInit, "attrs module is not available")
def test_repr_attrs_init_false(self):
item = AttrsItemWithoutInit()
adapter = ItemAdapter(item)
self.assertEqual(repr(adapter), "<ItemAdapter for AttrsItemWithoutInit()>")
adapter["name"] = "set after init"
self.assertEqual(
repr(adapter),
"<ItemAdapter for AttrsItemWithoutInit(name='set after init')>",
)
@unittest.skipIf(not PydanticV1Model, "pydantic module is not available")
def test_repr_pydantic(self):
item = PydanticV1Model(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(
repr(adapter),
"<ItemAdapter for PydanticV1Model(name='asdf', value=1234)>",
)
class ItemAdapterInitError(unittest.TestCase):
def test_non_item(self):
with self.assertRaises(TypeError):
ItemAdapter(ScrapySubclassedItem)
with self.assertRaises(TypeError):
ItemAdapter(dict)
with self.assertRaises(TypeError):
ItemAdapter(1234)
class BaseTestMixin:
maxDiff = None
item_class = None
item_class_nested = None
item_class_json_schema = None
def setUp(self):
if self.item_class is None:
raise unittest.SkipTest
def test_get_set_value(self):
item = self.item_class()
adapter = ItemAdapter(item)
self.assertEqual(adapter.get("name"), None)
self.assertEqual(adapter.get("value"), None)
adapter["name"] = "asdf"
adapter["value"] = 1234
self.assertEqual(adapter.get("name"), "asdf")
self.assertEqual(adapter.get("value"), 1234)
self.assertEqual(adapter["name"], "asdf")
self.assertEqual(adapter["value"], 1234)
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(adapter.get("name"), "asdf")
self.assertEqual(adapter.get("value"), 1234)
self.assertEqual(adapter["name"], "asdf")
self.assertEqual(adapter["value"], 1234)
def test_get_value_keyerror(self):
item = self.item_class()
adapter = ItemAdapter(item)
with self.assertRaises(KeyError):
adapter["undefined_field"]
def test_as_dict(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual({"name": "asdf", "value": 1234}, dict(adapter))
def test_as_dict_nested(self):
item = self.item_class_nested(
nested=self.item_class(name="asdf", value=1234),
adapter=ItemAdapter({"foo": "bar", "nested_list": [1, 2, 3, 4, 5]}),
dict_={"foo": "bar", "answer": 42, "nested_dict": {"a": "b"}},
list_=[1, 2, 3],
set_={1, 2, 3},
tuple_=(1, 2, 3),
int_=123,
)
adapter = ItemAdapter(item)
self.assertEqual(
adapter.asdict(),
{
"nested": {"name": "asdf", "value": 1234},
"adapter": {"foo": "bar", "nested_list": [1, 2, 3, 4, 5]},
"dict_": {"foo": "bar", "answer": 42, "nested_dict": {"a": "b"}},
"list_": [1, 2, 3],
"set_": {1, 2, 3},
"tuple_": (1, 2, 3),
"int_": 123,
},
)
def test_field_names(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertIsInstance(adapter.field_names(), KeysView)
self.assertEqual(sorted(adapter.field_names()), ["name", "value"])
def test_json_schema(self):
item_class = self.item_class_json_schema
actual = ItemAdapter.get_json_schema(item_class)
self.assertEqual(self.expected_json_schema, actual)
def test_json_schema_empty(self):
actual = ItemAdapter.get_json_schema(self.item_class_empty)
expected = {"type": "object"}
if self.item_class_empty is not dict and not PydanticAdapter.is_item_class(
self.item_class_empty
):
expected["additionalProperties"] = False
self.assertEqual(expected, actual)
_NESTED_JSON_SCHEMA = {
"type": "object",
"properties": {
"is_nested": {"type": "boolean", "default": True},
},
"additionalProperties": False,
}
class NonDictTestMixin(BaseTestMixin):
item_class_subclassed = None
item_class_empty = None
expected_json_schema = {
"additionalProperties": False,
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Display name",
},
"value": {
"default": None,
},
"color": {
"type": "string",
"enum": ["red", "green", "blue"],
},
"produced": {"type": "boolean"},
"answer": {
"type": SetList(["string", "null", "number"]),
},
"numbers": {"type": "array", "items": {"type": "number"}},
"aliases": {
"type": "object",
"additionalProperties": {"type": "string"},
},
"nested": _NESTED_JSON_SCHEMA,
"nested_list": {
"type": "array",
"items": _NESTED_JSON_SCHEMA,
},
"nested_dict": {
"type": "object",
"additionalProperties": _NESTED_JSON_SCHEMA,
},
"nested_dict_list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": _NESTED_JSON_SCHEMA,
},
},
},
"required": [
"name",
"color",
"answer",
"numbers",
"aliases",
"nested",
"nested_list",
"nested_dict",
"nested_dict_list",
],
"type": "object",
"llmHint": "Hi model!",
}
def test_set_value_keyerror(self):
item = self.item_class()
adapter = ItemAdapter(item)
with self.assertRaises(KeyError):
adapter["undefined_field"] = "some value"
def test_metadata_common(self):
adapter = ItemAdapter(self.item_class())
self.assertIsInstance(adapter.get_field_meta("name"), MappingProxyType)
self.assertIsInstance(adapter.get_field_meta("value"), MappingProxyType)
with self.assertRaises(KeyError):
adapter.get_field_meta("undefined_field")
def test_get_field_meta_defined_fields(self):
adapter = ItemAdapter(self.item_class())
self.assertEqual(adapter.get_field_meta("name"), MappingProxyType({"serializer": str}))
self.assertEqual(adapter.get_field_meta("value"), MappingProxyType({"serializer": int}))
def test_delitem_len_iter(self):
item = self.item_class(name="asdf", value=1234)
adapter = ItemAdapter(item)
self.assertEqual(len(adapter), 2)
self.assertEqual(sorted(iter(adapter)), ["name", "value"])
del adapter["name"]
self.assertEqual(len(adapter), 1)
self.assertEqual(sorted(iter(adapter)), ["value"])
del adapter["value"]
self.assertEqual(len(adapter), 0)
self.assertEqual(sorted(iter(adapter)), [])
with self.assertRaises(KeyError):
del adapter["name"]
with self.assertRaises(KeyError):
del adapter["value"]
with self.assertRaises(KeyError):
del adapter["undefined_field"]
def test_field_names_from_class(self):
field_names = ItemAdapter.get_field_names_from_class(self.item_class)
assert isinstance(field_names, list)
self.assertEqual(sorted(field_names), ["name", "value"])
def test_field_names_from_class_nested(self):
field_names = ItemAdapter.get_field_names_from_class(self.item_class_subclassed)
assert isinstance(field_names, list)
self.assertEqual(sorted(field_names), ["name", "subclassed", "value"])
def test_field_names_from_class_empty(self):
field_names = ItemAdapter.get_field_names_from_class(self.item_class_empty)
assert isinstance(field_names, list)
self.assertEqual(field_names, [])
class DictTestCase(unittest.TestCase, BaseTestMixin):
item_class = dict
item_class_nested = dict
item_class_json_schema = dict
item_class_empty = dict
expected_json_schema = {"type": "object"}
def test_get_value_keyerror_item_dict(self):
"""Instantiate without default values."""
adapter = ItemAdapter(self.item_class())
with self.assertRaises(KeyError):
adapter["name"]
def test_empty_metadata(self):
adapter = ItemAdapter(self.item_class(name="foo", value=5))
for field_name in ("name", "value", "undefined_field"):
self.assertEqual(adapter.get_field_meta(field_name), MappingProxyType({}))
def test_field_names_updated(self):
item = self.item_class(name="asdf")
field_names = ItemAdapter(item).field_names()
self.assertEqual(sorted(field_names), ["name"])
item["value"] = 1234
self.assertEqual(sorted(field_names), ["name", "value"])
def test_field_names_from_class(self):
assert ItemAdapter.get_field_names_from_class(dict) is None
class ScrapySubclassedItemTestCase(NonDictTestMixin, unittest.TestCase):
item_class = ScrapySubclassedItem
item_class_nested = ScrapySubclassedItemNested
item_class_subclassed = ScrapySubclassedItemSubclassed
item_class_empty = ScrapySubclassedItemEmpty
item_class_json_schema = ScrapySubclassedItemJsonSchema
expected_json_schema = {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema.items()
if k not in {"properties"}
},
"properties": {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema["properties"].items()
if k != "produced"
},
# No type, since none was specified in json_schema_extra.
"produced": {},
},
# Scrapy items seem to sort fields alphabetically. produced is required
# because there is no default factory support in Scrapy.
"required": sorted(NonDictTestMixin.expected_json_schema["required"] + ["produced"]),
"llmHint": "Hi model!",
}
def test_get_value_keyerror_item_dict(self):
"""Instantiate without default values."""
adapter = ItemAdapter(self.item_class())
with self.assertRaises(KeyError):
adapter["name"]
_PYDANTIC_NESTED_JSON_SCHEMA = {
k: v for k, v in _NESTED_JSON_SCHEMA.items() if k != "additionalProperties"
}
class PydanticV1ModelTestCase(NonDictTestMixin, unittest.TestCase):
item_class = PydanticV1Model
item_class_nested = PydanticV1ModelNested
item_class_subclassed = PydanticV1ModelSubclassed
item_class_empty = PydanticV1ModelEmpty
item_class_json_schema = PydanticV1ModelJsonSchema
expected_json_schema = {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema.items()
if k not in {"additionalProperties", "properties"}
},
"properties": {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema["properties"].items()
if k not in {"nested", "nested_list", "nested_dict", "nested_dict_list"}
},
"nested": _PYDANTIC_NESTED_JSON_SCHEMA,
"nested_list": {
"type": "array",
"items": _PYDANTIC_NESTED_JSON_SCHEMA,
},
"nested_dict": {
"type": "object",
"additionalProperties": _PYDANTIC_NESTED_JSON_SCHEMA,
},
"nested_dict_list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": _PYDANTIC_NESTED_JSON_SCHEMA,
},
},
},
"required": [
*NonDictTestMixin.expected_json_schema["required"][:2],
"produced",
*NonDictTestMixin.expected_json_schema["required"][2:],
],
}
def test_get_field_meta_defined_fields(self):
adapter = ItemAdapter(self.item_class())
name_actual = adapter.get_field_meta("name")
name_expected = MappingProxyType(
{
"serializer": str,
"default_factory": name_actual["default_factory"],
}
)
self.assertEqual(name_expected, name_actual)
value_actual = adapter.get_field_meta("value")
value_expected = MappingProxyType(
{
"serializer": int,
"default_factory": value_actual["default_factory"],
}
)
self.assertEqual(value_expected, value_actual)
class PydanticModelTestCase(NonDictTestMixin, unittest.TestCase):
item_class = PydanticModel
item_class_nested = PydanticModelNested
item_class_subclassed = PydanticModelSubclassed
item_class_empty = PydanticModelEmpty
item_class_json_schema = PydanticModelJsonSchema
expected_json_schema = {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema.items()
if k not in {"additionalProperties", "properties"}
},
"properties": {
**{
k: v
for k, v in NonDictTestMixin.expected_json_schema["properties"].items()
if k not in {"nested", "nested_list", "nested_dict", "nested_dict_list"}
},
"nested": _PYDANTIC_NESTED_JSON_SCHEMA,
"nested_list": {
"type": "array",
"items": _PYDANTIC_NESTED_JSON_SCHEMA,
},
"nested_dict": {
"type": "object",
"additionalProperties": _PYDANTIC_NESTED_JSON_SCHEMA,
},
"nested_dict_list": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": _PYDANTIC_NESTED_JSON_SCHEMA,
},
},
},
}
def test_get_field_meta_defined_fields(self):
adapter = ItemAdapter(self.item_class())
self.assertEqual(
adapter.get_field_meta("name")["json_schema_extra"],
MappingProxyType({"serializer": str}),
)
self.assertEqual(
adapter.get_field_meta("value")["json_schema_extra"],
MappingProxyType({"serializer": int}),
)
class DataClassItemTestCase(NonDictTestMixin, unittest.TestCase):
item_class = DataClassItem
item_class_nested = DataClassItemNested
item_class_subclassed = DataClassItemSubclassed
item_class_empty = DataClassItemEmpty
item_class_json_schema = DataClassItemJsonSchema
class AttrsItemTestCase(NonDictTestMixin, unittest.TestCase):
item_class = AttrsItem
item_class_nested = AttrsItemNested
item_class_subclassed = AttrsItemSubclassed
item_class_empty = AttrsItemEmpty
item_class_json_schema = AttrsItemJsonSchema
|