🎭
Playwright for Python 
Docs | API
Playwright is a Python library to automate Chromium, Firefox and WebKit browsers with a single API. Playwright delivers automation that is ever-green, capable, reliable and fast. See how Playwright is better.
| Linux | macOS | Windows | |
|---|---|---|---|
| Chromium 90.0.4396.0 |
|
|
|
| WebKit 14.1 |
|
|
|
| Firefox 85.0b10 |
|
|
|
Headless execution is supported for all browsers on all platforms.
Usage
pip install playwright==1.8.0a1
playwright install
This installs Playwright and browser binaries for Chromium, Firefox and WebKit. Playwright requires Python 3.7+.
Record and generate code
Playwright can record user interactions in a browser and generate code. See demo.
# Pass --help to see all options
playwright codegen
Playwright offers both sync (blocking) API and async API. They are identical in terms of capabilities and only differ in how one consumes the API.
Sync API
This is our default API for short snippets and tests. If you are not using asyncio in your application, it is the easiest to use Sync API notation.
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
for browser_type in [p.chromium, p.firefox, p.webkit]:
browser = browser_type.launch()
page = browser.new_page()
page.goto('http://whatsmyuseragent.org/')
page.screenshot(path=f'example-{browser_type.name}.png')
browser.close()
Async API
If you app is based on the modern asyncio loop and you are used to async/await constructs, Playwright exposes Async API for you. You should also use this API inside the Jupyter Notebook and other REPL frameworks that are already based on asyncio.
import asyncio
from playwright.async_api import async_playwright
async def main():
async with async_playwright() as p:
for browser_type in [p.chromium, p.firefox, p.webkit]:
browser = await browser_type.launch()
page = await browser.newPage()
await page.goto('http://whatsmyuseragent.org/')
await page.screenshot(path=f'example-{browser_type.name}.png')
await browser.close()
asyncio.run(main())
With pytest
Use our pytest plugin for Playwright.
def test_playwright_is_visible_on_google(page):
page.goto("https://www.google.com")
page.type("input[name=q]", "Playwright GitHub")
page.click("input[type=submit]")
page.wait_for_selector("text=microsoft/Playwright")
Interactive mode (REPL)
Blocking REPL, as in CLI:
>>> from playwright.sync_api import sync_playwright
>>> playwright = sync_playwright().start()
# Use playwright.chromium, playwright.firefox or playwright.webkit
# Pass headless=False to see the browser UI
>>> browser = playwright.chromium.launch()
>>> page = browser.new_page()
>>> page.goto("http://whatsmyuseragent.org/")
>>> page.screenshot(path="example.png")
>>> browser.close()
>>> playwright.stop()
Async REPL such as Jupyter Notebook:
>>> from playwright.async_api import async_playwright
>>> playwright = await async_playwright().start()
>>> browser = await playwright.chromium.launch()
>>> page = await browser.new_page()
>>> await page.goto("http://whatsmyuseragent.org/")
>>> await page.screenshot(path="example.png")
>>> await browser.close()
>>> await playwright.stop()
Examples
Mobile and geolocation
This snippet emulates Mobile Safari on a device at a given geolocation, navigates to maps.google.com, performs action and takes a screenshot.
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
iphone_11 = p.devices["iPhone 11 Pro"]
browser = p.webkit.launch(headless=False)
context = browser.new_context(
**iphone_11,
locale="en-US",
geolocation={"longitude": 12.492507, "latitude": 41.889938 },
permissions=["geolocation"]
)
page = context.new_page()
page.goto("https://maps.google.com")
page.click("text=Your location")
page.screenshot(path="colosseum-iphone.png")
browser.close()
Async variant
import asyncio
from playwright.async_api import async_playwright
async def main():
async with async_playwright() as p:
iphone_11 = p.devices["iPhone 11 Pro"]
browser = await p.webkit.launch(headless=False)
context = await browser.newContext(
**iphone_11,
locale="en-US",
geolocation={"longitude": 12.492507, "latitude": 41.889938},
permissions=["geolocation"]
)
page = await context.newPage()
await page.goto("https://maps.google.com")
await page.click("text="Your location"")
await page.screenshot(path="colosseum-iphone.png")
await browser.close()
asyncio.run(main())
Evaluate JS in browser
This code snippet navigates to example.com in Firefox, and executes a script in the page context.
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
browser = p.firefox.launch()
page = browser.new_page()
page.goto("https://www.example.com/")
dimensions = page.evaluate("""() => {
return {
width: document.documentElement.clientWidth,
height: document.documentElement.clientHeight,
deviceScaleFactor: window.devicePixelRatio
}
}""")
print(dimensions)
browser.close()
Async variant
import asyncio
from playwright.async_api import async_playwright
async def main():
async with async_playwright() as p:
browser = await p.firefox.launch()
page = await browser.new_page()
await page.goto("https://www.example.com/")
dimensions = await page.evaluate("""() => {
return {
width: document.documentElement.clientWidth,
height: document.documentElement.clientHeight,
deviceScaleFactor: window.devicePixelRatio
}
}""")
print(dimensions)
await browser.close()
asyncio.run(main())
Intercept network requests
This code snippet sets up request routing for a Chromium page to log all network requests.
from playwright.sync_api import sync_playwright
with sync_playwright() as p:
browser = p.chromium.launch()
page = browser.new_page()
def log_and_continue_request(route, request):
print(request.url)
route.continue_()
# Log and continue all network requests
page.route("**/*", log_and_continue_request)
page.goto("http://todomvc.com")
browser.close()
Async variant
import asyncio
from playwright.async_api import async_playwright
async def main():
async with async_playwright() as p:
browser = await p.chromium.launch()
page = await browser.newPage()
async def log_and_continue_request(route, request):
print(request.url)
await route.continue_()
# Log and continue all network requests
await page.route("**/*", log_and_continue_request)
await page.goto("http://todomvc.com")
await browser.close()
asyncio.run(main())
Documentation
Check out our new documentation site!
Is Playwright ready?
Yes, Playwright for Python is ready! The latest version of Playwright for Python is 1.8.0a. We are ready to drop the Alpha bit once we hear from you. Once it is gone, we will become semver compatible and the API will be frozen in its present form for years. We will still be adding features with every release, but we promise to not break it anymore!
Migration from the pre-release versions
The API has changed since the last 0.170.0 version:
-
Snake case notation for methods and arguments:
# old browser.newPage()
# new browser.new_page()
-
Import has changed to include sync vs async mode explicitly:
# old from playwright import sync_playwright
# new from playwright.sync_api import sync_playwright
That's about it! Our new doc site uses proper notation and examples for the new API.
![[Bug]: AttributeError: 'PlaywrightContextManager' object has no attribute '_playwright'](https://avatars.githubusercontent.com/u/65446343?v=4)
![[Question]: 'c:\Users\ASUS' is not recognized as an internal or external command, operable program or batch file.](https://avatars.githubusercontent.com/u/16819120?v=4)
![[Question]: Taking screenshot of page immediately](https://avatars.githubusercontent.com/u/49095968?v=4)
![[Question]: Getting error `FileNotFoundError: [Errno 2] No such file or directory: '/Users/my_user/.pyenv/versions/pwright_new/lib/python3.9/site-packages/playwright/driver/playwright-cli'`](https://avatars.githubusercontent.com/u/15132522?v=4)
![[Bug]: Not able to install Playwright in Docker on M1 with aarch64 architecture](https://avatars.githubusercontent.com/u/86087397?v=4)
![[BUG] Now work mocking with route.fulfill json](https://avatars.githubusercontent.com/u/73783735?v=4)
![[Ports]: Backport client side changes](https://avatars.githubusercontent.com/u/89237858?v=4)
3k Jan 4, 2023
7.7k Jan 7, 2023
2 Aug 19, 2022
1.1k Dec 30, 2022
15 Feb 1, 2022
4 Sep 22, 2022
12 Dec 26, 2022
3.2k Dec 31, 2022
909 Dec 15, 2022
3.5k Dec 30, 2022
19 Sep 10, 2022
6.4k Jan 5, 2023
122 Nov 22, 2022
7.5k Dec 31, 2022
941 Jan 3, 2023
1 Nov 22, 2021
62 Oct 10, 2022
31 May 28, 2021
