Skip to content

changelog.rst

Latest commit

 

History

History
310 lines (248 loc) · 20.1 KB

changelog.rst

File metadata and controls

310 lines (248 loc) · 20.1 KB

Changelog

0.24.0 (UNRELEASED)

  • BREAKING: Updated minimum supported pytest version to v8.2.0
  • Adds an optional loop_scope keyword argument to pytest.mark.asyncio. This argument controls which event loop is used to run the marked async test. #706, #871
  • Deprecates the optional scope keyword argument to pytest.mark.asyncio for API consistency with pytest_asyncio.fixture. Users are encouraged to use the loop_scope keyword argument, which does exactly the same.
  • Raises an error when passing scope or loop_scope as a positional argument to @pytest.mark.asyncio. #812
  • Fixes a bug that caused module-scoped async fixtures to fail when reused in other modules #862 #668
  • Improves detection of multiple event loops being requested by the same test in strict mode #868

0.23.8 (2024-07-17)

  • Fixes a bug that caused duplicate markers in async tests #813
  • Declare support for Python 3.13

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.7 (2024-05-19)

  • Silence deprecation warnings about unclosed event loops that occurred with certain CPython patch releases #817

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.6 (2024-03-19)

  • Fix compatibility with pytest 8.2 #800

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.5 (2024-02-09)

  • Declare compatibility with pytest 8 #737
  • Fix typing errors with recent versions of mypy #769
  • Prevent DeprecationWarning about internal use of asyncio.get_event_loop() from affecting test cases #757

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.4 (2024-01-28)

  • pytest-asyncio no longer imports additional, unrelated packages during test collection #729
  • Addresses further issues that caused an internal pytest error during test collection
  • Declares incompatibility with pytest 8 #737

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.3 (2024-01-01)

  • Fixes a bug that caused event loops to be closed prematurely when using async generator fixtures with class scope or wider in a function-scoped test #706
  • Fixes various bugs that caused an internal pytest error during test collection #711 #713 #719

Known issues

As of v0.23, pytest-asyncio attaches an asyncio event loop to each item of the test suite (i.e. session, packages, modules, classes, functions) and allows tests to be run in those loops when marked accordingly. Pytest-asyncio currently assumes that async fixture scope is correlated with the new event loop scope. This prevents fixtures from being evaluated independently from the event loop scope and breaks some existing test suites (see #706). For example, a test suite may require all fixtures and tests to run in the same event loop, but have async fixtures that are set up and torn down for each module. If you're affected by this issue, please continue using the v0.21 release, until it is resolved.

0.23.2 (2023-12-04)

  • Fixes a bug that caused an internal pytest error when collecting .txt files #703

0.23.1 (2023-12-03)

  • Fixes a bug that caused an internal pytest error when using module-level skips #701

0.23.0 (2023-12-03)

This release is backwards-compatible with v0.21. Changes are non-breaking, unless you upgrade from v0.22.

  • BREAKING: The asyncio_event_loop mark has been removed. Event loops with class, module, package, and session scopes can be requested via the scope keyword argument to the _asyncio_ mark.
  • Introduces the event_loop_policy fixture which allows testing with non-default or multiple event loops #662
  • Introduces pytest_asyncio.is_async_test which returns whether a test item is managed by pytest-asyncio #376
  • Removes and pytest-trio, mypy, and flaky from the test dependencies #620, #674, #678,

0.22.0 (2023-10-31)

This release has been yanked from PyPI due to fundamental issues with the _asyncio_event_loop_ mark.

  • Class-scoped and module-scoped event loops can be requested via the _asyncio_event_loop_ mark. #620
  • Deprecate redefinition of the event_loop fixture. #587 Users requiring a class-scoped or module-scoped asyncio event loop for their tests should mark the corresponding class or module with asyncio_event_loop.
  • Test items based on asynchronous generators always exit with xfail status and emit a warning during the collection phase. This behavior is consistent with synchronous yield tests. #642
  • Remove support for Python 3.7
  • Declare support for Python 3.12

0.21.2 (2024-04-29)

  • Fix compatibility with pytest 8.2. Backport of #800 to pytest-asyncio v0.21 for users who are unable to upgrade to a more recent version (see #706)

0.21.1 (2023-07-12)

  • Output a proper error message when an invalid asyncio_mode is selected.
  • Extend warning message about unclosed event loops with additional possible cause. #531
  • Previously, some tests reported "skipped" or "xfailed" as a result. Now all tests report a "success" result.

0.21.0 (2023-03-19)

  • Drop compatibility with pytest 6.1. Pytest-asyncio now depends on pytest 7.0 or newer.
  • pytest-asyncio cleans up any stale event loops when setting up and tearing down the event_loop fixture. This behavior has been deprecated and pytest-asyncio emits a DeprecationWarning when tearing down the event_loop fixture and current event loop has not been closed.

0.20.3 (2022-12-08)

  • Prevent DeprecationWarning to bubble up on CPython 3.10.9 and 3.11.1. #460

0.20.2 (2022-11-11)

  • Fixes an issue with async fixtures that are defined as methods on a test class not being rebound to the actual test instance. #197
  • Replaced usage of deprecated @pytest.mark.tryfirst with @pytest.hookimpl(tryfirst=True) #438

0.20.1 (2022-10-21)

  • Fixes an issue that warned about using an old version of pytest, even though the most recent version was installed. #430

0.20.0 (2022-10-21)

  • BREAKING: Removed legacy mode. If you're upgrading from v0.19 and you haven't configured asyncio_mode = legacy, you can upgrade without taking any additional action. If you're upgrading from an earlier version or you have explicitly enabled legacy mode, you need to switch to auto or strict mode before upgrading to this version.
  • Deprecate use of pytest v6.
  • Fixed an issue which prevented fixture setup from being cached. #404

0.19.0 (2022-07-13)

  • BREAKING: The default asyncio_mode is now strict. #293
  • Removes setup.py since all relevant configuration is present setup.cfg. Users requiring an editable installation of pytest-asyncio need to use pip v21.1 or newer. #283
  • Declare support for Python 3.11.

0.18.3 (2022-03-25)

  • Adds pytest-trio to the test dependencies
  • Fixes a bug that caused pytest-asyncio to try to set up async pytest_trio fixtures in strict mode. #298

0.18.2 (2022-03-03)

  • Fix asyncio auto mode not marking static methods. #295
  • Fix a compatibility issue with Hypothesis 6.39.0. #302

0.18.1 (2022-02-10)

  • Fixes a regression that prevented async fixtures from working in synchronous tests. #286

0.18.0 (2022-02-07)

  • Raise a warning if @pytest.mark.asyncio is applied to non-async function. #275
  • Support parametrized event_loop fixture. #278

0.17.2 (2022-01-17)

  • Require typing-extensions on Python<3.8 only. #269
  • Fix a regression in tests collection introduced by 0.17.1, the plugin works fine with non-python tests again. #267

0.17.1 (2022-01-16)

  • Fixes a bug that prevents async Hypothesis tests from working without explicit asyncio marker when --asyncio-mode=auto is set. #258
  • Fixed a bug that closes the default event loop if the loop doesn't exist #257
  • Added type annotations. #198
  • Show asyncio mode in pytest report headers. #266
  • Relax asyncio_mode type definition; it allows to support pytest 6.1+. #262

0.17.0 (2022-01-13)

  • pytest-asyncio no longer alters existing event loop policies. #168, #188
  • Drop support for Python 3.6
  • Fixed an issue when pytest-asyncio was used in combination with flaky or inherited asynchronous Hypothesis tests. #178 #231
  • Added flaky to test dependencies
  • Added unused_udp_port and unused_udp_port_factory fixtures (similar to unused_tcp_port and unused_tcp_port_factory counterparts. #99
  • Added the plugin modes: strict, auto, and legacy. See documentation for details. #125
  • Correctly process KeyboardInterrupt during async fixture setup phase #219

0.16.0 (2021-10-16)

  • Add support for Python 3.10

0.15.1 (2021-04-22)

  • Hotfix for errors while closing event loops while replacing them. #209 #210

0.15.0 (2021-04-19)

  • Add support for Python 3.9
  • Abandon support for Python 3.5. If you still require support for Python 3.5, please use pytest-asyncio v0.14 or earlier.
  • Set unused_tcp_port_factory fixture scope to 'session'. #163
  • Properly close event loops when replacing them. #208

0.14.0 (2020-06-24)

  • Fix #162, and event_loop fixture behavior now is coherent on all scopes. #164

0.12.0 (2020-05-04)

  • Run the event loop fixture as soon as possible. This helps with fixtures that have an implicit dependency on the event loop. #156

0.11.0 (2020-04-20)

  • Test on 3.8, drop 3.3 and 3.4. Stick to 0.10 for these versions. #152
  • Use the new Pytest 5.4.0 Function API. We therefore depend on pytest >= 5.4.0. #142
  • Better pytest.skip support. #126

0.10.0 (2019-01-08)

  • pytest-asyncio integrates with Hypothesis to support @given on async test functions using asyncio. #102
  • Pytest 4.1 support. #105

0.9.0 (2018-07-28)

  • Python 3.7 support.
  • Remove event_loop_process_pool fixture and pytest.mark.asyncio_process_pool marker (see https://bugs.python.org/issue34075 for deprecation and removal details)

0.8.0 (2017-09-23)

  • Improve integration with other packages (like aiohttp) with more careful event loop handling. #64

0.7.0 (2017-09-08)

  • Python versions pre-3.6 can use the async_generator library for async fixtures. #62 <#62>

0.6.0 (2017-05-28)

  • Support for Python versions pre-3.5 has been dropped.
  • pytestmark now works on both module and class level.
  • The forbid_global_loop parameter has been removed.
  • Support for async and async gen fixtures has been added. #45
  • The deprecation warning regarding asyncio.async() has been fixed. #51

0.5.0 (2016-09-07)

  • Introduced a changelog. #31
  • The event_loop fixture is again responsible for closing itself. This makes the fixture slightly harder to correctly override, but enables other fixtures to depend on it correctly. #30
  • Deal with the event loop policy by wrapping a special pytest hook, pytest_fixture_setup. This allows setting the policy before fixtures dependent on the event_loop fixture run, thus allowing them to take advantage of the forbid_global_loop parameter. As a consequence of this, we now depend on pytest 3.0. #29

0.4.1 (2016-06-01)

  • Fix a bug preventing the propagation of exceptions from the plugin. #25

0.4.0 (2016-05-30)

  • Make event_loop fixtures simpler to override by closing them in the plugin, instead of directly in the fixture. #21
  • Introduce the forbid_global_loop parameter. #21

0.3.0 (2015-12-19)

  • Support for Python 3.5 async/await syntax. #17

0.2.0 (2015-08-01)

  • unused_tcp_port_factory fixture. #10

0.1.1 (2015-04-23)

Initial release.