bpo-33689: Blank lines in .pth file cause a duplicate sys.path entry (GH-20679)

This commit is contained in:
idomic 2020-09-19 15:13:29 -04:00 committed by GitHub
parent ae0d2a33ec
commit 0c71a66b53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 1 deletions

View File

@ -170,6 +170,8 @@ def addpackage(sitedir, name, known_paths):
for n, line in enumerate(f):
if line.startswith("#"):
continue
if line.strip() == "":
continue
try:
if line.startswith(("import ", "import\t")):
exec(line)

View File

@ -161,6 +161,12 @@ class HelperFunctionsTests(unittest.TestCase):
self.assertRegex(err_out.getvalue(), 'Traceback')
self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError')
def test_addpackage_empty_lines(self):
# Issue 33689
pth_dir, pth_fn = self.make_pth("\n\n \n\n")
known_paths = site.addpackage(pth_dir, pth_fn, set())
self.assertEqual(known_paths, set())
def test_addpackage_import_bad_pth_file(self):
# Issue 5258
pth_dir, pth_fn = self.make_pth("abc\x00def\n")
@ -595,7 +601,6 @@ class StartupImportTests(unittest.TestCase):
'import site, sys; site.enablerlcompleter(); sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
self.assertTrue(r, "'__interactivehook__' not added by enablerlcompleter()")
@unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
class _pthFileTests(unittest.TestCase):

View File

@ -0,0 +1,4 @@
Ignore empty or whitespace-only lines in .pth files. This matches the
documentated behavior. Before, empty lines caused the site-packages
dir to appear multiple times in sys.path.
By Ido Michael, contributors Malcolm Smith and Tal Einat.