web-poet
Getting started
Overview
Installation
Tutorial
From the ground up
Writing page objects
Page objects
Inputs
Items
Rules
Fields
Additional requests
Input validation
Using page params
Stats
Tests for page objects
Frameworks
Writing frameworks
Framework specification
Rules
Additional requests
Retries
Frameworks
Reference
API reference
Contributing
Changelog
License
web-poet
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
|
X
A
add_rule() (web_poet.rules.RulesRegistry method)
AnnotatedInstance (class in web_poet)
annotation_decode() (in module web_poet)
annotation_encode() (in module web_poet)
AnyResponse (class in web_poet.page_inputs.response)
ApplyRule (class in web_poet.rules)
as_list() (in module web_poet.utils)
B
base_url (web_poet.mixins.ResponseShortcutsMixin property)
(web_poet.pages.BrowserPage property)
(web_poet.pages.WebPage property)
batch_execute() (web_poet.page_inputs.client.HttpClient method)
body (web_poet.page_inputs.http.HttpRequest attribute)
(web_poet.page_inputs.http.HttpResponse attribute)
bom_encoding() (web_poet.page_inputs.http.HttpResponseBody method)
BrowserHtml (class in web_poet.page_inputs.browser)
BrowserPage (class in web_poet.pages)
BrowserResponse (class in web_poet.page_inputs.browser)
C
cached_method() (in module web_poet.utils)
consume_modules() (in module web_poet.rules)
css() (web_poet.mixins.ResponseShortcutsMixin method)
(web_poet.mixins.SelectableMixin method)
(web_poet.page_inputs.browser.BrowserHtml method)
(web_poet.page_inputs.browser.BrowserResponse method)
(web_poet.page_inputs.http.HttpResponse method)
(web_poet.page_inputs.response.AnyResponse method)
(web_poet.pages.BrowserPage method)
(web_poet.pages.WebPage method)
D
declared_encoding() (web_poet.page_inputs.http.HttpResponseBody method)
(web_poet.page_inputs.http.HttpResponseHeaders method)
DummyStatCollector (class in web_poet.page_inputs.stats)
E
encoding (web_poet.page_inputs.http.HttpResponse property)
ensure_awaitable() (in module web_poet.utils)
execute() (web_poet.page_inputs.client.HttpClient method)
Extractor (class in web_poet.pages)
F
field() (in module web_poet.fields)
FieldInfo (class in web_poet.fields)
FieldsMixin (class in web_poet.fields)
from_bytes_dict() (web_poet.page_inputs.http.HttpRequestHeaders class method)
(web_poet.page_inputs.http.HttpResponseHeaders class method)
from_name_value_pairs() (web_poet.page_inputs.http.HttpRequestHeaders class method)
(web_poet.page_inputs.http.HttpResponseHeaders class method)
G
get() (web_poet.page_inputs.client.HttpClient method)
get_fields_dict() (in module web_poet.fields)
get_fq_class_name() (in module web_poet.utils)
get_generic_param() (in module web_poet.utils)
get_item() (in module web_poet.example)
get_rules() (web_poet.rules.RulesRegistry method)
get_saved_responses() (web_poet.page_inputs.client.HttpClient method)
H
handle_urls() (web_poet.rules.RulesRegistry method)
headers (web_poet.page_inputs.http.HttpRequest attribute)
(web_poet.page_inputs.http.HttpResponse attribute)
html (web_poet.mixins.ResponseShortcutsMixin property)
(web_poet.page_inputs.browser.BrowserResponse attribute)
(web_poet.pages.BrowserPage property)
(web_poet.pages.WebPage property)
HttpClient (class in web_poet.page_inputs.client)
HttpError
HttpRequest (class in web_poet.page_inputs.http)
HttpRequestBody (class in web_poet.page_inputs.http)
HttpRequestError
HttpRequestHeaders (class in web_poet.page_inputs.http)
HttpResponse (class in web_poet.page_inputs.http)
HttpResponseBody (class in web_poet.page_inputs.http)
HttpResponseError
HttpResponseHeaders (class in web_poet.page_inputs.http)
I
inc() (web_poet.page_inputs.stats.DummyStatCollector method)
(web_poet.page_inputs.stats.StatCollector method)
(web_poet.page_inputs.stats.Stats method)
Injectable (class in web_poet.pages)
is_injectable() (in module web_poet.pages)
item_cls (web_poet.pages.BrowserPage property)
(web_poet.pages.Returns property)
(web_poet.pages.WebPage property)
item_from_fields() (in module web_poet.fields)
item_from_fields_sync() (in module web_poet.fields)
ItemPage (class in web_poet.pages)
J
jmespath() (web_poet.mixins.ResponseShortcutsMixin method)
(web_poet.mixins.SelectableMixin method)
(web_poet.page_inputs.browser.BrowserHtml method)
(web_poet.page_inputs.browser.BrowserResponse method)
(web_poet.page_inputs.http.HttpResponse method)
(web_poet.page_inputs.response.AnyResponse method)
(web_poet.pages.BrowserPage method)
(web_poet.pages.WebPage method)
json() (web_poet.page_inputs.http.HttpResponse method)
(web_poet.page_inputs.http.HttpResponseBody method)
M
memoizemethod_noargs() (in module web_poet.utils)
meta (web_poet.fields.FieldInfo attribute)
method (web_poet.page_inputs.http.HttpRequest attribute)
module
web_poet.example
web_poet.exceptions.core
web_poet.exceptions.http
web_poet.fields
web_poet.mixins
web_poet.page_inputs
web_poet.page_inputs.browser
web_poet.page_inputs.client
web_poet.page_inputs.http
web_poet.page_inputs.page_params
web_poet.page_inputs.response
web_poet.page_inputs.stats
web_poet.pages
web_poet.requests
web_poet.rules
web_poet.utils
N
name (web_poet.fields.FieldInfo attribute)
NoSavedHttpResponse
O
out (web_poet.fields.FieldInfo attribute)
overrides_for() (web_poet.rules.RulesRegistry method)
P
page_cls_for_item() (web_poet.rules.RulesRegistry method)
PageObjectAction
,
[1]
PageParams (class in web_poet.page_inputs.page_params)
post() (web_poet.page_inputs.client.HttpClient method)
R
request (web_poet.exceptions.http.HttpError attribute)
request() (web_poet.page_inputs.client.HttpClient method)
request_fingerprint() (in module web_poet.page_inputs.http)
RequestDownloaderT (in module web_poet.requests)
RequestDownloaderVarError
response (web_poet.exceptions.http.HttpResponseError attribute)
(web_poet.page_inputs.response.AnyResponse attribute)
(web_poet.pages.BrowserPage attribute)
(web_poet.pages.WebPage attribute)
ResponseShortcutsMixin (class in web_poet.mixins)
Retry
,
[1]
Returns (class in web_poet.pages)
RulesRegistry (class in web_poet.rules)
S
search() (web_poet.rules.RulesRegistry method)
SelectableMixin (class in web_poet.mixins)
selector (web_poet.mixins.ResponseShortcutsMixin property)
(web_poet.mixins.SelectableMixin property)
(web_poet.page_inputs.browser.BrowserHtml property)
(web_poet.page_inputs.browser.BrowserResponse property)
(web_poet.page_inputs.http.HttpResponse property)
(web_poet.page_inputs.response.AnyResponse property)
(web_poet.pages.BrowserPage property)
(web_poet.pages.WebPage property)
SelectorExtractor (class in web_poet.pages)
set() (web_poet.page_inputs.stats.DummyStatCollector method)
(web_poet.page_inputs.stats.StatCollector method)
(web_poet.page_inputs.stats.Stats method)
StatCollector (class in web_poet.page_inputs.stats)
Stats (class in web_poet.page_inputs.stats)
status (web_poet.page_inputs.browser.BrowserResponse attribute)
(web_poet.page_inputs.http.HttpResponse attribute)
(web_poet.page_inputs.response.AnyResponse property)
T
text (web_poet.page_inputs.browser.BrowserResponse property)
(web_poet.page_inputs.http.HttpResponse property)
(web_poet.page_inputs.response.AnyResponse property)
to_item() (web_poet.pages.BrowserPage method)
(web_poet.pages.Extractor method)
(web_poet.pages.ItemPage method)
(web_poet.pages.WebPage method)
top_rules_for_item() (web_poet.rules.RulesRegistry method)
U
url (web_poet.mixins.ResponseShortcutsMixin property)
(web_poet.page_inputs.browser.BrowserResponse attribute)
(web_poet.page_inputs.http.HttpRequest attribute)
(web_poet.page_inputs.http.HttpResponse attribute)
(web_poet.page_inputs.response.AnyResponse property)
(web_poet.pages.BrowserPage property)
(web_poet.pages.WebPage property)
urljoin() (web_poet.mixins.ResponseShortcutsMixin method)
(web_poet.page_inputs.browser.BrowserResponse method)
(web_poet.page_inputs.http.HttpRequest method)
(web_poet.page_inputs.http.HttpResponse method)
(web_poet.page_inputs.response.AnyResponse method)
(web_poet.pages.BrowserPage method)
(web_poet.pages.WebPage method)
UseFallback
,
[1]
W
web_poet.default_registry (in module web_poet.exceptions.http)
web_poet.example
module
web_poet.exceptions.core
module
web_poet.exceptions.http
module
web_poet.fields
module
web_poet.handle_urls() (in module web_poet.exceptions.http)
web_poet.mixins
module
web_poet.page_inputs
module
web_poet.page_inputs.browser
module
web_poet.page_inputs.client
module
web_poet.page_inputs.http
module
web_poet.page_inputs.page_params
module
web_poet.page_inputs.response
module
web_poet.page_inputs.stats
module
web_poet.pages
module
web_poet.requests
module
web_poet.rules
module
web_poet.utils
module
WebPage (class in web_poet.pages)
X
xpath() (web_poet.mixins.ResponseShortcutsMixin method)
(web_poet.mixins.SelectableMixin method)
(web_poet.page_inputs.browser.BrowserHtml method)
(web_poet.page_inputs.browser.BrowserResponse method)
(web_poet.page_inputs.http.HttpResponse method)
(web_poet.page_inputs.response.AnyResponse method)
(web_poet.pages.BrowserPage method)
(web_poet.pages.WebPage method)