> **Источник:** https://python-all.ru/3.0/library/pickle.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# `pickle` – сериализация объектов Python

Модуль `pickle` реализует фундаментальный, но мощный алгоритм сериализации и десериализации структуры объектов Python. «Pickling» – это процесс преобразования иерархии объектов Python в поток байтов, а «unpickling» – обратная операция, при которой поток байтов преобразуется обратно в иерархию объектов. Pickling (и unpickling) также известен как «сериализация», «маршалинг» [\[1\]](https://python-all.ru/3.0/library/pickle.html#id5) или «уплощение», однако во избежание путаницы здесь используются термины «pickling» и «unpickling».

## Отношение к другим модулям Python

Модуль `pickle` имеет прозрачный оптимизатор (`_pickle`), написанный на C. Он используется, когда доступен. В противном случае используется реализация на чистом Python.

В Python есть более примитивный модуль сериализации под названием [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal), но в целом `pickle` всегда должен быть предпочтительным способом сериализации объектов Python. [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) существует в первую очередь для поддержки `.pyc`-файлов Python.

Модуль `pickle` отличается от [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) несколькими существенными аспектами:

- Модуль `pickle` отслеживает уже сериализованные объекты, чтобы последующие ссылки на тот же объект не сериализовались повторно. [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) этого не делает.

  Это влияет как на рекурсивные объекты, так и на разделение объектов. Рекурсивные объекты – это объекты, содержащие ссылки на самих себя. Они не обрабатываются marshal, и более того, попытка маршалировать рекурсивные объекты приведёт к аварийному завершению интерпретатора Python. Разделение объектов (object sharing) происходит, когда на один и тот же объект есть несколько ссылок в разных местах сериализуемой иерархии объектов. `pickle` сохраняет такие объекты только один раз и гарантирует, что все остальные ссылки указывают на главную копию. Разделяемые объекты остаются разделяемыми, что может быть очень важно для изменяемых объектов.
- [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) нельзя использовать для сериализации пользовательских классов и их экземпляров. `pickle` может прозрачно сохранять и восстанавливать экземпляры классов, однако определение класса должно быть импортируемым и находиться в том же модуле, что и при сохранении объекта.
- Формат сериализации [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) не гарантирует переносимости между версиями Python. Поскольку его основная задача – поддержка файлов `.pyc`, разработчики Python оставляют за собой право изменять формат сериализации несовместимым с предыдущими версиями образом, если возникнет необходимость. Формат сериализации `pickle` гарантированно обратно совместим с разными выпусками Python.

> **Предупреждение**
>
> Модуль `pickle` не предназначен для защиты от ошибочных или вредоносных данных. Не следует распаковывать данные, полученные из ненадёжного или непроверенного источника.

Обратите внимание, что сериализация – это более примитивное понятие, чем сохранение (persistence); хотя `pickle` читает и записывает файловые объекты, он не решает проблему именования сохраняемых объектов, ни (ещё более сложную) проблему конкурентного доступа к сохраняемым объектам. Модуль `pickle` может преобразовать сложный объект в поток байтов и обратно – из потока байтов в объект с той же внутренней структурой. Самое очевидное, что можно сделать с этими потоками байтов – записать их в файл, но также можно передать их по сети или сохранить в базе данных. Модуль [`shelve`](https://python-all.ru/3.0/library/shelve.html#module-shelve) предоставляет простой интерфейс для упаковки (pickle) и распаковки (unpickle) объектов в файлах баз данных в стиле DBM.

## Формат потока данных

Формат данных, используемый `pickle`, является специфичным для Python. Это даёт преимущество: отсутствуют ограничения, накладываемые внешними стандартами, такими как XDR (который не может представлять разделение указателей); однако это означает, что программы на других языках могут не смочь восстановить упакованные (pickled) объекты Python.

По умолчанию формат данных `pickle` использует компактное двоичное представление. Модуль [`pickletools`](https://python-all.ru/3.0/library/pickletools.html#module-pickletools) содержит инструменты для анализа потоков данных, созданных `pickle`.

В настоящее время существует 4 различных протокола для упаковки.

- Версия протокола 0 является оригинальным ASCII-протоколом и обратно совместима с предыдущими версиями Python.
- Версия протокола 1 – это старый двоичный формат, также совместимый с ранними версиями Python.
- Версия протокола 2 была представлена в Python 2.3. Она обеспечивает гораздо более эффективную упаковку (pickling) [*классов нового стиля*](https://python-all.ru/3.0/glossary.html#term-new-style-class).
- Версия протокола 3 была добавлена в Python 3.0. Она имеет явную поддержку байтов (bytes) и не может быть распакована модулями pickle Python 2.x. Это текущий рекомендуемый протокол, используйте его, когда это возможно.

Смотрите [**PEP 307**](https://python-all.ru/3.0/library/pickle.html) для получения информации об улучшениях, внесённых протоколом 2. См. исходный код [`pickletools`](https://python-all.ru/3.0/library/pickletools.html#module-pickletools) для подробных комментариев об опкодах, используемых протоколами pickle.

## Интерфейс модуля

Чтобы сериализовать иерархию объектов, сначала создаётся объект Pickler, затем вызывается его метод [`dump()`](https://python-all.ru/3.0/library/pickle.html#pickle.dump). Для десериализации потока данных сначала создаётся Unpickler, затем вызывается его метод [`load()`](https://python-all.ru/3.0/library/pickle.html#pickle.load). Модуль `pickle` предоставляет следующую константу:

#### `[pickle.HIGHEST_PROTOCOL]pickle.HIGHEST_PROTOCOL`

Самая высокая доступная версия протокола. Это значение можно передать как аргумент

*protocol*

.

> **Примечание**
>
> Файлы pickle, созданные с протоколами \>= 1, следует всегда открывать в бинарном режиме. Для старого ASCII-протокола pickle 0 можно использовать как текстовый, так и бинарный режим, при условии соблюдения согласованности.
>
> Файл pickle, записанный с протоколом 0 в бинарном режиме, будет содержать одиночные символы перевода строки в качестве разделителей строк и поэтому будет выглядеть «странно» при просмотре в Блокноте или других редакторах, не поддерживающих этот формат.

#### `[pickle.DEFAULT_PROTOCOL]pickle.DEFAULT_PROTOCOL`

Протокол, используемый по умолчанию для упаковки (pickling). Может быть меньше, чем HIGHEST\_PROTOCOL. В настоящее время протокол по умолчанию – 3; это протокол, не обратно совместимый, предназначенный для Python 3.0.

Модуль `pickle` предоставляет следующие функции для упрощения процесса упаковки (pickling):

#### `[pickle.dump]pickle.dump(obj, file[, protocol])`

Записывает сериализованное представление *obj* в открытый файловый объект *file*. Это эквивалентно `Pickler(file, протокол).dump(obj)`.

Необязательный аргумент *protocol* указывает упаковщику использовать заданный протокол; поддерживаются протоколы 0, 1, 2, 3. Протокол по умолчанию – 3; это обратно несовместимый протокол, разработанный для Python 3.0.

Указание отрицательной версии протокола выбирает самую высокую поддерживаемую версию протокола. Чем выше используемый протокол, тем более новая версия Python требуется для чтения созданного pickle.

Аргумент *file* должен иметь метод write(), принимающий единственный аргумент типа bytes. Таким образом, это может быть файловый объект, открытый для бинарной записи, экземпляр io.BytesIO или любой другой пользовательский объект, удовлетворяющий этому интерфейсу.

#### `[pickle.dumps]pickle.dumps(obj[, protocol])`

Возвращает сериализованное представление объекта в виде объекта [`bytes`](https://python-all.ru/3.0/library/functions.html#bytes) вместо записи в файл.

Необязательный аргумент *protocol* указывает упаковщику использовать заданный протокол; поддерживаются протоколы 0, 1, 2, 3. Протокол по умолчанию – 3; это обратно несовместимый протокол, разработанный для Python 3.0.

Указание отрицательной версии протокола выбирает самую высокую поддерживаемую версию протокола. Чем выше используемый протокол, тем более новая версия Python требуется для чтения созданного pickle.

#### `[pickle.load]pickle.load(file[, *, encoding="ASCII", errors="strict"])`

Читает сериализованное представление объекта из открытого файлового объекта *file* и возвращает восстановленную иерархию объектов, указанную в нём. Это эквивалентно `Unpickler(file).load()`.

Версия протокола pickle определяется автоматически, поэтому аргумент protocol не требуется. Байты, следующие за представлением сериализованного объекта, игнорируются.

Аргумент *file* должен иметь два метода: read(), принимающий целочисленный аргумент, и readline(), не требующий аргументов. Оба метода должны возвращать bytes. Таким образом, *file* может быть бинарным файловым объектом, открытым для чтения, объектом BytesIO или любым другим пользовательским объектом, удовлетворяющим этому интерфейсу.

Необязательные именованные аргументы – encoding и errors, которые используются для декодирования 8-битных строковых экземпляров, сериализованных Python 2.x. По умолчанию они равны 'ASCII' и 'strict' соответственно.

#### `[pickle.loads]pickle.loads(bytes_object[, *, encoding="ASCII", errors="strict"])`

Читает сериализованную иерархию объектов из объекта [`bytes`](https://python-all.ru/3.0/library/functions.html#bytes) и возвращает восстановленную иерархию объектов, содержащуюся в нём.

Версия протокола pickle определяется автоматически, поэтому аргумент protocol не требуется. Байты, следующие за представлением сериализованного объекта, игнорируются.

Необязательные именованные аргументы – encoding и errors, которые используются для декодирования 8-битных строковых экземпляров, сериализованных Python 2.x. По умолчанию они равны 'ASCII' и 'strict' соответственно.

Модуль `pickle` определяет три исключения:

#### `[pickle.PickleError]exception pickle.PickleError`

Общий базовый класс для других исключений при упаковке. Наследует

[`Exception`](https://python-all.ru/3.0/library/exceptions.html#exceptions.Exception)

.

#### `[pickle.PicklingError]exception pickle.PicklingError`

Исключение, возникающее при обнаружении [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler) объекта, который невозможно упаковать. Наследует [`PickleError`](https://python-all.ru/3.0/library/pickle.html#pickle.PickleError).

Обратитесь к разделу [*Какие объекты можно упаковывать и распаковывать?*](https://python-all.ru/3.0/library/pickle.html#pickle-picklable), чтобы узнать, какие объекты можно упаковывать.

#### `[pickle.UnpicklingError]exception pickle.UnpicklingError`

Исключение, возникающее при проблеме распаковки (unpickling) объекта, например, при повреждении данных или нарушении безопасности. Наследует [`PickleError`](https://python-all.ru/3.0/library/pickle.html#pickle.PickleError).

Обратите внимание, что во время распаковки могут возбуждаться и другие исключения, включая (но не ограничиваясь) AttributeError, EOFError, ImportError и IndexError.

Модуль `pickle` экспортирует два класса: [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler) и [`Unpickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler):

#### `[pickle.Pickler]class pickle.Pickler(file[, protocol])`

Он принимает двоичный файл для записи потока данных pickle.

Необязательный аргумент *protocol* указывает упаковщику использовать заданный протокол; поддерживаются протоколы 0, 1, 2, 3. Протокол по умолчанию – 3; это обратно несовместимый протокол, разработанный для Python 3.0.

Указание отрицательной версии протокола выбирает самую высокую поддерживаемую версию протокола. Чем выше используемый протокол, тем более новая версия Python требуется для чтения созданного pickle.

Аргумент *file* должен иметь метод write(), принимающий единственный аргумент типа bytes. Таким образом, это может быть файловый объект, открытый для бинарной записи, экземпляр io.BytesIO или любой другой пользовательский объект, удовлетворяющий этому интерфейсу.

#### `[pickle.Pickler.dump]dump(obj)`

Записывает представление

*obj*

в виде pickle в открытый объект файла, переданный в конструкторе.

#### `[pickle.Pickler.persistent_id]persistent_id(obj)`

По умолчанию ничего не делает. Этот метод существует, чтобы подкласс мог его переопределить.

Если [`persistent_id()`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler.persistent_id) возвращает `None`, *obj* упаковывается обычным образом. Любое другое значение заставляет [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler) выдать это значение как постоянный идентификатор для *obj*. Смысл этого постоянного идентификатора должен быть определён [`Unpickler.persistent_load()`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler.persistent_load). Обратите внимание, что значение, возвращаемое [`persistent_id()`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler.persistent_id), само не может иметь постоянный идентификатор.

См. [*Постоянство внешних объектов*](https://python-all.ru/3.0/library/pickle.html#pickle-persistent) для подробностей и примеров использования.

#### `[pickle.Pickler.clear_memo]clear_memo()`

Устарело. Вместо этого используйте метод

`clear()`

на

[`memo`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler.memo)

. Очищает memo пиклера; полезно при повторном использовании пиклеров.

#### `[pickle.Pickler.fast]fast`

Устарело. При установке в истинное значение включает быстрый режим. Быстрый режим отключает использование memo, тем самым ускоряя процесс упаковки за счёт отсутствия лишних кодов операций PUT. Его не следует использовать с самореферентными объектами, иначе [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler) будет рекурсировать бесконечно.

Используйте [`pickletools.optimize()`](https://python-all.ru/3.0/library/pickletools.html#pickletools.optimize), если нужны более компактные упаковки.

#### `[pickle.Pickler.memo]memo`

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

Можно выполнять несколько вызовов метода [`dump()`](https://python-all.ru/3.0/library/pickle.html#pickle.dump) одного и того же экземпляра [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler). Эти вызовы должны соответствовать такому же количеству вызовов метода [`load()`](https://python-all.ru/3.0/library/pickle.html#pickle.load) соответствующего экземпляра [`Unpickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler) . Если один и тот же объект сериализуется несколькими вызовами [`dump()`](https://python-all.ru/3.0/library/pickle.html#pickle.dump), то все вызовы [`load()`](https://python-all.ru/3.0/library/pickle.html#pickle.load) будут давать ссылки на один и тот же объект.

Обратите внимание: это предназначено для сериализации нескольких объектов без промежуточных изменений самих объектов или их частей. Если объект изменяется, а затем сериализуется повторно с использованием того же экземпляра [`Pickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Pickler), объект не будет сериализован заново – будет сериализована ссылка на него, и [`Unpickler`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler) вернёт старое значение, а не изменённое.

#### `[pickle.Unpickler]class pickle.Unpickler(file[, *, encoding="ASCII", errors="strict"])`

Принимает бинарный файл для чтения потока данных pickle.

Версия протокола pickle определяется автоматически, поэтому аргумент протокола не нужен.

Аргумент *file* должен иметь два метода: метод read(), принимающий целочисленный аргумент, и метод readline(), не требующий аргументов. Оба метода должны возвращать байты. Таким образом, *file* может быть бинарным файловым объектом, открытым для чтения, объектом BytesIO или любым другим пользовательским объектом, соответствующим данному интерфейсу.

Необязательные именованные аргументы – encoding и errors, которые используются для декодирования 8-битных строк, сериализованных Python 2.x. По умолчанию они равны 'ASCII' и 'strict' соответственно.

#### `[pickle.Unpickler.load]load()`

Читает представление объекта в pickle из открытого объекта файла, переданного в конструкторе, и возвращает восстановленную иерархию объектов, указанную в нём. Байты, следующие за представлением объекта в pickle, игнорируются.

#### `[pickle.Unpickler.persistent_load]persistent_load(pid)`

По умолчанию вызывает `UnpickingError`.

Если определена, [`persistent_load()`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler.persistent_load) должна возвращать объект, заданный постоянным идентификатором *pid*. Если встречен недопустимый постоянный идентификатор, должно быть возбуждено `UnpickingError`.

См. [*Постоянство внешних объектов*](https://python-all.ru/3.0/library/pickle.html#pickle-persistent) для подробностей и примеров использования.

#### `[pickle.Unpickler.find_class]find_class(module, name)`

Импортирует модуль *module* при необходимости и возвращает из него объект с именем *name*. Аргументы *module* и *name* – строки (тип [`str`](https://python-all.ru/3.0/library/functions.html#str)). Обратите внимание: вопреки своему названию, [`find_class()`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler.find_class) также используется для поиска функций.

Подклассы могут переопределить этот метод для получения контроля над тем, объекты какого типа и каким образом могут быть загружены, что потенциально снижает риски безопасности. См. [*Ограничение глобальных объектов*](https://python-all.ru/3.0/library/pickle.html#pickle-restrict) для подробностей.

## Какие объекты можно сериализовать и десериализовать?

Следующие типы можно сериализовать:

- `None`, `True` и `False`
- целые числа, числа с плавающей запятой, комплексные числа
- строки, байты, байтовые массивы
- кортежи, списки, множества и словари, содержащие только сериализуемые объекты
- Функции, определённые на верхнем уровне модуля.
- встроенные функции, определённые на верхнем уровне модуля
- классы, определённые на верхнем уровне модуля
- экземпляры таких классов, у которых `__dict__` или `__setstate__()` могут быть упакованы (см. раздел [*Pickling Class Instances*](https://python-all.ru/3.0/library/pickle.html#pickle-inst) для подробностей)

Попытка запакетить (pickle) непиклируемый объект вызовет исключение [`PicklingError`](https://python-all.ru/3.0/library/pickle.html#pickle.PicklingError); при этом в базовый файл может быть уже записано некоторое количество байт. Попытка запакетить сильно рекурсивную структуру данных может превысить максимальную глубину рекурсии – в этом случае будет возбуждено [`RuntimeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.RuntimeError). Можно аккуратно увеличить этот предел с помощью [`sys.setrecursionlimit()`](https://python-all.ru/3.0/library/sys.html#sys.setrecursionlimit).

Обратите внимание, что функции (встроенные и определяемые пользователем) упаковываются по «полному имени» (fully qualified) ссылке, а не по значению. Это означает, что упаковывается только имя функции вместе с именем модуля, в котором функция определена. Ни код функции, ни её атрибуты не упаковываются. Таким образом, определяющий модуль должен быть импортируем в среде распаковки, и модуль должен содержать именованный объект, иначе будет возбуждено исключение. [\[2\]](https://python-all.ru/3.0/library/pickle.html#id6)

Аналогично, классы пиклятся по именованной ссылке, поэтому в среде распикливания действуют те же ограничения. Обратите внимание, что ни код класса, ни его данные не пиклятся, так что в следующем примере атрибут класса `attr` не восстанавливается в среде распикливания:

```python
class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)
```

Эти ограничения объясняют, почему сериализуемые функции и классы должны быть определены на верхнем уровне модуля.

Аналогично, при упаковке экземпляров классов код и данные класса не упаковываются вместе с ними. Упаковываются только данные экземпляра. Это сделано намеренно, чтобы можно было исправлять ошибки в классе или добавлять методы, и при этом загружать объекты, созданные более ранней версией класса. Если предполагается использовать долгоживущие объекты, которые будут существовать на протяжении многих версий класса, возможно, стоит добавить в объекты номер версии, чтобы подходящие преобразования могли быть выполнены методом `__setstate__()` класса.

## Сериализация экземпляров классов

В этом разделе описываются общие механизмы, позволяющие определять, настраивать и контролировать процесс сериализации и десериализации экземпляров классов.

В большинстве случаев для того, чтобы экземпляры можно было пиклить, дополнительный код не требуется. По умолчанию pickle извлекает класс и атрибуты экземпляра через интроспекцию. При распикливании экземпляра класса его метод [`__init__()`](https://python-all.ru/3.0/reference/datamodel.html#object.__init__) обычно *не* вызывается. Стандартное поведение сначала создаёт неинициализированный экземпляр, а затем восстанавливает сохранённые атрибуты. Следующий код показывает реализацию этого поведения:

```python
def save(obj):
    return (obj.__class__, obj.__dict__)

def load(cls, attributes):
    obj = cls.__new__(cls)
    obj.__dict__.update(attributes)
    return obj
```

Классы могут изменить поведение по умолчанию, предоставив один или несколько специальных методов. В протоколе 2 и новее классы, реализующие метод `__getnewargs__()`, могут определять значения, передаваемые методу [`__new__()`](https://python-all.ru/3.0/reference/datamodel.html#object.__new__) при десериализации. Это часто требуется для классов, чей метод [`__new__()`](https://python-all.ru/3.0/reference/datamodel.html#object.__new__) требует аргументов.

Классы могут дальше влиять на то, как их экземпляры сериализуются; если класс определяет метод `__getstate__()`, он вызывается, и возвращаемый объект сериализуется как содержимое экземпляра, вместо содержимого словаря экземпляра. Если метод `__getstate__()` отсутствует, `__dict__` экземпляра сериализуется как обычно.

При десериализации, если класс определяет `__setstate__()`, он вызывается с десериализованным состоянием. В этом случае не требуется, чтобы объект состояния был словарем. В противном случае сериализованное состояние должно быть словарем, и его элементы присваиваются словарю нового экземпляра.

> **Примечание**
>
> Если `__getstate__()` возвращает ложное значение, метод `__setstate__()` не будет вызван.

Обратитесь к разделу [*Handling Stateful Objects*](https://python-all.ru/3.0/library/pickle.html#pickle-state) за дополнительной информацией об использовании методов `__getstate__()` и `__setstate__()`.

Как мы увидим, pickle не использует напрямую описанные выше методы. На самом деле эти методы являются частью протокола копирования, который реализует специальный метод `__reduce__()`. Протокол копирования предоставляет единый интерфейс для получения данных, необходимых для упаковки и копирования объектов. [\[3\]](https://python-all.ru/3.0/library/pickle.html#id7)

Хотя реализация `__reduce__()` напрямую в своих классах – мощный инструмент, это чревато ошибками. По этой причине разработчикам классов следует по возможности использовать высокоуровневый интерфейс (т.е. `__getnewargs__()`, `__getstate__()` и `__setstate__()`). Однако мы покажем случаи, когда использование `__reduce__()` является единственным вариантом или приводит к более эффективной сериализации (или и то, и другое).

Интерфейс на данный момент определён следующим образом. Метод `__reduce__()` не принимает аргументов и должен возвращать либо строку, либо, что предпочтительнее, кортеж (возвращаемый объект часто называют «значением reduce»).

Если возвращается строка, она должна интерпретироваться как имя глобальной переменной. Это должно быть локальное имя объекта относительно его модуля; модуль pickle ищет в пространстве имён модуля, чтобы определить модуль объекта. Такое поведение обычно полезно для синглтонов.

Если возвращается кортеж, его длина должна быть от двух до пяти элементов. Необязательные элементы можно опустить или указать `None` в качестве их значения. Семантика каждого элемента перечислена по порядку:

- Вызываемый объект, который будет вызван для создания начальной версии объекта.
- Кортеж аргументов для вызываемого объекта. Если вызываемый объект не принимает аргументов, необходимо передать пустой кортеж.
- Необязательно: состояние объекта, которое будет передано методу `__setstate__()` объекта, как описано ранее. Если у объекта нет такого метода, значение должно быть словарём, и оно будет добавлено в атрибут `__dict__` объекта.
- Необязательно: итератор (не последовательность), порождающий последовательные элементы. Эти элементы будут добавлены к объекту с помощью `obj.append(item)` либо, пакетно, с помощью `obj.extend(list_of_items)`. Это в первую очередь используется для подклассов списка, но может применяться и другими классами, если у них есть методы `append()` и `extend()` с соответствующей сигнатурой. (Будет ли использован `append()` или `extend()`, зависит от версии протокола pickle, а также от количества добавляемых элементов, поэтому оба должны поддерживаться.)
- Необязательно: итератор (не последовательность), порождающий последовательные пары ключ-значение. Эти элементы будут сохранены в объект с помощью `obj[key] = value`. Это в первую очередь используется для подклассов словаря, но может применяться и другими классами, если они реализуют [`__setitem__()`](https://python-all.ru/3.0/reference/datamodel.html#object.__setitem__).

В качестве альтернативы может быть определён метод `__reduce_ex__()`. Единственное отличие заключается в том, что этот метод должен принимать один целочисленный аргумент – версию протокола. При его наличии pickle будет использовать его вместо метода `__reduce__()`. Кроме того, `__reduce__()` автоматически становится синонимом расширенной версии. Основное назначение этого метода – предоставление обратно совместимых значений reduce для старых версий Python.

### Персистентность внешних объектов

Для удобства сохранения объектов модуль `pickle` поддерживает концепцию ссылки на объект вне упакованного потока данных. Такие объекты обозначаются постоянным идентификатором, который должен быть либо строкой из буквенно-цифровых символов (для протокола 0) [\[4\]](https://python-all.ru/3.0/library/pickle.html#id8), либо произвольным объектом (для любого более нового протокола).

Разрешение таких постоянных идентификаторов не определяется модулем `pickle`; он делегирует это разрешение определённым пользователем методам упаковщика и распаковщика – `persistent_id()` и `persistent_load()` соответственно.

Для упаковки объектов, имеющих внешний постоянный идентификатор, упаковщик должен иметь пользовательский метод `persistent_id()`, который принимает объект в качестве аргумента и возвращает либо `None`, либо постоянный идентификатор для этого объекта. Когда возвращается `None`, упаковщик просто упаковывает объект как обычно. Когда возвращается строка постоянного идентификатора, упаковщик упакует этот объект вместе с маркером, чтобы распаковщик распознал его как постоянный идентификатор.

Для распаковки внешних объектов распаковщик должен иметь пользовательский метод `persistent_load()`, который принимает объект постоянного идентификатора и возвращает объект, на который он ссылается.

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

```python
# Простой пример, показывающий, как с помощью persistent ID можно упаковать внешние объекты по ссылке.
# внешние объекты по ссылке.

import pickle
import sqlite3
from collections import namedtuple

# Простой класс, представляющий запись в нашей базе данных.
MemoRecord = namedtuple("MemoRecord", "key, task")

class DBPickler(pickle.Pickler):

    def persistent_id(self, obj):
        # Вместо упаковки MemoRecord как обычного экземпляра класса, мы выводим
        # постоянный идентификатор.
        if isinstance(obj, MemoRecord):
            # Здесь наш постоянный идентификатор – это просто кортеж, содержащий метку и ключ, который ссылается на определённую запись в базе данных.
            # ключ, который ссылается на определённую запись в базе данных.
            return ("MemoRecord", obj.key)
        else:
            # Этот метод вызывается при каждом обнаружении постоянного идентификатора.
            # требуется упаковать как обычно.
            return None

class DBUnpickler(pickle.Unpickler):

    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection

    def persistent_load(self, pid):
        # Извлеките запись из базы данных по ссылке и верните её.
        # Всегда возбуждает исключение, если невозможно вернуть правильный объект.
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # Извлеките указанную запись из базы данных и верните её.
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # Инициализируйте и наполните базу данных.
            # Извлеките записи для упаковки.
            # по постоянному идентификатору.
            raise pickle.UnpicklingError("unsupported persistent object")

def main():
    import io, pprint

    # Обновите запись для надёжности.
    conn = sqlite3.connect(":memory:")
    cursor = conn.cursor()
    cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
    tasks = (
        'give food to fish',
        'prepare group meeting',
        'fight with a zebra',
        )
    for task in tasks:
        cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))

    # Извлеките записи, которые требуется упаковать.
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # Выводит и нумерует строки в текстовом файле.
    file = io.BytesIO()
    DBPickler(file).dump(memos)

    print("Pickled records:")
    pprint.pprint(memos)

    # Обновите запись, для верности.
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

    # Удаляет не подлежащие упаковке записи.
    file.seek(0)
    memos = DBUnpickler(file, conn).load()

    print("Unpickled records:")
    pprint.pprint(memos)

if __name__ == '__main__':
    main()
```

### Обработка объектов с состоянием

Вот пример, показывающий, как изменить поведение упаковки для класса. Класс `TextReader` открывает текстовый файл и возвращает номер строки и содержимое строки каждый раз, когда вызывается его метод `readline()`. Если экземпляр `TextReader` упаковывается, все атрибуты, *кроме* файлового объекта, сохраняются. При распаковке экземпляра файл открывается заново, и чтение возобновляется с последней позиции. Для реализации этого поведения используются методы `__setstate__()` и `__getstate__()`.

```python
class TextReader:
    """Print and number lines in a text file."""

    def __init__(self, filename):
        self.filename = filename
        self.file = open(filename)
        self.lineno = 0

    def readline(self):
        self.lineno += 1
        line = self.file.readline()
        if not line:
            return None
        if line.endswith("\n"):
            line = line[:-1]
        return "%i: %s" % (self.lineno, line)

    def __getstate__(self):
        # Copy the object's state from self.__dict__ which contains
        # all our instance attributes. Always use the dict.copy()
        # method to avoid modifying the original state.
        state = self.__dict__.copy()
        # Remove the unpicklable entries.
        del state['file']
        return state

    def __setstate__(self, state):
        # Restore instance attributes (i.e., filename and lineno).
        self.__dict__.update(state)
        # Restore the previously opened file's state. To do so, we need to
        # reopen it and read from it until the line count is restored.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Finally, save the file.
        self.file = file
```

Пример использования может выглядеть так:

```python
>>> reader = TextReader("hello.txt")
>>> reader.readline()
'1: Hello world!'
>>> reader.readline()
'2: I am line number two.'
>>> new_reader = pickle.loads(pickle.dumps(reader))
>>> new_reader.readline()
'3: Goodbye!'
```

## Ограничение глобалов

По умолчанию распаковщик импортирует любой класс или функцию, найденные в данных pickle. Для многих приложений такое поведение неприемлемо, поскольку оно позволяет распаковщику импортировать и вызывать произвольный код. Просто подумайте, что делает этот вручную созданный поток данных pickle при загрузке:

```python
>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0
```

В этом примере анпиклер импортирует функцию [`os.system()`](https://python-all.ru/3.0/library/os.html#os.system), а затем применяет строковый аргумент «echo hello world». Хотя этот пример безобиден, нетрудно представить такой, который может повредить систему.

По этой причине может потребоваться контролировать, что распаковывается, путём настройки [`Unpickler.find_class()`](https://python-all.ru/3.0/library/pickle.html#pickle.Unpickler.find_class). Вопреки своему названию, `find_class()` вызывается всякий раз, когда запрашивается глобальный объект (т.е. класс или функция). Таким образом, можно либо полностью запретить глобальные объекты, либо ограничить их безопасным подмножеством.

Вот пример анпиклера, который разрешает загрузку только нескольких безопасных классов из модуля [`builtins`](https://python-all.ru/3.0/library/builtins.html#module-builtins):

```python
import builtins
import io
import pickle

safe_builtins = {
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
}

class RestrictedUnpickler(pickle.Unpickler):

    def find_class(self, module, name):
        # Разрешать только безопасные классы из builtins.
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # Запрещать всё остальное.
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))

def restricted_loads(s):
    """Вспомогательная функция, аналогичная pickle.loads()."""
    return RestrictedUnpickler(io.BytesIO(s)).load()
```

Пример использования нашего десериализатора, работающего как задумано:

```python
>>> restricted_loads(pickle.dumps([1, 2, range(15)]))
[1, 2, range(0, 15)]
>>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'os.system' is forbidden
>>> restricted_loads(b'cbuiltins\neval\n'
...                  b'(S\'getattr(__import__("os"), "system")'
...                  b'("echo hello world")\'\ntR.')
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'builtins.eval' is forbidden
```

Как показывают наши примеры, необходимо быть осторожным с тем, что разрешается десериализовать. Поэтому если безопасность является проблемой, возможно, стоит рассмотреть альтернативы, такие как API маршалинга в [`xmlrpc.client`](https://python-all.ru/3.0/library/xmlrpc.client.html#module-xmlrpc.client) или сторонние решения.

## Пример

Для простейшего кода используйте функции [`dump()`](https://python-all.ru/3.0/library/pickle.html#pickle.dump) и [`load()`](https://python-all.ru/3.0/library/pickle.html#pickle.load). Обратите внимание, что самоссылающийся список сериализуется и восстанавливается корректно.

```python
import pickle

data1 = {'a': [1, 2.0, 3, 4+6j],
         'b': ("string", "string using Unicode features \u0394"),
         'c': None}

selfref_list = [1, 2, 3]
selfref_list.append(selfref_list)

output = open('data.pkl', 'wb')

# Сериализовать словарь с использованием протокола 2.
pickle.dump(data1, output, 2)

# Сериализовать список с использованием наивысшего доступного протокола.
pickle.dump(selfref_list, output, -1)

output.close()
```

Следующий пример считывает полученные сериализованные данные. При чтении файла, содержащего pickle, файл следует открывать в бинарном режиме, так как нельзя быть уверенным, какой формат использовался – ASCII или бинарный.

```python
import pprint, pickle

pkl_file = open('data.pkl', 'rb')

data1 = pickle.load(pkl_file)
pprint.pprint(data1)

data2 = pickle.load(pkl_file)
pprint.pprint(data2)

pkl_file.close()
```

> **См. также**
>
> **Модуль [`copyreg`](https://python-all.ru/3.0/library/copyreg.html#module-copyreg)**
>
> Регистрация конструктора интерфейса pickle для расширенных типов.
>
> **Модуль [`shelve`](https://python-all.ru/3.0/library/shelve.html#module-shelve)**
>
> Индексированные базы данных объектов; использует
>
> `pickle`
>
> .
>
> **Модуль [`copy`](https://python-all.ru/3.0/library/copy.html#module-copy)**
>
> Поверхностное и глубокое копирование объектов.
>
> **Модуль [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal)**
>
> Высокопроизводительная сериализация встроенных типов.

Сноски

| [\[1\]](https://python-all.ru/3.0/library/pickle.html#id1) | Не путайте это с модулем [`marshal`](https://python-all.ru/3.0/library/marshal.html#module-marshal) |
| --- | --- |

| [\[2\]](https://python-all.ru/3.0/library/pickle.html#id2) | Возникающее исключение, скорее всего, будет [`ImportError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.ImportError) или [`AttributeError`](https://python-all.ru/3.0/library/exceptions.html#exceptions.AttributeError), но может быть и другим. |
| --- | --- |

| [\[3\]](https://python-all.ru/3.0/library/pickle.html#id3) | Модуль [`copy`](https://python-all.ru/3.0/library/copy.html#module-copy) использует этот протокол для операций поверхностного и глубокого копирования. |
| --- | --- |

| [\[4\]](https://python-all.ru/3.0/library/pickle.html#id4) | Ограничение на алфавитно-цифровые символы связано с тем, что постоянные идентификаторы в протоколе 0 разделяются символом новой строки. Поэтому если в постоянных идентификаторах встречаются какие-либо символы новой строки, результирующий pickle станет нечитаемым. |
| --- | --- |