diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2019-12-11 01:05:10 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-11 01:05:10 (GMT) |
commit | b7a0109cd2bafaa21a4d50aad307e901c68f9156 (patch) | |
tree | 744785e406bf815353d7c29c69c8bfe59e24f2c0 /Lib/importlib | |
parent | d0802d07d2c864b95480a9b24c7cc050e19189d5 (diff) | |
download | cpython-b7a0109cd2bafaa21a4d50aad307e901c68f9156.zip cpython-b7a0109cd2bafaa21a4d50aad307e901c68f9156.tar.gz cpython-b7a0109cd2bafaa21a4d50aad307e901c68f9156.tar.bz2 |
bpo-39022, bpo-38594: Sync with importlib_metadata 1.3 (GH-17568)
* bpo-39022, bpo-38594: Sync with importlib_metadata 1.3 including improved docs for custom finders and better serialization support in EntryPoints.
* 📜🤖 Added by blurb_it.
* Correct module reference
Diffstat (limited to 'Lib/importlib')
-rw-r--r-- | Lib/importlib/metadata.py | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/Lib/importlib/metadata.py b/Lib/importlib/metadata.py index 8cb45ec..53f9fb5 100644 --- a/Lib/importlib/metadata.py +++ b/Lib/importlib/metadata.py @@ -37,7 +37,8 @@ class PackageNotFoundError(ModuleNotFoundError): """The package was not found.""" -class EntryPoint(collections.namedtuple('EntryPointBase', 'name value group')): +class EntryPoint( + collections.namedtuple('EntryPointBase', 'name value group')): """An entry point as defined by Python packaging conventions. See `the packaging docs on entry points @@ -107,6 +108,12 @@ class EntryPoint(collections.namedtuple('EntryPointBase', 'name value group')): """ return iter((self.name, self)) + def __reduce__(self): + return ( + self.__class__, + (self.name, self.value, self.group), + ) + class PackagePath(pathlib.PurePosixPath): """A reference to a path in a package""" @@ -334,10 +341,21 @@ class DistributionFinder(MetaPathFinder): """ class Context: + """ + Keyword arguments presented by the caller to + ``distributions()`` or ``Distribution.discover()`` + to narrow the scope of a search for distributions + in all DistributionFinders. + + Each DistributionFinder may expect any parameters + and should attempt to honor the canonical + parameters defined below when appropriate. + """ name = None """ Specific name for which a distribution finder should match. + A name of ``None`` matches all distributions. """ def __init__(self, **kwargs): @@ -347,6 +365,9 @@ class DistributionFinder(MetaPathFinder): def path(self): """ The path that a distribution finder should search. + + Typically refers to Python package paths and defaults + to ``sys.path``. """ return vars(self).get('path', sys.path) |