- #449: Expanded type annotations.
- python/cpython#103661: Removed excess error suppression in
_read_files_egginfo_installedand fixed path handling on Windows.
- #422: Removed ABC metaclass from
Distributionand instead deprecated construction of
Distributionobjects without concrete methods.
- Updated docs with tweaks from upstream CPython.
- Consolidated some behaviors in tests around
- Added type annotation for
- #115: Support
- #442: Fixed issue introduced in v6.1.0 where non-importable
names (metadata dirs) began appearing in
PackageMetadatanow stipulates an additional
getmethod allowing for easy querying of metadata keys that may not be present.
packages_distributionsnow honors packages and modules with Python modules that not
- #434: Expand protocol for
PackageMetadata.get_allto match the upstream implementation of
Distributionas an abstract class, enforcing definition of abstract methods in instantiated subclasses. It's no longer possible to instantiate a
Distributionor any subclasses unless they define the abstract methods.
Please comment in the issue if this change breaks any projects. This change will likely be rolled back if it causes significant disruption.
- #371: Deprecated expectation that
Nonefor missing keys. In the future, it will raise a
- #415: Instrument
SimplePathwith generic support.
- #97, #284, #300: Removed compatibility shims for deprecated entry point interfaces.
- #396: Added compatibility for
PathDistributionsoriginating from Python 3.8 and 3.9.
- py-93259: Now raise
Noneor an empty string are passed to
Distribution.from_name(and other callers).
- #379: In
PathDistribution._name_from_stem, avoid including parts of the extension in the result.
- #381: In
PathDistribution._normalized_name, ensure names loaded from the stem of the filename are also normalized, ensuring duplicate entry points by packages varying only by non-normalized name are hidden.
- #372: Removed cast of path items in FastPath, not needed.
- #369: Fixed bug where
EntryPoint.extraswas returning match objects and not the extras strings.
- #367: In
Distribution.requiresfor egg-info, if
requires.txtis empty, return an empty list.
- bpo-46246: Added
- #365 and bpo-46546: Avoid leaking
- #361: Avoid potential REDoS in
- #354: Removed
Distribution._localfactory. This functionality was created as a demonstration of the possible implementation. Now, the pep517 package provides this functionality directly through pep517.meta.load.
- Require Python 3.7 or later.
- #357: Fixed requirement generation from egg-info when a URL requirement is given.
- #353: Fixed discovery of distributions when path is empty.
#348: Restored support for
EntryPointaccess by item, deprecating support in the process. Users are advised to use direct member access instead of item-based access:
- ep -> ep.name - ep -> ep.value - ep -> ep.group - ep[:] -> ep.name, ep.value, ep.group
- #337: Rewrote
EntryPointas a simple class, still immutable and still with the attributes, but without any expectation for
namedtuplefunctionality such as
- #344: Fixed regression in
packages_distributionswhen neither top-level.txt nor a files manifest is present.
- #330: In
packages_distributions, now infer top-level names from
top-level.txt(Setuptools-specific metadata) is not present.
- #334: Correct
SimplePathprotocol to match
- Moved workaround for #327 to
- bpo-44784: Avoid errors in test suite when DeprecationWarnings are treated as errors.
- #327: Deprecation warnings now honor call stack variance on PyPy.
- #326: Performance tests now rely on
To disable these tests, which require network access
and a git checkout, pass
-p no:perfto pytest.
- #319: Remove
SelectableGroupsdeprecation exception for flake8.
- #300: Restore compatibility in the result from
EntryPoints) to honor expectations in older implementations and issuing deprecation warnings for these cases:
EntryPointsobjects are once again mutable, allowing for
sort()and other list-based mutation operations. Avoid deprecation warnings by casting to a mutable sequence (e.g.
EntryPointsresults once again allow for access by index. To avoid deprecation warnings, cast the result to a Sequence first (e.g.
- #320: Fix issue where normalized name for eggs was incorrectly solicited, leading to metadata being unavailable for eggs.
- #317: De-duplication of distributions no longer requires
loading the full metadata for
PathDistributionobjects, entry point loading performance by ~10x.
- Prefer f-strings to
- #312: Add support for metadata 2.2 (
- #315: Add
SimplePathprotocol for interface clarity in
- #306: Clearer guidance about compatibility in readme.
PackageMetadataas returned by
Distribution.metadata()now provides normalized metadata honoring PEP 566:
- If a long description is provided in the payload of the
RFC 822 value, it can be retrieved as the
- Any multi-line values in the metadata will be returned as such.
- For any multi-line values, line continuation characters are removed. This backward-incompatible change means that any projects relying on the RFC 822 line continuation characters being present must be tolerant to them having been removed.
- Add a
jsonproperty that provides the metadata converted to a JSON-compatible form per PEP 566.
- If a long description is provided in the payload of the RFC 822 value, it can be retrieved as the
- Minor tweaks from CPython.
- #295: Internal refactoring to unify section parsing logic.
- #296: Exclude 'prepare' package.
- #297: Fix ValueError when entry points contains comments.
Use of Mapping (dict) interfaces on
SelectableGroupsis now flagged as deprecated. Instead, users are advised to use the select interface for future compatibility.
Suppress the warning with this filter:
ignore:SelectableGroups dict interface.
Or with this invocation in the Python environment:
warnings.filterwarnings('ignore', 'SelectableGroups dict interface').
Preferably, switch to the
selectinterface introduced in 3.7.0. See the entry points documentation and changelog for the 3.6 release below for more detail.
For some use-cases, especially those that rely on
importlib.metadatain Python 3.8 and 3.9 or those relying on older
importlib_metadata(especially on Python 3.5 and earlier), backports.entry_points_selectable was created to ease the transition. Please have a look at that project if simply relying on importlib_metadata 3.6+ is not straightforward. Background in #298.
#283: Entry point parsing no longer relies on ConfigParser and instead uses a custom, one-pass parser to load the config, resulting in a ~20% performance improvement when loading entry points.
- #293: Re-enabled lazy evaluation of path lookup through a FreezableDefaultDict.
- #293: Workaround for error in distribution search.
- #290: Add mtime-based caching for
FastPathand its lookups, dramatically increasing performance for repeated distribution lookups.
- Docs enhancements and cleanup following review in GH-24782.
- Cleaned up cruft in entry_points docstring.
- Internal refactoring to facilitate
entry_points() -> dictdeprecation.
- #131: Added
packages_distributionsto conveniently resolve a top-level package or module to its distribution(s).
#284: Introduces new
EntryPointsobject, a tuple of
EntryPointobjects but with convenience properties for selecting and inspecting the results:
namekeyword parameters and returns a new
EntryPointstuple with only those that match the selection.
.groupsproperty presents all of the group names.
.namesproperty presents the names of the entry points.
- Item access (e.g.
eps[name]) retrieves a single entry point by name.
entry_pointsnow accepts "selection parameters", same as
entry_points()now provides a future-compatible
SelectableGroupsobject that supplies the above interface (except item access) but remains a dict for compatibility.
In the future,
entry_points()will return an
EntryPointsobject for all entry points.
If passing selection parameters to
entry_points, the future behavior is invoked and an
EntryPointsis the result.
#284: Construction of entry points using
dict([EntryPoint, ...])is now deprecated and raises an appropriate DeprecationWarning and will be removed in a future version.
Distribution.entry_pointsnow presents as an
EntryPointsobject and access by index is no longer allowed. If access by index is required, cast to a sequence first.
entry_pointsnow only returns entry points for unique distributions (by name).
- #10: Project now declares itself as being typed.
- #272: Additional performance enhancements to distribution discovery.
- #111: For PyPA projects, add test ensuring that
MetadataPathFinder._search_pathshonors the needed interface. Method is still private.
EntryPointobjects now expose a
.distobject referencing the
Distributionwhen constructed from a Distribution.
- The object returned by
metadata()now has a formally-defined protocol called
PackageMetadatawith declared support for the
.get_all()method. Fixes #126.
- #261: Restored compatibility for package discovery for metadata without version in the name and for legacy eggs.
- Merge with 2.1.0.
- #253: When querying for package metadata, the lookup now honors package normalization rules.
- Require Python 3.6 or later.
importlib_metadatano longer presents a
__version__attribute. Consumers wishing to resolve the version of the package should query it directly with
importlib_metadata.version('importlib-metadata'). Closes #71.
PathNotFoundErrornow has a custom
__str__mentioning "package metadata" being missing to help guide users to the cause when the package is installed but no metadata is present. Closes #124.
Distribution._local()as a provisional demonstration of how to load metadata for a local package. Implicitly requires that pep517 is installed. Ref #42.
- Ensure inputs to FastPath are Unicode. Closes #121.
- Tests now rely on
importlib.resources.files(and backport) instead of the older
- Support any iterable from
find_distributions. Closes #122.
- Fix redundant entries from
FastPath.zip_children. Closes #117.
- Improve reliability and consistency of compatibility imports for contextlib and pathlib when running tests. Closes #116.
- Additional performance optimizations in FastPath now saves an additional 20% on a typical call.
- Correct for issue where PyOxidizer finder has no
__module__attribute. Closes #110.
- Through careful optimization,
distribution()is 3-4x faster. Thanks to Antony Lee for the contribution. Closes #95.
- When searching through
sys.path, if any error occurs attempting to list a path entry, that entry is skipped, making the system much more lenient to errors. Closes #94.
- Improve custom finders documentation. Closes #105.
- Once again, drop support for Python 3.4. Ref #104.
- Restored support for Python 3.4 due to improper version compatibility declarations in the v1.1.0 and v1.1.1 releases. Closes #104.
- Repaired project metadata to correctly declare the
python_requiresdirective. Closes #103.
repr(EntryPoint)on PyPy 3 also. Closes #102.
- Dropped support for Python 3.4.
- EntryPoints are now pickleable. Closes #96.
repr(EntryPoint)on PyPy 2. Closes #97.
- Project adopts semver for versioning.
- Removed compatibility shim introduced in 0.23.
- For better compatibility with the stdlib implementation and to avoid the same distributions being discovered by the stdlib and backport implementations, the backport now disables the stdlib DistributionFinder during initialization (import time). Closes #91 and closes #100.
- Added a compatibility shim to prevent failures on beta releases of Python before the signature changed to accept the "context" parameter on find_distributions. This workaround will have a limited lifespan, not to extend beyond release of Python 3.8 final.
distribution_nameas recommended in the following functions:
requires. This backward-incompatible change is expected to have little impact as these functions are assumed to be primarily used with positional parameters.
importlib.metadatanow exposes the
DistributionFindermetaclass and references it in the docs for extending the search algorithm.
Distribution.atfor constructing a Distribution object from a known metadata directory on the file system. Closes #80.
- Distribution finders now receive a context object that
.nameproperties. This change introduces a fundamental backward incompatibility for any projects implementing a
find_distributionsmethod on a
MetaPathFinder. This new layer of abstraction allows this context to be supplied directly or constructed on demand and opens the opportunity for a
find_distributionsmethod to solicit additional context from the caller. Closes #85.
- Clarify in the docs that calls to
Nonewhen the metadata is not present. Closes #69.
- Return all requirements and not just the first for dist-info packages. Closes #67.
- Restrain over-eager egg metadata resolution.
- Add support for entry points with colons in the name. Closes #75.
- Parse entry points case sensitively. Closes #68
- Add a version constraint on the backport configparser package. Closes #66
- Fix a permission problem in the tests on Windows.
- Don't crash if there exists an EGG-INFO directory on sys.path.
- Fix documentation.
local_distributionfunction from the API. This backward-incompatible change removes this behavior summarily. Projects should remove their reliance on this behavior. A replacement behavior is under review in the pep517 project. Closes #42.
- Update docstrings to match PEP 8. Closes #63.
- Merged modules into one module. Closes #62.
- Add support for eggs. !65; Closes #19.
- Support generic zip files (not just wheels). Closes #59
- Support zip files with multiple distributions in them. Closes #60
- Fully expose the public API in
DistributionABC is now officially part of the public API. Closes #37.
- Fixed support for older single file egg-info formats. Closes #43.
- Fixed a testing bug when
$CWDhas spaces in the path. Closes #50.
- Add Python 3.8 to the
- Fixed issue where entry points without an attribute would raise an Exception. Closes #40.
- Removed unused
entry_points(). Closes #44.
DistributionFinderclasses must now be instantiated before being placed on
- This library can now discover/enumerate all installed packages. This backward-incompatible change alters the protocol finders must implement to support distribution package discovery. Closes #24.
- The signature of
find_distributions()on custom installer finders should now accept two parameters,
pathand these parameters must supply defaults.
entry_points()method no longer accepts a package name but instead returns all entry points in a dictionary keyed by the
resolvemethod has been removed. Instead, call
EntryPoint.load(), which has the same semantics as
entrypoints. This is a backward incompatible change.
- Metadata is now always returned as Unicode text regardless of Python version. Closes #29.
- This library can now discover metadata for a 'local' package (found in the current-working directory). Closes #27.
files()function for resolving files from a distribution.
- Added a new
requires()function, which returns the requirements for a package suitable for parsing by
packaging.requirements.Requirement. Closes #18.
- The top-level
read_text()function has been removed. Use
PackagePath.read_text()on instances returned by the
files()function. This is a backward incompatible change.
- Release dates are now automatically injected into the changelog based on SCM tags.
- Fixed issue where packages with dashes in their names would not be discovered. Closes #21.
- Distribution lookup is now case-insensitive. Closes #20.
- Wheel distributions can no longer be discovered by their module name. Like Path distributions, they must be indicated by their distribution package name.
importlib_metadata.distributionfunction. Now the public interface is primarily the utility functions exposed in
importlib_metadata.__all__. Closes #14.
- Added two new utility functions
- Updated README and removed details about Distribution class, now considered private. Closes #15.
- Added test suite support for Python 3.4+.
- Fixed SyntaxErrors on Python 3.4 and 3.5. !12
- Fixed errors on Windows joining Path elements. !15
- Added usage documentation. Closes #8
- Add support for getting metadata from wheels on
sys.path. Closes #9
importlib_metadata.entry_points(). Closes #1
importlib_metadata.resolve(). Closes #12
- Add support for Python 2.7. Closes #4
- Initial release.