Welcome to Pyppeteer’s documentation!

Pyppeteer

PyPI PyPI version Documentation Build Status codecov

Unofficial Python port of puppeteer JavaScript (headless) chrome/chromium browser automation library.

WORK IN PROGRESS

Currently not all features are tested.

Installation

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

Usage

Note: When you run pyppeteer first time, it downloads a recent version of Chromium (~100MB).

Example: open web page and take a screenshot.

import asyncio
from pyppeteer.launcher import launch

async def main(browser):
    page = await browser.newPage()
    await page.goto('http://example.com')
    await page.screenshot({'path': 'example.png'})

browser = launch()
asyncio.get_event_loop().run_until_complete(main(browser))
browser.close()

Example: evaluate script on the page.

import asyncio
from pyppeteer.launcher import launch

async def main(browser):
    page = await browser.newPage()
    await page.goto('http://example.com')
    await page.screenshot({'path': 'example.png'})

    dimensions = await page.evaluate('''() => {
        return {
            width: document.documentElement.clientWidth,
            height: document.documentElement.clientHeight,
            deviceScaleFactor: window.devicePixelRatio,
        }
    }''')

    print(dimensions)
    # >>> {'width': 800, 'height': 600, 'deviceScaleFactor': 1}

browser = launch()
asyncio.get_event_loop().run_until_complete(main(browser))
browser.close()

Pyppeteer has almost same API as puppeteer. More APIs are listed in the document.

Puppeteer’s document is also useful for pyppeteer users.

Differences between puppeteer and pyppeteer

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.

Keyword argument for options

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)

Element selector method name ($ -> querySelector)

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().

Argument of Page.evaluate() / ElementHandle.evaluate()

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')

Future Plan

  1. Catch up development of puppeteer
    • Not intend to add original API which puppeteer does not have
  2. Add more tests and fix bugs

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Indices and tables