Merged revisions 74128 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
................
r74128 | alexandre.vassalotti | 2009-07-20 20:51:58 -0400 (Mon, 20 Jul 2009) | 14 lines
Merged revisions 73706,73778 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r73706 | georg.brandl | 2009-06-30 12:18:55 -0400 (Tue, 30 Jun 2009) | 1 line
#6384: Add a heading for the exception hierarchy.
........
r73778 | r.david.murray | 2009-07-02 14:19:20 -0400 (Thu, 02 Jul 2009) | 3 lines
Issue 6389: add documentation for the 'mode' flags defined in the
stat module.
........
................
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 43fa9b0..feeeffd 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -422,6 +422,8 @@
Base class for warnings related to :class:`bytes` and :class:`buffer`.
+Exception hierarchy
+-------------------
The class hierarchy for built-in exceptions is:
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 90e59ef..218437e 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -755,25 +755,25 @@
following values (as defined in the :mod:`stat` module) or bitwise ORed
combinations of them:
- * ``stat.S_ISUID``
- * ``stat.S_ISGID``
- * ``stat.S_ENFMT``
- * ``stat.S_ISVTX``
- * ``stat.S_IREAD``
- * ``stat.S_IWRITE``
- * ``stat.S_IEXEC``
- * ``stat.S_IRWXU``
- * ``stat.S_IRUSR``
- * ``stat.S_IWUSR``
- * ``stat.S_IXUSR``
- * ``stat.S_IRWXG``
- * ``stat.S_IRGRP``
- * ``stat.S_IWGRP``
- * ``stat.S_IXGRP``
- * ``stat.S_IRWXO``
- * ``stat.S_IROTH``
- * ``stat.S_IWOTH``
- * ``stat.S_IXOTH``
+ * :data:`stat.S_ISUID`
+ * :data:`stat.S_ISGID`
+ * :data:`stat.S_ENFMT`
+ * :data:`stat.S_ISVTX`
+ * :data:`stat.S_IREAD`
+ * :data:`stat.S_IWRITE`
+ * :data:`stat.S_IEXEC`
+ * :data:`stat.S_IRWXU`
+ * :data:`stat.S_IRUSR`
+ * :data:`stat.S_IWUSR`
+ * :data:`stat.S_IXUSR`
+ * :data:`stat.S_IRWXG`
+ * :data:`stat.S_IRGRP`
+ * :data:`stat.S_IWGRP`
+ * :data:`stat.S_IXGRP`
+ * :data:`stat.S_IRWXO`
+ * :data:`stat.S_IROTH`
+ * :data:`stat.S_IWOTH`
+ * :data:`stat.S_IXOTH`
Availability: Unix, Windows.
diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst
index d4eae5d..b318bb7 100644
--- a/Doc/library/stat.rst
+++ b/Doc/library/stat.rst
@@ -137,6 +137,131 @@
of the size field for other character and block devices varies more, depending
on the implementation of the underlying system call.
+The variables below define the flags used in the :data:`ST_MODE` field.
+
+Use of the functions above is more portable than use of the first set of flags:
+
+.. data:: S_IFMT
+
+ Bit mask for the file type bit fields.
+
+.. data:: S_IFSOCK
+
+ Socket.
+
+.. data:: S_IFLNK
+
+ Symbolic link.
+
+.. data:: S_IFREG
+
+ Regular file.
+
+.. data:: S_IFBLK
+
+ Block device.
+
+.. data:: S_IFDIR
+
+ Directory.
+
+.. data:: S_IFCHR
+
+ Character device.
+
+.. data:: S_IFIFO
+
+ FIFO.
+
+The following flags can also be used in the *mode* argument of :func:`os.chmod`:
+
+.. data:: S_ISUID
+
+ Set UID bit.
+
+.. data:: S_ISGID
+
+ Set-group-ID bit. This bit has several special uses. For a directory
+ it indicates that BSD semantics is to be used for that directory:
+ files created there inherit their group ID from the directory, not
+ from the effective group ID of the creating process, and directories
+ created there will also get the :data:`S_ISGID` bit set. For a
+ file that does not have the group execution bit (:data:`S_IXGRP`)
+ set, the set-group-ID bit indicates mandatory file/record locking
+ (see also :data:`S_ENFMT`).
+
+.. data:: S_ISVTX
+
+ Sticky bit. When this bit is set on a directory it means that a file
+ in that directory can be renamed or deleted only by the owner of the
+ file, by the owner of the directory, or by a privileged process.
+
+.. data:: S_IRWXU
+
+ Mask for file owner permissions.
+
+.. data:: S_IRUSR
+
+ Owner has read permission.
+
+.. data:: S_IWUSR
+
+ Owner has write permission.
+
+.. data:: S_IXUSR
+
+ Owner has execute permission.
+
+.. data:: S_IRWXG
+
+ Mask for group permissions.
+
+.. data:: S_IRGRP
+
+ Group has read permission.
+
+.. data:: S_IWGRP
+
+ Group has write permission.
+
+.. data:: S_IXGRP
+
+ Group has execute permission.
+
+.. data:: S_IRWXO
+
+ Mask for permissions for others (not in group).
+
+.. data:: S_IROTH
+
+ Others have read permission.
+
+.. data:: S_IWOTH
+
+ Others have write permission.
+
+.. data:: S_IXOTH
+
+ Others have execute permission.
+
+.. data:: S_ENFMT
+
+ System V file locking enforcement. This flag is shared with :data:`S_ISGID`:
+ file/record locking is enforced on files that do not have the group
+ execution bit (:data:`S_IXGRP`) set.
+
+.. data:: S_IREAD
+
+ Unix V7 synonym for :data:`S_IRUSR`.
+
+.. data:: S_IWRITE
+
+ Unix V7 synonym for :data:`S_IWUSR`.
+
+.. data:: S_IEXEC
+
+ Unix V7 synonym for :data:`S_IXUSR`.
+
Example::
import os, sys