posixfile — Объекты, подобные файлам, с поддержкой блокировки

Этот модуль реализует некоторые дополнительные функции по сравнению со встроенными объектами файлов. В частности, он реализует блокировку файлов, управление флагами файлов и простой интерфейс для дублирования объекта файла. Модуль определяет новый объект файла — объект posixfile. Он имеет все стандартные методы объекта файла и добавляет методы, описанные ниже. Этот модуль работает только для определенных типов Unix, так как он использует fcntl.fcntl() для блокировки файлов.

Для создания объекта posixfile используйте функцию posixfile.open(). Результирующий объект выглядит и ведет себя примерно так же, как стандартный объект файла.

Модуль posixfile определяет следующие константы:

posixfile.SEEK_SET

Смещение вычисляется с начала файла.

posixfile.SEEK_CUR

Смещение вычисляется от текущей позиции в файле.

posixfile.SEEK_END

Смещение вычисляется от конца файла.

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

posixfile.open(filename[, mode[, bufsize]])

Создает новый объект posixfile с заданным именем файла и режимом. Аргументы filename, mode и bufsize интерпретируются так же, как и во встроенной функции open().

posixfile.fileopen(fileobject)

Создает новый объект posixfile с заданным стандартным объектом файла. Результирующий объект имеет то же имя файла и режим, что и исходный объект файла.

Объект posixfile определяет следующие дополнительные методы:

posixfile.lock(fmt[, len[, start[, whence]]])

Блокирует указанный участок файла, на который ссылается объект файла. Формат описан ниже в таблице. Аргумент len задаёт длину участка, который следует заблокировать. По умолчанию это 0. start задаёт начальное смещение участка, по умолчанию 0. Аргумент whence задаёт, относительно чего вычисляется смещение. Принимает одно из значений констант SEEK_SET, SEEK_CUR или SEEK_END. По умолчанию SEEK_SET. Для получения дополнительной информации об аргументах обратитесь к справочной странице fcntl(2) вашей системы.

posixfile.flags([flags])

Устанавливает указанные флаги для файла, на который ссылается объект файла. Новые флаги объединяются с предыдущими при помощи побитового ИЛИ, если не указано иное. Формат описан ниже в таблице. Без аргумента flags возвращается строка, представляющая текущие флаги (это то же самое, что и модификатор ?). Для получения дополнительной информации о флагах обратитесь к справочной странице fcntl(2) вашей системы.

posixfile.dup()

Дублирует объект файла и связанный с ним указатель файла и дескриптор. Результирующий объект ведёт себя так, как будто он был вновь открыт.

posixfile.dup2(fd)

Дублирует объект файла и связанный с ним указатель файла и дескриптор. Новый объект будет иметь заданный дескриптор файла. В противном случае результирующий объект ведёт себя так, как будто он был вновь открыт.

posixfile.file()

Возвращает стандартный объект файла, на котором основан объект posixfile. Это иногда необходимо для функций, которые настаивают на стандартном объекте файла.

Все методы поднимают исключение IOError, если запрос не удаётся.

Символы формата для метода lock() имеют следующее значение:

Кроме того, к формату можно добавить следующие модификаторы:

Примечание:

1. Возвращаемая блокировка имеет формат (mode, len, start, whence, pid), где mode — символ, представляющий тип блокировки (‘r’ или ‘w’). Этот модификатор предотвращает предоставление запроса; он предназначен только для запросов.

Символы формата для метода flags() имеют следующие значения:

Кроме того, к формату можно добавить следующие модификаторы:

Примечания:

1. Модификаторы ! и = взаимоисключают друг друга.
2. Эта строка представляет флаги после того, как они могли быть изменены тем же вызовом.

Примеры:

import posixfile

file = posixfile.open('testfile', 'w')
file.lock('w|')
...
file.lock('u')
file.close()