diff options
Diffstat (limited to 'Doc/library/os.rst')
| -rw-r--r-- | Doc/library/os.rst | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index b74350d5f7b..d8835f698fd 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -1065,7 +1065,7 @@ Files and Directories Like :func:`stat`, but do not follow symbolic links. This is an alias for :func:`stat` on platforms that do not support symbolic links, such as - Windows. + Windows prior to 6.0 (Vista). .. function:: mkfifo(path[, mode]) @@ -1181,7 +1181,7 @@ Files and Directories and the call may raise an UnicodeDecodeError. If the *path* is a bytes object, the result will be a bytes object. - Availability: Unix. + Availability: Unix, Windows. .. function:: remove(path) @@ -1341,9 +1341,25 @@ Files and Directories .. function:: symlink(source, link_name) - Create a symbolic link pointing to *source* named *link_name*. + Create a symbolic link pointing to *source* named *link_name*. On Windows, + symlink version takes an additional, optional parameter, + *target_is_directory*, which defaults to False. - Availability: Unix. + symlink(source, link_name, target_is_directory=False) + + On Windows, a symlink represents a file or a directory, and does not + morph to the target dynamically. For this reason, when creating a + symlink on Windows, if the target is not already present, the symlink + will default to being a file symlink. If *target_is_directory* is set to + True, the symlink will be created as a directory symlink. This + parameter is ignored if the target exists (and the symlink is created + with the same type as the target). + + Symbolic link support was introduced in Windows 6.0 (Vista). *symlink* + will raise a NotImplementedError on Windows versions earlier than 6.0. The + SeCreateSymbolicLinkPrivilege is required in order to create symlinks. + + Availability: Unix, Windows 6.0. .. function:: unlink(path) |