playwright-ruby-client 0.0.4 → 0.0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +120 -6
- data/docs/api_coverage.md +351 -0
- data/lib/playwright.rb +9 -0
- data/lib/playwright/channel_owner.rb +16 -2
- data/lib/playwright/channel_owners/android.rb +10 -1
- data/lib/playwright/channel_owners/android_device.rb +163 -0
- data/lib/playwright/channel_owners/browser.rb +20 -27
- data/lib/playwright/channel_owners/browser_context.rb +51 -0
- data/lib/playwright/channel_owners/console_message.rb +0 -4
- data/lib/playwright/channel_owners/element_handle.rb +306 -0
- data/lib/playwright/channel_owners/frame.rb +473 -7
- data/lib/playwright/channel_owners/js_handle.rb +51 -0
- data/lib/playwright/channel_owners/page.rb +589 -4
- data/lib/playwright/channel_owners/request.rb +98 -0
- data/lib/playwright/channel_owners/webkit_browser.rb +1 -1
- data/lib/playwright/connection.rb +15 -14
- data/lib/playwright/errors.rb +1 -1
- data/lib/playwright/event_emitter.rb +17 -1
- data/lib/playwright/http_headers.rb +20 -0
- data/lib/playwright/input_files.rb +42 -0
- data/lib/playwright/input_type.rb +19 -0
- data/lib/playwright/input_types/android_input.rb +19 -0
- data/lib/playwright/input_types/keyboard.rb +32 -0
- data/lib/playwright/input_types/mouse.rb +4 -0
- data/lib/playwright/input_types/touchscreen.rb +4 -0
- data/lib/playwright/javascript.rb +13 -0
- data/lib/playwright/javascript/expression.rb +67 -0
- data/lib/playwright/javascript/function.rb +67 -0
- data/lib/playwright/javascript/value_parser.rb +75 -0
- data/lib/playwright/javascript/value_serializer.rb +54 -0
- data/lib/playwright/playwright_api.rb +45 -25
- data/lib/playwright/select_option_values.rb +32 -0
- data/lib/playwright/timeout_settings.rb +19 -0
- data/lib/playwright/url_matcher.rb +19 -0
- data/lib/playwright/utils.rb +37 -0
- data/lib/playwright/version.rb +1 -1
- data/lib/playwright/wait_helper.rb +73 -0
- data/lib/playwright_api/accessibility.rb +46 -6
- data/lib/playwright_api/android.rb +33 -0
- data/lib/playwright_api/android_device.rb +78 -0
- data/lib/playwright_api/android_input.rb +25 -0
- data/lib/playwright_api/binding_call.rb +18 -0
- data/lib/playwright_api/browser.rb +93 -12
- data/lib/playwright_api/browser_context.rb +279 -28
- data/lib/playwright_api/browser_type.rb +68 -5
- data/lib/playwright_api/cdp_session.rb +23 -1
- data/lib/playwright_api/chromium_browser_context.rb +26 -0
- data/lib/playwright_api/console_message.rb +20 -7
- data/lib/playwright_api/dialog.rb +48 -2
- data/lib/playwright_api/download.rb +19 -4
- data/lib/playwright_api/element_handle.rb +278 -104
- data/lib/playwright_api/file_chooser.rb +20 -3
- data/lib/playwright_api/frame.rb +452 -147
- data/lib/playwright_api/js_handle.rb +78 -19
- data/lib/playwright_api/keyboard.rb +99 -9
- data/lib/playwright_api/mouse.rb +22 -0
- data/lib/playwright_api/page.rb +864 -222
- data/lib/playwright_api/playwright.rb +116 -14
- data/lib/playwright_api/request.rb +86 -24
- data/lib/playwright_api/response.rb +18 -7
- data/lib/playwright_api/route.rb +49 -0
- data/lib/playwright_api/selectors.rb +28 -2
- data/lib/playwright_api/video.rb +8 -0
- data/lib/playwright_api/web_socket.rb +0 -8
- data/lib/playwright_api/worker.rb +25 -13
- data/playwright.gemspec +3 -0
- metadata +66 -2
@@ -6,18 +6,18 @@ module Playwright
|
|
6
6
|
# Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
|
7
7
|
# have wildly different output.
|
8
8
|
#
|
9
|
-
#
|
10
|
-
# platform-specific APIs. Accessibility namespace gives
|
9
|
+
# Rendering engines of Chromium, Firefox and Webkit have a concept of "accessibility tree", which is then translated into
|
10
|
+
# different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
|
11
11
|
#
|
12
|
-
# Most of the accessibility tree gets filtered out when converting from
|
13
|
-
# assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
|
14
|
-
# "interesting" nodes of the tree.
|
12
|
+
# Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
|
13
|
+
# AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
|
14
|
+
# only the "interesting" nodes of the tree.
|
15
15
|
class Accessibility < PlaywrightApi
|
16
16
|
|
17
17
|
# Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
|
18
18
|
# page.
|
19
19
|
#
|
20
|
-
# >
|
20
|
+
# > NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
|
21
21
|
# Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
|
22
22
|
#
|
23
23
|
# An example of dumping the entire accessibility tree:
|
@@ -28,6 +28,16 @@ module Playwright
|
|
28
28
|
# console.log(snapshot);
|
29
29
|
# ```
|
30
30
|
#
|
31
|
+
# ```python async
|
32
|
+
# snapshot = await page.accessibility.snapshot()
|
33
|
+
# print(snapshot)
|
34
|
+
# ```
|
35
|
+
#
|
36
|
+
# ```python sync
|
37
|
+
# snapshot = page.accessibility.snapshot()
|
38
|
+
# print(snapshot)
|
39
|
+
# ```
|
40
|
+
#
|
31
41
|
# An example of logging the focused node's name:
|
32
42
|
#
|
33
43
|
#
|
@@ -46,6 +56,36 @@ module Playwright
|
|
46
56
|
# return null;
|
47
57
|
# }
|
48
58
|
# ```
|
59
|
+
#
|
60
|
+
# ```python async
|
61
|
+
# def find_focused_node(node):
|
62
|
+
# if (node.get("focused"))
|
63
|
+
# return node
|
64
|
+
# for child in (node.get("children") or []):
|
65
|
+
# found_node = find_focused_node(child)
|
66
|
+
# return found_node
|
67
|
+
# return None
|
68
|
+
#
|
69
|
+
# snapshot = await page.accessibility.snapshot()
|
70
|
+
# node = find_focused_node(snapshot)
|
71
|
+
# if node:
|
72
|
+
# print(node["name"])
|
73
|
+
# ```
|
74
|
+
#
|
75
|
+
# ```python sync
|
76
|
+
# def find_focused_node(node):
|
77
|
+
# if (node.get("focused"))
|
78
|
+
# return node
|
79
|
+
# for child in (node.get("children") or []):
|
80
|
+
# found_node = find_focused_node(child)
|
81
|
+
# return found_node
|
82
|
+
# return None
|
83
|
+
#
|
84
|
+
# snapshot = page.accessibility.snapshot()
|
85
|
+
# node = find_focused_node(snapshot)
|
86
|
+
# if node:
|
87
|
+
# print(node["name"])
|
88
|
+
# ```
|
49
89
|
def snapshot(interestingOnly: nil, root: nil)
|
50
90
|
raise NotImplementedError.new('snapshot is not implemented yet.')
|
51
91
|
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
module Playwright
|
2
|
+
# @nodoc
|
3
|
+
class Android < PlaywrightApi
|
4
|
+
|
5
|
+
# @nodoc
|
6
|
+
def after_initialize
|
7
|
+
wrap_impl(@impl.after_initialize)
|
8
|
+
end
|
9
|
+
|
10
|
+
# @nodoc
|
11
|
+
def devices
|
12
|
+
wrap_impl(@impl.devices)
|
13
|
+
end
|
14
|
+
|
15
|
+
# -- inherited from EventEmitter --
|
16
|
+
# @nodoc
|
17
|
+
def on(event, callback)
|
18
|
+
wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
|
19
|
+
end
|
20
|
+
|
21
|
+
# -- inherited from EventEmitter --
|
22
|
+
# @nodoc
|
23
|
+
def off(event, callback)
|
24
|
+
wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
|
25
|
+
end
|
26
|
+
|
27
|
+
# -- inherited from EventEmitter --
|
28
|
+
# @nodoc
|
29
|
+
def once(event, callback)
|
30
|
+
wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
module Playwright
|
2
|
+
# @nodoc
|
3
|
+
class AndroidDevice < PlaywrightApi
|
4
|
+
|
5
|
+
# @nodoc
|
6
|
+
def tree
|
7
|
+
wrap_impl(@impl.tree)
|
8
|
+
end
|
9
|
+
|
10
|
+
# @nodoc
|
11
|
+
def close
|
12
|
+
wrap_impl(@impl.close)
|
13
|
+
end
|
14
|
+
|
15
|
+
# @nodoc
|
16
|
+
def shell(command)
|
17
|
+
wrap_impl(@impl.shell(unwrap_impl(command)))
|
18
|
+
end
|
19
|
+
|
20
|
+
# @nodoc
|
21
|
+
def after_initialize
|
22
|
+
wrap_impl(@impl.after_initialize)
|
23
|
+
end
|
24
|
+
|
25
|
+
# @nodoc
|
26
|
+
def tap_on(selector, duration: nil, timeout: nil)
|
27
|
+
wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
|
28
|
+
end
|
29
|
+
|
30
|
+
# @nodoc
|
31
|
+
def screenshot(path: nil)
|
32
|
+
wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
|
33
|
+
end
|
34
|
+
|
35
|
+
# @nodoc
|
36
|
+
def input
|
37
|
+
wrap_impl(@impl.input)
|
38
|
+
end
|
39
|
+
|
40
|
+
# @nodoc
|
41
|
+
def launch_browser(pkg: nil, acceptDownloads: nil, bypassCSP: nil, colorScheme: nil, deviceScaleFactor: nil, extraHTTPHeaders: nil, geolocation: nil, hasTouch: nil, httpCredentials: nil, ignoreHTTPSErrors: nil, isMobile: nil, javaScriptEnabled: nil, locale: nil, logger: nil, offline: nil, permissions: nil, proxy: nil, recordHar: nil, recordVideo: nil, storageState: nil, timezoneId: nil, userAgent: nil, videoSize: nil, videosPath: nil, viewport: nil, &block)
|
42
|
+
wrap_impl(@impl.launch_browser(pkg: unwrap_impl(pkg), acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
|
43
|
+
end
|
44
|
+
|
45
|
+
# @nodoc
|
46
|
+
def info(selector)
|
47
|
+
wrap_impl(@impl.info(unwrap_impl(selector)))
|
48
|
+
end
|
49
|
+
|
50
|
+
# @nodoc
|
51
|
+
def serial
|
52
|
+
wrap_impl(@impl.serial)
|
53
|
+
end
|
54
|
+
|
55
|
+
# @nodoc
|
56
|
+
def model
|
57
|
+
wrap_impl(@impl.model)
|
58
|
+
end
|
59
|
+
|
60
|
+
# -- inherited from EventEmitter --
|
61
|
+
# @nodoc
|
62
|
+
def on(event, callback)
|
63
|
+
wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
|
64
|
+
end
|
65
|
+
|
66
|
+
# -- inherited from EventEmitter --
|
67
|
+
# @nodoc
|
68
|
+
def off(event, callback)
|
69
|
+
wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
|
70
|
+
end
|
71
|
+
|
72
|
+
# -- inherited from EventEmitter --
|
73
|
+
# @nodoc
|
74
|
+
def once(event, callback)
|
75
|
+
wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
module Playwright
|
2
|
+
# @nodoc
|
3
|
+
class AndroidInput < PlaywrightApi
|
4
|
+
|
5
|
+
# @nodoc
|
6
|
+
def type(text)
|
7
|
+
wrap_impl(@impl.type(unwrap_impl(text)))
|
8
|
+
end
|
9
|
+
|
10
|
+
# @nodoc
|
11
|
+
def drag(from, to, steps)
|
12
|
+
wrap_impl(@impl.drag(unwrap_impl(from), unwrap_impl(to), unwrap_impl(steps)))
|
13
|
+
end
|
14
|
+
|
15
|
+
# @nodoc
|
16
|
+
def press(key)
|
17
|
+
wrap_impl(@impl.press(unwrap_impl(key)))
|
18
|
+
end
|
19
|
+
|
20
|
+
# @nodoc
|
21
|
+
def tap_point(point)
|
22
|
+
wrap_impl(@impl.tap_point(unwrap_impl(point)))
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -1,5 +1,23 @@
|
|
1
1
|
module Playwright
|
2
2
|
# @nodoc
|
3
3
|
class BindingCall < PlaywrightApi
|
4
|
+
|
5
|
+
# -- inherited from EventEmitter --
|
6
|
+
# @nodoc
|
7
|
+
def on(event, callback)
|
8
|
+
wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
|
9
|
+
end
|
10
|
+
|
11
|
+
# -- inherited from EventEmitter --
|
12
|
+
# @nodoc
|
13
|
+
def off(event, callback)
|
14
|
+
wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
|
15
|
+
end
|
16
|
+
|
17
|
+
# -- inherited from EventEmitter --
|
18
|
+
# @nodoc
|
19
|
+
def once(event, callback)
|
20
|
+
wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
|
21
|
+
end
|
4
22
|
end
|
5
23
|
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
module Playwright
|
2
|
-
# - extends: [EventEmitter]
|
2
|
+
# - extends: [EventEmitter]
|
3
3
|
#
|
4
|
-
# A Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a
|
4
|
+
# A Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a `Page`:
|
5
5
|
#
|
6
6
|
#
|
7
7
|
# ```js
|
@@ -15,8 +15,36 @@ module Playwright
|
|
15
15
|
# })();
|
16
16
|
# ```
|
17
17
|
#
|
18
|
-
#
|
19
|
-
#
|
18
|
+
# ```python async
|
19
|
+
# import asyncio
|
20
|
+
# from playwright.async_api import async_playwright
|
21
|
+
#
|
22
|
+
# async def run(playwright):
|
23
|
+
# firefox = playwright.firefox
|
24
|
+
# browser = await firefox.launch()
|
25
|
+
# page = await browser.new_page()
|
26
|
+
# await page.goto("https://example.com")
|
27
|
+
# await browser.close()
|
28
|
+
#
|
29
|
+
# async def main():
|
30
|
+
# async with async_playwright() as playwright:
|
31
|
+
# await run(playwright)
|
32
|
+
# asyncio.run(main())
|
33
|
+
# ```
|
34
|
+
#
|
35
|
+
# ```python sync
|
36
|
+
# from playwright.sync_api import sync_playwright
|
37
|
+
#
|
38
|
+
# def run(playwright):
|
39
|
+
# firefox = playwright.firefox
|
40
|
+
# browser = firefox.launch()
|
41
|
+
# page = browser.new_page()
|
42
|
+
# page.goto("https://example.com")
|
43
|
+
# browser.close()
|
44
|
+
#
|
45
|
+
# with sync_playwright() as playwright:
|
46
|
+
# run(playwright)
|
47
|
+
# ```
|
20
48
|
class Browser < PlaywrightApi
|
21
49
|
|
22
50
|
# In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any
|
@@ -27,7 +55,7 @@ module Playwright
|
|
27
55
|
#
|
28
56
|
# The `Browser` object itself is considered to be disposed and cannot be used anymore.
|
29
57
|
def close
|
30
|
-
|
58
|
+
wrap_impl(@impl.close)
|
31
59
|
end
|
32
60
|
|
33
61
|
# Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
|
@@ -40,13 +68,27 @@ module Playwright
|
|
40
68
|
# const context = await browser.newContext();
|
41
69
|
# console.log(browser.contexts().length); // prints `1`
|
42
70
|
# ```
|
71
|
+
#
|
72
|
+
# ```python async
|
73
|
+
# browser = await pw.webkit.launch()
|
74
|
+
# print(len(browser.contexts())) # prints `0`
|
75
|
+
# context = await browser.new_context()
|
76
|
+
# print(len(browser.contexts())) # prints `1`
|
77
|
+
# ```
|
78
|
+
#
|
79
|
+
# ```python sync
|
80
|
+
# browser = pw.webkit.launch()
|
81
|
+
# print(len(browser.contexts())) # prints `0`
|
82
|
+
# context = browser.new_context()
|
83
|
+
# print(len(browser.contexts())) # prints `1`
|
84
|
+
# ```
|
43
85
|
def contexts
|
44
|
-
|
86
|
+
wrap_impl(@impl.contexts)
|
45
87
|
end
|
46
88
|
|
47
89
|
# Indicates that the browser is connected.
|
48
90
|
def connected?
|
49
|
-
|
91
|
+
wrap_impl(@impl.connected?)
|
50
92
|
end
|
51
93
|
|
52
94
|
# Creates a new browser context. It won't share cookies/cache with other browser contexts.
|
@@ -62,6 +104,24 @@ module Playwright
|
|
62
104
|
# await page.goto('https://example.com');
|
63
105
|
# })();
|
64
106
|
# ```
|
107
|
+
#
|
108
|
+
# ```python async
|
109
|
+
# browser = await playwright.firefox.launch() # or "chromium" or "webkit".
|
110
|
+
# # create a new incognito browser context.
|
111
|
+
# context = await browser.new_context()
|
112
|
+
# # create a new page in a pristine context.
|
113
|
+
# page = await context.new_page()
|
114
|
+
# await page.goto("https://example.com")
|
115
|
+
# ```
|
116
|
+
#
|
117
|
+
# ```python sync
|
118
|
+
# browser = playwright.firefox.launch() # or "chromium" or "webkit".
|
119
|
+
# # create a new incognito browser context.
|
120
|
+
# context = browser.new_context()
|
121
|
+
# # create a new page in a pristine context.
|
122
|
+
# page = context.new_page()
|
123
|
+
# page.goto("https://example.com")
|
124
|
+
# ```
|
65
125
|
def new_context(
|
66
126
|
acceptDownloads: nil,
|
67
127
|
bypassCSP: nil,
|
@@ -82,12 +142,14 @@ module Playwright
|
|
82
142
|
recordHar: nil,
|
83
143
|
recordVideo: nil,
|
84
144
|
storageState: nil,
|
145
|
+
storageStatePath: nil,
|
85
146
|
timezoneId: nil,
|
86
147
|
userAgent: nil,
|
87
148
|
videoSize: nil,
|
88
149
|
videosPath: nil,
|
89
|
-
viewport: nil
|
90
|
-
|
150
|
+
viewport: nil,
|
151
|
+
&block)
|
152
|
+
wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), storageStatePath: unwrap_impl(storageStatePath), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
|
91
153
|
end
|
92
154
|
|
93
155
|
# Creates a new page in a new browser context. Closing this page will close the context as well.
|
@@ -115,22 +177,41 @@ module Playwright
|
|
115
177
|
recordHar: nil,
|
116
178
|
recordVideo: nil,
|
117
179
|
storageState: nil,
|
180
|
+
storageStatePath: nil,
|
118
181
|
timezoneId: nil,
|
119
182
|
userAgent: nil,
|
120
183
|
videoSize: nil,
|
121
184
|
videosPath: nil,
|
122
185
|
viewport: nil)
|
123
|
-
|
186
|
+
wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), storageStatePath: unwrap_impl(storageStatePath), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport)))
|
124
187
|
end
|
125
188
|
|
126
189
|
# Returns the browser version.
|
127
190
|
def version
|
128
|
-
|
191
|
+
wrap_impl(@impl.version)
|
129
192
|
end
|
130
193
|
|
131
194
|
# @nodoc
|
132
195
|
def after_initialize
|
133
|
-
|
196
|
+
wrap_impl(@impl.after_initialize)
|
197
|
+
end
|
198
|
+
|
199
|
+
# -- inherited from EventEmitter --
|
200
|
+
# @nodoc
|
201
|
+
def on(event, callback)
|
202
|
+
wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
|
203
|
+
end
|
204
|
+
|
205
|
+
# -- inherited from EventEmitter --
|
206
|
+
# @nodoc
|
207
|
+
def off(event, callback)
|
208
|
+
wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
|
209
|
+
end
|
210
|
+
|
211
|
+
# -- inherited from EventEmitter --
|
212
|
+
# @nodoc
|
213
|
+
def once(event, callback)
|
214
|
+
wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
|
134
215
|
end
|
135
216
|
end
|
136
217
|
end
|
@@ -1,5 +1,5 @@
|
|
1
1
|
module Playwright
|
2
|
-
# - extends: [EventEmitter]
|
2
|
+
# - extends: [EventEmitter]
|
3
3
|
#
|
4
4
|
# BrowserContexts provide a way to operate multiple independent browser sessions.
|
5
5
|
#
|
@@ -19,6 +19,26 @@ module Playwright
|
|
19
19
|
# // Dispose context once it's no longer needed.
|
20
20
|
# await context.close();
|
21
21
|
# ```
|
22
|
+
#
|
23
|
+
# ```python async
|
24
|
+
# # create a new incognito browser context
|
25
|
+
# context = await browser.new_context()
|
26
|
+
# # create a new page inside context.
|
27
|
+
# page = await context.new_page()
|
28
|
+
# await page.goto("https://example.com")
|
29
|
+
# # dispose context once it"s no longer needed.
|
30
|
+
# await context.close()
|
31
|
+
# ```
|
32
|
+
#
|
33
|
+
# ```python sync
|
34
|
+
# # create a new incognito browser context
|
35
|
+
# context = browser.new_context()
|
36
|
+
# # create a new page inside context.
|
37
|
+
# page = context.new_page()
|
38
|
+
# page.goto("https://example.com")
|
39
|
+
# # dispose context once it"s no longer needed.
|
40
|
+
# context.close()
|
41
|
+
# ```
|
22
42
|
class BrowserContext < PlaywrightApi
|
23
43
|
|
24
44
|
# Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be
|
@@ -28,6 +48,14 @@ module Playwright
|
|
28
48
|
# ```js
|
29
49
|
# await browserContext.addCookies([cookieObject1, cookieObject2]);
|
30
50
|
# ```
|
51
|
+
#
|
52
|
+
# ```python async
|
53
|
+
# await browser_context.add_cookies([cookie_object1, cookie_object2])
|
54
|
+
# ```
|
55
|
+
#
|
56
|
+
# ```python sync
|
57
|
+
# browser_context.add_cookies([cookie_object1, cookie_object2])
|
58
|
+
# ```
|
31
59
|
def add_cookies(cookies)
|
32
60
|
raise NotImplementedError.new('add_cookies is not implemented yet.')
|
33
61
|
end
|
@@ -43,7 +71,7 @@ module Playwright
|
|
43
71
|
# An example of overriding `Math.random` before the page loads:
|
44
72
|
#
|
45
73
|
#
|
46
|
-
# ```js
|
74
|
+
# ```js browser
|
47
75
|
# // preload.js
|
48
76
|
# Math.random = () => 42;
|
49
77
|
# ```
|
@@ -56,7 +84,17 @@ module Playwright
|
|
56
84
|
# });
|
57
85
|
# ```
|
58
86
|
#
|
59
|
-
#
|
87
|
+
# ```python async
|
88
|
+
# # in your playwright script, assuming the preload.js file is in same directory.
|
89
|
+
# await browser_context.add_init_script(path="preload.js")
|
90
|
+
# ```
|
91
|
+
#
|
92
|
+
# ```python sync
|
93
|
+
# # in your playwright script, assuming the preload.js file is in same directory.
|
94
|
+
# browser_context.add_init_script(path="preload.js")
|
95
|
+
# ```
|
96
|
+
#
|
97
|
+
# > NOTE: The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and
|
60
98
|
# [`method: Page.addInitScript`] is not defined.
|
61
99
|
def add_init_script(script, arg: nil)
|
62
100
|
raise NotImplementedError.new('add_init_script is not implemented yet.')
|
@@ -81,15 +119,29 @@ module Playwright
|
|
81
119
|
# // do stuff ..
|
82
120
|
# context.clearPermissions();
|
83
121
|
# ```
|
122
|
+
#
|
123
|
+
# ```python async
|
124
|
+
# context = await browser.new_context()
|
125
|
+
# await context.grant_permissions(["clipboard-read"])
|
126
|
+
# # do stuff ..
|
127
|
+
# context.clear_permissions()
|
128
|
+
# ```
|
129
|
+
#
|
130
|
+
# ```python sync
|
131
|
+
# context = browser.new_context()
|
132
|
+
# context.grant_permissions(["clipboard-read"])
|
133
|
+
# # do stuff ..
|
134
|
+
# context.clear_permissions()
|
135
|
+
# ```
|
84
136
|
def clear_permissions
|
85
137
|
raise NotImplementedError.new('clear_permissions is not implemented yet.')
|
86
138
|
end
|
87
139
|
|
88
140
|
# Closes the browser context. All the pages that belong to the browser context will be closed.
|
89
141
|
#
|
90
|
-
# >
|
142
|
+
# > NOTE: The default browser context cannot be closed.
|
91
143
|
def close
|
92
|
-
|
144
|
+
wrap_impl(@impl.close)
|
93
145
|
end
|
94
146
|
|
95
147
|
# If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
|
@@ -131,6 +183,57 @@ module Playwright
|
|
131
183
|
# })();
|
132
184
|
# ```
|
133
185
|
#
|
186
|
+
# ```python async
|
187
|
+
# import asyncio
|
188
|
+
# from playwright.async_api import async_playwright
|
189
|
+
#
|
190
|
+
# async def run(playwright):
|
191
|
+
# webkit = playwright.webkit
|
192
|
+
# browser = await webkit.launch(headless=false)
|
193
|
+
# context = await browser.new_context()
|
194
|
+
# await context.expose_binding("pageURL", lambda source: source["page"].url)
|
195
|
+
# page = await context.new_page()
|
196
|
+
# await page.set_content("""
|
197
|
+
# <script>
|
198
|
+
# async function onClick() {
|
199
|
+
# document.querySelector('div').textContent = await window.pageURL();
|
200
|
+
# }
|
201
|
+
# </script>
|
202
|
+
# <button onclick="onClick()">Click me</button>
|
203
|
+
# <div></div>
|
204
|
+
# """)
|
205
|
+
# await page.click("button")
|
206
|
+
#
|
207
|
+
# async def main():
|
208
|
+
# async with async_playwright() as playwright:
|
209
|
+
# await run(playwright)
|
210
|
+
# asyncio.run(main())
|
211
|
+
# ```
|
212
|
+
#
|
213
|
+
# ```python sync
|
214
|
+
# from playwright.sync_api import sync_playwright
|
215
|
+
#
|
216
|
+
# def run(playwright):
|
217
|
+
# webkit = playwright.webkit
|
218
|
+
# browser = webkit.launch(headless=false)
|
219
|
+
# context = browser.new_context()
|
220
|
+
# context.expose_binding("pageURL", lambda source: source["page"].url)
|
221
|
+
# page = context.new_page()
|
222
|
+
# page.set_content("""
|
223
|
+
# <script>
|
224
|
+
# async function onClick() {
|
225
|
+
# document.querySelector('div').textContent = await window.pageURL();
|
226
|
+
# }
|
227
|
+
# </script>
|
228
|
+
# <button onclick="onClick()">Click me</button>
|
229
|
+
# <div></div>
|
230
|
+
# """)
|
231
|
+
# page.click("button")
|
232
|
+
#
|
233
|
+
# with sync_playwright() as playwright:
|
234
|
+
# run(playwright)
|
235
|
+
# ```
|
236
|
+
#
|
134
237
|
# An example of passing an element handle:
|
135
238
|
#
|
136
239
|
#
|
@@ -146,6 +249,34 @@ module Playwright
|
|
146
249
|
# <div>Or click me</div>
|
147
250
|
# `);
|
148
251
|
# ```
|
252
|
+
#
|
253
|
+
# ```python async
|
254
|
+
# async def print(source, element):
|
255
|
+
# print(await element.text_content())
|
256
|
+
#
|
257
|
+
# await context.expose_binding("clicked", print, handle=true)
|
258
|
+
# await page.set_content("""
|
259
|
+
# <script>
|
260
|
+
# document.addEventListener('click', event => window.clicked(event.target));
|
261
|
+
# </script>
|
262
|
+
# <div>Click me</div>
|
263
|
+
# <div>Or click me</div>
|
264
|
+
# """)
|
265
|
+
# ```
|
266
|
+
#
|
267
|
+
# ```python sync
|
268
|
+
# def print(source, element):
|
269
|
+
# print(element.text_content())
|
270
|
+
#
|
271
|
+
# context.expose_binding("clicked", print, handle=true)
|
272
|
+
# page.set_content("""
|
273
|
+
# <script>
|
274
|
+
# document.addEventListener('click', event => window.clicked(event.target));
|
275
|
+
# </script>
|
276
|
+
# <div>Click me</div>
|
277
|
+
# <div>Or click me</div>
|
278
|
+
# """)
|
279
|
+
# ```
|
149
280
|
def expose_binding(name, callback, handle: nil)
|
150
281
|
raise NotImplementedError.new('expose_binding is not implemented yet.')
|
151
282
|
end
|
@@ -181,6 +312,72 @@ module Playwright
|
|
181
312
|
# await page.click('button');
|
182
313
|
# })();
|
183
314
|
# ```
|
315
|
+
#
|
316
|
+
# ```python async
|
317
|
+
# import asyncio
|
318
|
+
# import hashlib
|
319
|
+
# from playwright.async_api import async_playwright
|
320
|
+
#
|
321
|
+
# async def sha1(text):
|
322
|
+
# m = hashlib.sha1()
|
323
|
+
# m.update(bytes(text, "utf8"))
|
324
|
+
# return m.hexdigest()
|
325
|
+
#
|
326
|
+
#
|
327
|
+
# async def run(playwright):
|
328
|
+
# webkit = playwright.webkit
|
329
|
+
# browser = await webkit.launch(headless=False)
|
330
|
+
# context = await browser.new_context()
|
331
|
+
# await context.expose_function("sha1", sha1)
|
332
|
+
# page = await context.new_page()
|
333
|
+
# await page.set_content("""
|
334
|
+
# <script>
|
335
|
+
# async function onClick() {
|
336
|
+
# document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
|
337
|
+
# }
|
338
|
+
# </script>
|
339
|
+
# <button onclick="onClick()">Click me</button>
|
340
|
+
# <div></div>
|
341
|
+
# """)
|
342
|
+
# await page.click("button")
|
343
|
+
#
|
344
|
+
# async def main():
|
345
|
+
# async with async_playwright() as playwright:
|
346
|
+
# await run(playwright)
|
347
|
+
# asyncio.run(main())
|
348
|
+
# ```
|
349
|
+
#
|
350
|
+
# ```python sync
|
351
|
+
# import hashlib
|
352
|
+
# from playwright.sync_api import sync_playwright
|
353
|
+
#
|
354
|
+
# def sha1(text):
|
355
|
+
# m = hashlib.sha1()
|
356
|
+
# m.update(bytes(text, "utf8"))
|
357
|
+
# return m.hexdigest()
|
358
|
+
#
|
359
|
+
#
|
360
|
+
# def run(playwright):
|
361
|
+
# webkit = playwright.webkit
|
362
|
+
# browser = webkit.launch(headless=False)
|
363
|
+
# context = browser.new_context()
|
364
|
+
# context.expose_function("sha1", sha1)
|
365
|
+
# page = context.new_page()
|
366
|
+
# page.expose_function("sha1", sha1)
|
367
|
+
# page.set_content("""
|
368
|
+
# <script>
|
369
|
+
# async function onClick() {
|
370
|
+
# document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
|
371
|
+
# }
|
372
|
+
# </script>
|
373
|
+
# <button onclick="onClick()">Click me</button>
|
374
|
+
# <div></div>
|
375
|
+
# """)
|
376
|
+
# page.click("button")
|
377
|
+
#
|
378
|
+
# with sync_playwright() as playwright:
|
379
|
+
# run(playwright)
|
380
|
+
# ```
|
184
381
|
def expose_function(name, callback)
|
185
382
|
raise NotImplementedError.new('expose_function is not implemented yet.')
|
186
383
|
end
|
@@ -193,13 +390,13 @@ module Playwright
|
|
193
390
|
|
194
391
|
# Creates a new page in the browser context.
|
195
392
|
def new_page
|
196
|
-
|
393
|
+
wrap_impl(@impl.new_page)
|
197
394
|
end
|
198
395
|
|
199
396
|
# Returns all open pages in the context. Non visible pages, such as `"background_page"`, will not be listed here. You can
|
200
397
|
# find them using [`method: ChromiumBrowserContext.backgroundPages`].
|
201
398
|
def pages
|
202
|
-
|
399
|
+
wrap_impl(@impl.pages)
|
203
400
|
end
|
204
401
|
|
205
402
|
# Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
|
@@ -216,6 +413,22 @@ module Playwright
|
|
216
413
|
# await browser.close();
|
217
414
|
# ```
|
218
415
|
#
|
416
|
+
# ```python async
|
417
|
+
# context = await browser.new_context()
|
418
|
+
# page = await context.new_page()
|
419
|
+
# await context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
|
420
|
+
# await page.goto("https://example.com")
|
421
|
+
# await browser.close()
|
422
|
+
# ```
|
423
|
+
#
|
424
|
+
# ```python sync
|
425
|
+
# context = browser.new_context()
|
426
|
+
# page = context.new_page()
|
427
|
+
# context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
|
428
|
+
# page.goto("https://example.com")
|
429
|
+
# browser.close()
|
430
|
+
# ```
|
431
|
+
#
|
219
432
|
# or the same snippet using a regex pattern instead:
|
220
433
|
#
|
221
434
|
#
|
@@ -227,10 +440,29 @@ module Playwright
|
|
227
440
|
# await browser.close();
|
228
441
|
# ```
|
229
442
|
#
|
443
|
+
# ```python async
|
444
|
+
# context = await browser.new_context()
|
445
|
+
# page = await context.new_page()
|
446
|
+
# await context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
|
447
|
+
# page = await context.new_page()
|
448
|
+
# await page.goto("https://example.com")
|
449
|
+
# await browser.close()
|
450
|
+
# ```
|
451
|
+
#
|
452
|
+
# ```python sync
|
453
|
+
# context = browser.new_context()
|
454
|
+
# page = context.new_page()
|
455
|
+
# context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
|
456
|
+
# page = await context.new_page()
|
457
|
+
# page = context.new_page()
|
458
|
+
# page.goto("https://example.com")
|
459
|
+
# browser.close()
|
460
|
+
# ```
|
461
|
+
#
|
230
462
|
# Page routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both
|
231
463
|
# handlers.
|
232
464
|
#
|
233
|
-
# >
|
465
|
+
# > NOTE: Enabling routing disables http cache.
|
234
466
|
def route(url, handler)
|
235
467
|
raise NotImplementedError.new('route is not implemented yet.')
|
236
468
|
end
|
@@ -243,7 +475,7 @@ module Playwright
|
|
243
475
|
# - [`method: Page.setContent`]
|
244
476
|
# - [`method: Page.waitForNavigation`]
|
245
477
|
#
|
246
|
-
# >
|
478
|
+
# > NOTE: [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over
|
247
479
|
# [`method: BrowserContext.setDefaultNavigationTimeout`].
|
248
480
|
def set_default_navigation_timeout(timeout)
|
249
481
|
raise NotImplementedError.new('set_default_navigation_timeout is not implemented yet.')
|
@@ -252,7 +484,7 @@ module Playwright
|
|
252
484
|
|
253
485
|
# This setting will change the default maximum time for all the methods accepting `timeout` option.
|
254
486
|
#
|
255
|
-
# >
|
487
|
+
# > NOTE: [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and
|
256
488
|
# [`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`].
|
257
489
|
def set_default_timeout(timeout)
|
258
490
|
raise NotImplementedError.new('set_default_timeout is not implemented yet.')
|
@@ -263,7 +495,7 @@ module Playwright
|
|
263
495
|
# with page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a particular
|
264
496
|
# header, page-specific header value will be used instead of the browser context header value.
|
265
497
|
#
|
266
|
-
# >
|
498
|
+
# > NOTE: [`method: BrowserContext.setExtraHTTPHeaders`] does not guarantee the order of headers in the outgoing requests.
|
267
499
|
def set_extra_http_headers(headers)
|
268
500
|
raise NotImplementedError.new('set_extra_http_headers is not implemented yet.')
|
269
501
|
end
|
@@ -276,8 +508,16 @@ module Playwright
|
|
276
508
|
# await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
|
277
509
|
# ```
|
278
510
|
#
|
279
|
-
#
|
280
|
-
#
|
511
|
+
# ```python async
|
512
|
+
# await browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
|
513
|
+
# ```
|
514
|
+
#
|
515
|
+
# ```python sync
|
516
|
+
# browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
|
517
|
+
# ```
|
518
|
+
#
|
519
|
+
# > NOTE: Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages to
|
520
|
+
# read its geolocation.
|
281
521
|
def set_geolocation(geolocation)
|
282
522
|
raise NotImplementedError.new('set_geolocation is not implemented yet.')
|
283
523
|
end
|
@@ -305,31 +545,42 @@ module Playwright
|
|
305
545
|
raise NotImplementedError.new('unroute is not implemented yet.')
|
306
546
|
end
|
307
547
|
|
308
|
-
#
|
309
|
-
|
310
|
-
|
311
|
-
#
|
312
|
-
# ```js
|
313
|
-
# const context = await browser.newContext();
|
314
|
-
# await context.grantPermissions(['geolocation']);
|
315
|
-
# ```
|
316
|
-
def wait_for_event(event, optionsOrPredicate: nil)
|
317
|
-
raise NotImplementedError.new('wait_for_event is not implemented yet.')
|
548
|
+
# @nodoc
|
549
|
+
def after_initialize
|
550
|
+
wrap_impl(@impl.after_initialize)
|
318
551
|
end
|
319
552
|
|
320
553
|
# @nodoc
|
321
|
-
def
|
322
|
-
|
554
|
+
def browser=(req)
|
555
|
+
wrap_impl(@impl.browser=(unwrap_impl(req)))
|
323
556
|
end
|
324
557
|
|
325
558
|
# @nodoc
|
326
|
-
def
|
327
|
-
|
559
|
+
def owner_page=(req)
|
560
|
+
wrap_impl(@impl.owner_page=(unwrap_impl(req)))
|
328
561
|
end
|
329
562
|
|
330
563
|
# @nodoc
|
331
564
|
def options=(req)
|
332
|
-
|
565
|
+
wrap_impl(@impl.options=(unwrap_impl(req)))
|
566
|
+
end
|
567
|
+
|
568
|
+
# -- inherited from EventEmitter --
|
569
|
+
# @nodoc
|
570
|
+
def on(event, callback)
|
571
|
+
wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
|
572
|
+
end
|
573
|
+
|
574
|
+
# -- inherited from EventEmitter --
|
575
|
+
# @nodoc
|
576
|
+
def off(event, callback)
|
577
|
+
wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
|
578
|
+
end
|
579
|
+
|
580
|
+
# -- inherited from EventEmitter --
|
581
|
+
# @nodoc
|
582
|
+
def once(event, callback)
|
583
|
+
wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
|
333
584
|
end
|
334
585
|
end
|
335
586
|
end
|