diff options
author | Martin Panter <vadmium+py@gmail.com> | 2016-06-10 08:40:02 (GMT) |
---|---|---|
committer | Martin Panter <vadmium+py@gmail.com> | 2016-06-10 08:40:02 (GMT) |
commit | b7bdfcff97d13b803d182f02f7005bce9ae29f18 (patch) | |
tree | dbfddae945ad336b3c74066b01db18ed0bd68fd6 /Doc/library/os.rst | |
parent | 596357de2381fc23c554d146c0edfc9af10e66b7 (diff) | |
parent | 63b91e5403d58d8a56e60c760133f32659ac93c3 (diff) | |
download | cpython-b7bdfcff97d13b803d182f02f7005bce9ae29f18.zip cpython-b7bdfcff97d13b803d182f02f7005bce9ae29f18.tar.gz cpython-b7bdfcff97d13b803d182f02f7005bce9ae29f18.tar.bz2 |
Issue #24617: Merge os.mkdir() doc from 3.5
Diffstat (limited to 'Doc/library/os.rst')
-rw-r--r-- | Doc/library/os.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index b06b414..46d49df 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -1656,9 +1656,15 @@ features: Create a directory named *path* with numeric mode *mode*. + If the directory already exists, :exc:`FileExistsError` is raised. + + .. _mkdir_modebits: + On some systems, *mode* is ignored. Where it is used, the current umask - value is first masked out. If the directory already exists, - :exc:`FileExistsError` is raised. + value is first masked out. If bits other than the last 9 (i.e. the last 3 + digits of the octal representation of the *mode*) are set, their meaning is + platform-dependent. On some platforms, they are ignored and you should call + :func:`chmod` explicitly to set them. This function can also support :ref:`paths relative to directory descriptors <dir_fd>`. @@ -1679,8 +1685,8 @@ features: Recursive directory creation function. Like :func:`mkdir`, but makes all intermediate-level directories needed to contain the leaf directory. - The default *mode* is ``0o777`` (octal). On some systems, *mode* is - ignored. Where it is used, the current umask value is first masked out. + The *mode* parameter is passed to :func:`mkdir`; see :ref:`the mkdir() + description <mkdir_modebits>` for how it is interpreted. If *exist_ok* is ``False`` (the default), an :exc:`OSError` is raised if the target directory already exists. |