summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-22 10:01:24 (GMT)
committerGitHub <noreply@github.com>2023-08-22 10:01:24 (GMT)
commitdd73f2f76ab1eabe92a2ca820430be723df31cde (patch)
treed300ea1393c8b4653e2e8d246c3a5282784e9c78
parentb26a7b78c9658a9b888f56ce3dc8cfae127d1eca (diff)
downloadcpython-dd73f2f76ab1eabe92a2ca820430be723df31cde.zip
cpython-dd73f2f76ab1eabe92a2ca820430be723df31cde.tar.gz
cpython-dd73f2f76ab1eabe92a2ca820430be723df31cde.tar.bz2
[3.12] gh-106242: Make ntpath.realpath errors consistent with abspath when there are embedded nulls (GH-108248) (#108251)
gh-106242: Make ntpath.realpath errors consistent with abspath when there are embedded nulls (GH-108248) * gh-106242: Make ntpath.realpath errors consistent with abspath when there are embedded nulls * Update 2023-08-22-00-36-57.gh-issue-106242.q24ITw.rst mention Windows and the former incorrect ValueError. --------- (cherry picked from commit de33b5c662ea8d35d81ed857c6a39e34ab94c510) Co-authored-by: Steve Dower <steve.dower@python.org> Co-authored-by: Gregory P. Smith <greg@krypto.org>
-rw-r--r--Lib/ntpath.py12
-rw-r--r--Lib/test/test_ntpath.py6
-rw-r--r--Misc/NEWS.d/next/Windows/2023-08-22-00-36-57.gh-issue-106242.q24ITw.rst4
3 files changed, 22 insertions, 0 deletions
diff --git a/Lib/ntpath.py b/Lib/ntpath.py
index dadcdc0..df3402d 100644
--- a/Lib/ntpath.py
+++ b/Lib/ntpath.py
@@ -721,6 +721,14 @@ else:
try:
path = _getfinalpathname(path)
initial_winerror = 0
+ except ValueError as ex:
+ # gh-106242: Raised for embedded null characters
+ # In strict mode, we convert into an OSError.
+ # Non-strict mode returns the path as-is, since we've already
+ # made it absolute.
+ if strict:
+ raise OSError(str(ex)) from None
+ path = normpath(path)
except OSError as ex:
if strict:
raise
@@ -740,6 +748,10 @@ else:
try:
if _getfinalpathname(spath) == path:
path = spath
+ except ValueError as ex:
+ # Unexpected, as an invalid path should not have gained a prefix
+ # at any point, but we ignore this error just in case.
+ pass
except OSError as ex:
# If the path does not exist and originally did not exist, then
# strip the prefix anyway.
diff --git a/Lib/test/test_ntpath.py b/Lib/test/test_ntpath.py
index 78e1cb5..d91dcdf 100644
--- a/Lib/test/test_ntpath.py
+++ b/Lib/test/test_ntpath.py
@@ -394,6 +394,10 @@ class TestNtpath(NtpathTestCase):
d = drives.pop().encode()
self.assertEqual(ntpath.realpath(d), d)
+ # gh-106242: Embedded nulls and non-strict fallback to abspath
+ self.assertEqual(ABSTFN + "\0spam",
+ ntpath.realpath(os_helper.TESTFN + "\0spam", strict=False))
+
@os_helper.skip_unless_symlink
@unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
def test_realpath_strict(self):
@@ -404,6 +408,8 @@ class TestNtpath(NtpathTestCase):
self.addCleanup(os_helper.unlink, ABSTFN)
self.assertRaises(FileNotFoundError, ntpath.realpath, ABSTFN, strict=True)
self.assertRaises(FileNotFoundError, ntpath.realpath, ABSTFN + "2", strict=True)
+ # gh-106242: Embedded nulls should raise OSError (not ValueError)
+ self.assertRaises(OSError, ntpath.realpath, ABSTFN + "\0spam", strict=True)
@os_helper.skip_unless_symlink
@unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
diff --git a/Misc/NEWS.d/next/Windows/2023-08-22-00-36-57.gh-issue-106242.q24ITw.rst b/Misc/NEWS.d/next/Windows/2023-08-22-00-36-57.gh-issue-106242.q24ITw.rst
new file mode 100644
index 0000000..ffe42ec
--- /dev/null
+++ b/Misc/NEWS.d/next/Windows/2023-08-22-00-36-57.gh-issue-106242.q24ITw.rst
@@ -0,0 +1,4 @@
+Fixes :func:`~os.path.realpath` to behave consistently when passed a path
+containing an embedded null character on Windows. In strict mode, it now
+raises :exc:`OSError` instead of the unexpected :exc:`ValueError`, and in
+non-strict mode will make the path absolute.