importlib-metadata

#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 PathDistribution objects, entry point loading performance by ~10x.

Prefer f-strings to .format calls.

#312: Add support for metadata 2.2 (Dynamic field).

#315: Add SimplePath protocol for interface clarity in PathDistribution.

#306: Clearer guidance about compatibility in readme.

#304: PackageMetadata as returned by metadata() and 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 Description field.

• 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 json property that provides the metadata converted to a JSON-compatible form per PEP 566.

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 SelectableGroups is 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 select interface 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.metadata in 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 FastPath and 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() -> dict deprecation.

#131: Added packages_distributions to conveniently resolve a top-level package or module to its distribution(s).

#284: Introduces new EntryPoints object, a tuple of EntryPoint objects but with convenience properties for selecting and inspecting the results:

• .select() accepts group or name keyword parameters and returns a new EntryPoints tuple with only those that match the selection.

• .groups property presents all of the group names.

• .names property presents the names of the entry points.

• Item access (e.g. eps[name]) retrieves a single entry point by name.

entry_points now accepts "selection parameters", same as EntryPoint.select().

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

In the future, entry_points() will return an EntryPoints object for all entry points.

If passing selection parameters to entry_points, the future behavior is invoked and an EntryPoints is 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.

#300: Distribution.entry_points now presents as an EntryPoints object and access by index is no longer allowed. If access by index is required, cast to a sequence first.

#280: entry_points now 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_paths honors the needed interface. Method is still private.

#265: EntryPoint objects now expose a .dist object referencing the Distribution when constructed from a Distribution.

The object returned by metadata() now has a formally-defined protocol called PackageMetadata with declared support for the .get_all() method. Fixes #126.

Merge with 2.1.0.

Require Python 3.6 or later.

#361: Avoid potential REDoS in EntryPoint.pattern.

#353: Fixed discovery of distributions when path is empty.

#261: Restored compatibility for package discovery for metadata without version in the name and for legacy eggs.

#253: When querying for package metadata, the lookup now honors package normalization rules.

importlib_metadata no 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.

PathNotFoundError now 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.

Added 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 path function.

Support any iterable from find_distributions. Closes #122.

Added module and attr attributes to EntryPoint

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_requires directive. Closes #103.

Fixed repr(EntryPoint) on PyPy 3 also. Closes #102.

Dropped support for Python 3.4.

EntryPoints are now pickleable. Closes #96.

Fixed 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.

Renamed package parameter to distribution_name as recommended in the following functions: distribution, metadata, version, files, and requires. This backward-incompatible change is expected to have little impact as these functions are assumed to be primarily used with positional parameters.

importlib.metadata now exposes the DistributionFinder metaclass and references it in the docs for extending the search algorithm.

Add Distribution.at for constructing a Distribution object from a known metadata directory on the file system. Closes #80.

Distribution finders now receive a context object that supplies .path and .name properties. This change introduces a fundamental backward incompatibility for any projects implementing a find_distributions method 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_distributions method to solicit additional context from the caller. Closes #85.

Clarify in the docs that calls to .files could return None when 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.

Removed local_distribution function 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 importlib_metadata.__all__.

The Distribution ABC 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 $CWD has spaces in the path. Closes #50.

Add Python 3.8 to the tox testing matrix.