Mercurial > cpython-lru_cache-weakref

annotate Lib/stat.py @ 70817:dd775b1561ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix markup.
author Georg Brandl <georg@python.org>
date Tue, 14 Jun 2011 21:09:55 +0200
parents 36e296e66d21
children 529e26aa4fa3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11707
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 1810
diff changeset
1 """Constants/functions for interpreting results of os.stat() and os.lstat().
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 1810
diff changeset
2
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 1810
diff changeset
3 Suggested usage: from stat import *
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 1810
diff changeset
4 """
6f4146846337 The third and final doc-string sweep by Ka-Ping Yee.
Guido van Rossum <guido@python.org>
parents: 1810
diff changeset
5
45955
36e296e66d21 Merged revisions 61644,61646-61647,61649-61652,61656-61658,61663,61665,61667 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 42084
diff changeset
6 # Indices for stat struct members in the tuple returned by os.stat()
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 ST_MODE = 0
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 ST_INO = 1
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 ST_DEV = 2
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 ST_NLINK = 3
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 ST_UID = 4
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 ST_GID = 5
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 ST_SIZE = 6
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 ST_ATIME = 7
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 ST_MTIME = 8
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 ST_CTIME = 9
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
18
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
19 # Extract bits from the mode
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
20
56
a7e8fb7bb6a2 Added S_IMODE() to strip the file type (S_IFMT) from a mode.
Guido van Rossum <guido@python.org>
parents: 20
diff changeset
21 def S_IMODE(mode):
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
22 return mode & 0o7777
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
23
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 def S_IFMT(mode):
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
25 return mode & 0o170000
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
26
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
27 # Constants used as S_IFMT() for various file types
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
28 # (not all are implemented on all systems)
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
30 S_IFDIR = 0o040000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
31 S_IFCHR = 0o020000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
32 S_IFBLK = 0o060000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
33 S_IFREG = 0o100000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
34 S_IFIFO = 0o010000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
35 S_IFLNK = 0o120000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
36 S_IFSOCK = 0o140000
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
37
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
38 # Functions to test for each file type
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
39
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 def S_ISDIR(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
41 return S_IFMT(mode) == S_IFDIR
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
42
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 def S_ISCHR(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
44 return S_IFMT(mode) == S_IFCHR
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
45
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 def S_ISBLK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
47 return S_IFMT(mode) == S_IFBLK
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
48
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 def S_ISREG(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
50 return S_IFMT(mode) == S_IFREG
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
51
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 def S_ISFIFO(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
53 return S_IFMT(mode) == S_IFIFO
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
54
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
55 def S_ISLNK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
56 return S_IFMT(mode) == S_IFLNK
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
58 def S_ISSOCK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
59 return S_IFMT(mode) == S_IFSOCK
852
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
60
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
61 # Names for permission bits
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
62
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
63 S_ISUID = 0o4000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
64 S_ISGID = 0o2000
852
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
65 S_ENFMT = S_ISGID
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
66 S_ISVTX = 0o1000
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
67 S_IREAD = 0o0400
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
68 S_IWRITE = 0o0200
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
69 S_IEXEC = 0o0100
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
70 S_IRWXU = 0o0700
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
71 S_IRUSR = 0o0400
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
72 S_IWUSR = 0o0200
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
73 S_IXUSR = 0o0100
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
74 S_IRWXG = 0o0070
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
75 S_IRGRP = 0o0040
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
76 S_IWGRP = 0o0020
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
77 S_IXGRP = 0o0010
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
78 S_IRWXO = 0o0007
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
79 S_IROTH = 0o0004
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
80 S_IWOTH = 0o0002
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40893
diff changeset
81 S_IXOTH = 0o0001
40893
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
82
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
83 # Names for file flags
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
84
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
85 UF_NODUMP = 0x00000001
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
86 UF_IMMUTABLE = 0x00000002
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
87 UF_APPEND = 0x00000004
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
88 UF_OPAQUE = 0x00000008
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
89 UF_NOUNLINK = 0x00000010
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
90 SF_ARCHIVED = 0x00010000
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
91 SF_IMMUTABLE = 0x00020000
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
92 SF_APPEND = 0x00040000
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
93 SF_NOUNLINK = 0x00100000
32c4897b5d46 Merged revisions 53623-53858 via svnmerge from
Thomas Wouters <thomas@python.org>
parents: 16657
diff changeset
94 SF_SNAPSHOT = 0x00200000