Skip to content

Deprecate dict interface of entry_points result. #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaraco merged 2 commits into from
Mar 27, 2021
Merged

Deprecate dict interface of entry_points result. #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a36cbd
Deprecate dict usage of SelectableGroups.
jaraco Mar 4, 2021
ae14c73
Update changelog.
jaraco Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
v3.8.0
======

* Use of Mapping (dict) interfaces on ``SelectableGroups``
is now flagged as deprecated. Instead, users are advised
to use the select interface for future compatibility.

v3.7.0
======

Expand All @@ -24,12 +31,10 @@ v3.6.0

``entry_points()`` now provides a future-compatible
``SelectableGroups`` object that supplies the above interface
but remains a dict for compatibility.
(except item access) but remains a dict for compatibility.

In the future, ``entry_points()`` will return an
``EntryPoints`` object, but provide for backward
compatibility with a deprecated ``__getitem__``
accessor by group and a ``get()`` method.
``EntryPoints`` object for all entry points.

If passing selection parameters to ``entry_points``, the
future behavior is invoked and an ``EntryPoints`` is the
Expand Down
5 changes: 3 additions & 2 deletions importlib_metadata/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ def values(self):
return super().values()


class SelectableGroups(dict):
class SelectableGroups(Deprecated, dict):
"""
A backward- and forward-compatible result from
entry_points that fully implements the dict interface.
Expand All @@ -270,7 +270,8 @@ def _all(self):
"""
Reconstruct a list of all entrypoints from the groups.
"""
return EntryPoints(itertools.chain.from_iterable(self.values()))
groups = super(Deprecated, self).values()
return EntryPoints(itertools.chain.from_iterable(groups))

@property
def groups(self):
Expand Down