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 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
|
from __future__ import annotations
import dataclasses
import attr
import pytest
from itemadapter import ItemAdapter
from itemloaders.processors import Compose, Identity, MapCompose, TakeFirst
from scrapy.http import HtmlResponse, Response
from scrapy.item import Field, Item
from scrapy.loader import ItemLoader
from scrapy.selector import Selector
# test items
class NameItem(Item):
name = Field()
class SummaryItem(NameItem):
url = Field()
summary = Field()
class NestedItem(Item):
name = Field()
name_div = Field()
name_value = Field()
url = Field()
image = Field()
@attr.s
class AttrsNameItem:
name = attr.ib(default="")
@dataclasses.dataclass
class NameDataClass:
name: list = dataclasses.field(default_factory=list)
# test item loaders
class NameItemLoader(ItemLoader):
default_item_class = SummaryItem
class NestedItemLoader(ItemLoader):
default_item_class = NestedItem
class ProcessorItemLoader(NameItemLoader):
name_in = MapCompose(lambda v: v.title())
class DefaultedItemLoader(NameItemLoader):
default_input_processor = MapCompose(lambda v: v[:-1])
# test processors
def processor_with_args(value, other=None, loader_context=None):
if "key" in loader_context:
return loader_context["key"]
return value
class TestBasicItemLoader:
def test_add_value_on_unknown_field(self):
il = ProcessorItemLoader()
with pytest.raises(KeyError):
il.add_value("wrong_field", ["lala", "lolo"])
def test_load_item_using_default_loader(self):
i = SummaryItem()
i["summary"] = "lala"
il = ItemLoader(item=i)
il.add_value("name", "marta")
item = il.load_item()
assert item is i
assert item["summary"] == ["lala"]
assert item["name"] == ["marta"]
def test_load_item_using_custom_loader(self):
il = ProcessorItemLoader()
il.add_value("name", "marta")
item = il.load_item()
assert item["name"] == ["Marta"]
class InitializationTestMixin:
item_class: type | None = None
def test_keep_single_value(self):
"""Loaded item should contain values from the initial item"""
input_item = self.item_class(name="foo")
il = ItemLoader(item=input_item)
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo"]}
def test_keep_list(self):
"""Loaded item should contain values from the initial item"""
input_item = self.item_class(name=["foo", "bar"])
il = ItemLoader(item=input_item)
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo", "bar"]}
def test_add_value_singlevalue_singlevalue(self):
"""Values added after initialization should be appended"""
input_item = self.item_class(name="foo")
il = ItemLoader(item=input_item)
il.add_value("name", "bar")
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo", "bar"]}
def test_add_value_singlevalue_list(self):
"""Values added after initialization should be appended"""
input_item = self.item_class(name="foo")
il = ItemLoader(item=input_item)
il.add_value("name", ["item", "loader"])
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo", "item", "loader"]}
def test_add_value_list_singlevalue(self):
"""Values added after initialization should be appended"""
input_item = self.item_class(name=["foo", "bar"])
il = ItemLoader(item=input_item)
il.add_value("name", "qwerty")
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo", "bar", "qwerty"]}
def test_add_value_list_list(self):
"""Values added after initialization should be appended"""
input_item = self.item_class(name=["foo", "bar"])
il = ItemLoader(item=input_item)
il.add_value("name", ["item", "loader"])
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {
"name": ["foo", "bar", "item", "loader"]
}
def test_get_output_value_singlevalue(self):
"""Getting output value must not remove value from item"""
input_item = self.item_class(name="foo")
il = ItemLoader(item=input_item)
assert il.get_output_value("name") == ["foo"]
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo"]}
def test_get_output_value_list(self):
"""Getting output value must not remove value from item"""
input_item = self.item_class(name=["foo", "bar"])
il = ItemLoader(item=input_item)
assert il.get_output_value("name") == ["foo", "bar"]
loaded_item = il.load_item()
assert isinstance(loaded_item, self.item_class)
assert ItemAdapter(loaded_item).asdict() == {"name": ["foo", "bar"]}
def test_values_single(self):
"""Values from initial item must be added to loader._values"""
input_item = self.item_class(name="foo")
il = ItemLoader(item=input_item)
assert il._values.get("name") == ["foo"]
def test_values_list(self):
"""Values from initial item must be added to loader._values"""
input_item = self.item_class(name=["foo", "bar"])
il = ItemLoader(item=input_item)
assert il._values.get("name") == ["foo", "bar"]
class TestInitializationFromDict(InitializationTestMixin):
item_class = dict
class TestInitializationFromItem(InitializationTestMixin):
item_class = NameItem
class TestInitializationFromAttrsItem(InitializationTestMixin):
item_class = AttrsNameItem
class TestInitializationFromDataClass(InitializationTestMixin):
item_class = NameDataClass
class BaseNoInputReprocessingLoader(ItemLoader):
title_in = MapCompose(str.upper)
title_out = TakeFirst()
class NoInputReprocessingItem(Item):
title = Field()
class NoInputReprocessingItemLoader(BaseNoInputReprocessingLoader):
default_item_class = NoInputReprocessingItem
class TestNoInputReprocessingFromItem:
"""
Loaders initialized from loaded items must not reprocess fields (Item instances)
"""
def test_avoid_reprocessing_with_initial_values_single(self):
il = NoInputReprocessingItemLoader(item=NoInputReprocessingItem(title="foo"))
il_loaded = il.load_item()
assert il_loaded == {"title": "foo"}
assert NoInputReprocessingItemLoader(item=il_loaded).load_item() == {
"title": "foo"
}
def test_avoid_reprocessing_with_initial_values_list(self):
il = NoInputReprocessingItemLoader(
item=NoInputReprocessingItem(title=["foo", "bar"])
)
il_loaded = il.load_item()
assert il_loaded == {"title": "foo"}
assert NoInputReprocessingItemLoader(item=il_loaded).load_item() == {
"title": "foo"
}
def test_avoid_reprocessing_without_initial_values_single(self):
il = NoInputReprocessingItemLoader()
il.add_value("title", "FOO")
il_loaded = il.load_item()
assert il_loaded == {"title": "FOO"}
assert NoInputReprocessingItemLoader(item=il_loaded).load_item() == {
"title": "FOO"
}
def test_avoid_reprocessing_without_initial_values_list(self):
il = NoInputReprocessingItemLoader()
il.add_value("title", ["foo", "bar"])
il_loaded = il.load_item()
assert il_loaded == {"title": "FOO"}
assert NoInputReprocessingItemLoader(item=il_loaded).load_item() == {
"title": "FOO"
}
class TestOutputProcessorItem:
def test_output_processor(self):
class TempItem(Item):
temp = Field()
def __init__(self, *args, **kwargs):
super().__init__(self, *args, **kwargs)
self.setdefault("temp", 0.3)
class TempLoader(ItemLoader):
default_item_class = TempItem
default_input_processor = Identity()
default_output_processor = Compose(TakeFirst())
loader = TempLoader()
item = loader.load_item()
assert isinstance(item, TempItem)
assert dict(item) == {"temp": 0.3}
class TestSelectortemLoader:
response = HtmlResponse(
url="",
encoding="utf-8",
body=b"""
<html>
<body>
<div id="id">marta</div>
<p>paragraph</p>
<a href="http://www.scrapy.org">homepage</a>
<img src="/images/logo.png" width="244" height="65" alt="Scrapy">
</body>
</html>
""",
)
def test_init_method(self):
l = ProcessorItemLoader()
assert l.selector is None
def test_init_method_errors(self):
l = ProcessorItemLoader()
with pytest.raises(RuntimeError):
l.add_xpath("url", "//a/@href")
with pytest.raises(RuntimeError):
l.replace_xpath("url", "//a/@href")
with pytest.raises(RuntimeError):
l.get_xpath("//a/@href")
with pytest.raises(RuntimeError):
l.add_css("name", "#name::text")
with pytest.raises(RuntimeError):
l.replace_css("name", "#name::text")
with pytest.raises(RuntimeError):
l.get_css("#name::text")
def test_init_method_with_selector(self):
sel = Selector(text="<html><body><div>marta</div></body></html>")
l = ProcessorItemLoader(selector=sel)
assert l.selector is sel
l.add_xpath("name", "//div/text()")
assert l.get_output_value("name") == ["Marta"]
def test_init_method_with_selector_css(self):
sel = Selector(text="<html><body><div>marta</div></body></html>")
l = ProcessorItemLoader(selector=sel)
assert l.selector is sel
l.add_css("name", "div::text")
assert l.get_output_value("name") == ["Marta"]
def test_init_method_with_base_response(self):
"""Selector should be None after initialization"""
response = Response("https://scrapy.org")
l = ProcessorItemLoader(response=response)
assert l.selector is None
def test_init_method_with_response(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_xpath("name", "//div/text()")
assert l.get_output_value("name") == ["Marta"]
def test_init_method_with_response_css(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_css("name", "div::text")
assert l.get_output_value("name") == ["Marta"]
l.add_css("url", "a::attr(href)")
assert l.get_output_value("url") == ["http://www.scrapy.org"]
# combining/accumulating CSS selectors and XPath expressions
l.add_xpath("name", "//div/text()")
assert l.get_output_value("name") == ["Marta", "Marta"]
l.add_xpath("url", "//img/@src")
assert l.get_output_value("url") == [
"http://www.scrapy.org",
"/images/logo.png",
]
def test_add_xpath_re(self):
l = ProcessorItemLoader(response=self.response)
l.add_xpath("name", "//div/text()", re="ma")
assert l.get_output_value("name") == ["Ma"]
def test_replace_xpath(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_xpath("name", "//div/text()")
assert l.get_output_value("name") == ["Marta"]
l.replace_xpath("name", "//p/text()")
assert l.get_output_value("name") == ["Paragraph"]
l.replace_xpath("name", ["//p/text()", "//div/text()"])
assert l.get_output_value("name") == ["Paragraph", "Marta"]
def test_get_xpath(self):
l = ProcessorItemLoader(response=self.response)
assert l.get_xpath("//p/text()") == ["paragraph"]
assert l.get_xpath("//p/text()", TakeFirst()) == "paragraph"
assert l.get_xpath("//p/text()", TakeFirst(), re="pa") == "pa"
assert l.get_xpath(["//p/text()", "//div/text()"]) == ["paragraph", "marta"]
def test_replace_xpath_multi_fields(self):
l = ProcessorItemLoader(response=self.response)
l.add_xpath(None, "//div/text()", TakeFirst(), lambda x: {"name": x})
assert l.get_output_value("name") == ["Marta"]
l.replace_xpath(None, "//p/text()", TakeFirst(), lambda x: {"name": x})
assert l.get_output_value("name") == ["Paragraph"]
def test_replace_xpath_re(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_xpath("name", "//div/text()")
assert l.get_output_value("name") == ["Marta"]
l.replace_xpath("name", "//div/text()", re="ma")
assert l.get_output_value("name") == ["Ma"]
def test_add_css_re(self):
l = ProcessorItemLoader(response=self.response)
l.add_css("name", "div::text", re="ma")
assert l.get_output_value("name") == ["Ma"]
l.add_css("url", "a::attr(href)", re="http://(.+)")
assert l.get_output_value("url") == ["www.scrapy.org"]
def test_replace_css(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_css("name", "div::text")
assert l.get_output_value("name") == ["Marta"]
l.replace_css("name", "p::text")
assert l.get_output_value("name") == ["Paragraph"]
l.replace_css("name", ["p::text", "div::text"])
assert l.get_output_value("name") == ["Paragraph", "Marta"]
l.add_css("url", "a::attr(href)", re="http://(.+)")
assert l.get_output_value("url") == ["www.scrapy.org"]
l.replace_css("url", "img::attr(src)")
assert l.get_output_value("url") == ["/images/logo.png"]
def test_get_css(self):
l = ProcessorItemLoader(response=self.response)
assert l.get_css("p::text") == ["paragraph"]
assert l.get_css("p::text", TakeFirst()) == "paragraph"
assert l.get_css("p::text", TakeFirst(), re="pa") == "pa"
assert l.get_css(["p::text", "div::text"]) == ["paragraph", "marta"]
assert l.get_css(["a::attr(href)", "img::attr(src)"]) == [
"http://www.scrapy.org",
"/images/logo.png",
]
def test_replace_css_multi_fields(self):
l = ProcessorItemLoader(response=self.response)
l.add_css(None, "div::text", TakeFirst(), lambda x: {"name": x})
assert l.get_output_value("name") == ["Marta"]
l.replace_css(None, "p::text", TakeFirst(), lambda x: {"name": x})
assert l.get_output_value("name") == ["Paragraph"]
l.add_css(None, "a::attr(href)", TakeFirst(), lambda x: {"url": x})
assert l.get_output_value("url") == ["http://www.scrapy.org"]
l.replace_css(None, "img::attr(src)", TakeFirst(), lambda x: {"url": x})
assert l.get_output_value("url") == ["/images/logo.png"]
def test_replace_css_re(self):
l = ProcessorItemLoader(response=self.response)
assert l.selector
l.add_css("url", "a::attr(href)")
assert l.get_output_value("url") == ["http://www.scrapy.org"]
l.replace_css("url", "a::attr(href)", re=r"http://www\.(.+)")
assert l.get_output_value("url") == ["scrapy.org"]
class TestSubselectorLoader:
response = HtmlResponse(
url="",
encoding="utf-8",
body=b"""
<html>
<body>
<header>
<div id="id">marta</div>
<p>paragraph</p>
</header>
<footer class="footer">
<a href="http://www.scrapy.org">homepage</a>
<img src="/images/logo.png" width="244" height="65" alt="Scrapy">
</footer>
</body>
</html>
""",
)
def test_nested_xpath(self):
l = NestedItemLoader(response=self.response)
nl = l.nested_xpath("//header")
nl.add_xpath("name", "div/text()")
nl.add_css("name_div", "#id")
nl.add_value("name_value", nl.selector.xpath('div[@id = "id"]/text()').getall())
assert l.get_output_value("name") == ["marta"]
assert l.get_output_value("name_div") == ['<div id="id">marta</div>']
assert l.get_output_value("name_value") == ["marta"]
assert l.get_output_value("name") == nl.get_output_value("name")
assert l.get_output_value("name_div") == nl.get_output_value("name_div")
assert l.get_output_value("name_value") == nl.get_output_value("name_value")
def test_nested_css(self):
l = NestedItemLoader(response=self.response)
nl = l.nested_css("header")
nl.add_xpath("name", "div/text()")
nl.add_css("name_div", "#id")
nl.add_value("name_value", nl.selector.xpath('div[@id = "id"]/text()').getall())
assert l.get_output_value("name") == ["marta"]
assert l.get_output_value("name_div") == ['<div id="id">marta</div>']
assert l.get_output_value("name_value") == ["marta"]
assert l.get_output_value("name") == nl.get_output_value("name")
assert l.get_output_value("name_div") == nl.get_output_value("name_div")
assert l.get_output_value("name_value") == nl.get_output_value("name_value")
def test_nested_replace(self):
l = NestedItemLoader(response=self.response)
nl1 = l.nested_xpath("//footer")
nl2 = nl1.nested_xpath("a")
l.add_xpath("url", "//footer/a/@href")
assert l.get_output_value("url") == ["http://www.scrapy.org"]
nl1.replace_xpath("url", "img/@src")
assert l.get_output_value("url") == ["/images/logo.png"]
nl2.replace_xpath("url", "@href")
assert l.get_output_value("url") == ["http://www.scrapy.org"]
def test_nested_ordering(self):
l = NestedItemLoader(response=self.response)
nl1 = l.nested_xpath("//footer")
nl2 = nl1.nested_xpath("a")
nl1.add_xpath("url", "img/@src")
l.add_xpath("url", "//footer/a/@href")
nl2.add_xpath("url", "text()")
l.add_xpath("url", "//footer/a/@href")
assert l.get_output_value("url") == [
"/images/logo.png",
"http://www.scrapy.org",
"homepage",
"http://www.scrapy.org",
]
def test_nested_load_item(self):
l = NestedItemLoader(response=self.response)
nl1 = l.nested_xpath("//footer")
nl2 = nl1.nested_xpath("img")
l.add_xpath("name", "//header/div/text()")
nl1.add_xpath("url", "a/@href")
nl2.add_xpath("image", "@src")
item = l.load_item()
assert item is l.item
assert item is nl1.item
assert item is nl2.item
assert item["name"] == ["marta"]
assert item["url"] == ["http://www.scrapy.org"]
assert item["image"] == ["/images/logo.png"]
# Functions as processors
def function_processor_strip(iterable):
return [x.strip() for x in iterable]
def function_processor_upper(iterable):
return [x.upper() for x in iterable]
class FunctionProcessorItem(Item):
foo = Field(
input_processor=function_processor_strip,
output_processor=function_processor_upper,
)
class FunctionProcessorItemLoader(ItemLoader):
default_item_class = FunctionProcessorItem
class TestFunctionProcessor:
def test_processor_defined_in_item(self):
lo = FunctionProcessorItemLoader()
lo.add_value("foo", " bar ")
lo.add_value("foo", [" asdf ", " qwerty "])
assert dict(lo.load_item()) == {"foo": ["BAR", "ASDF", "QWERTY"]}
|