From 96ddc58281d2b6b2258b1a628bccf252090d5611 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 19 Oct 2020 14:14:21 -0700 Subject: [PATCH] bpo-42089: Sync with current cpython branch of importlib_metadata (GH-22775) ~~The only differences are in the test files.~~ Automerge-Triggered-By: @jaraco --- Lib/importlib/metadata.py | 9 +++++++++ Lib/test/test_importlib/fixtures.py | 9 +++------ Lib/test/test_importlib/test_main.py | 12 ++++++++++++ .../Library/2020-10-19-16-53-19.bpo-42089.R1dthW.rst | 2 ++ 4 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2020-10-19-16-53-19.bpo-42089.R1dthW.rst diff --git a/Lib/importlib/metadata.py b/Lib/importlib/metadata.py index ffa0cba45706..302d61d505cb 100644 --- a/Lib/importlib/metadata.py +++ b/Lib/importlib/metadata.py @@ -37,6 +37,15 @@ __all__ = [ class PackageNotFoundError(ModuleNotFoundError): """The package was not found.""" + def __str__(self): + tmpl = "No package metadata was found for {self.name}" + return tmpl.format(**locals()) + + @property + def name(self): + name, = self.args + return name + class EntryPoint( collections.namedtuple('EntryPointBase', 'name value group')): diff --git a/Lib/test/test_importlib/fixtures.py b/Lib/test/test_importlib/fixtures.py index 985277f64615..8fa92909d583 100644 --- a/Lib/test/test_importlib/fixtures.py +++ b/Lib/test/test_importlib/fixtures.py @@ -6,6 +6,8 @@ import tempfile import textwrap import contextlib +from test.support.os_helper import FS_NONASCII + @contextlib.contextmanager def tempdir(): @@ -212,12 +214,7 @@ def build_files(file_defs, prefix=pathlib.Path()): class FileBuilder: def unicode_filename(self): - try: - from test.support import os_helper - except ImportError: - # outside CPython, hard-code a unicode snowman - return '☃' - return os_helper.FS_NONASCII or \ + return FS_NONASCII or \ self.skip("File system does not support non-ascii.") diff --git a/Lib/test/test_importlib/test_main.py b/Lib/test/test_importlib/test_main.py index 91e501a2eb7c..a26bab636154 100644 --- a/Lib/test/test_importlib/test_main.py +++ b/Lib/test/test_importlib/test_main.py @@ -32,6 +32,18 @@ class BasicTests(fixtures.DistInfoPkg, unittest.TestCase): with self.assertRaises(PackageNotFoundError): Distribution.from_name('does-not-exist') + def test_package_not_found_mentions_metadata(self): + """ + When a package is not found, that could indicate that the + packgae is not installed or that it is installed without + metadata. Ensure the exception mentions metadata to help + guide users toward the cause. See #124. + """ + with self.assertRaises(PackageNotFoundError) as ctx: + Distribution.from_name('does-not-exist') + + assert "metadata" in str(ctx.exception) + def test_new_style_classes(self): self.assertIsInstance(Distribution, type) diff --git a/Misc/NEWS.d/next/Library/2020-10-19-16-53-19.bpo-42089.R1dthW.rst b/Misc/NEWS.d/next/Library/2020-10-19-16-53-19.bpo-42089.R1dthW.rst new file mode 100644 index 000000000000..3f3affd1a7df --- /dev/null +++ b/Misc/NEWS.d/next/Library/2020-10-19-16-53-19.bpo-42089.R1dthW.rst @@ -0,0 +1,2 @@ +In ``importlib.metadata.PackageNotFoundError``, make reference to the +package metadata being missing to improve the user experience. -- 2.47.3