Implement #1578269. Patch by Jason R. Coombs.
Added Windows support for os.symlink when run on Windows 6.0 or greater,
aka Vista. Previous Windows versions will raise NotImplementedError
when trying to symlink.
Includes numerous test updates and additions to test_os, including
a symlink_support module because of the fact that privilege escalation
is required in order to run the tests to ensure that the user is able
to create symlinks. By default, accounts do not have the required
privilege, so the escalation code will have to be exposed later (or
documented on how to do so). I'll be following up with that work next.
Note that the tests use ctypes, which was agreed on during the PyCon
language summit.
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index b74350d..d8835f6 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1065,7 +1065,7 @@
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 @@
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 @@
.. 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)