playwright-ruby-client 1.38.0 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 421d718c0a7b5e649fe2632e9f193ef66722149f63a52ba0c1baa63252a0b99d
-  data.tar.gz: 0fb410e0d38bff1cd589afa3499ac3938c1897220be2a7c9ebcf7bddfa4c157c
+  metadata.gz: a0dedf5c9cce96afd64ad16c45baed1b2c1fe37bb9b2632a741d8b75640bf2ae
+  data.tar.gz: 5f056dc5acd7bd5860c3ccaee1d7e5460923e9eb2a985c41ec1e36c8d8c91b7a
 SHA512:
-  metadata.gz: da207f741063627b79efb045adff0af67c935926f30cc5086da9fcf2ccf80555c2f449dc57b2cd953d939c0117ed4f6050c93c8ad35a3d9e654b0141d75e1c53
-  data.tar.gz: eac5d5f995949b5e6e925016e2f0ab3ad4dd6c92766e8204023fa84f1a2b50d157659f9bdbb1fcac6500fae64752632b3ed3dfcd6fb042c07706f3ce30c00b48
+  metadata.gz: 82629797b234ab08abe2c9258605d0d7826eeaf3f4f70274e3f1ced8a5b41560ee1832f7ae98522ce7dfe1a826bd5058c88e9aba7f6d507d16bfa20d20206cea
+  data.tar.gz: '0027783e79287ba14021438154229a4de61c041c983a9f6fa582d533524df395bfb9cfaedbabf9e3d6be015a2ebed9a1fa03674bd86965f693bbd12bae9c67ce'

data/documentation/docs/api/browser.md

@@ -8,15 +8,19 @@ sidebar_position: 10
 
 A Browser is created via [BrowserType#launch](./browser_type#launch). An example of using a [Browser](./browser) to create a [Page](./page):
 
-```ruby
-firefox = playwright.firefox
-browser = firefox.launch
-begin
-  page = browser.new_page
-  page.goto("https://example.com")
-ensure
-  browser.close
-end
+```python sync title=example_5d31815545511b1d8ce5dfce5b153cb5ea46a1868cee95eb211d77f33026788b.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    firefox = playwright.firefox
+    browser = firefox.launch()
+    page = browser.new_page()
+    page.goto("https://example.com")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 ## browser_type

data/documentation/docs/api/browser_context.md

@@ -158,21 +158,29 @@ See [Page#expose_binding](./page#expose_binding) for page-only version.
 
 An example of exposing page URL to all frames in all pages in the context:
 
-```ruby
-browser_context.expose_binding("pageURL", ->(source) { source[:page].url })
-page = browser_context.new_page
-
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.pageURL();
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
+```python sync title=example_a450852d36dda88564582371af8d87bb58b1a517aac4fa60b7a58a0e41c5ceff.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=false)
+    context = browser.new_context()
+    context.expose_binding("pageURL", lambda source: source["page"].url)
+    page = context.new_page()
+    page.set_content("""
+    <script>
+      async function onClick() {
+        document.querySelector('div').textContent = await window.pageURL();
+      }
+    </script>
+    <button onclick="onClick()">Click me</button>
+    <div></div>
+    """)
+    page.get_by_role("button").click()
+
+with sync_playwright() as playwright:
+    run(playwright)
 
-page.get_by_role("button").click
 ```
 
 An example of passing an element handle:
@@ -217,25 +225,36 @@ See [Page#expose_function](./page#expose_function) for page-only version.
 
 An example of adding a `sha256` function to all pages in the context:
 
-```ruby
-require 'digest'
-
-def sha256(text)
-  Digest::SHA256.hexdigest(text)
-end
+```python sync title=example_714719de9c92e66678257180301c2512f8cd69185f53a5121b6c52194f61a871.py
+import hashlib
+from playwright.sync_api import sync_playwright
+
+def sha256(text: str) -> str:
+    m = hashlib.sha256()
+    m.update(bytes(text, "utf8"))
+    return m.hexdigest()
+
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=False)
+    context = browser.new_context()
+    context.expose_function("sha256", sha256)
+    page = context.new_page()
+    page.set_content("""
+        <script>
+          async function onClick() {
+            document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
+          }
+        </script>
+        <button onclick="onClick()">Click me</button>
+        <div></div>
+    """)
+    page.get_by_role("button").click()
+
+with sync_playwright() as playwright:
+    run(playwright)
 
-browser_context.expose_function("sha256", method(:sha256))
-page = browser_context.new_page()
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
-page.get_by_role("button").click
 ```
 
 ## grant_permissions

data/documentation/docs/api/browser_type.md

@@ -8,15 +8,20 @@ sidebar_position: 10
 BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a
 typical example of using Playwright to drive automation:
 
-```ruby
-chromium = playwright.chromium
-chromium.launch do |browser|
-  page = browser.new_page
-  page.goto('https://example.com/')
+```python sync title=example_2f9fbff87f35af4b76a27f54efeca3201696bbfa94ce03fee5a3df2639cc27d3.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    chromium = playwright.chromium
+    browser = chromium.launch()
+    page = browser.new_page()
+    page.goto("https://example.com")
+    # other actions...
+    browser.close()
 
-  # other actions
+with sync_playwright() as playwright:
+    run(playwright)
 
-end
 ```
 
 ## connect_over_cdp

data/documentation/docs/api/dialog.md

@@ -9,21 +9,24 @@ sidebar_position: 10
 
 An example of using [Dialog](./dialog) class:
 
-```ruby
-def handle_dialog(dialog)
-  puts "[#{dialog.type}] #{dialog.message}"
-  if dialog.message =~ /foo/
-    dialog.accept
-  else
-    dialog.dismiss
-  end
-end
-
-page.on("dialog", method(:handle_dialog))
-page.evaluate("confirm('foo')") # will be accepted
-# => [confirm] foo
-page.evaluate("alert('bar')") # will be dismissed
-# => [alert] bar
+```python sync title=example_a7dcc75b7aa5544237ac3a964e9196d0445308864d3ce820f8cb8396f687b04a.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def handle_dialog(dialog):
+    print(dialog.message)
+    dialog.dismiss()
+
+def run(playwright: Playwright):
+    chromium = playwright.chromium
+    browser = chromium.launch()
+    page = browser.new_page()
+    page.on("dialog", handle_dialog)
+    page.evaluate("alert('1')")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 **NOTE**: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener.

data/documentation/docs/api/element_handle.md

@@ -505,13 +505,14 @@ Triggers a `change` and `input` event once all the provided options have been se
 
 **Usage**
 
-```ruby
-# single selection matching the value
-element_handle.select_option(value: "blue")
+```python sync title=example_e6bbc99e34c9f6ee73aa7d4265d34af456e6c67d185530f0a77f8064050a3ec4.py
+# Single selection matching the value or label
+handle.select_option("blue")
 # single selection matching both the label
-element_handle.select_option(label: "blue")
+handle.select_option(label="blue")
 # multiple selection
-element_handle.select_option(value: ["red", "green", "blue"])
+handle.select_option(value=["red", "green", "blue"])
+
 ```
 
 ## select_text

data/documentation/docs/api/frame.md

@@ -15,16 +15,25 @@ At every point of time, page exposes its current frame tree via the [Page#main_f
 
 An example of dumping frame tree:
 
-```ruby
-def dump_frame_tree(frame, indent = 0)
-  puts "#{' ' * indent}#{frame.name}@#{frame.url}"
-  frame.child_frames.each do |child|
-    dump_frame_tree(child, indent + 2)
-  end
-end
+```python sync title=example_2bc8a0187190738d8dc7b29c66ad5f9f2187fd1827455e9ceb1e9ace26aaf534.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    firefox = playwright.firefox
+    browser = firefox.launch()
+    page = browser.new_page()
+    page.goto("https://www.theverge.com")
+    dump_frame_tree(page.main_frame, "")
+    browser.close()
+
+def dump_frame_tree(frame, indent):
+    print(indent + frame.name + '@' + frame.url)
+    for child in frame.child_frames:
+        dump_frame_tree(child, indent + "    ")
+
+with sync_playwright() as playwright:
+    run(playwright)
 
-page.goto("https://www.theverge.com")
-dump_frame_tree(page.main_frame)
 ```
 
 ## add_script_tag
@@ -911,13 +920,14 @@ Triggers a `change` and `input` event once all the provided options have been se
 
 **Usage**
 
-```ruby
-# single selection matching the value
-frame.select_option("select#colors", value: "blue")
+```python sync title=example_3f390f340c78c42dd0c88a09b2f56575b02b163786e8cdee33581217afced6b2.py
+# Single selection matching the value or label
+frame.select_option("select#colors", "blue")
 # single selection matching both the label
-frame.select_option("select#colors", label: "blue")
+frame.select_option("select#colors", label="blue")
 # multiple selection
-frame.select_option("select#colors", value: ["red", "green", "blue"])
+frame.select_option("select#colors", value=["red", "green", "blue"])
+
 ```
 
 ## set_checked
@@ -1089,9 +1099,20 @@ Returns when the `expression` returns a truthy value, returns that value.
 
 The [Frame#wait_for_function](./frame#wait_for_function) can be used to observe viewport size change:
 
-```ruby
-frame.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
-frame.wait_for_function("() => window.x > 0")
+```python sync title=example_e6a8c279eb09e58e3522cb6237f5d62165b164cad0c1916720af299ffcb8dc8a.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    page = browser.new_page()
+    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
+    page.main_frame.wait_for_function("() => window.x > 0")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 To pass an argument to the predicate of `frame.waitForFunction` function:
@@ -1167,13 +1188,22 @@ function will throw.
 
 This method works across navigations:
 
-```ruby
-%w[https://google.com https://bbc.com].each do |current_url|
-  page.goto(current_url, waitUntil: "domcontentloaded")
-  frame = page.main_frame
-  element = frame.wait_for_selector("img")
-  puts "Loaded image: #{element["src"]}"
-end
+```python sync title=example_6e2a71807566cf008382d4c163ff6e71e34d7f10ef6706ad7fcaa9b70c256a66.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    chromium = playwright.chromium
+    browser = chromium.launch()
+    page = browser.new_page()
+    for current_url in ["https://google.com", "https://bbc.com"]:
+        page.goto(current_url, wait_until="domcontentloaded")
+        element = page.main_frame.wait_for_selector("img")
+        print("Loaded image: " + str(element.get_attribute("src")))
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 ## wait_for_timeout

data/documentation/docs/api/locator.md

@@ -42,6 +42,8 @@ def all_inner_texts
 
 Returns an array of `node.innerText` values for all matching nodes.
 
+**NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] with `useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -57,6 +59,8 @@ def all_text_contents
 
 Returns an array of `node.textContent` values for all matching nodes.
 
+**NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -232,6 +236,8 @@ def count
 
 Returns the number of elements matching the locator.
 
+**NOTE**: If you need to assert the number of elements on the page, prefer [`method: LocatorAssertions.toHaveCount`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -526,6 +532,8 @@ alias: `[]`
 
 Returns the matching element's attribute value.
 
+**NOTE**: If you need to assert an element's attribute, prefer [`method: LocatorAssertions.toHaveAttribute`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 ## get_by_alt_text
 
 ```
@@ -808,6 +816,8 @@ def inner_text(timeout: nil)
 
 Returns the [`element.innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText).
 
+**NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] with `useInnerText` option to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 ## input_value
 
 ```
@@ -817,6 +827,8 @@ def input_value(timeout: nil)
 
 Returns the value for the matching `<input>` or `<textarea>` or `<select>` element.
 
+**NOTE**: If you need to assert input value, prefer [`method: LocatorAssertions.toHaveValue`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -836,6 +848,8 @@ def checked?(timeout: nil)
 
 Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
 
+**NOTE**: If you need to assert that checkbox is checked, prefer [`method: LocatorAssertions.toBeChecked`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -851,6 +865,8 @@ def disabled?(timeout: nil)
 
 Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
 
+**NOTE**: If you need to assert that an element is disabled, prefer [`method: LocatorAssertions.toBeDisabled`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -866,6 +882,8 @@ def editable?(timeout: nil)
 
 Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable).
 
+**NOTE**: If you need to assert that an element is editable, prefer [`method: LocatorAssertions.toBeEditable`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -881,6 +899,8 @@ def enabled?(timeout: nil)
 
 Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
 
+**NOTE**: If you need to assert that an element is enabled, prefer [`method: LocatorAssertions.toBeEnabled`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -896,6 +916,8 @@ def hidden?(timeout: nil)
 
 Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible).
 
+**NOTE**: If you need to assert that element is hidden, prefer [`method: LocatorAssertions.toBeHidden`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -911,6 +933,8 @@ def visible?(timeout: nil)
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible).
 
+**NOTE**: If you need to assert that element is visible, prefer [`method: LocatorAssertions.toBeVisible`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 **Usage**
 
 ```ruby
@@ -1277,6 +1301,8 @@ def text_content(timeout: nil)
 
 Returns the [`node.textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent).
 
+**NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] to avoid flakiness. See [assertions guide](https://playwright.dev/python/docs/test-assertions) for more details.
+
 ## type
 
 ```

data/documentation/docs/api/page.md

@@ -12,12 +12,21 @@ instance might have multiple [Page](./page) instances.
 
 This example creates a page, navigates it to a URL, and then saves a screenshot:
 
-```ruby
-playwright.webkit.launch do |browser|
-  page = browser.new_page
-  page.goto('https://example.com/')
-  page.screenshot(path: 'screenshot.png')
-end
+```python sync title=example_94e620cdbdfd41e2c9b14d561052ffa89535fc346038c4584ea4dd8520f5401c.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    context = browser.new_context()
+    page = context.new_page()
+    page.goto("https://example.com")
+    page.screenshot(path="screenshot.png")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 The Page class emits various events (described below) which can be handled using any of Node's native
@@ -462,18 +471,29 @@ See [BrowserContext#expose_binding](./browser_context#expose_binding) for the co
 
 An example of exposing page URL to all frames in a page:
 
-```ruby
-page.expose_binding("pageURL", ->(source) { source[:page].url })
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.pageURL();
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
-page.locator("button").click
+```python sync title=example_4f7d99a72aaea957cc5678ed8728965338d78598d7772f47fbf23c28f0eba52d.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=false)
+    context = browser.new_context()
+    page = context.new_page()
+    page.expose_binding("pageURL", lambda source: source["page"].url)
+    page.set_content("""
+    <script>
+      async function onClick() {
+        document.querySelector('div').textContent = await window.pageURL();
+      }
+    </script>
+    <button onclick="onClick()">Click me</button>
+    <div></div>
+    """)
+    page.click("button")
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 An example of passing an element handle:
@@ -517,24 +537,35 @@ See [BrowserContext#expose_function](./browser_context#expose_function) for cont
 
 An example of adding a `sha256` function to the page:
 
-```ruby
-require 'digest'
+```python sync title=example_0f68a39bdff02a3df161c74e81cabb8a2ff1f09f0d09f6ef9b799a6f2f19a280.py
+import hashlib
+from playwright.sync_api import sync_playwright, Playwright
 
-def sha1(text)
-  Digest::SHA256.hexdigest(text)
-end
+def sha256(text):
+    m = hashlib.sha256()
+    m.update(bytes(text, "utf8"))
+    return m.hexdigest()
+
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=False)
+    page = browser.new_page()
+    page.expose_function("sha256", sha256)
+    page.set_content("""
+        <script>
+          async function onClick() {
+            document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
+          }
+        </script>
+        <button onclick="onClick()">Click me</button>
+        <div></div>
+    """)
+    page.click("button")
+
+with sync_playwright() as playwright:
+    run(playwright)
 
-page.expose_function("sha256", method(:sha256))
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
-page.locator("button").click
 ```
 
 ## fill
@@ -1324,13 +1355,14 @@ Triggers a `change` and `input` event once all the provided options have been se
 
 **Usage**
 
-```ruby
-# single selection matching the value
-page.select_option("select#colors", value: "blue")
+```python sync title=example_8260034c740933903e5a39d30a4f4e388bdffa9e82acd9a5fe1fb774752a505a.py
+# Single selection matching the value or label
+page.select_option("select#colors", "blue")
 # single selection matching both the label
-page.select_option("select#colors", label: "blue")
+page.select_option("select#colors", label="blue")
 # multiple selection
-page.select_option("select#colors", value: ["red", "green", "blue"])
+page.select_option("select#colors", value=["red", "green", "blue"])
+
 ```
 
 ## set_checked
@@ -1644,9 +1676,20 @@ Returns when the `expression` returns a truthy value. It resolves to a JSHandle
 
 The [Page#wait_for_function](./page#wait_for_function) can be used to observe viewport size change:
 
-```ruby
-page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
-page.wait_for_function("() => window.x > 0")
+```python sync title=example_83eed1f1f00ad73f641bf4a49f672e81c4faf1ca098a4a5070afeeabb88312f5.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    page = browser.new_page()
+    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
+    page.wait_for_function("() => window.x > 0")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 To pass an argument to the predicate of [Page#wait_for_function](./page#wait_for_function) function:
@@ -1814,12 +1857,22 @@ function will throw.
 
 This method works across navigations:
 
-```ruby
-%w[https://google.com https://bbc.com].each do |current_url|
-  page.goto(current_url, waitUntil: "domcontentloaded")
-  element = page.wait_for_selector("img")
-  puts "Loaded image: #{element["src"]}"
-end
+```python sync title=example_903c7325fd65fcdf6f22c77fc159922a568841abce60ae1b7c54ab5837401862.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    chromium = playwright.chromium
+    browser = chromium.launch()
+    page = browser.new_page()
+    for current_url in ["https://google.com", "https://bbc.com"]:
+        page.goto(current_url, wait_until="domcontentloaded")
+        element = page.wait_for_selector("img")
+        print("Loaded image: " + str(element.get_attribute("src")))
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 ## wait_for_timeout