stat — Интерпретация результатов stat()

Исходный код: Lib/stat.py

Модуль stat определяет константы и функции для интерпретации результатов вызовов os.stat(), os.fstat() и os.lstat() (если они существуют). Для получения полной информации о вызовах stat(), fstat() и lstat(), обратитесь к документации вашей системы.

Модуль stat определяет следующие функции для проверки типов файлов:

stat.S_ISDIR(mode)

Возвращает ненулевое значение, если режим соответствует каталогу.

stat.S_ISCHR(mode)

Возвращает ненулевое значение, если режим соответствует файлу специального устройства символьного типа.

stat.S_ISBLK(mode)

Возвращает ненулевое значение, если режим соответствует файлу специального устройства блочного типа.

stat.S_ISREG(mode)

Возвращает ненулевое значение, если режим соответствует обычному файлу.

stat.S_ISFIFO(mode)

Возвращает ненулевое значение, если режим соответствует FIFO (именованной очереди).

stat.S_ISLNK(mode)

Возвращает ненулевое значение, если режим соответствует символической ссылке.

stat.S_ISSOCK(mode)

Возвращает ненулевое значение, если режим соответствует сокету.

Определены две дополнительные функции для более общей обработки режима файла:

stat.S_IMODE(mode)

Возвращает часть режима файла, которая может быть установлена с помощью os.chmod() — то есть биты разрешений файла, плюс биты «липкий бит», «set-group-ID» и «set-user-ID» (на системах, которые их поддерживают).

stat.S_IFMT(mode)

Возвращает часть режима файла, описывающую тип файла (используется функциями S_IS*() выше).

Обычно вы используете функции os.path.is*() для проверки типа файла; данные функции полезны, когда вы выполняете несколько проверок одного и того же файла и хотите избежать накладных расходов вызова stat() системного вызова для каждой проверки. Они также полезны при проверке информации о файле, которая не обрабатывается os.path, такие как проверки на блочные и символьные устройства.

Пример:

import os, sys
from stat import *

def walktree(top, callback):
    '''recursively descend the directory tree rooted at top,
       calling the callback function for each regular file'''

    for f in os.listdir(top):
        pathname = os.path.join(top, f)
        mode = os.stat(pathname).st_mode
        if S_ISDIR(mode):
            # It's a directory, recurse into it
            walktree(pathname, callback)
        elif S_ISREG(mode):
            # It's a file, call the callback function
            callback(pathname)
        else:
            # Unknown file type, print a message
            print 'Skipping %s' % pathname

def visitfile(file):
    print 'visiting', file

if __name__ == '__main__':
    walktree(sys.argv[1], visitfile)

Все переменные ниже просто представляют символические индексы в 10-кортеже, возвращаемом os.stat(), os.fstat() или os.lstat().

stat.ST_MODE

Режим защиты индексного узла.

stat.ST_INO

Номер индексного узла.

stat.ST_DEV

Устройство, на котором находится индексный узел.

stat.ST_NLINK

Количество ссылок на индексный узел.

stat.ST_UID

Идентификатор пользователя владельца.

stat.ST_GID

Идентификатор группы владельца.

stat.ST_SIZE

Размер обычного файла в байтах; количество данных, ожидающих обработки в некоторых специальных файлах.

stat.ST_ATIME

Время последнего доступа.

stat.ST_MTIME

Время последней модификации.

stat.ST_CTIME

«ctime» согласно данным операционной системы. На некоторых системах (например, Unix) это время последнего изменения метаданных, а на других (например, Windows) — время создания (см. документацию платформы для получения подробностей).

Интерпретация «размера файла» меняется в зависимости от типа файла. Для обычных файлов это размер файла в байтах. Для FIFO и сокетов в большинстве вариантов Unix (включая Linux), «размер» — количество байт, ожидающих чтения во время вызова os.stat(), os.fstat() или os.lstat(); это иногда может быть полезно, особенно для опроса одного из этих специальных файлов после неостанавливающегося открытия. Значение поля «размер» для других символьных и блочных устройств варьируется в зависимости от реализации базового системного вызова.

Переменные ниже определяют флаги, используемые в поле ST_MODE.

Использование функций выше более портативное, чем использование первого набора флагов:

stat.S_IFSOCK

Сокет.

stat.S_IFLNK

Символическая ссылка.

stat.S_IFREG

Обычный файл.

stat.S_IFBLK

Блочное устройство.

stat.S_IFDIR

Каталог.

stat.S_IFCHR

Символьное устройство.

stat.S_IFIFO

FIFO.

Следующие флаги также могут быть использованы в аргументе mode функции os.chmod():

stat.S_ISUID

Бит установки UID.

stat.S_ISGID

Бит установки GID. Этот бит имеет несколько специальных применений. Для каталога он указывает, что должны быть использованы семантики BSD для этого каталога: файлы, созданные в нём, наследуют свой идентификатор группы из каталога, а не из эффективного идентификатора группы процесса-создателя, и каталоги, созданные в нём, также получат бит S_ISGID. Для файла, у которого не установлен бит выполнения для группы (S_IXGRP), бит установки GID указывает на принудительное блокирование файла/записи (см. также S_ENFMT).

stat.S_ISVTX

Липкий бит. Если этот бит установлен для каталога, это означает, что файл в этом каталоге может быть переименован или удалён только владельцем файла, владельцем каталога или привилегированным процессом.

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

Другие имеют разрешение на выполнение.

stat.S_ENFMT

Принуждение к блокированию файлов в системе V. Этот флаг совместно используется с S_ISGID: блокирование файлов/записей принуждается для файлов, у которых не установлен бит выполнения для группы (S_IXGRP).

stat.S_IREAD

Синоним Unix V7 для S_IRUSR.

stat.S_IWRITE

Синоним Unix V7 для S_IWUSR.

stat.S_IEXEC

Синоним Unix V7 для S_IXUSR.

Следующие флаги могут быть использованы в аргументе flags функции os.chflags():

stat.UF_NODUMP

Файл не должен быть выгружен.

stat.UF_IMMUTABLE

Файл не может быть изменён.

stat.UF_APPEND

Файл может быть только добавлен.

stat.UF_OPAQUE

Директория непрозрачна при просмотре через стеки объединения.

stat.UF_NOUNLINK

Файл нельзя переименовать или удалить.

stat.UF_COMPRESSED

Файл хранится в сжатом формате (Mac OS X 10.6+).

stat.UF_HIDDEN

Файл не должен отображаться в графическом интерфейсе (Mac OS X 10.5+).

stat.SF_ARCHIVED

Файл может быть архивирован.

stat.SF_IMMUTABLE

Файл нельзя изменить.

stat.SF_APPEND

Файл можно только добавлять.

stat.SF_NOUNLINK

Файл нельзя переименовать или удалить.

stat.SF_SNAPSHOT

Файл является файлом моментального снимка.

См. страницу руководства *BSD или Mac OS chflags(2) для получения дополнительной информации.