stat.py 5.01 KB
Newer Older
1 2 3 4 5
"""Constants/functions for interpreting results of os.stat() and os.lstat().

Suggested usage: from stat import *
"""

6
# Indices for stat struct members in the tuple returned by os.stat()
Guido van Rossum's avatar
Guido van Rossum committed
7 8 9 10 11 12 13 14 15 16 17 18

ST_MODE  = 0
ST_INO   = 1
ST_DEV   = 2
ST_NLINK = 3
ST_UID   = 4
ST_GID   = 5
ST_SIZE  = 6
ST_ATIME = 7
ST_MTIME = 8
ST_CTIME = 9

19 20
# Extract bits from the mode

21
def S_IMODE(mode):
22 23 24
    """Return the portion of the file's mode that can be set by
    os.chmod().
    """
25
    return mode & 0o7777
26

Guido van Rossum's avatar
Guido van Rossum committed
27
def S_IFMT(mode):
28 29 30
    """Return the portion of the file's mode that describes the
    file type.
    """
31
    return mode & 0o170000
32 33 34

# Constants used as S_IFMT() for various file types
# (not all are implemented on all systems)
Guido van Rossum's avatar
Guido van Rossum committed
35

36 37 38 39 40 41 42
S_IFDIR  = 0o040000  # directory
S_IFCHR  = 0o020000  # character device
S_IFBLK  = 0o060000  # block device
S_IFREG  = 0o100000  # regular file
S_IFIFO  = 0o010000  # fifo (named pipe)
S_IFLNK  = 0o120000  # symbolic link
S_IFSOCK = 0o140000  # socket file
Guido van Rossum's avatar
Guido van Rossum committed
43

44 45
# Functions to test for each file type

Guido van Rossum's avatar
Guido van Rossum committed
46
def S_ISDIR(mode):
47
    """Return True if mode is from a directory."""
Tim Peters's avatar
Tim Peters committed
48
    return S_IFMT(mode) == S_IFDIR
Guido van Rossum's avatar
Guido van Rossum committed
49 50

def S_ISCHR(mode):
51
    """Return True if mode is from a character special device file."""
Tim Peters's avatar
Tim Peters committed
52
    return S_IFMT(mode) == S_IFCHR
Guido van Rossum's avatar
Guido van Rossum committed
53 54

def S_ISBLK(mode):
55
    """Return True if mode is from a block special device file."""
Tim Peters's avatar
Tim Peters committed
56
    return S_IFMT(mode) == S_IFBLK
Guido van Rossum's avatar
Guido van Rossum committed
57 58

def S_ISREG(mode):
59
    """Return True if mode is from a regular file."""
Tim Peters's avatar
Tim Peters committed
60
    return S_IFMT(mode) == S_IFREG
Guido van Rossum's avatar
Guido van Rossum committed
61 62

def S_ISFIFO(mode):
63
    """Return True if mode is from a FIFO (named pipe)."""
Tim Peters's avatar
Tim Peters committed
64
    return S_IFMT(mode) == S_IFIFO
Guido van Rossum's avatar
Guido van Rossum committed
65 66

def S_ISLNK(mode):
67
    """Return True if mode is from a symbolic link."""
Tim Peters's avatar
Tim Peters committed
68
    return S_IFMT(mode) == S_IFLNK
Guido van Rossum's avatar
Guido van Rossum committed
69 70

def S_ISSOCK(mode):
71
    """Return True if mode is from a socket."""
Tim Peters's avatar
Tim Peters committed
72
    return S_IFMT(mode) == S_IFSOCK
73 74 75

# Names for permission bits

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
S_ISUID = 0o4000  # set UID bit
S_ISGID = 0o2000  # set GID bit
S_ENFMT = S_ISGID # file locking enforcement
S_ISVTX = 0o1000  # sticky bit
S_IREAD = 0o0400  # Unix V7 synonym for S_IRUSR
S_IWRITE = 0o0200 # Unix V7 synonym for S_IWUSR
S_IEXEC = 0o0100  # Unix V7 synonym for S_IXUSR
S_IRWXU = 0o0700  # mask for owner permissions
S_IRUSR = 0o0400  # read by owner
S_IWUSR = 0o0200  # write by owner
S_IXUSR = 0o0100  # execute by owner
S_IRWXG = 0o0070  # mask for group permissions
S_IRGRP = 0o0040  # read by group
S_IWGRP = 0o0020  # write by group
S_IXGRP = 0o0010  # execute by group
S_IRWXO = 0o0007  # mask for others (not in group) permissions
S_IROTH = 0o0004  # read by others
S_IWOTH = 0o0002  # write by others
S_IXOTH = 0o0001  # execute by others
95 96 97

# Names for file flags

98 99 100 101 102 103 104 105 106 107 108 109
UF_NODUMP    = 0x00000001  # do not dump file
UF_IMMUTABLE = 0x00000002  # file may not be changed
UF_APPEND    = 0x00000004  # file may only be appended to
UF_OPAQUE    = 0x00000008  # directory is opaque when viewed through a union stack
UF_NOUNLINK  = 0x00000010  # file may not be renamed or deleted
UF_COMPRESSED = 0x00000020 # OS X: file is hfs-compressed
UF_HIDDEN    = 0x00008000  # OS X: file should not be displayed
SF_ARCHIVED  = 0x00010000  # file may be archived
SF_IMMUTABLE = 0x00020000  # file may not be changed
SF_APPEND    = 0x00040000  # file may only be appended to
SF_NOUNLINK  = 0x00100000  # file may not be renamed or deleted
SF_SNAPSHOT  = 0x00200000  # file is a snapshot file
110 111 112 113


_filemode_table = (
    ((S_IFLNK,         "l"),
114
     (S_IFSOCK,        "s"),  # Must appear before IFREG and IFDIR as IFSOCK == IFREG | IFDIR
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
     (S_IFREG,         "-"),
     (S_IFBLK,         "b"),
     (S_IFDIR,         "d"),
     (S_IFCHR,         "c"),
     (S_IFIFO,         "p")),

    ((S_IRUSR,         "r"),),
    ((S_IWUSR,         "w"),),
    ((S_IXUSR|S_ISUID, "s"),
     (S_ISUID,         "S"),
     (S_IXUSR,         "x")),

    ((S_IRGRP,         "r"),),
    ((S_IWGRP,         "w"),),
    ((S_IXGRP|S_ISGID, "s"),
     (S_ISGID,         "S"),
     (S_IXGRP,         "x")),

    ((S_IROTH,         "r"),),
    ((S_IWOTH,         "w"),),
    ((S_IXOTH|S_ISVTX, "t"),
     (S_ISVTX,         "T"),
     (S_IXOTH,         "x"))
)

def filemode(mode):
    """Convert a file's mode to a string of the form '-rwxrwxrwx'."""
    perm = []
    for table in _filemode_table:
        for bit, char in table:
            if mode & bit == bit:
                perm.append(char)
                break
        else:
            perm.append("-")
    return "".join(perm)
151

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

# Windows FILE_ATTRIBUTE constants for interpreting os.stat()'s
# "st_file_attributes" member

FILE_ATTRIBUTE_ARCHIVE = 32
FILE_ATTRIBUTE_COMPRESSED = 2048
FILE_ATTRIBUTE_DEVICE = 64
FILE_ATTRIBUTE_DIRECTORY = 16
FILE_ATTRIBUTE_ENCRYPTED = 16384
FILE_ATTRIBUTE_HIDDEN = 2
FILE_ATTRIBUTE_INTEGRITY_STREAM = 32768
FILE_ATTRIBUTE_NORMAL = 128
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED = 8192
FILE_ATTRIBUTE_NO_SCRUB_DATA = 131072
FILE_ATTRIBUTE_OFFLINE = 4096
FILE_ATTRIBUTE_READONLY = 1
FILE_ATTRIBUTE_REPARSE_POINT = 1024
FILE_ATTRIBUTE_SPARSE_FILE = 512
FILE_ATTRIBUTE_SYSTEM = 4
FILE_ATTRIBUTE_TEMPORARY = 256
FILE_ATTRIBUTE_VIRTUAL = 65536


175 176 177
# If available, use C implementation
try:
    from _stat import *
178
except ImportError:
179
    pass