You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Mattwmaster58 f98f9030d3
Merge pull request #392 from abe-101/dev
2 months ago
.circleci update puppeteer / chromium deps for debian buster 8 months ago
docs Allow options to be passed into pyppeteer.defaultArgs 4 years ago
pyppeteer fix asyncio.ensure_future example 2 months ago
tests Do not call async events implicitly 3 years ago
.coveragerc Update tox and travis script 5 years ago
.gitignore Update git ignore file 4 years ago
.noserc Separate test server module 5 years ago
.pre-commit-config.yaml add pre-commit for dev work from upstream 2 years ago
CHANGELOG.md fix: circular import #344 7 months ago
CONTRIBUTING.md update grammar, add releasing section 1 year ago
LICENSE Update license description 5 years ago
README.md update README.md grammar 2 years ago
poetry.lock remove support for python 3.6 7 months ago
pyproject.toml version bump 7 months ago
spell.txt Accept a list of arguments as ignoreDefaultArgs option 4 years ago
tox.ini ft: revert to pyppeteer from pyppeteer2 2 years ago

README.md

pyppeteer

PyPI PyPI version Documentation CircleCI codecov

Note: this is a continuation of the pyppeteer project. Before undertaking any sort of developement, it is highly recommended that you take a look at #16 for the ongoing effort to update this library to avoid duplicating efforts.

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

Installation

pyppeteer requires Python >= 3.6

Install with pip from PyPI:

pip install pyppeteer

Or install the latest version from this github repo:

pip install -U git+https://github.com/pyppeteer/pyppeteer@dev

Usage

Note: When you run pyppeteer for the first time, it downloads the latest version of Chromium (~150MB) if it is not found on your system. If you don't prefer this behavior, ensure that a suitable Chrome binary is installed. One way to do this is to run pyppeteer-install command before prior to using this library.

Full documentation can be found here. Puppeteer's documentation and its troubleshooting guide are also great resources for pyppeteer users.

Examples

Open web page and take a screenshot:

import asyncio
from pyppeteer import launch

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

asyncio.get_event_loop().run_until_complete(main())

Evaluate javascript on a page:

import asyncio
from pyppeteer import launch

async def main():
    browser = await launch()
    page = await browser.newPage()
    await page.goto('https://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}
    await browser.close()

asyncio.get_event_loop().run_until_complete(main())

Differences between puppeteer and pyppeteer

pyppeteer strives to replicate the puppeteer API as close as possible, however, fundamental differences between Javascript and Python make this difficult to do precisely. More information on specifics can be found in the documentation.

Keyword arguments for options

puppeteer uses an object for passing options to functions/methods. pyppeteer methods/functions accept both dictionary (python equivalent to JavaScript's objects) and keyword arguments for options.

Dictionary style options (similar to puppeteer):

browser = await launch({'headless': True})

Keyword argument style options (more pythonic, isn't it?):

browser = await launch(headless=True)

Element selector method names

In python, $ is not a valid identifier. The equivalent methods to Puppeteer's $, $$, and $x methods are listed below, along with some shorthand methods for your convenience:

puppeteer pyppeteer pyppeteer shorthand
Page.$() Page.querySelector() Page.J()
Page.$$() Page.querySelectorAll() Page.JJ()
Page.$x() Page.xpath() Page.Jx()

Arguments of Page.evaluate() and Page.querySelectorEval()

puppeteer's version of evaluate() takes a JavaScript function or a string representation of a JavaScript expression. pyppeteer takes string representation of JavaScript expression or function. pyppeteer will try to automatically detect if the string is function or expression, but it will fail sometimes. If an expression is erroneously treated as function and an error is raised, try setting force_expr to True, to force pyppeteer to treat the string as expression.

Examples:

Get a page's textContent:

content = await page.evaluate('document.body.textContent', force_expr=True)

Get an element's textContent:

element = await page.querySelector('h1')
title = await page.evaluate('(element) => element.textContent', element)

Roadmap

See projects

Credits

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