gh-82367: Use `FindFirstFile` Win32 API in `ntpath.realpath()`#110298

moonsikpark · 2023-10-03T16:06:51Z

ntpath.realpath() breaks out of traversing a series of paths where a (handled) ERROR_ACCESS_DENIED or ERROR_SHARING_VIOLATION occurs.

Using FindFirstFile Win32 API, we can query their real name to correct the case and also resolve MS-DOS (also called 8.3) style file names such as C:\\LONGFI~1.TXT.

Issue: Use FindFirstFile in ntpath.realpath() when access is denied #82367

📚 Documentation preview 📚: https://cpython-previews--110298.org.readthedocs.build/

zware

A few documentation nits, but mostly this looks pretty good to me. It will need approval from either @zooba or @eryksun before I'd be comfortable merging it, though.

Doc/whatsnew/3.13.rst

Misc/NEWS.d/next/Windows/2023-10-03-12-30-59.gh-issue-82367.nxwfMx.rst

Doc/library/os.path.rst

zooba · 2023-10-03T19:36:45Z

The code change looks great to me. Awesome job!

With Zach's requested doc changes, I think this is good to merge.

…ython#110298) * Use `FindFirstFile` Win32 API to fix a bug where `ntpath.realpath()` breaks out of traversing a series of paths where a (handled) `ERROR_ACCESS_DENIED` or `ERROR_SHARING_VIOLATION` occurs. * Update docs to reflect that `ntpath.realpath()` eliminates MS-DOS style names.

ghost · 2023-10-04T14:15:13Z

All commit authors signed the Contributor License Agreement.

…ython#110298) * Use `FindFirstFile` Win32 API to fix a bug where `ntpath.realpath()` breaks out of traversing a series of paths where a (handled) `ERROR_ACCESS_DENIED` or `ERROR_SHARING_VIOLATION` occurs. * Update docs to reflect that `ntpath.realpath()` eliminates MS-DOS style names.

Lib/ntpath.py

Lib/test/test_ntpath.py

eryksun

LGTM. Thank you, Moonsik, and thanks also for taking the extra time to make the test more robust.

…ython#110298) * Use `FindFirstFile` Win32 API to fix a bug where `ntpath.realpath()` breaks out of traversing a series of paths where a (handled) `ERROR_ACCESS_DENIED` or `ERROR_SHARING_VIOLATION` occurs. * Update docs to reflect that `ntpath.realpath()` eliminates MS-DOS style names.

zware · 2023-10-05T14:50:07Z

Thanks Steve and Eryk for the reviews, and Moonsik for the patch and excellent collaboration!

…ythonGH-110298) * Use `FindFirstFile` Win32 API to fix a bug where `ntpath.realpath()` breaks out of traversing a series of paths where a (handled) `ERROR_ACCESS_DENIED` or `ERROR_SHARING_VIOLATION` occurs. * Update docs to reflect that `ntpath.realpath()` eliminates MS-DOS style names.

The test was added in pythongh-110298, with a fix that was never backported to 3.12 and below. It was most likely skipped in the GHA run.

The test was added in gh-110298, with a fix that was never backported to 3.12 and below. It was most likely skipped in the GHA run.

bedevere-appbot added the awaiting review label Oct 3, 2023

bedevere-appbot mentioned this pull request Oct 3, 2023
Use FindFirstFile in ntpath.realpath() when access is denied #82367
Closed

zware reviewed Oct 3, 2023
View reviewed changes

Doc/whatsnew/3.13.rst Outdated Show resolvedHide resolved
Misc/NEWS.d/next/Windows/2023-10-03-12-30-59.gh-issue-82367.nxwfMx.rst Outdated Show resolvedHide resolved
Doc/library/os.path.rst Outdated Show resolvedHide resolved

zware requested review from eryksun and zooba October 3, 2023 17:28

moonsikpark force-pushed the gh-82367-use-findfirstfile-in-nt-realpath branch from 2c49ffc to 4590347Compare October 4, 2023 11:38

moonsikpark force-pushed the gh-82367-use-findfirstfile-in-nt-realpath branch from 4590347 to f675a4fCompare October 4, 2023 11:50

moonsikpark force-pushed the gh-82367-use-findfirstfile-in-nt-realpath branch from d88c757 to e17852cCompare October 4, 2023 14:41

eryksun reviewed Oct 4, 2023
View reviewed changes

Lib/ntpath.py Outdated Show resolvedHide resolved