`fcntl.md`

133 строк · 15.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/fcntl.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `fcntl` – системные вызовы `fcntl` и `ioctl`89---1011Этот модуль выполняет управление файлами и вводом-выводом на файловых дескрипторах. Он является интерфейсом к `fcntl()` и `ioctl()` процедурам Unix. За подробностями обращайтесь к *[fcntl(2)](https://python-all.ru/3.12/library/fcntl.html)* и *[ioctl(2)](https://python-all.ru/3.12/library/fcntl.html)* справочным страницам Unix.1213[Доступность](https://python-all.ru/3.12/library/intro.html#availability): Unix, не Emscripten, не WASI.1415Все функции в этом модуле первым аргументом принимают файловый дескриптор *fd*. Это может быть целочисленный файловый дескриптор, например, возвращаемый `sys.stdin.fileno()`, или объект [`io.IOBase`](https://python-all.ru/3.12/library/io.html#io.IOBase), такой как сам `sys.stdin`, который предоставляет [`fileno()`](https://python-all.ru/3.12/library/io.html#io.IOBase.fileno), возвращающий настоящий файловый дескриптор.1617Изменено в версии 3.3: Ранее операции в этом модуле вызывали [`IOError`](https://python-all.ru/3.12/library/exceptions.html#IOError), теперь они вызывают [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError).1819Изменено в версии 3.8: Модуль fcntl теперь содержит константы `F_ADD_SEALS`, `F_GET_SEALS` и `F_SEAL_*` для запечатывания [`os.memfd_create()`](https://python-all.ru/3.12/library/os.html#os.memfd_create) файловых дескрипторов.2021Изменено в версии 3.9: В macOS модуль fcntl предоставляет константу `F_GETPATH`, которая получает путь к файлу из файлового дескриптора. В Linux (\>=3.15) модуль fcntl предоставляет константы `F_OFD_GETLK`, `F_OFD_SETLK` и `F_OFD_SETLKW`, используемые при работе с блокировками открытого файлового описания.2223Изменено в версии 3.10: В Linux \>= 2.6.11 модуль fcntl предоставляет константы `F_GETPIPE_SZ` и `F_SETPIPE_SZ`, которые позволяют проверять и изменять размер канала (pipe) соответственно.2425Изменено в версии 3.11: В FreeBSD модуль fcntl предоставляет константы `F_DUP2FD` и `F_DUP2FD_CLOEXEC`, которые позволяют дублировать файловый дескриптор, причём последняя также устанавливает флаг `FD_CLOEXEC`.2627Изменено в версии 3.12: На Linux \>= 4.5 модуль [`fcntl`](https://python-all.ru/3.12/library/fcntl.html#module-fcntl) предоставляет константы `FICLONE` и `FICLONERANGE`, которые позволяют совместно использовать часть данных одного файла с другим файлом через рефлинк в некоторых файловых системах (например, btrfs, OCFS2 и XFS). Такое поведение обычно называется «копирование при записи».2829Модуль определяет следующие функции:3031#### `fcntl.fcntl(fd, cmd, arg=0)`3233Выполняет операцию *cmd* над файловым дескриптором *fd* (файловые объекты, предоставляющие метод [`fileno()`](https://python-all.ru/3.12/library/io.html#io.IOBase.fileno), также принимаются). Значения, используемые для *cmd*, зависят от операционной системы и доступны в виде констант в модуле [`fcntl`](https://python-all.ru/3.12/library/fcntl.html#module-fcntl), с теми же именами, что и в соответствующих C заголовочных файлах. Аргумент *arg* может быть целым числом или объектом [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). При целочисленном значении возвращаемое значение этой функции является целым значением, возвращённым вызовом C `fcntl()`. Когда аргумент – байты, он представляет двоичную структуру, например, созданную [`struct.pack()`](https://python-all.ru/3.12/library/struct.html#struct.pack). Двоичные данные копируются в буфер, адрес которого передаётся вызову C `fcntl()`. Возвращаемое значение после успешного вызова – содержимое буфера, преобразованное в объект [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Длина возвращаемого объекта будет совпадать с длиной аргумента *arg*. Это ограничено 1024 байтами. Если информация, возвращённая в буфер операционной системой, превышает 1024 байта, это, скорее всего, приведёт к нарушению сегментации или более тонкому повреждению данных.3435Если вызов `fcntl()` завершается неудачей, возбуждается [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError).3637Вызывает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `fcntl.fcntl` с аргументами `fd`, `cmd`, `arg`.3839#### `fcntl.ioctl(fd, request, arg=0, mutate_flag=True)`4041Эта функция идентична [`fcntl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.fcntl), за исключением того, что обработка аргументов ещё более сложная.4243Параметр *request* ограничен значениями, которые могут поместиться в 32 бита. Дополнительные константы, которые могут быть полезны в качестве аргумента *request*, можно найти в модуле [`termios`](https://python-all.ru/3.12/library/termios.html#module-termios), под теми же именами, что и в соответствующих заголовочных файлах C.4445Параметр *arg* может быть целым числом, объектом, поддерживающим интерфейс буфера только для чтения (например, [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes)), или объектом, поддерживающим интерфейс буфера для чтения и записи (например, [`bytearray`](https://python-all.ru/3.12/library/stdtypes.html#bytearray)).4647Во всех случаях, кроме последнего, поведение соответствует функции [`fcntl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.fcntl) .4849Если передан изменяемый буфер, то поведение определяется значением параметра *mutate\_flag*.5051Если он ложен, изменяемость буфера игнорируется, и поведение соответствует буферу только для чтения, за исключением того, что упомянутое ограничение в 1024 байта не применяется – при условии, что передаваемый буфер имеет длину не меньше той, что операционная система хочет туда записать, всё должно работать.5253Если *mutate\_flag* истинен (по умолчанию), то буфер (фактически) передаётся базовому системному вызову [`ioctl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.ioctl), его код возврата возвращается в вызывающий Python, а новое содержимое буфера отражает действие [`ioctl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.ioctl). Это небольшое упрощение, поскольку если переданный буфер короче 1024 байт, он сначала копируется в статический буфер длиной 1024 байта, который затем передаётся [`ioctl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.ioctl) и копируется обратно в исходный буфер.5455Если вызов `ioctl()` завершается неудачей, возбуждается исключение [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError).5657Пример:5859```python60>>> import array, fcntl, struct, termios, os61>>> os.getpgrp()621334163>>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]641334165>>> buf = array.array('h', [0])66>>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)67068>>> buf69array('h', [13341])70```7172Вызывает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `fcntl.ioctl` с аргументами `fd`, `request`, `arg`.7374#### `fcntl.flock(fd, operation)`7576Выполняет операцию блокировки *operation* для файлового дескриптора *fd* (также принимаются файловые объекты, предоставляющие метод [`fileno()`](https://python-all.ru/3.12/library/io.html#io.IOBase.fileno)). Подробнее см. в руководстве Unix *[flock(2)](https://python-all.ru/3.12/library/fcntl.html)*. (В некоторых системах эта функция эмулируется с помощью `fcntl()`.)7778Если вызов `flock()` завершается неудачей, возбуждается исключение [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError).7980Возбуждает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `fcntl.flock` с аргументами `fd`, `operation`.8182#### `fcntl.lockf(fd, cmd, len=0, start=0, whence=0)`8384По сути, это обёртка вокруг вызовов блокировки [`fcntl()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.fcntl). *fd* – это файловый дескриптор (также принимаются файловые объекты, предоставляющие метод [`fileno()`](https://python-all.ru/3.12/library/io.html#io.IOBase.fileno)) файла, который нужно заблокировать или разблокировать, а *cmd* – одно из следующих значений:8586#### `fcntl.LOCK_UN`8788Освобождает существующую блокировку.8990#### `fcntl.LOCK_SH`9192Захватывает разделяемую блокировку.9394#### `fcntl.LOCK_EX`9596Захватывает исключительную блокировку.9798#### `fcntl.LOCK_NB`99100Побитовое ИЛИ с любой из трёх других констант `LOCK_*`, чтобы сделать запрос неблокирующим.101102Если используется `LOCK_NB` и блокировку не удаётся захватить, будет возбуждено исключение [`OSError`](https://python-all.ru/3.12/library/exceptions.html#OSError), и у исключения будет атрибут *errno*, установленный в [`EACCES`](https://python-all.ru/3.12/library/errno.html#errno.EACCES) или [`EAGAIN`](https://python-all.ru/3.12/library/errno.html#errno.EAGAIN) (в зависимости от операционной системы; для переносимости проверяйте оба значения). По крайней мере в некоторых системах `LOCK_EX` можно использовать только если файловый дескриптор ссылается на файл, открытый для записи.103104*len* – количество байтов для блокировки, *start* – смещение в байтах, с которого начинается блокировка, относительно *whence*, а *whence* работает как в [`io.IOBase.seek()`](https://python-all.ru/3.12/library/io.html#io.IOBase.seek), а именно:105106- `0` – относительно начала файла ([`os.SEEK_SET`](https://python-all.ru/3.12/library/os.html#os.SEEK_SET))107- `1` – относительно текущей позиции буфера ([`os.SEEK_CUR`](https://python-all.ru/3.12/library/os.html#os.SEEK_CUR))108- `2` – относительно конца файла ([`os.SEEK_END`](https://python-all.ru/3.12/library/os.html#os.SEEK_END))109110Значение по умолчанию для *start* – 0, то есть начало от начала файла. Значение по умолчанию для *len* – 0, то есть блокировка до конца файла. Значение по умолчанию для *whence* – также 0.111112Возбуждает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `fcntl.lockf` с аргументами `fd`, `cmd`, `len`, `start`, `whence`.113114Примеры (все на системе, совместимой с SVR4):115116```python117import struct, fcntl, os118119f = open(...)120rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)121122lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)123rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)124```125126Обратите внимание, что в первом примере переменная возвращаемого значения *rv* будет содержать целое число; во втором примере она будет содержать объект [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Разметка структуры для переменной *lockdata* зависит от системы, поэтому использование вызова [`flock()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.flock) может быть предпочтительнее.127128> **См. также**129>130> **Модуль [`os`](https://python-all.ru/3.12/library/os.html#module-os)**131>132> Если флаги блокировки [`O_SHLOCK`](https://python-all.ru/3.12/library/os.html#os.O_SHLOCK) и [`O_EXLOCK`](https://python-all.ru/3.12/library/os.html#os.O_EXLOCK) присутствуют в модуле [`os`](https://python-all.ru/3.12/library/os.html#module-os) (только в BSD), функция [`os.open()`](https://python-all.ru/3.12/library/os.html#os.open) предоставляет альтернативу функциям [`lockf()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.lockf) и [`flock()`](https://python-all.ru/3.12/library/fcntl.html#fcntl.flock).133