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