Skip to content

Commit 34df7b6

Browse files
committed
Readme updates
1 parent 9fe18b5 commit 34df7b6

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ does not match the running Browser. If you prefer the `User-Agent` sent by
112112
default by the specific browser you're using, set the Scrapy user agent to `None`.
113113

114114

115-
## Supported settings
115+
## Supported [settings](https://docs.scrapy.org/en/latest/topics/settings.html)
116116

117117
### `PLAYWRIGHT_BROWSER_TYPE`
118118
Type `str`, default `"chromium"`.
@@ -177,8 +177,8 @@ PLAYWRIGHT_MAX_CONTEXTS = 8
177177
### `PLAYWRIGHT_DEFAULT_NAVIGATION_TIMEOUT`
178178
Type `Optional[float]`, default `None`
179179

180-
Timeout to be used when requesting pages by Playwright. If `None` or unset,
181-
the default value will be used (30000 ms at the time of writing this).
180+
Timeout to be used when requesting pages by Playwright, in milliseconds. If
181+
`None` or unset, the default value will be used (30000 ms at the time of writing).
182182
See the docs for [BrowserContext.set_default_navigation_timeout](https://playwright.dev/python/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout).
183183

184184
```python
@@ -268,7 +268,7 @@ only supported when using Scrapy>=2.4. With prior versions, only strings are
268268
supported.
269269

270270

271-
## Supported request meta keys
271+
## Supported [`Request.meta`](https://docs.scrapy.org/en/latest/topics/request-response.html#scrapy.http.Request.meta) keys
272272

273273
### `playwright`
274274
Type `bool`, default `False`
@@ -375,14 +375,14 @@ class AwesomeSpider(scrapy.Spider):
375375
avoid using these methods unless you know exactly what you're doing.
376376

377377
### `playwright_page_methods`
378-
Type `Iterable`, default `()`
378+
Type `Iterable[PageMethod]`, default `()`
379379

380-
An iterable of `scrapy_playwright.page.PageMethod` objects to indicate
381-
actions to be performed on the page before returning the final response.
382-
See [Executing actions on pages](#executing-actions-on-pages).
380+
An iterable of [`scrapy_playwright.page.PageMethod`](#pagemethod-class)
381+
objects to indicate actions to be performed on the page before returning the
382+
final response. See [Executing actions on pages](#executing-actions-on-pages).
383383

384384
### `playwright_page`
385-
Type `Optional[playwright.async_api._generated.Page]`, default `None`
385+
Type `Optional[playwright.async_api.Page]`, default `None`
386386

387387
A [Playwright page](https://playwright.dev/python/docs/api/class-page) to be used to
388388
download the request. If unspecified, a new page is created for each request.
@@ -441,7 +441,8 @@ def parse(self, response):
441441

442442
## Receiving Page objects in callbacks
443443

444-
Specifying a non-False value for the `playwright_include_page` meta key for a
444+
Specifying a value that evaluates to `True` in the
445+
[`playwright_include_page`](#playwright_include_page) meta key for a
445446
request will result in the corresponding `playwright.async_api.Page` object
446447
being available in the `playwright_page` meta key in the request callback.
447448
In order to be able to `await` coroutines on the provided `Page` object,
@@ -564,7 +565,7 @@ that context is used and `playwright_context_kwargs` are ignored.
564565

565566
### Closing a context during a crawl
566567

567-
After [receiving the Page object in your callback](#receiving-the-page-object-in-the-callback),
568+
After [receiving the Page object in your callback](#receiving-page-objects-in-callbacks),
568569
you can access a context though the corresponding [`Page.context`](https://playwright.dev/python/docs/api/class-page#page-context)
569570
attribute, and await [`close`](https://playwright.dev/python/docs/api/class-browsercontext#browser-context-close) on it.
570571

@@ -825,7 +826,7 @@ class ScrollSpider(scrapy.Spider):
825826
```
826827

827828

828-
For more examples, please see the scripts in the [examples](examples) directory.
829+
See the [examples](examples) directory for more.
829830

830831

831832
## Known issues
@@ -858,11 +859,12 @@ scrapy-playwright download handler.
858859

859860
## Reporting issues
860861

861-
Before reporting an issue please try to make sure the problem cannot be
862-
reproduced by using Playwright directly. To do this, translate your spider code
863-
to a reasonably close Playwright script. If the problem still occurs this way,
864-
you should instead report it
865-
[upstream](https://github.com/microsoft/playwright-python). For instance:
862+
Before opening an issue please make sure the unexpected behavior can only be
863+
observed by using this package and not with standalone Playwright. To do this,
864+
translate your spider code to a reasonably close Playwright script: if the
865+
issue also occurs this way, you should instead report it
866+
[upstream](https://github.com/microsoft/playwright-python).
867+
For instance:
866868

867869
```python
868870
import scrapy

0 commit comments

Comments
 (0)