bpo-37834: Normalise handling of reparse points on Windows by zooba · Pull Request #15231 · python/cpython

Expand Up @@ -1858,6 +1858,12 @@ features: .. versionchanged:: 3.6 Accepts a :term:`path-like object` for *src* and *dst*.
.. versionchanged:: 3.8 On Windows, now opens reparse points that represent another path (name surrogates), including symbolic links and directory junctions. Other kinds of reparse points are resolved by the operating system as for :func:`~os.stat`.

.. function:: mkdir(path, mode=0o777, *, dir_fd=None)
Expand Down Expand Up @@ -2039,6 +2045,10 @@ features: This function can also support :ref:`paths relative to directory descriptors <dir_fd>`.
When trying to resolve a path that may contain links, use :func:`~os.path.realpath` to properly handle recursion and platform differences.
.. availability:: Unix, Windows.
.. versionchanged:: 3.2 Expand All @@ -2053,6 +2063,11 @@ features: .. versionchanged:: 3.8 Accepts a :term:`path-like object` and a bytes object on Windows.
.. versionchanged:: 3.8 Added support for directory junctions, and changed to return the substitution path (which typically includes ``\\?\`` prefix) rather than the optional "print name" field that was previously returned.
.. function:: remove(path, *, dir_fd=None)
Remove (delete) the file *path*. If *path* is a directory, an Expand Down Expand Up @@ -2366,7 +2381,8 @@ features:
On Unix, this method always requires a system call. On Windows, it only requires a system call if *follow_symlinks* is ``True`` and the entry is a symbolic link. entry is a reparse point (for example, a symbolic link or directory junction).
On Windows, the ``st_ino``, ``st_dev`` and ``st_nlink`` attributes of the :class:`stat_result` are always set to zero. Call :func:`os.stat` to Expand Down Expand Up @@ -2403,6 +2419,17 @@ features: This function can support :ref:`specifying a file descriptor <path_fd>` and :ref:`not following symlinks <follow_symlinks>`.
On Windows, passing ``follow_symlinks=False`` will disable following all name-surrogate reparse points, which includes symlinks and directory junctions. Other types of reparse points that do not resemble links or that the operating system is unable to follow will be opened directly. When following a chain of multiple links, this may result in the original link being returned instead of the non-link that prevented full traversal. To obtain stat results for the final path in this case, use the :func:`os.path.realpath` function to resolve the path name as far as possible and call :func:`lstat` on the result. This does not apply to dangling symlinks or junction points, which will raise the usual exceptions.
.. index:: module: stat
Example:: Expand All @@ -2427,6 +2454,14 @@ features: .. versionchanged:: 3.6 Accepts a :term:`path-like object`.
.. versionchanged:: 3.8 On Windows, all reparse points that can be resolved by the operating system are now followed, and passing ``follow_symlinks=False`` disables following all name surrogate reparse points. If the operating system reaches a reparse point that it is not able to follow, *stat* now returns the information for the original path as if ``follow_symlinks=False`` had been specified instead of raising an error.

.. class:: stat_result
Expand Down Expand Up @@ -2578,7 +2613,7 @@ features:
File type.
On Windows systems, the following attribute is also available: On Windows systems, the following attributes are also available:
.. attribute:: st_file_attributes
Expand All @@ -2587,6 +2622,12 @@ features: :c:func:`GetFileInformationByHandle`. See the ``FILE_ATTRIBUTE_*`` constants in the :mod:`stat` module.
.. attribute:: st_reparse_tag
When :attr:`st_file_attributes` has the ``FILE_ATTRIBUTE_REPARSE_POINT`` set, this field contains the tag identifying the type of reparse point. See the ``IO_REPARSE_TAG_*`` constants in the :mod:`stat` module.
The standard module :mod:`stat` defines functions and constants that are useful for extracting information from a :c:type:`stat` structure. (On Windows, some items are filled with dummy values.) Expand Down Expand Up @@ -2614,6 +2655,14 @@ features: .. versionadded:: 3.7 Added the :attr:`st_fstype` member to Solaris/derivatives.
.. versionadded:: 3.8 Added the :attr:`st_reparse_tag` member on Windows.
.. versionchanged:: 3.8 On Windows, the :attr:`st_mode` member now identifies special files as :const:`S_IFCHR`, :const:`S_IFIFO` or :const:`S_IFBLK` as appropriate.
.. function:: statvfs(path)
Perform a :c:func:`statvfs` system call on the given path. The return value is Expand Down