10000 bpo-46362: Ensure ntpath.abspath() uses the Windows API correctly (GH… · python/cpython@d4e64cd · GitHub
[go: up one dir, main page]
Skip to content

Commit d4e64cd

Browse files
neoneneneonene
authored
bpo-46362: Ensure ntpath.abspath() uses the Windows API correctly (GH-30571)
This makes ntpath.abspath()/getpath_abspath() follow normpath(), since some WinAPIs such as PathCchSkipRoot() require backslashed paths.
1 parent b8ddf7e commit d4e64cd

File tree

8 files changed

+114
-42
lines changed

8 files changed

+114
-42
lines changed

‎Include/internal/pycore_fileutils.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,9 @@ extern int _Py_EncodeNonUnicodeWchar_InPlace(
235235

236236
extern int _Py_isabs(const wchar_t *path);
237237
extern int _Py_abspath(const wchar_t *path, wchar_t **abspath_p);
238+
#ifdef MS_WINDOWS
239+
extern int _PyOS_getfullpathname(const wchar_t *path, wchar_t **abspath_p);
240+
#endif
238241
extern wchar_t * _Py_join_relfile(const wchar_t *dirname,
239242
const wchar_t *relfile);
240243
extern int _Py_add_relfile(wchar_t *dirname,

‎Lib/ntpath.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ def _abspath_fallback(path):
551551
def abspath(path):
552552
"""Return the absolute version of a path."""
553553
try:
554-
return normpath(_getfullpathname(path))
554+
return _getfullpathname(normpath(path))
555555
except (OSError, ValueError):
556556
return _abspath_fallback(path)
557557

‎Lib/test/test_embed.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1404,6 +1404,33 @@ def test_init_pyvenv_cfg(self):
14041404
api=API_COMPAT, env=env,
14051405
ignore_stderr=True, cwd=tmpdir)
14061406

1407+
@unittest.skipUnless(MS_WINDOWS, 'specific to Windows')
1408+
def test_getpath_abspath_win32(self):
1409+
# Check _Py_abspath() is passed a backslashed path not to fall back to
1410+
# GetFullPathNameW() on startup, which (re-)normalizes the path overly.
1411+
# Currently, _Py_normpath() doesn't trim trailing dots and spaces.
1412+
CASES = [
1413+
("C:/a. . .", "C:\\a. . ."),
1414+
("C:\\a. . .", "C:\\a. . ."),
1415+
("\\\\?\\C:////a////b. . .", "\\\\?\\C:\\a\\b. . ."),
1416+
("//a/b/c. . .", "\\\\a\\b\\c. . ."),
1417+
("\\\\a\\b\\c. . .", "\\\\a\\b\\c. . ."),
1418+
("a. . .", f"{os.getcwd()}\\a"), # relpath gets fully normalized
1419+
]
1420+
out, err = self.run_embedded_interpreter(
1421+
"test_init_initialize_config",
1422+
env=dict(PYTHONPATH=os.path.pathsep.join(c[0] for c in CASES))
1423+
)
1424+
self.assertEqual(err, "")
1425+
try:
1426+
out = json.loads(out)
1427+
except json.JSONDecodeError:
1428+
self.fail(f"fail to decode stdout: {out!r}")
1429+
1430+
results = out['config']["module_search_paths"]
1431+
for (_, expected), result in zip(CASES, results):
1432+
self.assertEqual(result, expected)
1433+
14071434
def test_global_pathconfig(self):
14081435
# Test C API functions getting the path configuration:
14091436
#

‎Lib/test/test_ntpath.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,40 @@ def test_expanduser(self):
613613
@unittest.skipUnless(nt, "abspath requires 'nt' module")
614614
def test_abspath(self):
615615
tester('ntpath.abspath("C:\\")', "C:\\")
616+
tester('ntpath.abspath("\\\\?\\C:////spam////eggs. . .")', "\\\\?\\C:\\spam\\eggs")
617+
tester('ntpath.abspath("\\\\.\\C:////spam////eggs. . .")', "\\\\.\\C:\\spam\\eggs")
618+
tester('ntpath.abspath("//spam//eggs. . .")', "\\\\spam\\eggs")
619+
tester('ntpath.abspath("\\\\spam\\\\eggs. . .")', "\\\\spam\\eggs")
620+
tester('ntpath.abspath("C:/spam. . .")', "C:\\spam")
621+
tester('ntpath.abspath("C:\\spam. . .")', "C:\\spam")
622+
tester('ntpath.abspath("C:/nul")', "\\\\.\\nul")
623+
tester('ntpath.abspath("C:\\nul")', "\\\\.\\nul")
624+
tester('ntpath.abspath("//..")', "\\\\")
625+
tester('ntpath.abspath("//../")', "\\\\..\\")
626+
tester('ntpath.abspath("//../..")', "\\\\..\\")
627+
tester('ntpath.abspath("//../../")', "\\\\..\\..\\")
628+
tester('ntpath.abspath("//../../../")', "\\\\..\\..\\")
629+
tester('ntpath.abspath("//../../../..")', "\\\\..\\..\\")
630+
tester('ntpath.abspath("//../../../../")', "\\\\..\\..\\")
631+
tester('ntpath.abspath("//server")', "\\\\server")
632+
tester('ntpath.abspath("//server/")', "\\\\server\\")
633+
tester('ntpath.abspath("//server/..")', "\\\\server\\")
634+
tester('ntpath.abspath("//server/../")', "\\\\server\\..\\")
635+
tester('ntpath.abspath("//server/../..")', "\\\\server\\..\\")
636+
tester('ntpath.abspath("//server/../../")', "\\\\server\\..\\")
637+
tester('ntpath.abspath("//server/../../..")', "\\\\server\\..\\")
638+
tester('ntpath.abspath("//server/../../../")', "\\\\server\\..\\")
639+
tester('ntpath.abspath("//server/share")', "\\\\server\\share")
640+
tester('ntpath.abspath("//server/share/")', "\\\\server\\share\\")
641+
tester('ntpath.abspath("//server/share/..")', "\\\\server\\share\\")
642+
tester('ntpath.abspath("//server/share/../")', "\\\\server\\share\\")
643+
tester('ntpath.abspath("//server/share/../..")', "\\\\server\\share\\")
644+
tester('ntpath.abspath("//server/share/../../")', "\\\\server\\share\\")
645+
tester('ntpath.abspath("C:\\nul. . .")', "\\\\.\\nul")
646+
tester('ntpath.abspath("//... . .")', "\\\\")
647+
tester('ntpath.abspath("//.. . . .")', "\\\\")
648+
tester('ntpath.abspath("//../... . .")', "\\\\..\\")
649+
tester('ntpath.abspath("//../.. . . .")', "\\\\..\\")
616650
with os_helper.temp_cwd(os_helper.TESTFN) as cwd_dir: # bpo-31047
617651
tester('ntpath.abspath("")', cwd_dir)
618652
tester('ntpath.abspath(" ")', cwd_dir + "\\ ")

‎Misc/NEWS.d/next/Windows/2022-01-13-22-31-09.bpo-46362.f2cuEb.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
os.path.abspath("C:\CON") is now fixed to return "\\.\CON", not the same path.
2+
The regression was true of all legacy DOS devices such as COM1, LPT1, or NUL.

‎Modules/getpath.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,16 @@ getpath_abspath(PyObject *Py_UNUSED(self), PyObject *args)
5959
{
6060
PyObject *r = NULL;
6161
PyObject *pathobj;
62-
const wchar_t *path;
62+
wchar_t *path;
6363
if (!PyArg_ParseTuple(args, "U", &pathobj)) {
6464
return NULL;
6565
}
6666
Py_ssize_t len;
6767
path = PyUnicode_AsWideCharString(pathobj, &len);
6868
if (path) {
6969
wchar_t *abs;
70-
if (_Py_abspath(path, &abs) == 0 && abs) {
71-
r = PyUnicode_FromWideChar(_Py_normpath(abs, -1), -1);
70+
if (_Py_abspath((const wchar_t *)_Py_normpath(path, -1), &abs) == 0 && abs) {
71+
r = PyUnicode_FromWideChar(abs, -1);
7272
PyMem_RawFree((void *)abs);
7373
} else {
7474
PyErr_SetString(PyExc_OSError, "failed to make path absolute");

‎Modules/posixmodule.c

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4240,6 +4240,48 @@ os_listdir_impl(PyObject *module, path_t *path)
42404240
}
42414241

42424242
#ifdef MS_WINDOWS
4243+
int
4244+
_PyOS_getfullpathname(const wchar_t *path, wchar_t **abspath_p)
4245+
{
4246+
wchar_t woutbuf[MAX_PATH], *woutbufp = woutbuf;
4247+
DWORD result;
4248+
4249+
result = GetFullPathNameW(path,
4250+
Py_ARRAY_LENGTH(woutbuf), woutbuf,
4251+
NULL);
4252+
if (!result) {
4253+
return -1;
4254+
}
4255+
4256+
if (result >= Py_ARRAY_LENGTH(woutbuf)) {
4257+
if ((size_t)result <= (size_t)PY_SSIZE_T_MAX / sizeof(wchar_t)) {
4258+
woutbufp = PyMem_RawMalloc((size_t)result * sizeof(wchar_t));
4259+
}
4260+
else {
4261+
woutbufp = NULL;
4262+
}
4263+
if (!woutbufp) {
4264+
*abspath_p = NULL;
4265+
return 0;
4266+
}
4267+
4268+
result = GetFullPathNameW(path, result, woutbufp, NULL);
4269+
if (!result) {
4270+
PyMem_RawFree(woutbufp);
4271+
return -1;
4272+
}
4273+
}
4274+
4275+
if (woutbufp != woutbuf) {
4276+
*abspath_p = woutbufp;
4277+
return 0;
4278+
}
4279+
4280+
*abspath_p = _PyMem_RawWcsdup(woutbufp);
4281+
return 0;
4282+
}
4283+
4284+
42434285
/* A helper function for abspath on win32 */
42444286
/*[clinic input]
42454287
os._getfullpathname
@@ -4255,8 +4297,7 @@ os__getfullpathname_impl(PyObject *module, path_t *path)
42554297
{
42564298
wchar_t *abspath;
42574299

4258-
/* _Py_abspath() is implemented with GetFullPathNameW() on Windows */
4259-
if (_Py_abspath(path->wide, &abspath) < 0) {
4300+
if (_PyOS_getfullpathname(path->wide, &abspath) < 0) {
42604301
return win32_error_object("GetFullPathNameW", path->object);
42614302
}
42624303
if (abspath == NULL) {

‎Python/fileutils.c

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,42 +2049,7 @@ _Py_abspath(const wchar_t *path, wchar_t **abspath_p)
20492049
}
20502050

20512051
#ifdef MS_WINDOWS
2052-
wchar_t woutbuf[MAX_PATH], *woutbufp = woutbuf;
2053-
DWORD result;
2054-
2055-
result = GetFullPathNameW(path,
2056-
Py_ARRAY_LENGTH(woutbuf), woutbuf,
2057-
NULL);
2058-
if (!result) {
2059-
return -1;
2060-
}
2061-
2062-
if (result >= Py_ARRAY_LENGTH(woutbuf)) {
2063-
if ((size_t)result <= (size_t)PY_SSIZE_T_MAX / sizeof(wchar_t)) {
2064-
woutbufp = PyMem_RawMalloc((size_t)result * sizeof(wchar_t));
2065-
}
2066-
else {
2067-
woutbufp = NULL;
2068-
}
2069-
if (!woutbufp) {
2070-
*abspath_p = NULL;
2071-
return 0;
2072-
}
2073-
2074-
result = GetFullPathNameW(path, result, woutbufp, NULL);
2075-
if (!result) {
2076-
PyMem_RawFree(woutbufp);
2077-
return -1;
2078-
}
2079-
}
2080-
2081-
if (woutbufp != woutbuf) {
2082-
*abspath_p = woutbufp;
2083-
return 0;
2084-
}
2085-
2086-
*abspath_p = _PyMem_RawWcsdup(woutbufp);
2087-
return 0;
2052+
return _PyOS_getfullpathname(path, abspath_p);
20882053
#else
20892054
wchar_t cwd[MAXPATHLEN + 1];
20902055
cwd[Py_ARRAY_LENGTH(cwd) - 1] = 0;

0 commit comments

Comments
 (0)
0