Add mechanism for explicit marking of fixtures which should be run with asyncio by pipermerriam · Pull Request #125 · pytest-dev/pytest-asyncio

pipermerriam · 2019-05-10T20:00:20Z

Fixes Require explicit marks for async fixtures #124

Opening this up to get feedback from the maintainers.

With this patch existing users of pytest-asyncio should not experience any change in behavior.

This exposes a new API pytest_asyncio.asyncio_fixture that is intended to be used like this:

import pytest_asyncio


@pytest_asyncio.asyncio_fixture
async def server():   # async yield fixture
    await server.start()
    yield
    await server.stop()

@pytest_asyncio.asyncio_fixture
async def client():  # normal async function
    await client.connect_to_server()
    return client

This PR also adds a pytest.ini configuration value: asyncio_mode which defaults to True. When set to False, only fixtures with the above mark (as well as a few other conditions) will be run by the asyncio event loop.

Some notes:

I did not see a test suite. This was tested manually against a local project. If you'd like me to write up some tests I don't mind, but it felt heavy handed to do that without the blessing of a maintainer.
Looking for feedback on whether this is a feature that will be accepted before I polish this and make it nice.

…der asyncio

asvetlov · 2019-05-14T16:24:34Z

I'm not a maintainer but have 5 cents to add.

I think we need not a bool flag but three-state:

"on": automatically apply pytest.mark.asyncio to all discovered asynchronous fixtures and tests
"off": do nothing with autoapplying
"compat" (which is default and deprecated): the current behavior. Apply asyncio mark to async fixtures but don't apply to async tests.

Having default "compat" mode deprecated we notice people switch either to "on" or "off" in their pytest configuration to avoid deprecation warning displayed by pytest.
After some deprecation period we can switch default and even drop "compat" mode eventually.

asvetlov · 2019-06-12T09:09:11Z

@pipermerriam do you want to implement on/off/compat mode?

pipermerriam · 2019-06-12T16:25:46Z

@asvetlov yes, but it will be about 2 weeks before I pick this back up. Life and work things taking front seat for a bit and won't be able to focus on this for till then. (won't be offended if anyone takes what I started and moves forward with it)

asvetlov · 2019-06-12T19:05:35Z

I'm personally is overwhelmed as well by my job and fixing CPython 3.8 beta.
I had a hope to finish 3.8 hacking this week but seems I need more time.
There is a low chance that I can pick up your job in a week or two.

graingert · 2021-06-27T19:08:54Z

@pipermerriam I had a go at resolving the conflicts, but I'm not sure what needs doing in pytest_asyncio/plugin.py

Gentoo are currently having trouble when running the anyio test suite with pytest-asyncio installed

codecov-commenter · 2022-01-07T18:42:01Z

Codecov Report

Merging #125 (7fb70ed) into master (d48569e) will decrease coverage by 0.58%.
The diff coverage is 94.66%.

@@            Coverage Diff             @@
##           master     #125      +/-   ##
==========================================
- Coverage   96.17%   95.59%   -0.59%     
==========================================
  Files           2        2              
  Lines         157      227      +70     
==========================================
+ Hits          151      217      +66     
- Misses          6       10       +4

Impacted Files	Coverage Δ
pytest_asyncio/plugin.py	`95.53% <94.52%> (-0.62%)`	⬇️
pytest_asyncio/__init__.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d48569e...7fb70ed. Read the comment docs.

graingert · 2022-01-07T18:50:30Z

@asvetlov thanks for taking this on!

README.rst

asvetlov · 2022-01-07T21:33:44Z

The PR is done and tested.

@Tinche @seifertm I very much appreciate your review.

Please feel free to ask a question if elaboration is needed.

Co-authored-by: Thomas Grainger <[email protected]>

Tinche

Left suggestions for a couple of typos, looks good overall. A really good change!

README.rst

Co-authored-by: Tin Tvrtković <[email protected]>

seifertm

This is great! Tests shouldn't just break when pytest-asyncio is installed in addition to any other package. The new modes are also more consistent than the current behavior.

I like that we switched from @pytest_asyncio.asyncio_fixture to the shorter @pytest_asyncio.fixture. I also appreciate that asyncio_mode=strict is the new default.

I annotated a few typos and issues in the docs. Other than that: Great job!

pytest_asyncio/plugin.py

tests/modes/test_legacy_mode.py

README.rst

Co-authored-by: Michael Seifert <[email protected]>

asvetlov · 2022-01-08T17:41:50Z

Thanks, guys!

Add mechanism for explicit marking of fixtures which should be run un…

8360902

…der asyncio

pipermerriam mentioned this pull request May 10, 2019

[WIP] Trio based implementation of the Endpoint API ethereum/lahja#56

Closed

This comment has been minimized.

Sign in to view

pipermerriam mentioned this pull request Jun 12, 2019

Require explicit marks for async fixtures #124

Closed

florimondmanca mentioned this pull request Sep 30, 2019

Fix bug when entering/exiting task group as part of different asyncio tasks agronholm/anyio#75

Closed

asvetlov added 2 commits January 7, 2022 14:31

Add __all__

6fc12d8

Implement auto, strict, legacy modes

b8eef27

Reformat

ce6bbf5

asvetlov added 3 commits January 7, 2022 22:11

Work on

b6f3ca0

Add tests

da87ba6

Update README

2523772

graingert reviewed Jan 7, 2022

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Update README.rst

41892a1

Co-authored-by: Thomas Grainger <[email protected]>

Tinche self-requested a review January 8, 2022 15:37

Tinche approved these changes Jan 8, 2022

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

seifertm self-requested a review January 8, 2022 16:19

Apply suggestions from code review

eeaec64

Co-authored-by: Tin Tvrtković <[email protected]>

seifertm approved these changes Jan 8, 2022

View reviewed changes

pytest_asyncio/plugin.py Outdated Show resolved Hide resolved

pytest_asyncio/plugin.py Outdated Show resolved Hide resolved

tests/modes/test_legacy_mode.py Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

asvetlov and others added 2 commits January 8, 2022 19:27

Apply suggestions from code review

63b45bf

Co-authored-by: Michael Seifert <[email protected]>

Update tests/modes/test_legacy_mode.py

7fb70ed

Co-authored-by: Michael Seifert <[email protected]>

asvetlov merged commit f86d900 into pytest-dev:master Jan 8, 2022

asvetlov mentioned this pull request Jan 8, 2022

Automatically mark async test functions #61

Closed

Comments

Conversation

pipermerriam commented May 10, 2019

Uh oh!

This comment has been minimized.

asvetlov commented May 14, 2019

Uh oh!

asvetlov commented Jun 12, 2019

Uh oh!

pipermerriam commented Jun 12, 2019

Uh oh!

asvetlov commented Jun 12, 2019

Uh oh!

graingert commented Jun 27, 2021

Uh oh!

codecov-commenter commented Jan 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

graingert commented Jan 7, 2022

Uh oh!

Uh oh!

asvetlov commented Jan 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Tinche left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

seifertm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asvetlov commented Jan 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-commenter commented Jan 7, 2022 •

edited

Loading

asvetlov commented Jan 7, 2022 •

edited

Loading