Unofficial Python port of puppeteer JavaScript (headless) chrome/chromium browser automation library.
- Free software: MIT license (including the work distributed under the Apache 2.0 license)
- Documentation: https://miyakogi.github.io/pyppeteer
Currently not all features are tested.
Pyppeteer requires python 3.6+. (experimentally supports python 3.5)
Install by pip from PyPI:
python3 -m pip install pyppeteer
Or install latest version from github:
python3 -m pip install -U git+https://github.com/miyakogi/pyppeteer.git@dev
Below code open web page and take a screenshot.
import asyncio
from pyppeteer.launcher import launch
async def main():
browser = launch()
page = await browser.newPage()
await page.goto('http://example.com')
await page.screenshot({'path': 'example.png'})
browser.close()
asyncio.get_event_loop().run_until_complete(main())
Pyppeteer has almost same API as puppeteer. More APIs are listed in the document.
Puppeteer's document is also useful for pyppeteer users.
Pyppeteer is to be as similar as puppeteer, but some differences between python and JavaScript make it difficult.
These are differences between puppeteer and pyppeteer.
Puppeteer uses object (dictionary in python) for passing options to functions/methods. Pyppeteer accepts both dictionary and keyword argument for options.
Dictionary style option (similar to puppeteer):
browser = launch({'headless': True})
Keyword argument style option (more pythonic, isn't it?):
browser = launch(headless=True)
In python, $
is not usable for method name.
So pyppeteer uses Page.querySelector()
instead of Page.$()
, and
ElementHandle.querySelector()
instead of ElementHandle.$()
.
Pyppeteer has shorthand of this method, Page.J()
and ElementHandle.J()
.
Puppeteer's version of evaluate()
takes JavaScript raw function, but
pyppeteer takes string of JavaScript function.
Example to get element's inner text:
element = await page.querySelector('h1')
title = await element.evaluate('(element) => element.textContent')
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.