Skip to main content

Pyppeteer

PyPI PyPI version Documentation Build Status codecov

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

Note: Currently not all features are tested and some APIs are unstable

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 import launch

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

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

Example: evaluate script on the page.

import asyncio
from pyppeteer import launch

async def main():
    browser = launch()
    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}
    await 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.

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 Page.querySelectorAll() instead of Page.$$(). Pyppeteer has shorthands for these methods, Page.J() and Page.JJ().

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

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 page.evaluate('(element) => element.textContent', element)

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.

Metadata

Release files for pyppeteer 0.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyppeteer 0.0.11
File Size Uploaded Provenance Actions
pyppeteer-0.0.11.tar.gz 70.5 kB Without provenance Details for pyppeteer-0.0.11.tar.gz

Release files / pyppeteer-0.0.11.tar.gz

Download URL pyppeteer-0.0.11.tar.gz
Size 70.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3a03394295aaaa2a06e672d16059add9ed6223dc9a4431beb77226c7bfd6215a
BLAKE2b-256 checksum
How to use checksums
76f88416105fd940b6f1d105535861d5c73be107aa34ac6179989a162d3b28d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pyppeteer 0.0.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.11 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page