Mercurial > cpython-lru_cache-weakref

annotate Lib/stat.py @ 25838:8540887bcec6 2.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.
author Guido van Rossum <guido@python.org>
date Fri, 18 Oct 2002 13:42:21 +0000
parents 79d533934ac1
children 53fd144a3f1a
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
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
6 # XXX Strictly spoken, this module may have to be adapted for each POSIX
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
7 # implementation; in practice, however, the numeric constants used by
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
8 # stat() are almost universal (even for stat() emulations on non-UNIX
1810
d892ac4b4fb9 * Lib/linecache.py: don't crash on empty filename
Guido van Rossum <guido@python.org>
parents: 852
diff changeset
9 # systems like MS-DOS).
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
10
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
11 # Indices for stat struct members in tuple returned by os.stat()
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
12
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 ST_MODE = 0
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 ST_INO = 1
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 ST_DEV = 2
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 ST_NLINK = 3
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 ST_UID = 4
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 ST_GID = 5
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 ST_SIZE = 6
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 ST_ATIME = 7
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 ST_MTIME = 8
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 ST_CTIME = 9
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
23
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
24 # 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
25
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
26 def S_IMODE(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
27 return mode & 07777
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
28
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 def S_IFMT(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
30 return mode & 0170000
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
31
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
32 # 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
33 # (not all are implemented on all systems)
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 S_IFDIR = 0040000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 S_IFCHR = 0020000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 S_IFBLK = 0060000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 S_IFREG = 0100000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 S_IFIFO = 0010000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 S_IFLNK = 0120000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 S_IFSOCK = 0140000
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
42
775
45b3a78f256b Use bitwise ops instead of %; added some warnings and comments
Guido van Rossum <guido@python.org>
parents: 559
diff changeset
43 # 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
44
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
45 def S_ISDIR(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
46 return S_IFMT(mode) == S_IFDIR
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
47
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
48 def S_ISCHR(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
49 return S_IFMT(mode) == S_IFCHR
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
50
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 def S_ISBLK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
52 return S_IFMT(mode) == S_IFBLK
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
53
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 def S_ISREG(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
55 return S_IFMT(mode) == S_IFREG
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
56
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
57 def S_ISFIFO(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
58 return S_IFMT(mode) == S_IFIFO
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
59
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 def S_ISLNK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
61 return S_IFMT(mode) == S_IFLNK
20
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
62
118545312f3b Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
63 def S_ISSOCK(mode):
15872
3685ef2a55a4 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 11707
diff changeset
64 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
65
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
66 # Names for permission bits
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
67
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
68 S_ISUID = 04000
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
69 S_ISGID = 02000
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
70 S_ENFMT = S_ISGID
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
71 S_ISVTX = 01000
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
72 S_IREAD = 00400
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
73 S_IWRITE = 00200
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
74 S_IEXEC = 00100
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
75 S_IRWXU = 00700
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
76 S_IRUSR = 00400
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
77 S_IWUSR = 00200
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
78 S_IXUSR = 00100
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
79 S_IRWXG = 00070
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
80 S_IRGRP = 00040
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
81 S_IWGRP = 00020
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
82 S_IXGRP = 00010
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
83 S_IRWXO = 00007
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
84 S_IROTH = 00004
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
85 S_IWOTH = 00002
1ac5c6727e8c Add names for perm bits (S_IREAD etc).
Guido van Rossum <guido@python.org>
parents: 775
diff changeset
86 S_IXOTH = 00001