`mmap.md`

179 строк · 18.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.7/library/mmap.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`mmap`](https://python-all.ru/3.7/library/mmap.html#module-mmap) – Поддержка файлов с отображением в память89---1011Объекты файлов с отображением в память ведут себя и как [`bytearray`](https://python-all.ru/3.7/library/stdtypes.html#bytearray), и как [файловые объекты](https://python-all.ru/3.7/glossary.html#term-file-object). Объекты mmap можно использовать почти везде, где ожидаются [`bytearray`](https://python-all.ru/3.7/library/stdtypes.html#bytearray); например, можно использовать модуль [`re`](https://python-all.ru/3.7/library/re.html#module-re) для поиска в файле с отображением в память. Также можно изменить один байт, выполнив `obj[index] = 97`, или изменить подпоследовательность, присвоив значение срезу: `obj[i1:i2] = b'...'`. Кроме того, можно читать и записывать данные, начиная с текущей позиции в файле, и `seek()` по файлу в разные позиции.1213Файл с отображением в память создаётся конструктором [`mmap`](https://python-all.ru/3.7/library/mmap.html#mmap.mmap), который отличается на Unix и Windows. В любом случае необходимо предоставить файловый дескриптор файла, открытого для обновления. Если требуется отобразить существующий файловый объект Python, используйте его метод `fileno()`, чтобы получить правильное значение параметра *fileno*. В противном случае можно открыть файл с помощью функции [`os.open()`](https://python-all.ru/3.7/library/os.html#os.open), которая напрямую возвращает файловый дескриптор (файл всё равно нужно закрыть после использования).1415> **Примечание**16>17> Если нужно создать отображение в память для буферизованного файла, доступного для записи, сначала следует [`flush()`](https://python-all.ru/3.7/library/io.html#io.IOBase.flush) файл. Это необходимо, чтобы локальные изменения в буферах были доступны для отображения.1819Для версий конструктора как для Unix, так и для Windows, *access* может быть указан как необязательный именованный параметр. *access* принимает одно из четырёх значений: `ACCESS_READ`, `ACCESS_WRITE` или `ACCESS_COPY` для указания памяти только для чтения, сквозной записи или копирования при записи соответственно, или `ACCESS_DEFAULT`, чтобы обратиться к *prot*. *access* можно использовать как в Unix, так и в Windows. Если *access* не задан, Windows mmap возвращает отображение со сквозной записью. Начальные значения памяти для всех трёх типов доступа берутся из указанного файла. Присваивание `ACCESS_READ` отображению памяти вызывает исключение [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError). Присваивание `ACCESS_WRITE` отображению памяти влияет и на память, и на базовый файл. Присваивание `ACCESS_COPY` отображению памяти влияет на память, но не обновляет базовый файл.2021Изменено в версии 3.7: Добавлена константа `ACCESS_DEFAULT`.2223Для отображения анонимной памяти в качестве fileno следует передать -1 вместе с длиной.2425#### `class mmap.mmap(fileno, length, tagname=None, access=ACCESS_DEFAULT[, offset])`2627**(Версия Windows)** Отображает *length* байтов из файла, указанного файловым дескриптором *fileno*, и создаёт объект mmap. Если *length* больше текущего размера файла, файл расширяется до *length* байтов. Если *length* равно `0`, максимальная длина отображения равна текущему размеру файла, за исключением случая, когда файл пуст – тогда Windows вызывает исключение (нельзя создать пустое отображение в Windows).2829*tagname*, если указан и не равен `None`, представляет собой строку, задающую имя тега для отображения. Windows позволяет иметь много разных отображений одного и того же файла. Если указать имя существующего тега, этот тег открывается, иначе создаётся новый тег с таким именем. Если этот параметр опущен или равен `None`, отображение создаётся без имени. Отказ от использования параметра tag поможет сохранить переносимость кода между Unix и Windows.3031*offset* может быть указан как неотрицательное целое смещение. Ссылки mmap будут относительными к смещению от начала файла. *offset* по умолчанию равен 0. *offset* должен быть кратен `ALLOCATIONGRANULARITY`.3233#### `class mmap.mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])`3435**(Версия Unix)** Отображает *length* байтов из файла, указанного файловым дескриптором *fileno*, и возвращает объект mmap. Если *length* равно `0`, максимальная длина отображения будет равна текущему размеру файла на момент вызова [`mmap`](https://python-all.ru/3.7/library/mmap.html#mmap.mmap).3637*flags* задаёт характер отображения. `MAP_PRIVATE` создаёт частное отображение с копированием при записи, поэтому изменения содержимого mmap-объекта будут частными для этого процесса, а `MAP_SHARED` создаёт отображение, разделяемое со всеми другими процессами, отображающими те же области файла. Значение по умолчанию – `MAP_SHARED`.3839*prot*, если указан, задаёт желаемую защиту памяти; два наиболее полезных значения – `PROT_READ` и `PROT_WRITE`, чтобы указать, что страницы можно читать или записывать. *prot* по умолчанию равен `PROT_READ | PROT_WRITE`.4041*access* может быть указан вместо *flags* и *prot* как необязательный именованный параметр. Указывать одновременно *flags*, *prot* и *access* – ошибка. Информацию о том, как использовать этот параметр, см. в описании *access* выше.4243*offset* может быть указан как неотрицательное целое смещение. Ссылки mmap будут относительными к смещению от начала файла. *offset* по умолчанию равен 0. *offset* должен быть кратен `ALLOCATIONGRANULARITY`, что в системах Unix равно `PAGESIZE`.4445Для обеспечения корректности созданного отображения в память файл, заданный дескриптором *fileno*, внутренне автоматически синхронизируется с физическим хранилищем на Mac OS X и OpenVMS.4647В этом примере показан простой способ использования [`mmap`](https://python-all.ru/3.7/library/mmap.html#mmap.mmap):4849```python50import mmap5152# записать простой пример файла53with open("hello.txt", "wb") as f:54    f.write(b"Hello Python!\n")5556with open("hello.txt", "r+b") as f:57    # отобразить файл в память, размер 0 означает весь файл58    mm = mmap.mmap(f.fileno(), 0)59    # прочитать содержимое с помощью стандартных методов файла60    print(mm.readline())  # выводит b"Hello Python!\n"61    # чтение содержимого с помощью срезовой нотации62    print(mm[:5])  # выводит b"Hello"63    # обновление содержимого с помощью срезовой нотации;64    # новое содержимое должно быть того же размера65    mm[6:] = b" world!\n"66    # ... и снова прочитать стандартными методами файлов67    mm.seek(0)68    print(mm.readline())  # выводит b"Hello  world!\n"69    # закрыть отображение70    mm.close()71```7273[`mmap`](https://python-all.ru/3.7/library/mmap.html#mmap.mmap) также можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.7/reference/compound_stmts.html#with):7475```python76import mmap7778with mmap.mmap(-1, 13) as mm:79    mm.write(b"Hello world!")80```8182Новое в версии 3.2: Поддержка контекстного менеджера.8384Следующий пример демонстрирует, как создать анонимное отображение и обмениваться данными между родительским и дочерним процессами:8586```python87import mmap88import os8990mm = mmap.mmap(-1, 13)91mm.write(b"Hello world!")9293pid = os.fork()9495if pid == 0:  # В дочернем процессе96    mm.seek(0)97    print(mm.readline())9899    mm.close()100```101102Объекты файлов с отображением в память поддерживают следующие методы:103104#### `close()`105106Закрывает mmap. Последующие вызовы других методов объекта приведут к возникновению исключения ValueError. Открытый файл при этом не закрывается.107108#### `closed`109110`True`, если файл закрыт.111112Новое в версии 3.2.113114#### `find(sub[, start[, end]])`115116Возвращает наименьший индекс в объекте, где встречается подпоследовательность *sub*, при условии, что *sub* содержится в диапазоне \[*start*, *end*\]. Необязательные аргументы *start* и *end* интерпретируются как в записи среза. В случае неудачи возвращает `-1`.117118Изменено в версии 3.5: Теперь принимается записываемый [байтоподобный объект](https://python-all.ru/3.7/glossary.html#term-bytes-like-object).119120#### `flush([offset[, size]])`121122Сбрасывает изменения, внесённые в копию файла в памяти, обратно на диск. Без использования этого вызова нет гарантии, что изменения будут записаны до того, как объект будет уничтожен. Если *offset* и *size* заданы, на диск будут сброшены только изменения в указанном диапазоне байтов; в противном случае сбрасывается вся область отображения. *offset* должен быть кратен `PAGESIZE` или `ALLOCATIONGRANULARITY`.123124**(версия Windows)** Ненулевое возвращённое значение означает успех; нулевое – неудачу.125126**(версия Unix)** Возвращается нулевое значение, означающее успех. При ошибке вызова возбуждается исключение.127128#### `move(dest, src, count)`129130Копирует *count* байт, начиная со смещения *src*, в индекс назначения *dest*. Если mmap был создан с `ACCESS_READ`, то вызовы move вызовут исключение [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).131132#### `read([n])`133134Возвращает [`bytes`](https://python-all.ru/3.7/library/stdtypes.html#bytes), содержащий до *n* байт, начиная с текущей позиции в файле. Если аргумент опущен, равен `None` или отрицательному значению, возвращаются все байты от текущей позиции до конца отображения. Позиция в файле обновляется так, чтобы указывать на байты после возвращённых.135136Изменено в версии 3.3: Аргумент можно опустить или задать `None`.137138#### `read_byte()`139140Возвращает байт в текущей позиции файла в виде целого числа и увеличивает позицию файла на 1.141142#### `readline()`143144Возвращает одну строку, начиная с текущей позиции в файле и до следующего символа новой строки.145146#### `resize(newsize)`147148Изменяет размер отображения и соответствующего файла, если таковой имеется. Если mmap был создан с помощью `ACCESS_READ` или `ACCESS_COPY`, изменение размера отображения вызовет исключение [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).149150#### `rfind(sub[, start[, end]])`151152Возвращает наибольший индекс в объекте, где найдена подпоследовательность *sub*, такой, что *sub* содержится в диапазоне \[*start*, *end*\]. Необязательные аргументы *start* и *end* интерпретируются как в нотации среза. Возвращает `-1` при неудаче.153154Изменено в версии 3.5: Теперь принимается записываемый [байтоподобный объект](https://python-all.ru/3.7/glossary.html#term-bytes-like-object).155156#### `seek(pos[, whence])`157158Устанавливает текущую позицию в файле. Аргумент *whence* необязателен и по умолчанию равен `os.SEEK_SET` или `0` (абсолютное позиционирование); другие значения: `os.SEEK_CUR` или `1` (смещение относительно текущей позиции) и `os.SEEK_END` или `2` (смещение относительно конца файла).159160#### `size()`161162Возвращает длину файла, которая может быть больше размера области отображения памяти.163164#### `tell()`165166Возвращает текущую позицию файлового указателя.167168#### `write(bytes)`169170Записывает байты из *bytes* в память в текущей позиции файлового указателя и возвращает количество записанных байт (всегда не меньше `len(bytes)`, так как в случае ошибки записи будет возбуждено исключение [`ValueError`](https://python-all.ru/3.7/library/exceptions.html#ValueError)). Позиция файла обновляется и указывает на байт сразу после записанных. Если отображение mmap было создано с `ACCESS_READ`, то запись в него вызовет исключение [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).171172Изменено в версии 3.5: Теперь принимается записываемый [байтоподобный объект](https://python-all.ru/3.7/glossary.html#term-bytes-like-object).173174Изменено в версии 3.6: Теперь возвращается количество записанных байт.175176#### `write_byte(byte)`177178Записывает целое число *byte* в память в текущей позиции файлового указателя; позиция файла увеличивается на `1`. Если отображение mmap было создано с `ACCESS_READ`, то запись в него вызовет исключение [`TypeError`](https://python-all.ru/3.7/library/exceptions.html#TypeError).179