Asynchronous wrapper over Chromium browser debugger protocol.
Project description
Асинхронная обёртка над протоколом отладчика браузера Chromium.
Запуски проводятся только в ОС Windows и Linux.
Установка
pip install aio-dt-protocol
Имеет одну зависимость: https://github.com/aaugustin/websockets
И так как всё общение через протокол основано на формате JSON, по желанию можно установить в окружение ujson: https://github.com/ultrajson/ultrajson
Примеры:
import asyncio
from aio_dt_protocol import Browser
from aio_dt_protocol import BrowserName
from aio_dt_protocol import find_instances
from aio_dt_protocol.data import KeyEvents
DEBUG_PORT: int = 9222
BROWSER_NAME: str = BrowserName.CHROME
PROFILE_NAME: str = BROWSER_NAME.capitalize() + "_Profile"
async def main() -> None:
# ? Если на указанном порту есть запущенный браузер, происходит подключение.
if browser_instances := find_instances(DEBUG_PORT, BROWSER_NAME):
browser = Browser(
debug_port=DEBUG_PORT,
browser_pid=browser_instances[DEBUG_PORT])
msg = f"[- CONNECT TO EXIST BROWSER ON {DEBUG_PORT} PORT -]"
# ? Иначе, запуск нового браузера.
else:
browser = Browser(
debug_port=DEBUG_PORT, browser_exe=BROWSER_NAME,
profile_path=PROFILE_NAME
)
msg = f"[- LAUNCH NEW BROWSER ON {DEBUG_PORT} PORT -]"
print(msg)
# ? Будет печатать в консоль всё, что приходит по соединению со страницей.
# ? Полезно при разработке.
# async def action_printer(data: dict) -> None:
# print(data)
# conn = await browser.waitFirstTab(callback=action_printer)
conn = await browser.waitFirstTab()
print("[- GO TO GOOGLE ... -]")
await conn.Page.navigate("https://www.google.com", )
print("[- EMULATE INPUT TEXT ... -]")
input_node = await conn.DOM.querySelector("[type=search]")
# ? Эмуляция клика в поисковую строку
await input_node.click()
await asyncio.sleep(1)
# ? Вставка текста
await conn.Input.insertText("github PieceOfGood")
await asyncio.sleep(1)
# ? Эмуляция нажатия клавиши Enter
await conn.extend.action.sendKeyEvent(KeyEvents.enter)
await asyncio.sleep(1)
# ? Нажатие Enter можно заменить кликом по кнопке
# ? используя протокол
# submit_button_selector = "div:not([jsname])>center>[type=submit]:not([jsaction])"
# submit_button = await conn.DOM.querySelector(submit_button_selector)
# await submit_button.click()
# ? Или выполнить клик используя JavaScript
# click_code = f"""\
# document.querySelector("{submit_button_selector}").click();
# """
# await conn.extend.injectJS(click_code)
print("[- WAIT FOR CLOSE PAGE ... -]")
# ? Пока соединение существует, цикл выполняется.
await conn.waitForClose()
print("[- DONE -]")
if __name__ == '__main__':
asyncio.run(main())
На страницу можно легко зарегистрировать слушателей, которые будут вызываться на стороне клиентского(Python) кода. Для этого необходимо зарегистрировать вызываемую функцию в качестве такого слушателя. Это возможно выполнить двумя способами:
- Вручную передав методу
addBinding()доменаRuntimeимя функции в виде строки. - Воспользоваться более функциональной обёрткой первого способа, выраженной в методе
bindFunction()соединения.
Второй способ менее многословен. Под капотом он добавляет в контекст страницы утилиту py_call(), первым аргументом принимающую имя функции, после чего, любое кол-во позиционных аргументов, которые ожидает эта функция, а так же позволяет прикрепить любое кол-во аргументов, передаваемых в функцию последними. Например:
html = """\
<html lang="ru">
<head>
<meta charset="utf-8" />
<title>Test application</title>
</head>
<body>
<button id="knopka">Push me</button>
</body>
<script>
const btn = document.querySelector('#knopka');
btn.addEventListener('click', () => {
py_call("test_func", 1, "test")
});
</script>
</html>"""
# ? number и text будут переданы из браузера, а bind_arg указан при регистрации
async def test_func(number: int, text: str, bind_arg: dict) -> None:
print(f"[- test_func -] Called with args:\n\tnumber: {number}"
f"\n\ttext: {text}\n\tbing_arg: {bind_arg}")
await conn.bindFunction(
test_func, # ! слушатель
{"name": "test", "value": True} # ! bind_arg
)
# ? Если ожидается внушительный функционал прикрутить к странице, то это можно
# ? сделать за один раз.
# await conn.bindFunctions(
# (test_func, [ {"name": "test", "value": True} ]),
# # (any_awaitable1, [1, 2, 3])
# # (any_awaitable2, [])
# )
await conn.Page.navigate(html)
Headless
Чтобы запустить браузер в безголовом(headless) режиме, передайте пустую строку аргументу(profile_path) принимающему путь к папке профиля.
import asyncio
from aio_dt_protocol import Browser, BrowserName, find_instances
from aio_dt_protocol.utils import save_img_as, async_util_call
DEBUG_PORT: int = 9222
BROWSER_NAME: str = BrowserName.CHROME
async def main() -> None:
# ? Если на указанном порту есть запущенный браузер, происходит подключение.
if browser_instances := find_instances(DEBUG_PORT, BROWSER_NAME):
browser = Browser(
debug_port=DEBUG_PORT,
browser_pid=browser_instances[DEBUG_PORT])
msg = f"[- HEADLESS CONNECT TO EXIST BROWSER ON {DEBUG_PORT} PORT -]"
# ? Иначе, запуск нового браузера.
else:
browser = Browser(
debug_port=DEBUG_PORT, browser_exe=BROWSER_NAME,
profile_path=""
)
msg = f"[- HEADLESS LAUNCH NEW BROWSER ON {DEBUG_PORT} PORT -]"
print(msg)
print("[- WAITING PAGE -]")
conn = await browser.waitFirstTab()
print("[- GO TO GOOGLE -]")
await conn.Page.navigate("https://www.google.com")
print("[- MAKE SCREENSHOT -]")
await async_util_call(
save_img_as, "google.png", await conn.extend.makeScreenshot()
)
print("[- CLOSE BROWSER -]")
await conn.Browser.close()
print("[- DONE -]")
if __name__ == '__main__':
asyncio.run(main())
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aio_dt_protocol-1.1.1.tar.gz
(98.0 kB
view details)
File details
Details for the file aio_dt_protocol-1.1.1.tar.gz.
File metadata
- Download URL: aio_dt_protocol-1.1.1.tar.gz
- Upload date:
- Size: 98.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5c578855081ef8a8c8fa9f7ba3b678ca515dbfbbbd76d480e78227acffce2323 |
|
| MD5 | feac40ede77735f9ddbfd9512873f2eb |
|
| BLAKE2b-256 | d450ce3fedcc994a4c8e5853e0fc2053df4faf950ed9b5539c8c24b236f1cae3 |
