Skip to content

gh-117381: Fix error message for ntpath.commonpath #117382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 3, 2024
+54 −53
Merged

gh-117381: Fix error message for ntpath.commonpath #117382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ddc97f4
Fix error message for `ntpath.commonpath`
nineteendo Mar 29, 2024
f8aaf81
📜🤖 Added by blurb_it.
blurb-it[bot] Mar 29, 2024
35de65f
Simplify error message
nineteendo Mar 30, 2024
da28922
Update unittests
nineteendo Mar 31, 2024
a819efb
foo, bar, baz
nineteendo Apr 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions Lib/ntpath.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,16 +860,19 @@ def commonpath(paths):
drivesplits = [splitroot(p.replace(altsep, sep).lower()) for p in paths]
split_paths = [p.split(sep) for d, r, p in drivesplits]

if len({r for d, r, p in drivesplits}) != 1:
raise ValueError("Can't mix absolute and relative paths")

# Check that all drive letters or UNC paths match. The check is made only
# now otherwise type errors for mixing strings and bytes would not be
# caught.
if len({d for d, r, p in drivesplits}) != 1:
raise ValueError("Paths don't have the same drive")

drive, root, path = splitroot(paths[0].replace(altsep, sep))
if len({r for d, r, p in drivesplits}) != 1:
if drive:
raise ValueError("Can't mix absolute and relative paths")
else:
raise ValueError("Can't mix rooted and not-rooted paths")

common = path.split(sep)
common = [c for c in common if c and c != curdir]

Expand Down
97 changes: 47 additions & 50 deletions Lib/test/test_ntpath.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,46 +866,47 @@ def test_commonpath(self):
def check(paths, expected):
tester(('ntpath.commonpath(%r)' % paths).replace('\\\\', '\\'),
expected)
def check_error(exc, paths):
self.assertRaises(exc, ntpath.commonpath, paths)
self.assertRaises(exc, ntpath.commonpath,
[os.fsencode(p) for p in paths])
def check_error(paths, expected):
self.assertRaisesRegex(ValueError, expected, ntpath.commonpath, paths)
self.assertRaisesRegex(ValueError, expected, ntpath.commonpath, paths[::-1])
self.assertRaisesRegex(ValueError, expected, ntpath.commonpath,
[os.fsencode(p) for p in paths])
self.assertRaisesRegex(ValueError, expected, ntpath.commonpath,
[os.fsencode(p) for p in paths[::-1]])

self.assertRaises(TypeError, ntpath.commonpath, None)
self.assertRaises(ValueError, ntpath.commonpath, [])
self.assertRaises(ValueError, ntpath.commonpath, iter([]))
check_error(ValueError, ['C:\\Program Files', 'Program Files'])
check_error(ValueError, ['C:\\Program Files', 'C:Program Files'])
check_error(ValueError, ['\\Program Files', 'Program Files'])
check_error(ValueError, ['Program Files', 'C:\\Program Files'])

check(['C:\\Program Files'], 'C:\\Program Files')
check(['C:\\Program Files', 'C:\\Program Files'], 'C:\\Program Files')
check(['C:\\Program Files\\', 'C:\\Program Files'],
'C:\\Program Files')
check(['C:\\Program Files\\', 'C:\\Program Files\\'],
'C:\\Program Files')
check(['C:\\\\Program Files', 'C:\\Program Files\\\\'],
'C:\\Program Files')
check(['C:\\.\\Program Files', 'C:\\Program Files\\.'],
'C:\\Program Files')
check(['C:\\', 'C:\\bin'], 'C:\\')
check(['C:\\Program Files', 'C:\\bin'], 'C:\\')
check(['C:\\Program Files', 'C:\\Program Files\\Bar'],
'C:\\Program Files')
check(['C:\\Program Files\\Foo', 'C:\\Program Files\\Bar'],
'C:\\Program Files')
check(['C:\\Program Files', 'C:\\Projects'], 'C:\\')
check(['C:\\Program Files\\', 'C:\\Projects'], 'C:\\')

check(['C:\\Program Files\\Foo', 'C:/Program Files/Bar'],
'C:\\Program Files')
check(['C:\\Program Files\\Foo', 'c:/program files/bar'],
'C:\\Program Files')
check(['c:/program files/bar', 'C:\\Program Files\\Foo'],
'c:\\program files')

check_error(ValueError, ['C:\\Program Files', 'D:\\Program Files'])

# gh-117381: Logical error messages
check_error(['C:\\Foo', 'C:Foo'], "Can't mix absolute and relative paths")
check_error(['C:\\Foo', '\\Foo'], "Paths don't have the same drive")
check_error(['C:\\Foo', 'Foo'], "Paths don't have the same drive")
check_error(['C:Foo', '\\Foo'], "Paths don't have the same drive")
check_error(['C:Foo', 'Foo'], "Paths don't have the same drive")
check_error(['\\Foo', 'Foo'], "Can't mix rooted and not-rooted paths")

check(['C:\\Foo'], 'C:\\Foo')
check(['C:\\Foo', 'C:\\Foo'], 'C:\\Foo')
check(['C:\\Foo\\', 'C:\\Foo'], 'C:\\Foo')
check(['C:\\Foo\\', 'C:\\Foo\\'], 'C:\\Foo')
check(['C:\\\\Foo', 'C:\\Foo\\\\'], 'C:\\Foo')
check(['C:\\.\\Foo', 'C:\\Foo\\.'], 'C:\\Foo')
check(['C:\\', 'C:\\baz'], 'C:\\')
check(['C:\\Bar', 'C:\\baz'], 'C:\\')
check(['C:\\Foo', 'C:\\Foo\\Baz'], 'C:\\Foo')
check(['C:\\Foo\\Bar', 'C:\\Foo\\Baz'], 'C:\\Foo')
check(['C:\\Bar', 'C:\\Baz'], 'C:\\')
check(['C:\\Bar\\', 'C:\\Baz'], 'C:\\')

check(['C:\\Foo\\Bar', 'C:/Foo/Baz'], 'C:\\Foo')
check(['C:\\Foo\\Bar', 'c:/foo/baz'], 'C:\\Foo')
check(['c:/foo/bar', 'C:\\Foo\\Baz'], 'c:\\foo')

# gh-117381: Logical error messages
check_error(['C:\\Foo', 'D:\\Foo'], "Paths don't have the same drive")
check_error(['C:\\Foo', 'D:Foo'], "Paths don't have the same drive")
check_error(['C:Foo', 'D:Foo'], "Paths don't have the same drive")

check(['spam'], 'spam')
check(['spam', 'spam'], 'spam')
Expand All @@ -919,20 +920,16 @@ def check_error(exc, paths):

check([''], '')
check(['', 'spam\\alot'], '')
check_error(ValueError, ['', '\\spam\\alot'])

self.assertRaises(TypeError, ntpath.commonpath,
[b'C:\\Program Files', 'C:\\Program Files\\Foo'])
self.assertRaises(TypeError, ntpath.commonpath,
[b'C:\\Program Files', 'Program Files\\Foo'])
self.assertRaises(TypeError, ntpath.commonpath,
[b'Program Files', 'C:\\Program Files\\Foo'])
self.assertRaises(TypeError, ntpath.commonpath,
['C:\\Program Files', b'C:\\Program Files\\Foo'])
self.assertRaises(TypeError, ntpath.commonpath,
['C:\\Program Files', b'Program Files\\Foo'])
self.assertRaises(TypeError, ntpath.commonpath,
['Program Files', b'C:\\Program Files\\Foo'])

# gh-117381: Logical error messages
check_error(['', '\\spam\\alot'], "Can't mix rooted and not-rooted paths")

self.assertRaises(TypeError, ntpath.commonpath, [b'C:\\Foo', 'C:\\Foo\\Baz'])
self.assertRaises(TypeError, ntpath.commonpath, [b'C:\\Foo', 'Foo\\Baz'])
self.assertRaises(TypeError, ntpath.commonpath, [b'Foo', 'C:\\Foo\\Baz'])
self.assertRaises(TypeError, ntpath.commonpath, ['C:\\Foo', b'C:\\Foo\\Baz'])
self.assertRaises(TypeError, ntpath.commonpath, ['C:\\Foo', b'Foo\\Baz'])
self.assertRaises(TypeError, ntpath.commonpath, ['Foo', b'C:\\Foo\\Baz'])

@unittest.skipIf(is_emscripten, "Emscripten cannot fstat unnamed files.")
def test_sameopenfile(self):
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2024-03-29-21-43-19.gh-issue-117381.fT0JFM.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix error message for :func:`ntpath.commonpath`.
Loading