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_ISDOOR(mode)

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

Добавлена в версии 3.4.

stat.S_ISPORT(mode)

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

Добавлена в версии 3.4.

stat.S_ISWHT(mode)

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

Добавлена в версии 3.4.

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

stat.S_IMODE(mode)

Возвращает часть режима файла, которая может быть установлена с помощью os.chmod() — то есть биты разрешений файла, а также биты «sticky», «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.lstat(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)

Предоставляется дополнительная утилитарная функция для преобразования режима файла в читаемую строку:

stat.filemode(mode)

Преобразует режим файла в строку вида «-rwxrwxrwx».

Добавлена в версии 3.3.

Изменено в версии 3.4: Функция поддерживает S_IFDOOR, S_IFPORT и S_IFWHT.

Все переменные ниже — просто символические индексы в кортеже из 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.

stat.S_IFDOOR

Файл типа «дверь».

Добавлена в версии 3.4.

stat.S_IFPORT

Порт событий.

Добавлена в версии 3.4.

stat.S_IFWHT

Файл «whiteout».

Добавлена в версии 3.4.

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

stat.S_ISUID

Бит установления UID.

stat.S_ISGID

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

stat.S_ISVTX

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

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

Принудительное применение блокировки файлов System 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

Файл хранится в сжатом виде (macOS 10.6+).

stat.UF_HIDDEN

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

stat.SF_ARCHIVED

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

stat.SF_IMMUTABLE

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

stat.SF_APPEND

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

stat.SF_NOUNLINK

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

stat.SF_SNAPSHOT

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

Дополнительную информацию см. в справочной странице *BSD или macOS chflags(2).

В Windows следующие константы атрибутов файла доступны для проверки битов в элементе st_file_attributes возвращаемом os.stat(). Подробнее о значении этих констант см. в документации API Windows .

stat.FILE_ATTRIBUTE_ARCHIVE

stat.FILE_ATTRIBUTE_COMPRESSED

stat.FILE_ATTRIBUTE_DEVICE

stat.FILE_ATTRIBUTE_DIRECTORY

stat.FILE_ATTRIBUTE_ENCRYPTED

stat.FILE_ATTRIBUTE_HIDDEN

stat.FILE_ATTRIBUTE_INTEGRITY_STREAM

stat.FILE_ATTRIBUTE_NORMAL

stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED

stat.FILE_ATTRIBUTE_NO_SCRUB_DATA

stat.FILE_ATTRIBUTE_OFFLINE

stat.FILE_ATTRIBUTE_READONLY

stat.FILE_ATTRIBUTE_REPARSE_POINT

stat.FILE_ATTRIBUTE_SPARSE_FILE

stat.FILE_ATTRIBUTE_SYSTEM

stat.FILE_ATTRIBUTE_TEMPORARY

stat.FILE_ATTRIBUTE_VIRTUAL

Добавлена в версии 3.5.

В Windows следующие константы доступны для сравнения с элементом st_reparse_tag возвращаемым os.lstat(). Это хорошо известные константы, но не исчерпывающий список.

stat.IO_REPARSE_TAG_SYMLINK

stat.IO_REPARSE_TAG_MOUNT_POINT

stat.IO_REPARSE_TAG_APPEXECLINK

Добавлена в версии 3.8.