Playwright provides APIs to monitor and modify browser network traffic, both HTTP and HTTPS. Any requests that a page does, including XHRs and fetch requests, can be tracked, modified and handled.
Mock APIsCheck out our API mocking guide to learn more on how to
Perform HTTP Authentication.
context = browser.new_context(
http_credentials={"username": "bill", "password": "pa55w0rd"}
)
page = context.new_page()
page.goto("https://example.com")
context = await browser.new_context(
http_credentials={"username": "bill", "password": "pa55w0rd"}
)
page = await context.new_page()
await page.goto("https://example.com")
HTTP Proxy
You can configure pages to load over the HTTP(S) proxy or SOCKSv5. Proxy can be either set globally for the entire browser, or for each browser context individually.
You can optionally specify username and password for HTTP(S) proxy, you can also specify hosts to bypass the proxy for.
Here is an example of a global proxy:
browser = chromium.launch(proxy={
"server": "http://myproxy.com:3128",
"username": "usr",
"password": "pwd"
})
browser = await chromium.launch(proxy={
"server": "http://myproxy.com:3128",
"username": "usr",
"password": "pwd"
})
Its also possible to specify it per context:
browser = chromium.launch()
context = browser.new_context(proxy={"server": "http://myproxy.com:3128"})
browser = await chromium.launch()
context = await browser.new_context(proxy={"server": "http://myproxy.com:3128"})
Network events
You can monitor all the Requests and Responses:
from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
chromium = playwright.chromium
browser = chromium.launch()
page = browser.new_page()
page.on("request", lambda request: print(">>", request.method, request.url))
page.on("response", lambda response: print("<<", response.status, response.url))
page.goto("https://example.com")
browser.close()
with sync_playwright() as playwright:
run(playwright)
import asyncio
from playwright.async_api import async_playwright, Playwright
async def run(playwright: Playwright):
chromium = playwright.chromium
browser = await chromium.launch()
page = await browser.new_page()
page.on("request", lambda request: print(">>", request.method, request.url))
page.on("response", lambda response: print("<<", response.status, response.url))
await page.goto("https://example.com")
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
Or wait for a network response after the button click with page.expect_response():
with page.expect_response("**/api/fetch_data") as response_info:
page.get_by_text("Update").click()
response = response_info.value
async with page.expect_response("**/api/fetch_data") as response_info:
await page.get_by_text("Update").click()
response = await response_info.value
Variations
Wait for Responses with page.expect_response()
with page.expect_response(re.compile(r"\.jpeg$")) as response_info:
page.get_by_text("Update").click()
response = response_info.value
with page.expect_response(lambda response: token in response.url) as response_info:
page.get_by_text("Update").click()
response = response_info.value
async with page.expect_response(re.compile(r"\.jpeg$")) as response_info:
await page.get_by_text("Update").click()
response = await response_info.value
async with page.expect_response(lambda response: token in response.url) as response_info:
await page.get_by_text("Update").click()
response = await response_info.value
Handle requests
page.route(
"**/api/fetch_data",
lambda route: route.fulfill(status=200, body=test_data))
page.goto("https://example.com")
await page.route(
"**/api/fetch_data",
lambda route: route.fulfill(status=200, body=test_data))
await page.goto("https://example.com")
You can mock API endpoints via handling the network requests in your Playwright script.
VariationsSet up route on the entire browser context with browser_context.route() or page with page.route(). It will apply to popup windows and opened links.
context.route(
"**/api/login",
lambda route: route.fulfill(status=200, body="accept"))
page.goto("https://example.com")
await context.route(
"**/api/login",
lambda route: route.fulfill(status=200, body="accept"))
await page.goto("https://example.com")
Modify requests
def handle_route(route):
headers = route.request.headers
del headers["x-secret"]
route.continue_(headers=headers)
page.route("**/*", handle_route)
page.route("**/*", lambda route: route.continue_(method="POST"))
async def handle_route(route):
headers = route.request.headers
del headers["x-secret"]
await route.continue_(headers=headers)
await page.route("**/*", handle_route)
await page.route("**/*", lambda route: route.continue_(method="POST"))
You can continue requests with modifications. Example above removes an HTTP header from the outgoing requests.
Abort requestsYou can abort requests using page.route() and route.abort().
page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.route("**/*", lambda route: route.abort() if route.request.resource_type == "image" else route.continue_())
await page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
await page.route("**/*", lambda route: route.abort() if route.request.resource_type == "image" else route.continue_())
Modify responses
To modify a response use APIRequestContext to get the original response and then pass the response to route.fulfill(). You can override individual fields on the response via options:
def handle_route(route: Route) -> None:
response = route.fetch()
body = response.text()
body = body.replace("<title>", "<title>My prefix:")
route.fulfill(
response=response,
body=body,
headers={**response.headers, "content-type": "text/html"},
)
page.route("**/title.html", handle_route)
async def handle_route(route: Route) -> None:
response = await route.fetch()
body = await response.text()
body = body.replace("<title>", "<title>My prefix:")
await route.fulfill(
response=response,
body=body,
headers={**response.headers, "content-type": "text/html"},
)
await page.route("**/title.html", handle_route)
Glob URL patterns
Playwright uses simplified glob patterns for URL matching in network interception methods like page.route() or page.expect_response(). These patterns support basic wildcards:
*
matches any characters except /
**
matches any characters including /
?
matches only question mark ?
. If you want to match any character, use *
instead.{}
can be used to match a list of options separated by commas ,
\
can be used to escape any of special characters (note to escape backslash itself as \\
)Examples:
https://example.com/*.js
matches https://example.com/file.js
but not https://example.com/path/file.js
https://example.com/?page=1
matches https://example.com/?page=1
but not https://example.com
**/*.js
matches both https://example.com/file.js
and https://example.com/path/file.js
**/*.{png,jpg,jpeg}
matches all image requestsImportant notes:
Playwright supports WebSockets inspection, mocking and modifying out of the box. See our API mocking guide to learn how to mock WebSockets.
Every time a WebSocket is created, the page.on("websocket") event is fired. This event contains the WebSocket instance for further web socket frames inspection:
def on_web_socket(ws):
print(f"WebSocket opened: {ws.url}")
ws.on("framesent", lambda payload: print(payload))
ws.on("framereceived", lambda payload: print(payload))
ws.on("close", lambda payload: print("WebSocket closed"))
page.on("websocket", on_web_socket)
Missing Network Events and Service Workers
Playwright's built-in browser_context.route() and page.route() allow your tests to natively route requests and perform mocking and interception.
'block'
.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4