Skip to content

Commit cb37b5a

Browse files
committed
deploy: 7bace3d
1 parent 31bf165 commit cb37b5a

File tree

2 files changed

+60
-4
lines changed

2 files changed

+60
-4
lines changed

async_api.html

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5868,6 +5868,7 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
58685868
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
58695869
acceptDownloads: bool = None,
58705870
defaultBrowserType: str = None,
5871+
proxy: ProxyServer = None,
58715872
videosPath: str = None,
58725873
videoSize: IntSize = None,
58735874
recordHar: RecordHarOptions = None,
@@ -5911,6 +5912,8 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
59115912
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
59125913
acceptDownloads : Optional[bool]
59135914
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
5915+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
5916+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
59145917
videosPath : Optional[str]
59155918
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `browserContext.close` for videos to be saved.
59165919
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -5942,6 +5945,7 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
59425945
colorScheme=colorScheme,
59435946
acceptDownloads=acceptDownloads,
59445947
defaultBrowserType=defaultBrowserType,
5948+
proxy=proxy,
59455949
videosPath=videosPath,
59465950
videoSize=videoSize,
59475951
recordHar=recordHar,
@@ -5968,6 +5972,7 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
59685972
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
59695973
acceptDownloads: bool = None,
59705974
defaultBrowserType: str = None,
5975+
proxy: ProxyServer = None,
59715976
videosPath: str = None,
59725977
videoSize: IntSize = None,
59735978
recordHar: RecordHarOptions = None,
@@ -6012,6 +6017,8 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
60126017
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
60136018
acceptDownloads : Optional[bool]
60146019
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
6020+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
6021+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
60156022
videosPath : Optional[str]
60166023
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `page.close` for videos to be saved.
60176024
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -6043,6 +6050,7 @@ <h1 class="title">Module <code>playwright.async_api</code></h1>
60436050
colorScheme=colorScheme,
60446051
acceptDownloads=acceptDownloads,
60456052
defaultBrowserType=defaultBrowserType,
6053+
proxy=proxy,
60466054
videosPath=videosPath,
60476055
videoSize=videoSize,
60486056
recordHar=recordHar,
@@ -6633,6 +6641,7 @@ <h3>Methods</h3>
66336641
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
66346642
acceptDownloads: bool = None,
66356643
defaultBrowserType: str = None,
6644+
proxy: ProxyServer = None,
66366645
videosPath: str = None,
66376646
videoSize: IntSize = None,
66386647
recordHar: RecordHarOptions = None,
@@ -6676,6 +6685,8 @@ <h3>Methods</h3>
66766685
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
66776686
acceptDownloads : Optional[bool]
66786687
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
6688+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
6689+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
66796690
videosPath : Optional[str]
66806691
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `browserContext.close` for videos to be saved.
66816692
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -6707,6 +6718,7 @@ <h3>Methods</h3>
67076718
colorScheme=colorScheme,
67086719
acceptDownloads=acceptDownloads,
67096720
defaultBrowserType=defaultBrowserType,
6721+
proxy=proxy,
67106722
videosPath=videosPath,
67116723
videoSize=videoSize,
67126724
recordHar=recordHar,
@@ -6733,6 +6745,7 @@ <h3>Methods</h3>
67336745
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
67346746
acceptDownloads: bool = None,
67356747
defaultBrowserType: str = None,
6748+
proxy: ProxyServer = None,
67366749
videosPath: str = None,
67376750
videoSize: IntSize = None,
67386751
recordHar: RecordHarOptions = None,
@@ -6777,6 +6790,8 @@ <h3>Methods</h3>
67776790
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
67786791
acceptDownloads : Optional[bool]
67796792
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
6793+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
6794+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
67806795
videosPath : Optional[str]
67816796
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `page.close` for videos to be saved.
67826797
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -6808,6 +6823,7 @@ <h3>Methods</h3>
68086823
colorScheme=colorScheme,
68096824
acceptDownloads=acceptDownloads,
68106825
defaultBrowserType=defaultBrowserType,
6826+
proxy=proxy,
68116827
videosPath=videosPath,
68126828
videoSize=videoSize,
68136829
recordHar=recordHar,
@@ -6937,7 +6953,7 @@ <h2 id="returns">Returns</h2>
69376953
</details>
69386954
</dd>
69396955
<dt id="playwright.async_api.Browser.newContext"><code class="name flex">
6940-
<span>async def <span class="ident">newContext</span></span>(<span>self, viewport: Union[playwright.helper.IntSize, Literal[0]] = None, ignoreHTTPSErrors: bool = None, javaScriptEnabled: bool = None, bypassCSP: bool = None, userAgent: str = None, locale: str = None, timezoneId: str = None, geolocation: playwright.helper.Geolocation = None, permissions: List[str] = None, extraHTTPHeaders: Dict[str, str] = None, offline: bool = None, httpCredentials: playwright.helper.Credentials = None, deviceScaleFactor: int = None, isMobile: bool = None, hasTouch: bool = None, colorScheme: Literal['dark', 'light', 'no-preference'] = None, acceptDownloads: bool = None, defaultBrowserType: str = None, videosPath: str = None, videoSize: playwright.helper.IntSize = None, recordHar: playwright.helper.RecordHarOptions = None) ‑> <a title="playwright.async_api.BrowserContext" href="#playwright.async_api.BrowserContext">BrowserContext</a></span>
6956+
<span>async def <span class="ident">newContext</span></span>(<span>self, viewport: Union[playwright.helper.IntSize, Literal[0]] = None, ignoreHTTPSErrors: bool = None, javaScriptEnabled: bool = None, bypassCSP: bool = None, userAgent: str = None, locale: str = None, timezoneId: str = None, geolocation: playwright.helper.Geolocation = None, permissions: List[str] = None, extraHTTPHeaders: Dict[str, str] = None, offline: bool = None, httpCredentials: playwright.helper.Credentials = None, deviceScaleFactor: int = None, isMobile: bool = None, hasTouch: bool = None, colorScheme: Literal['dark', 'light', 'no-preference'] = None, acceptDownloads: bool = None, defaultBrowserType: str = None, proxy: playwright.helper.ProxyServer = None, videosPath: str = None, videoSize: playwright.helper.IntSize = None, recordHar: playwright.helper.RecordHarOptions = None) ‑> <a title="playwright.async_api.BrowserContext" href="#playwright.async_api.BrowserContext">BrowserContext</a></span>
69416957
</code></dt>
69426958
<dd>
69436959
<div class="desc"><p>Browser.newContext</p>
@@ -6978,6 +6994,8 @@ <h2 id="parameters">Parameters</h2>
69786994
<dd>Emulates <code>'prefers-colors-scheme'</code> media feature, supported values are <code>'light'</code>, <code>'dark'</code>, <code>'no-preference'</code>. See page.emulateMedia(options) for more details. Defaults to '<code>light</code>'.</dd>
69796995
<dt><strong><code>acceptDownloads</code></strong> :&ensp;<code>Optional[bool]</code></dt>
69806996
<dd>Whether to automatically download all the attachments. Defaults to <code>false</code> where all the downloads are canceled.</dd>
6997+
<dt><strong><code>proxy</code></strong> :&ensp;<code>Optional[{"server": str, "bypass": Optional[str], "username": Optional[str], "password": Optional[str]}]</code></dt>
6998+
<dd>Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example <code>launch({ proxy: { server: 'per-proxy' } })</code>.</dd>
69816999
<dt><strong><code>videosPath</code></strong> :&ensp;<code>Optional[str]</code></dt>
69827000
<dd>Enables video recording for all pages to <code>videosPath</code> folder. If not specified, videos are not recorded. Make sure to await <code>browserContext.close</code> for videos to be saved.</dd>
69837001
<dt><strong><code>videoSize</code></strong> :&ensp;<code>Optional[{"width": int, "height": int}]</code></dt>
@@ -7014,6 +7032,7 @@ <h2 id="returns">Returns</h2>
70147032
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
70157033
acceptDownloads: bool = None,
70167034
defaultBrowserType: str = None,
7035+
proxy: ProxyServer = None,
70177036
videosPath: str = None,
70187037
videoSize: IntSize = None,
70197038
recordHar: RecordHarOptions = None,
@@ -7057,6 +7076,8 @@ <h2 id="returns">Returns</h2>
70577076
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
70587077
acceptDownloads : Optional[bool]
70597078
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
7079+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
7080+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
70607081
videosPath : Optional[str]
70617082
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `browserContext.close` for videos to be saved.
70627083
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -7088,6 +7109,7 @@ <h2 id="returns">Returns</h2>
70887109
colorScheme=colorScheme,
70897110
acceptDownloads=acceptDownloads,
70907111
defaultBrowserType=defaultBrowserType,
7112+
proxy=proxy,
70917113
videosPath=videosPath,
70927114
videoSize=videoSize,
70937115
recordHar=recordHar,
@@ -7096,7 +7118,7 @@ <h2 id="returns">Returns</h2>
70967118
</details>
70977119
</dd>
70987120
<dt id="playwright.async_api.Browser.newPage"><code class="name flex">
7099-
<span>async def <span class="ident">newPage</span></span>(<span>self, viewport: Union[playwright.helper.IntSize, Literal[0]] = None, ignoreHTTPSErrors: bool = None, javaScriptEnabled: bool = None, bypassCSP: bool = None, userAgent: str = None, locale: str = None, timezoneId: str = None, geolocation: playwright.helper.Geolocation = None, permissions: List[str] = None, extraHTTPHeaders: Dict[str, str] = None, offline: bool = None, httpCredentials: playwright.helper.Credentials = None, deviceScaleFactor: int = None, isMobile: bool = None, hasTouch: bool = None, colorScheme: Literal['dark', 'light', 'no-preference'] = None, acceptDownloads: bool = None, defaultBrowserType: str = None, videosPath: str = None, videoSize: playwright.helper.IntSize = None, recordHar: playwright.helper.RecordHarOptions = None) ‑> <a title="playwright.async_api.Page" href="#playwright.async_api.Page">Page</a></span>
7121+
<span>async def <span class="ident">newPage</span></span>(<span>self, viewport: Union[playwright.helper.IntSize, Literal[0]] = None, ignoreHTTPSErrors: bool = None, javaScriptEnabled: bool = None, bypassCSP: bool = None, userAgent: str = None, locale: str = None, timezoneId: str = None, geolocation: playwright.helper.Geolocation = None, permissions: List[str] = None, extraHTTPHeaders: Dict[str, str] = None, offline: bool = None, httpCredentials: playwright.helper.Credentials = None, deviceScaleFactor: int = None, isMobile: bool = None, hasTouch: bool = None, colorScheme: Literal['dark', 'light', 'no-preference'] = None, acceptDownloads: bool = None, defaultBrowserType: str = None, proxy: playwright.helper.ProxyServer = None, videosPath: str = None, videoSize: playwright.helper.IntSize = None, recordHar: playwright.helper.RecordHarOptions = None) ‑> <a title="playwright.async_api.Page" href="#playwright.async_api.Page">Page</a></span>
71007122
</code></dt>
71017123
<dd>
71027124
<div class="desc"><p>Browser.newPage</p>
@@ -7138,6 +7160,8 @@ <h2 id="parameters">Parameters</h2>
71387160
<dd>Emulates <code>'prefers-colors-scheme'</code> media feature, supported values are <code>'light'</code>, <code>'dark'</code>, <code>'no-preference'</code>. See page.emulateMedia(options) for more details. Defaults to '<code>light</code>'.</dd>
71397161
<dt><strong><code>acceptDownloads</code></strong> :&ensp;<code>Optional[bool]</code></dt>
71407162
<dd>Whether to automatically download all the attachments. Defaults to <code>false</code> where all the downloads are canceled.</dd>
7163+
<dt><strong><code>proxy</code></strong> :&ensp;<code>Optional[{"server": str, "bypass": Optional[str], "username": Optional[str], "password": Optional[str]}]</code></dt>
7164+
<dd>Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example <code>launch({ proxy: { server: 'per-proxy' } })</code>.</dd>
71417165
<dt><strong><code>videosPath</code></strong> :&ensp;<code>Optional[str]</code></dt>
71427166
<dd>Enables video recording for all pages to <code>videosPath</code> folder. If not specified, videos are not recorded. Make sure to await <code>page.close</code> for videos to be saved.</dd>
71437167
<dt><strong><code>videoSize</code></strong> :&ensp;<code>Optional[{"width": int, "height": int}]</code></dt>
@@ -7174,6 +7198,7 @@ <h2 id="returns">Returns</h2>
71747198
colorScheme: Literal[&#34;dark&#34;, &#34;light&#34;, &#34;no-preference&#34;] = None,
71757199
acceptDownloads: bool = None,
71767200
defaultBrowserType: str = None,
7201+
proxy: ProxyServer = None,
71777202
videosPath: str = None,
71787203
videoSize: IntSize = None,
71797204
recordHar: RecordHarOptions = None,
@@ -7218,6 +7243,8 @@ <h2 id="returns">Returns</h2>
72187243
Emulates `&#39;prefers-colors-scheme&#39;` media feature, supported values are `&#39;light&#39;`, `&#39;dark&#39;`, `&#39;no-preference&#39;`. See page.emulateMedia(options) for more details. Defaults to &#39;`light`&#39;.
72197244
acceptDownloads : Optional[bool]
72207245
Whether to automatically download all the attachments. Defaults to `false` where all the downloads are canceled.
7246+
proxy : Optional[{&#34;server&#34;: str, &#34;bypass&#34;: Optional[str], &#34;username&#34;: Optional[str], &#34;password&#34;: Optional[str]}]
7247+
Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example `launch({ proxy: { server: &#39;per-proxy&#39; } })`.
72217248
videosPath : Optional[str]
72227249
Enables video recording for all pages to `videosPath` folder. If not specified, videos are not recorded. Make sure to await `page.close` for videos to be saved.
72237250
videoSize : Optional[{&#34;width&#34;: int, &#34;height&#34;: int}]
@@ -7249,6 +7276,7 @@ <h2 id="returns">Returns</h2>
72497276
colorScheme=colorScheme,
72507277
acceptDownloads=acceptDownloads,
72517278
defaultBrowserType=defaultBrowserType,
7279+
proxy=proxy,
72527280
videosPath=videosPath,
72537281
videoSize=videoSize,
72547282
recordHar=recordHar,

0 commit comments

Comments
 (0)