Skip to content

Update pluggy to 1.3.0#112

Closed
pyup-bot wants to merge 1 commit intomainfrom
pyup-update-pluggy-1.0.0-to-1.3.0
Closed

Update pluggy to 1.3.0#112
pyup-bot wants to merge 1 commit intomainfrom
pyup-update-pluggy-1.0.0-to-1.3.0

Conversation

@pyup-bot
Copy link
Collaborator

This PR updates pluggy from 1.0.0 to 1.3.0.

Changelog

1.3.0

=========================

Deprecations and Removals
-------------------------

- `426 <https://github.com/pytest-dev/pluggy/issues/426>`_: Python 3.7 is no longer supported.



Features
--------

- `428 <https://github.com/pytest-dev/pluggy/issues/428>`_: Pluggy now exposes its typings to static type checkers.

As part of this, the following changes are made:

- Renamed ``_Result`` to ``Result``, and exported as :class:`pluggy.Result`.
- Renamed ``_HookRelay`` to ``HookRelay``, and exported as :class:`pluggy.HookRelay`.
- Renamed ``_HookCaller`` to ``HookCaller``, and exported as :class:`pluggy.HookCaller`.
- Exported ``HookImpl`` as :class:`pluggy.HookImpl`.
- Renamed ``_HookImplOpts`` to ``HookimplOpts``, and exported as :class:`pluggy.HookimplOpts`.
- Renamed ``_HookSpecOpts`` to ``HookspecOpts``, and exported as :class:`pluggy.HookspecOpts`.
- Some fields and classes are marked ``Final`` and ``final``.
- The :ref:`api-reference` is updated to clearly delineate pluggy's public API.

Compatibility aliases are put in place for the renamed types.
We do not plan to remove the aliases, but we strongly recommend to only import from ``pluggy.*`` to ensure future compatibility.

Please note that pluggy is currently unable to provide strong typing for hook calls, e.g. ``pm.hook.my_hook(...)``,
nor to statically check that a hook implementation matches the hook specification's type.

1.2.0

=========================

Features
--------

- `405 <https://github.com/pytest-dev/pluggy/issues/405>`_: The new-style hook wrappers, added in the yanked 1.1.0 release, now require an explicit ``wrapper=True`` designation in the ``hookimpl()`` decorator.

1.1.0

=====================

.. note::

This release was yanked because unfortunately the implicit new-style hook wrappers broke some downstream projects.
See `403 <https://github.com/pytest-dev/pluggy/issues/403>`__ for more information.
This was rectified in the 1.2.0 release.

Deprecations and Removals
-------------------------

- `364 <https://github.com/pytest-dev/pluggy/issues/364>`_: Python 3.6 is no longer supported.



Features
--------

- `260 <https://github.com/pytest-dev/pluggy/issues/260>`_: Added "new-style" hook wrappers, a simpler but equally powerful alternative to the existing ``hookwrapper=True`` wrappers.

New-style wrappers are generator functions, similarly to ``hookwrapper``, but do away with the :class:`result <pluggy.Result>` object.
Instead, the return value is sent directly to the ``yield`` statement, or, if inner calls raised an exception, it is raised from the ``yield``.
The wrapper is expected to return a value or raise an exception, which will become the result of the hook call.

New-style wrappers are fully interoperable with old-style wrappers.
We encourage users to use the new style, however we do not intend to deprecate the old style any time soon.

See :ref:`hookwrappers` for the full documentation.


- `364 <https://github.com/pytest-dev/pluggy/issues/364>`_: Python 3.11 and 3.12 are now officially supported.


- `394 <https://github.com/pytest-dev/pluggy/issues/394>`_: Added the :meth:`~pluggy.Result.force_exception` method to ``_Result``.

``force_exception`` allows (old-style) hookwrappers to force an exception or override/adjust an existing exception of a hook invocation,
in a properly behaving manner. Using ``force_exception`` is preferred over raising an exception from the hookwrapper,
because raising an exception causes other hookwrappers to be skipped.
Links

@pyup-bot pyup-bot mentioned this pull request Aug 26, 2023
@pyup-bot
Copy link
Collaborator Author

Closing this in favor of #132

@pyup-bot pyup-bot closed this Jan 24, 2024
@felsb3 felsb3 deleted the pyup-update-pluggy-1.0.0-to-1.3.0 branch January 24, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments