[FEATURE] Expose Playwright async/await flavor #74

maratori · 2021-09-08T21:31:39Z

I need to run aiohttp server and use playwright in tests at the same time.
Am I right that pytest-playwright right now can't help me with that?

It provides fixtures only for sync API. But I need async API.
So I have to do something like that.

from aiohttp import web
from playwright.async_api import async_playwright

async def index_html(request):
    return web.Response(body="<html><body>Hello world</body></html>", content_type="text/html")

async def test_without_page_fixture_passes(aiohttp_server):
    app = web.Application()
    app.router.add_get("/", index_html)
    server = await aiohttp_server(app)
    async with async_playwright() as p:
        browser = await p.chromium.launch()
        context = await browser.new_context()
        page = await context.new_page()
        await page.goto(str(server.make_url("/")))
        assert await page.text_content("body") == "Hello world"

The text was updated successfully, but these errors were encountered:

mxschmitt · 2021-09-09T11:28:08Z

Exactly, currently the pytest plugin does only provide the sync APIs. So you need to launch browser etc. yourself, something similar to https://github.com/microsoft/playwright-python/blob/master/tests/async/conftest.py

Shall I rename this issue title into a feature request for providing also the async flavor?

maratori · 2021-09-09T11:36:07Z

Thanks.

Shall I rename this issue title into a feature request for providing also the async flavor?

Sure, go ahead.

dwiyatci · 2021-12-12T09:23:51Z

Exactly, currently the pytest plugin does only provide the sync APIs. So you need to launch browser etc. yourself, something similar to https://github.com/microsoft/playwright-python/blob/master/tests/async/conftest.py

Shall I rename this issue title into a feature request for providing also the async flavor?

@mxschmitt I'm on Playwright v1.17 and I did try to copy-paste all the fixtures in the file you pointed here (except the utils), but then I got:

E       fixture 'launch_arguments' not found
>       available fixtures: _verify_url, base_url, browser, browser_channel, browser_context_args, browser_factory, browser_name, browser_type, browser_type_launch_args, cache, capfd, capfdbinary, caplog, capsys, capsysbinary, context, context_factory, delete_output_dir, device, doctest_namespace, event_loop, is_chromium, is_firefox, is_webkit, launch_browser, monkeypatch, page, password, playwright, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, report_name, selectors, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory, username
>       use 'pytest --fixtures [testpath]' for help on them.

I quickly fixed it by changing launch_arguments to browser_type_launch_args, but then again, I got:

playwright = <async_generator object playwright at 0x111459d40>, browser_name = 'chromium'

    @pytest.fixture(scope="session")
    def browser_type(playwright, browser_name: str):
        if browser_name == "chromium":
>           return playwright.chromium
E           AttributeError: 'async_generator' object has no attribute 'chromium'

conftest.py:20: AttributeError

I'm pretty new to Python and pytest but I guess async_generator of playwright_object instead of playwright_object itself being "injected" to browser_type – any pointer on how I should remedy this? And is this async gonna be planned to be supported in the end? 😅 Thank you.

mxschmitt · 2021-12-12T15:35:37Z

@dwiyatci why do you prefer async over sync? Understanding this use-case for the testing scenario would us help to prioritize it.

dwiyatci · 2021-12-12T22:22:35Z

@mxschmitt I would like to implement a custom wait_for_network_settled function like this (microsoft/playwright#7856 (comment)), and I believe it'd be much easier if I could have asyncio in place.

fscherf · 2021-12-13T13:30:56Z

@mxschmitt: I want to use this plugin together with aiohttp-pytest, because my project is based on aiohttp. Thats the reason why @maratori and i prefer (in this case) async over sync.

baiyyee · 2022-09-17T03:10:16Z

any updates for this feature?

nathanielobrown · 2023-06-19T11:01:25Z

It is very odd that there are async/sync versions of Playwright Python but the integration with pytest only supports sync. If the primary purpose of Playwright is to write tests, but the async version cannot be used with the dominant test framework, then what is the async version's purpose? If the async version is intended for applications other than testing, then this is still odd as we'd likely want to use pytest to test that code.

On a more pragmatic level, as more and more applications are written using async libraries, more and more tests will need to be async. Also, having async tests allows us to use some cleaner semantics for things like processes that happen in parallel.

There's also the issue (microsoft/playwright-python#1339 (comment)) I ran into that we can't even mix async/sync tests in the same test suite and use playwright-pytest.

@mxschmitt, do you have pointers on how hard this would be/what would need to be done?

mxschmitt · 2023-06-19T11:13:10Z

@nathanielobrown I totally agree that providing an async layer would be cool! The reason why we didn't do it yet was that its more idiomatic to write tests in sync mode (debugging, you don't need to install other pytest plugins, REPL just works etc).

Regarding how hard it is to implement, I think it hardly depends on the question how much code we want to duplicate. In general the pytest-playwright plugin is not a lot of code, to provide an async version, we could in theory just copy it and use the async version of Playwright and it should just work™️ . Something where I'm not sure about is if we need a dedicated plugin (PIP package) for the async version or if we can internally detect somehow if its async or sync and then do conditional logic. This requires some investigation.

(happy to accept patches for it, just not something we prioritise, since not a lot of users have requested it so far.)

nathanielobrown · 2023-06-19T11:43:49Z

@mxschmitt, that's great to hear there is no technical blocker. My initial thought would be to add new fixtures to the same package with _async suffixes, like page_async. Then users can mix/match/migrate to their hearts content. Auto detection would be cool, but even if there's a way to do that I feel like that would be more likely to cause issues and it's not to much load to just use different fixture names.

Also this fix (microsoft/playwright-python#1339 (comment)) for the multiple event loops issue just worked from me and is topical.

I'll probably work something up locally and if it works well can create a PR.

m9810223 · 2023-06-25T16:18:23Z

Hey guys!
I made a plugin https://github.com/m9810223/playwright-async-pytest that support async playwright for my projects.
It refers to original plugin, welcome to use it if you need!

balazs-ita-epam · 2023-07-24T09:17:56Z

Waiting for the async feature in pytest!

maratori mentioned this issue Sep 8, 2021

Lona has no browser tests lona-web-org/lona#74

Closed

mxschmitt added the triaging label Sep 9, 2021

mxschmitt changed the title ~~pytest-playwright is not compatible with aiohttp~~ Expose Playwright async/await flavor Sep 9, 2021

mxschmitt added p3-collecting-feedback and removed triaging labels Sep 9, 2021

roniemartinez mentioned this issue Apr 25, 2022

feat(codegen): pytest support in codegen microsoft/playwright#13746

Merged

seifertm mentioned this issue Jun 19, 2022

RuntimeError: Cannot run the event loop while another loop is running pytest-dev/pytest-asyncio#359

Closed

mxschmitt changed the title ~~Expose Playwright async/await flavor~~ [Feature] Expose Playwright async/await flavor Jul 6, 2022

mxschmitt changed the title ~~[Feature] Expose Playwright async/await flavor~~ [FEATURE] Expose Playwright async/await flavor Jul 6, 2022

mxschmitt mentioned this issue Jul 12, 2022

[Question]: RuntimeError: Cannot run the event loop while another loop is running microsoft/playwright-python#1339

Closed

rwoll mentioned this issue Aug 15, 2022

Verify files status in parallel while using bulk upload microsoft/playwright-python#1480

Closed

This was referenced Feb 6, 2023

[Question] microsoft/playwright#20683

Closed

how to playwright async working pytest microsoft/playwright#20682

Closed

mxschmitt mentioned this issue Jul 21, 2023

[Question]: Best practices for using page-objects as pytest fixtures and for implementing async methods microsoft/playwright-python#2008

Closed

mxschmitt mentioned this issue Sep 1, 2023

chore: introduce asyncio mode #184

Draft

jamesbraza mentioned this issue Jan 25, 2024

Request: async support #201

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Expose Playwright async/await flavor #74

[FEATURE] Expose Playwright async/await flavor #74

maratori commented Sep 8, 2021

mxschmitt commented Sep 9, 2021 •

edited

maratori commented Sep 9, 2021

dwiyatci commented Dec 12, 2021

mxschmitt commented Dec 12, 2021

dwiyatci commented Dec 12, 2021

fscherf commented Dec 13, 2021

baiyyee commented Sep 17, 2022

nathanielobrown commented Jun 19, 2023

mxschmitt commented Jun 19, 2023

nathanielobrown commented Jun 19, 2023

m9810223 commented Jun 25, 2023

balazs-ita-epam commented Jul 24, 2023

[FEATURE] Expose Playwright async/await flavor #74

[FEATURE] Expose Playwright async/await flavor #74

Comments

maratori commented Sep 8, 2021

mxschmitt commented Sep 9, 2021 • edited

maratori commented Sep 9, 2021

dwiyatci commented Dec 12, 2021

mxschmitt commented Dec 12, 2021

dwiyatci commented Dec 12, 2021

fscherf commented Dec 13, 2021

baiyyee commented Sep 17, 2022

nathanielobrown commented Jun 19, 2023

mxschmitt commented Jun 19, 2023

nathanielobrown commented Jun 19, 2023

m9810223 commented Jun 25, 2023

balazs-ita-epam commented Jul 24, 2023

mxschmitt commented Sep 9, 2021 •

edited