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
|
from __future__ import annotations
from typing import Generic, Optional, TypeVar
import attrs
import pytest
from web_poet import BrowserResponse, HttpResponse, PageParams, field
from web_poet.pages import (
BrowserPage,
Injectable,
ItemPage,
ItemT,
Returns,
SelectorExtractor,
WebPage,
is_injectable,
)
@attrs.define
class Item:
name: str
def test_page_object() -> None:
class MyItemPage(Injectable):
def to_item(self) -> dict:
return {
"foo": "bar",
}
page_object = MyItemPage()
assert page_object.to_item() == {
"foo": "bar",
}
def test_web_page_object(book_list_html_response) -> None:
class MyWebPage(WebPage):
def to_item(self) -> dict: # type: ignore[override]
return {
"url": self.url,
"title": self.css("title::text").get("").strip(),
}
page_object = MyWebPage(book_list_html_response)
assert page_object.to_item() == {
"url": "http://books.toscrape.com/index.html",
"title": "All products | Books to Scrape - Sandbox",
}
def test_is_injectable() -> None:
class MyClass:
pass
class MyItemPage(ItemPage):
def to_item(self) -> dict: # type: ignore[override]
return {
"foo": "bar",
}
from collections.abc import Set as CollectionsSet # noqa: PYI025,PLC0415
from typing import Set as TypingSet # noqa: UP035,PLC0415
assert is_injectable(None) is False
assert is_injectable(type(None)) is False
assert is_injectable(set) is False
assert is_injectable(set[str]) is False
assert is_injectable(TypingSet[str]) is False # noqa: UP006
assert is_injectable(CollectionsSet[str]) is False
assert is_injectable(Optional[str]) is False # noqa: UP045
assert is_injectable(str | None) is False
assert is_injectable(MyClass) is False
assert is_injectable(MyClass()) is False
assert is_injectable(MyItemPage) is True
assert is_injectable(MyItemPage()) is False
assert is_injectable(ItemPage) is True
@pytest.mark.asyncio
async def test_item_page_typed() -> None:
class MyPage(ItemPage[Item]):
@field
def name(self):
return "name"
page = MyPage()
assert page.item_cls is Item
item = await page.to_item()
assert isinstance(item, Item)
assert item == Item(name="name")
@pytest.mark.asyncio
async def test_web_page_fields() -> None:
class MyPage(WebPage[Item]):
@field
def name(self):
return "name"
page = MyPage(HttpResponse(url="http://example.com", body=b""))
assert page.item_cls is Item
item = await page.to_item()
assert isinstance(item, Item)
assert item == Item(name="name")
def test_web_page_with_browser_response() -> None:
"""Test that BrowserPage works with BrowserResponse.
BrowserResponse has .html instead of .text, so we use BrowserPage
which is designed for BrowserResponse.
"""
html = """
<html>
<head><title>Test Page</title></head>
<body>
<a href="/page1">Link 1</a>
<a href="/page2">Link 2</a>
</body>
</html>
"""
browser_response = BrowserResponse(url="https://example.org", html=html, status=200)
class MyPage(BrowserPage[dict]):
def to_item(self) -> dict: # type: ignore[override]
return {
"url": self.url,
"title": self.css("title::text").get("").strip(),
"links": self.css("a::attr(href)").getall(),
}
page = MyPage(response=browser_response)
# These should work without AttributeError
assert page.url == "https://example.org"
assert page.css("title::text").get() == "Test Page"
assert page.xpath("//a/@href").getall() == ["/page1", "/page2"]
# Test to_item works correctly
item = page.to_item()
assert item["url"] == "https://example.org"
assert item["title"] == "Test Page"
assert item["links"] == ["/page1", "/page2"]
@pytest.mark.asyncio
async def test_item_page_typed_subclass() -> None:
class BasePage(ItemPage[ItemT]):
@field
def name(self):
return "name"
class Subclass(BasePage[Item]):
pass
page: BasePage = BasePage()
assert page.item_cls is dict
assert (await page.to_item()) == {"name": "name"}
page2: Subclass = Subclass()
assert page2.item_cls is Item
assert (await page2.to_item()) == Item(name="name")
@pytest.mark.asyncio
async def test_item_page_fields_typo() -> None:
class MyPage(ItemPage[Item]):
@field
def nane(self):
return "name"
page = MyPage()
assert page.item_cls is Item
with pytest.raises(TypeError, match="unexpected keyword argument 'nane'"):
await page.to_item()
@pytest.mark.asyncio
async def test_item_page_required_field_missing() -> None:
@attrs.define
class MyItem:
name: str
price: float | None
class MyPage(ItemPage[MyItem]):
@field
def price(self):
return 100
page = MyPage()
assert page.item_cls is MyItem
with pytest.raises(
TypeError, match="missing 1 required positional argument: 'name'"
):
await page.to_item()
@pytest.mark.asyncio
async def test_item_page_change_item_type_extra_fields() -> None:
class BasePage(ItemPage[Item]):
@field
def name(self):
return "hello"
@attrs.define
class MyItem(Item):
price: float
class Subclass(BasePage, Returns[MyItem]):
@field
def price(self):
return 123
page = Subclass()
assert page.item_cls is MyItem
item = await page.to_item()
assert isinstance(item, MyItem)
assert item == MyItem(name="hello", price=123)
@pytest.mark.asyncio
async def test_item_page_change_item_type_remove_fields() -> None:
@attrs.define
class MyItem:
name: str
price: float
class BasePage(ItemPage[MyItem]):
@field
def name(self):
return "hello"
@field
def price(self):
return 123
# Item only contains "name", but not "price"
class Subclass(BasePage, Returns[Item], skip_nonitem_fields=True):
pass
# Same as above but a slotted attrs class with dependency.
# See: https://github.com/scrapinghub/web-poet/issues/141
@attrs.define
class SubclassWithDep(BasePage, Returns[Item], skip_nonitem_fields=True):
params: PageParams
# Check if flicking skip_nonitem_fields to False in the subclass works
@attrs.define
class SubclassSkipFalse(SubclassWithDep, Returns[Item], skip_nonitem_fields=False):
pass
for page in [Subclass(), SubclassWithDep(params=PageParams())]:
assert page.item_cls is Item
item = await page.to_item()
assert isinstance(item, Item)
assert item == Item(name="hello")
page = SubclassSkipFalse(params=PageParams())
assert page.item_cls is Item
with pytest.raises(TypeError, match="unexpected keyword argument 'price'"):
await page.to_item()
# Item only contains "name", but not "price", but "price" should be passed
class SubclassStrict(BasePage, Returns[Item]):
pass
page2 = SubclassStrict()
assert page2.item_cls is Item
with pytest.raises(TypeError, match="unexpected keyword argument 'price'"):
await page2.to_item()
def test_returns_inheritance() -> None:
@attrs.define
class MyItem:
name: str
class BasePage(ItemPage[MyItem]):
@field
def name(self):
return "hello"
MetadataT = TypeVar("MetadataT")
class HasMetadata(Generic[MetadataT]):
pass
class DummyMetadata:
pass
class Page(BasePage, HasMetadata[DummyMetadata]):
pass
page = Page()
assert page.item_cls is MyItem
@pytest.mark.asyncio
async def test_extractor(book_list_html_response) -> None:
@attrs.define
class BookItem:
name: str
price: str
@attrs.define
class ListItem:
books: list[BookItem]
@attrs.define
class MyPage(ItemPage[ListItem]):
response: HttpResponse
@field
async def books(self):
books = []
for book in self.response.css("article"):
item = await BookExtractor(book).to_item()
books.append(item)
return books
class BookExtractor(SelectorExtractor[BookItem]):
@field(out=[str.lower])
def name(self):
return self.css("img.thumbnail::attr(alt)").get()
@field
def price(self):
return self.xpath(".//p[@class='price_color']/text()").get()
page = MyPage(book_list_html_response)
item = await page.to_item()
assert len(item.books) == 20
assert item.books[0].name == "a light in the attic"
assert item.books[0].price == "£51.77"
|
