Skip to content

Latest commit

 

History

History
842 lines (557 loc) · 29 KB

release-notes-python.md

File metadata and controls

842 lines (557 loc) · 29 KB
id title toc_max_heading_level
release-notes
Release notes
2

Version 1.26

Assertions

  • New option enabled for [method: LocatorAssertions.toBeEnabled].
  • [method: LocatorAssertions.toHaveText] now pierces open shadow roots.
  • New option editable for [method: LocatorAssertions.toBeEditable].
  • New option visible for [method: LocatorAssertions.toBeVisible].

Other highlights

  • New option max_redirects for [method: APIRequestContext.get] and others to limit redirect count.
  • Python 3.11 is now supported.

Behavior Change

A bunch of Playwright APIs already support the wait_until: "domcontentloaded" option. For example:

page.goto("https://playwright.dev", wait_until="domcontentloaded")

Prior to 1.26, this would wait for all iframes to fire the DOMContentLoaded event.

To align with web specification, the 'domcontentloaded' value only waits for the target frame to fire the 'DOMContentLoaded' event. Use wait_until="load" to wait for all iframes.

Browser Versions

  • Chromium 106.0.5249.30
  • Mozilla Firefox 104.0
  • WebKit 16.0

This version was also tested against the following stable channels:

  • Google Chrome 105
  • Microsoft Edge 105

Version 1.25

Announcements

  • 🎁 We now ship Ubuntu 22.04 Jammy Jellyfish docker image: mcr.microsoft.com/playwright/python:v1.26.1-jammy.
  • 🪦 This is the last release with macOS 10.15 support (deprecated as of 1.21).
  • ⚠️ Ubuntu 18 is now deprecated and will not be supported as of Dec 2022.

Browser Versions

  • Chromium 105.0.5195.19
  • Mozilla Firefox 103.0
  • WebKit 16.0

This version was also tested against the following stable channels:

  • Google Chrome 104
  • Microsoft Edge 104

Version 1.24

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/9F05o1shxcY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

🐂 Debian 11 Bullseye Support

Playwright now supports Debian 11 Bullseye on x86_64 for Chromium, Firefox and WebKit. Let us know if you encounter any issues!

Linux support looks like this:

Ubuntu 18.04 Ubuntu 20.04 Ubuntu 22.04 Debian 11
Chromium
WebKit
Firefox

New introduction docs

We rewrote our Getting Started docs to be more end-to-end testing focused. Check them out on playwright.dev.

Version 1.23

Network Replay

Now you can record network traffic into a HAR file and re-use this traffic in your tests.

To record network into HAR file:

npx playwright open --save-har=github.har.zip https://github.com/microsoft

Alternatively, you can record HAR programmatically:

context = await browser.new_context(record_har_path="github.har.zip")
# ... do stuff ...
await context.close()
context = browser.new_context(record_har_path="github.har.zip")
# ... do stuff ...
context.close()

Use the new methods [method: Page.routeFromHAR] or [method: BrowserContext.routeFromHAR] to serve matching responses from the HAR file:

await context.route_from_har("github.har.zip")
context.route_from_har("github.har.zip")

Read more in our documentation.

Advanced Routing

You can now use [method: Route.fallback] to defer routing to other handlers.

Consider the following example:

# Remove a header from all requests
async def remove_header_handler(route: Route) -> None:
    headers = await route.request.all_headers()
    if "if-none-match" in headers:
        del headers["if-none-match"]
    await route.fallback(headers=headers)

await page.route("**/*", remove_header_handler)

# Abort all images
async def abort_images_handler(route: Route) -> None:
    if route.request.resource_type == "image":
        await route.abort()
    else:
        await route.fallback()

await page.route("**/*", abort_images_handler)
# Remove a header from all requests
def remove_header_handler(route: Route) -> None:
    headers = route.request.all_headers()
    if "if-none-match" in headers:
        del headers["if-none-match"]
    route.fallback(headers=headers)

page.route("**/*", remove_header_handler)

# Abort all images
def abort_images_handler(route: Route) -> None:
    if route.request.resource_type == "image":
        route.abort()
    else:
        route.fallback()

page.route("**/*", abort_images_handler)

Note that the new methods [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR] also participate in routing and could be deferred to.

Web-First Assertions Update

  • New method [method: LocatorAssertions.toHaveValues] that asserts all selected values of <select multiple> element.
  • Methods [method: LocatorAssertions.toContainText] and [method: LocatorAssertions.toHaveText] now accept ignore_case option.

Miscellaneous

  • If there's a service worker that's in your way, you can now easily disable it with a new context option service_workers:

    context = await browser.new_context(service_workers="block")
    page = await context.new_page()
    context = browser.new_context(service_workers="block")
    page = context.new_page()
  • Using .zip path for recordHar context option automatically zips the resulting HAR:

    context = await browser.new_context(record_har_path="github.har.zip")
    context = browser.new_context(record_har_path="github.har.zip")
  • If you intend to edit HAR by hand, consider using the "minimal" HAR recording mode that only records information that is essential for replaying:

    context = await browser.new_context(record_har_mode="minimal", record_har_path="har.har")
    context = browser.new_context(record_har_mode="minimal", record_har_path="har.har")
  • Playwright now runs on Ubuntu 22 amd64 and Ubuntu 22 arm64.

Version 1.22

Highlights

  • Role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.

    # Click a button with accessible name "log in"
    page.locator("role=button[name='log in']").click()

    Read more in our documentation.

  • New [method: Locator.filter] API to filter an existing locator

    buttons = page.locator("role=button")
    # ...
    submit_button = buttons.filter(has_text="Submit")
    submit_button.click()
  • Codegen now supports generating Pytest Tests

    Graphics

Version 1.21

Highlights

  • New role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.

    # Click a button with accessible name "log in"
    await page.locator("role=button[name='log in']").click()
    # Click a button with accessible name "log in"
    page.locator("role=button[name='log in']").click()

    Read more in our documentation.

  • New scale option in [method: Page.screenshot] for smaller sized screenshots.

  • New caret option in [method: Page.screenshot] to control text caret. Defaults to "hide".

Behavior Changes

  • The mcr.microsoft.com/playwright docker image no longer contains Python. Please use mcr.microsoft.com/playwright/python as a Playwright-ready docker image with pre-installed Python.
  • Playwright now supports large file uploads (100s of MBs) via [method: Locator.setInputFiles] API.

Browser Versions

  • Chromium 101.0.4951.26
  • Mozilla Firefox 98.0.2
  • WebKit 15.4

This version was also tested against the following stable channels:

  • Google Chrome 100
  • Microsoft Edge 100

Version 1.20

Highlights

  • New options for methods [method: Page.screenshot], [method: Locator.screenshot] and [method: ElementHandle.screenshot]:
    • Option animations: "disabled" rewinds all CSS animations and transitions to a consistent state
    • Option mask: Locator[] masks given elements, overlaying them with pink #FF00FF boxes.
  • Trace Viewer now shows API testing requests.
  • [method: Locator.highlight] visually reveals element(s) for easier debugging.

Announcements

  • We now ship a designated Python docker image mcr.microsoft.com/playwright/python. Please switch over to it if you use Python. This is the last release that includes Python inside our javascript mcr.microsoft.com/playwright docker image.
  • v1.20 is the last release to receive WebKit update for macOS 10.15 Catalina. Please update MacOS to keep using latest & greatest WebKit!

Browser Versions

  • Chromium 101.0.4921.0
  • Mozilla Firefox 97.0.1
  • WebKit 15.4

This version was also tested against the following stable channels:

  • Google Chrome 99
  • Microsoft Edge 99

Version 1.19

Highlights

  • Locator now supports a has option that makes sure it contains another locator inside:

    await page.locator("article", has=page.locator(".highlight")).click()
    page.locator("article", has=page.locator(".highlight")).click()

    Read more in locator documentation

  • New [method: Locator.page]

  • [method: Page.screenshot] and [method: Locator.screenshot] now automatically hide blinking caret

  • Playwright Codegen now generates locators and frame locators

Browser Versions

  • Chromium 100.0.4863.0
  • Mozilla Firefox 96.0.1
  • WebKit 15.4

This version was also tested against the following stable channels:

  • Google Chrome 98
  • Microsoft Edge 98

Version 1.18

API Testing

Playwright for Python 1.18 introduces new API Testing that lets you send requests to the server directly from Python! Now you can:

  • test your server API
  • prepare server side state before visiting the web application in a test
  • validate server side post-conditions after running some actions in the browser

To do a request on behalf of Playwright's Page, use new [property: Page.request] API:

# Do a GET request on behalf of page
res = await page.request.get("http://example.com/foo.json")
# Do a GET request on behalf of page
res = page.request.get("http://example.com/foo.json")

Read more in our documentation.

Web-First Assertions

Playwright for Python 1.18 introduces Web-First Assertions.

Consider the following example:

from playwright.async_api import Page, expect

async def test_status_becomes_submitted(page: Page) -> None:
    # ..
    await page.locator("#submit-button").click()
    await expect(page.locator(".status")).to_have_text("Submitted")
from playwright.sync_api import Page, expect

def test_status_becomes_submitted(page: Page) -> None:
    # ..
    page.locator("#submit-button").click()
    expect(page.locator(".status")).to_have_text("Submitted")

Playwright will be re-testing the node with the selector .status until fetched Node has the "Submitted" text. It will be re-fetching the node and checking it over and over, until the condition is met or until the timeout is reached. You can pass this timeout as an option.

Read more in our documentation.

Locator Improvements

  • [method: Locator.dragTo]

  • Each locator can now be optionally filtered by the text it contains:

    await page.locator("li", has_text="my item").locator("button").click()
    page.locator("li", has_text="my item").locator("button").click()

    Read more in locator documentation

New APIs & changes

Browser Versions

  • Chromium 99.0.4812.0
  • Mozilla Firefox 95.0
  • WebKit 15.4

This version was also tested against the following stable channels:

  • Google Chrome 97
  • Microsoft Edge 97

Version 1.17

Frame Locators

Playwright 1.17 introduces frame locators - a locator to the iframe on the page. Frame locators capture the logic sufficient to retrieve the iframe and then locate elements in that iframe. Frame locators are strict by default, will wait for iframe to appear and can be used in Web-First assertions.

Graphics

Frame locators can be created with either [method: Page.frameLocator] or [method: Locator.frameLocator] method.

locator = page.frame_locator("my-frame").locator("text=Submit")
locator.click()

Read more at our documentation.

Trace Viewer Update

Playwright Trace Viewer is now available online at https://trace.playwright.dev! Just drag-and-drop your trace.zip file to inspect its contents.

NOTE: trace files are not uploaded anywhere; trace.playwright.dev is a progressive web application that processes traces locally.

  • Playwright Test traces now include sources by default (these could be turned off with tracing option)
  • Trace Viewer now shows test name
  • New trace metadata tab with browser details
  • Snapshots now have URL bar

image

HTML Report Update

  • HTML report now supports dynamic filtering
  • Report is now a single static HTML file that could be sent by e-mail or as a slack attachment.

image

Ubuntu ARM64 support + more

  • Playwright now supports Ubuntu 20.04 ARM64. You can now run Playwright tests inside Docker on Apple M1 and on Raspberry Pi.
  • You can now use Playwright to install stable version of Edge on Linux:
    npx playwright install msedge

New APIs

  • Tracing now supports a 'title' option
  • Page navigations support a new 'commit' waiting option

Version 1.16

🎭 Playwright Library

locator.wait_for

Wait for a locator to resolve to a single element with a given state. Defaults to the state: 'visible'.

Comes especially handy when working with lists:

order_sent = page.locator("#order-sent")
order_sent.wait_for()

Read more about [method: Locator.waitFor].

Docker support for Arm64

Playwright Docker image is now published for Arm64 so it can be used on Apple Silicon.

Read more about Docker integration.

🎭 Playwright Trace Viewer

  • run trace viewer with npx playwright show-trace and drop trace files to the trace viewer PWA
  • better visual attribution of action targets

Read more about Trace Viewer.

Browser Versions

  • Chromium 97.0.4666.0
  • Mozilla Firefox 93.0
  • WebKit 15.4

This version of Playwright was also tested against the following stable channels:

  • Google Chrome 94
  • Microsoft Edge 94

Version 1.15

🖱️ Mouse Wheel

By using Page.mouse.wheel you are now able to scroll vertically or horizontally.

📜 New Headers API

Previously it was not possible to get multiple header values of a response. This is now possible and additional helper functions are available:

🌈 Forced-Colors emulation

Its now possible to emulate the forced-colors CSS media feature by passing it in the context options or calling Page.emulate_media().

New APIs

Browser Versions

  • Chromium 96.0.4641.0
  • Mozilla Firefox 92.0
  • WebKit 15.0

Version 1.14

⚡️ New "strict" mode

Selector ambiguity is a common problem in automation testing. "strict" mode ensures that your selector points to a single element and throws otherwise.

Pass strict=true into your action calls to opt in.

# This will throw if you have more than one button!
page.click("button", strict=True)

📍 New Locators API

Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any given moment.

The difference between the Locator and ElementHandle is that the latter points to a particular element, while Locator captures the logic of how to retrieve that element.

Also, locators are "strict" by default!

locator = page.locator("button")
locator.click()

Learn more in the documentation.

🧩 Experimental React and Vue selector engines

React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to attribute selectors and supports all attribute selector operators.

page.locator("_react=SubmitButton[enabled=true]").click()
page.locator("_vue=submit-button[enabled=true]").click()

Learn more in the react selectors documentation and the vue selectors documentation.

✨ New nth and visible selector engines

  • nth selector engine is equivalent to the :nth-match pseudo class, but could be combined with other selector engines.
  • visible selector engine is equivalent to the :visible pseudo class, but could be combined with other selector engines.
# select the first button among all buttons
button.click("button >> nth=0")
# or if you are using locators, you can use first, nth() and last
page.locator("button").first.click()

# click a visible button
button.click("button >> visible=true")

Browser Versions

  • Chromium 94.0.4595.0
  • Mozilla Firefox 91.0
  • WebKit 15.0

Version 1.13

Playwright

  • 🖖 Programmatic drag-and-drop support via the [method: Page.dragAndDrop] API.
  • 🔎 Enhanced HAR with body sizes for requests and responses. Use via recordHar option in [method: Browser.newContext].

Tools

  • Playwright Trace Viewer now shows parameters, returned values and console.log() calls.

New and Overhauled Guides

Browser Versions

  • Chromium 93.0.4576.0
  • Mozilla Firefox 90.0
  • WebKit 14.2

New Playwright APIs

  • new baseURL option in [method: Browser.newContext] and [method: Browser.newPage]
  • [method: Response.securityDetails] and [method: Response.serverAddr]
  • [method: Page.dragAndDrop] and [method: Frame.dragAndDrop]
  • [method: Download.cancel]
  • [method: Page.inputValue], [method: Frame.inputValue] and [method: ElementHandle.inputValue]
  • new force option in [method: Page.fill], [method: Frame.fill], and [method: ElementHandle.fill]
  • new force option in [method: Page.selectOption], [method: Frame.selectOption], and [method: ElementHandle.selectOption]

Version 1.12

🧟‍♂️ Introducing Playwright Trace Viewer

Playwright Trace Viewer is a new GUI tool that helps exploring recorded Playwright traces after the script ran. Playwright traces let you examine:

  • page DOM before and after each Playwright action
  • page rendering before and after each Playwright action
  • browser network during script execution

Traces are recorded using the new [property: BrowserContext.tracing] API:

browser = chromium.launch()
context = browser.new_context()

# Start tracing before creating / navigating a page.
context.tracing.start(screenshots=True, snapshots=True)

page.goto("https://playwright.dev")

# Stop tracing and export it into a zip archive.
context.tracing.stop(path = "trace.zip")

Traces are examined later with the Playwright CLI:

playwright show-trace trace.zip

That will open the following GUI:

image

👉 Read more in trace viewer documentation.

Browser Versions

  • Chromium 93.0.4530.0
  • Mozilla Firefox 89.0
  • WebKit 14.2

This version of Playwright was also tested against the following stable channels:

  • Google Chrome 91
  • Microsoft Edge 91

New APIs

  • reducedMotion option in [method: Page.emulateMedia], [method: BrowserType.launchPersistentContext], [method: Browser.newContext] and [method: Browser.newPage]
  • [event: BrowserContext.request]
  • [event: BrowserContext.requestFailed]
  • [event: BrowserContext.requestFinished]
  • [event: BrowserContext.response]
  • tracesDir option in [method: BrowserType.launch] and [method: BrowserType.launchPersistentContext]
  • new [property: BrowserContext.tracing] API namespace
  • new [method: Download.page] method

Version 1.11

🎥 New video: Playwright: A New Test Automation Framework for the Modern Web (slides)

  • We talked about Playwright
  • Showed engineering work behind the scenes
  • Did live demos with new features ✨
  • Special thanks to applitools for hosting the event and inviting us!

Browser Versions

  • Chromium 92.0.4498.0
  • Mozilla Firefox 89.0b6
  • WebKit 14.2

New APIs

  • support for async predicates across the API in methods such as [method: Page.waitForRequest] and others
  • new emulation devices: Galaxy S8, Galaxy S9+, Galaxy Tab S4, Pixel 3, Pixel 4
  • new methods:
    • [method: Page.waitForURL] to await navigations to URL
    • [method: Video.delete] and [method: Video.saveAs] to manage screen recording
  • new options:
    • screen option in the [method: Browser.newContext] method to emulate window.screen dimensions
    • position option in [method: Page.check] and [method: Page.uncheck] methods
    • trial option to dry-run actions in [method: Page.check], [method: Page.uncheck], [method: Page.click], [method: Page.dblclick], [method: Page.hover] and [method: Page.tap]

Version 1.10

Bundled Browser Versions

  • Chromium 90.0.4430.0
  • Mozilla Firefox 87.0b10
  • WebKit 14.2

This version of Playwright was also tested against the following stable channels:

  • Google Chrome 89
  • Microsoft Edge 89

New APIs

Version 1.9

  • Playwright Inspector is a new GUI tool to author and debug your tests.

    • Line-by-line debugging of your Playwright scripts, with play, pause and step-through.
    • Author new scripts by recording user actions.
    • Generate element selectors for your script by hovering over elements.
    • Set the PWDEBUG=1 environment variable to launch the Inspector
  • Pause script execution with [method: Page.pause] in headed mode. Pausing the page launches Playwright Inspector for debugging.

  • New has-text pseudo-class for CSS selectors. :has-text("example") matches any element containing "example" somewhere inside, possibly in a child or a descendant element. See more examples.

  • Page dialogs are now auto-dismissed during execution, unless a listener for dialog event is configured. Learn more about this.

  • Playwright for Python is now stable with an idiomatic snake case API and pre-built Docker image to run tests in CI/CD.

Browser Versions

  • Chromium 90.0.4421.0
  • Mozilla Firefox 86.0b10
  • WebKit 14.1

New APIs

  • [method: Page.pause].

Version 1.8

New APIs

  • [method: ElementHandle.isChecked].
  • [method: ElementHandle.isDisabled].
  • [method: ElementHandle.isEditable].
  • [method: ElementHandle.isEnabled].
  • [method: ElementHandle.isHidden].
  • [method: ElementHandle.isVisible].
  • [method: Page.isChecked].
  • [method: Page.isDisabled].
  • [method: Page.isEditable].
  • [method: Page.isEnabled].
  • [method: Page.isHidden].
  • [method: Page.isVisible].
  • New option 'editable' in [method: ElementHandle.waitForElementState].

Browser Versions

  • Chromium 90.0.4392.0
  • Mozilla Firefox 85.0b5
  • WebKit 14.1

Version 1.7

  • New Java SDK: Playwright for Java is now on par with JavaScript, Python and .NET bindings.
  • Browser storage API: New convenience APIs to save and load browser storage state (cookies, local storage) to simplify automation scenarios with authentication.
  • New CSS selectors: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces new CSS extensions and there's more coming soon.
  • New website: The docs website at playwright.dev has been updated and is now built with Docusaurus.
  • Support for Apple Silicon: Playwright browser binaries for WebKit and Chromium are now built for Apple Silicon.

New APIs

  • [method: BrowserContext.storageState] to get current state for later reuse.
  • storageState option in [method: Browser.newContext] and [method: Browser.newPage] to setup browser context state.

Browser Versions

  • Chromium 89.0.4344.0
  • Mozilla Firefox 84.0b9
  • WebKit 14.1