gh-59022: Added tests for `pkgutil.extend_path` (#59022) (GH-121673)

This adds tests for the documented behaviour of `pkgutil.extend_path`
regarding different argument types as well as for `*.pkg` files.
This commit is contained in:
Andreas Stocker 2024-07-16 17:14:26 +02:00 committed by GitHub
parent 263c7e611b
commit 8f2532168b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 41 additions and 4 deletions

View File

@ -34,9 +34,9 @@ support.
*name* argument. This feature is similar to :file:`\*.pth` files (see the
:mod:`site` module for more information), except that it doesn't special-case
lines starting with ``import``. A :file:`\*.pkg` file is trusted at face
value: apart from checking for duplicates, all entries found in a
:file:`\*.pkg` file are added to the path, regardless of whether they exist
on the filesystem. (This is a feature.)
value: apart from skipping blank lines and ignoring comments, all entries
found in a :file:`\*.pkg` file are added to the path, regardless of whether
they exist on the filesystem (this is a feature).
If the input path is not a list (as is the case for frozen packages) it is
returned unchanged. The input path is not modified; an extended copy is

View File

@ -522,7 +522,43 @@ class ExtendPathTests(unittest.TestCase):
del sys.modules['foo.bar']
del sys.modules['foo.baz']
# XXX: test .pkg files
def test_extend_path_argument_types(self):
pkgname = 'foo'
dirname_0 = self.create_init(pkgname)
# If the input path is not a list it is returned unchanged
self.assertEqual('notalist', pkgutil.extend_path('notalist', 'foo'))
self.assertEqual(('not', 'a', 'list'), pkgutil.extend_path(('not', 'a', 'list'), 'foo'))
self.assertEqual(123, pkgutil.extend_path(123, 'foo'))
self.assertEqual(None, pkgutil.extend_path(None, 'foo'))
# Cleanup
shutil.rmtree(dirname_0)
del sys.path[0]
def test_extend_path_pkg_files(self):
pkgname = 'foo'
dirname_0 = self.create_init(pkgname)
with open(os.path.join(dirname_0, 'bar.pkg'), 'w') as pkg_file:
pkg_file.write('\n'.join([
'baz',
'/foo/bar/baz',
'',
'#comment'
]))
extended_paths = pkgutil.extend_path(sys.path, 'bar')
self.assertEqual(extended_paths[:-2], sys.path)
self.assertEqual(extended_paths[-2], 'baz')
self.assertEqual(extended_paths[-1], '/foo/bar/baz')
# Cleanup
shutil.rmtree(dirname_0)
del sys.path[0]
class NestedNamespacePackageTest(unittest.TestCase):

View File

@ -0,0 +1 @@
Add tests for :func:`pkgutil.extend_path`. Patch by Andreas Stocker.