Pyppeteer API 速查

Launcher

pyppeteer.launcher.launch（options: dict = None, **kwargs）
Launcher(options, **kwargs).launch()
pyppeteer.launcher.connect(options: dict = None, **kwargs)

Browser Class

browserContexts
coroutine close() → None
coroutine createIncognitoBrowserContext() → pyppeteer.browser.BrowserContext

browser = await launch()
# Create a new incognito browser context.
context = await browser.createIncognitoBrowserContext()
# Create a new page in a pristine context.
page = await context.newPage()
# Do stuff
await page.goto('https://example.com')
...

coroutine disconnect() → None
coroutine newPage() → pyppeteer.page.Page
coroutine pages() → List[pyppeteer.page.Page]
process
targets() → List[pyppeteer.target.Target]
coroutine userAgent() → str
coroutine version() → str
wsEndpoint

BrowserContext Class

# Create new incognito browser context
context = await browser.createIncognitoBrowserContext()
# Create a new page inside context
page = await context.newPage()
# ... do stuff with page ...
await page.goto('https://example.com')
# Dispose context once it's no longer needed
await context.close()

browser
coroutine close() → None
isIncognito() → bool
coroutine newPage() → pyppeteer.page.Page
targets() → List[pyppeteer.target.Target]

Page Class

coroutine J(selector: str) → Optional[pyppeteer.element_handle.ElementHandle]
alias to querySelector()
coroutine JJ(selector: str) → List[pyppeteer.element_handle.ElementHandle]
alias to querySelectorAll()
coroutine JJeval(selector: str, pageFunction: str, *args) → Any
alias to querySelectorAllEval()
coroutine Jeval(selector: str, pageFunction: str, *args) → Any
alias to querySelectorEval()
coroutine Jx(expression: str) → List[pyppeteer.element_handle.ElementHandle]
alias to xpath()
coroutine addScriptTag(options: Dict[KT, VT] = None, **kwargs) → pyppeteer.element_handle.ElementHandle
coroutine addStyleTag(options: Dict[KT, VT] = None, **kwargs) → pyppeteer.element_handle.ElementHandle
coroutine authenticate(credentials: Dict[str, str]) → Any
coroutine bringToFront() → None
browser
coroutine click(selector: str, options: dict = None, **kwargs) → None
coroutine close(options: Dict[KT, VT] = None, **kwargs) → None
coroutine content() → str
coroutine cookies(*urls) → dict
coverage-----Return Coverage.
coroutine deleteCookie(*cookies) → None
coroutine emulate(options: dict = None, **kwargs) → None
(This method is a shortcut for calling two methods: setUserAgent() setViewport() )
coroutine emulateMedia(mediaType: str = None) → None
coroutine evaluate(pageFunction: str, *args, force_expr: bool = False) → Any
coroutine evaluateHandle(pageFunction: str, *args) → pyppeteer.execution_context.JSHandle
coroutine evaluateOnNewDocument(pageFunction: str, *args) → None
coroutine exposeFunction(name: str, pyppeteerFunction: Callable[[…], Any]) → None
coroutine focus(selector: str) → None
frames
coroutine goBack(options: dict = None, **kwargs) → Optional[pyppeteer.network_manager.Response]
coroutine goForward(options: dict = None, **kwargs) → Optional[pyppeteer.network_manager.Response]
coroutine goto(url: str, options: dict = None, **kwargs) → Optional[pyppeteer.network_manager.Response]
coroutine hover(selector: str) → None
coroutine injectFile(filePath: str) → str
isClosed() → bool
keyboard
mainFrame
coroutine metrics() → Dict[str, Any]
mouse

coroutine pdf(options: dict = None, **kwargs) → bytes

Generate a pdf of the page.
Options:

path (str): The file path to save the PDF.
scale (float): Scale of the webpage rendering, defaults to 1.
displayHeaderFooter (bool): Display header and footer.
Defaults to False.
headerTemplate (str): HTML template for the print header. Should
be valid HTML markup with following classes.
date: formatted print date
title: document title
url: document location
pageNumber: current page number
totalPages: total pages in the document


footerTemplate (str): HTML template for the print footer. Should
use the same template as headerTemplate.
printBackground (bool): Print background graphics. Defaults to
False.
landscape (b