Skip to main content
PyPI PyPI version Documentation Build Status codecov

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

WORK IN PROGRESS

Not all features are implemented or tested currently.

  • The following features are not implemented yet.

    • PDF screenshot

    • Page.waitForSelector() and Frame.waitForSelector()

    • Page.waitForFunction() and Frame.waitForFunction()

  • Free software: MIT license (including the work distributed under the Apache 2.0 license)

  • Documentation: https://miyakogi.github.io/pyppeteer

Installation

Pyppeteer requires python 3.6+.

pip install https://github.com/miyakogi/pyppeteer.git

Usage

Below code 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()

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.

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 = page.querySelector('h1')
title = element.evaluate('(element) => element.innerText')

Credits

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

Metadata

Release files for pyppeteer 0.0.4

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.4
File Size Uploaded
pyppeteer-0.0.4.tar.gz 35.4 kB Details

Release files / pyppeteer-0.0.4.tar.gz

Download URL pyppeteer-0.0.4.tar.gz
Size 35.4 kB
Tags Source
SHA-256 checksum
How to use checksums
4bba8e35a6199c6d448efc9c02f33623336ff5b93e54f70fdee588db9dd78146
BLAKE2b-256 checksum
How to use checksums
25f4847c023e62d0a0c4f0fba9d904b0d4384726f845281c652bebe2db239196
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
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