11.1. pickle – сериализация объектов Python¶pickle – Python object serialization

11.1.1. Отношение к другим модулям Python¶Relationship to other Python modules

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

В Python есть более примитивный модуль сериализации под названием marshal, но в целом pickle всегда должен быть предпочтительным способом сериализации объектов Python. marshal существует в основном для поддержки файлов .pyc.

Модуль pickle отличается от marshal в нескольких важных аспектах:

• Модуль pickle отслеживает уже сериализованные объекты, чтобы последующие ссылки на тот же объект не сериализовались повторно. marshal этого не делает.

  Это имеет значение как для рекурсивных объектов, так и для совместного использования объектов. Рекурсивные объекты – это объекты, содержащие ссылки на самих себя. Они не обрабатываются модулем marshal; более того, попытка выполнить маршалинг рекурсивных объектов с помощью marshal приведёт к аварийному завершению интерпретатора Python. Совместное использование объектов возникает, когда на один и тот же объект есть несколько ссылок в разных местах сериализуемой иерархии. pickle сохраняет такие объекты только один раз и гарантирует, что все остальные ссылки указывают на главную копию. Совместно используемые объекты остаются совместно используемыми, что может быть очень важно для изменяемых объектов.

• marshal нельзя использовать для сериализации пользовательских классов и их экземпляров. pickle может прозрачно сохранять и восстанавливать экземпляры классов, однако определение класса должно быть импортируемым и находиться в том же модуле, что и на момент сохранения объекта.

• Формат сериализации marshal не гарантирует переносимости между версиями Python. Поскольку его основная задача – поддержка файлов .pyc, разработчики Python оставляют за собой право изменять формат сериализации способами, несовместимыми с предыдущими версиями, если возникнет необходимость. Формат сериализации pickle гарантированно обратно совместим во всех выпусках Python.

Обратите внимание, что сериализация – это более примитивное понятие, чем сохранение (persistence); хотя pickle читает и записывает файловые объекты, он не решает проблему именования сохраняемых объектов, ни (ещё более сложную) проблему параллельного доступа к сохраняемым объектам. Модуль pickle может преобразовать сложный объект в поток байтов и преобразовать поток байтов обратно в объект с той же внутренней структурой. Возможно, самое очевидное применение этим потокам байтов – запись их в файл, но также можно передать их по сети или сохранить в базе данных. Модуль shelve предоставляет простой интерфейс для упаковки (pickle) и распаковки (unpickle) объектов в файлах баз данных типа DBM.

11.1.2. Формат потока данных¶Data stream format

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

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

Модуль pickletools содержит инструменты для анализа потоков данных, создаваемых модулем pickle. Исходный код pickletools содержит обширные комментарии о кодах операций, используемых протоколами pickle.

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

• Протокол версии 0 – это исходный «человекочитаемый» протокол, обратно совместимый с более ранними версиями Python.
• Протокол версии 1 – это старый двоичный формат, также совместимый с более ранними версиями Python.
• Протокол версии 2 был представлен в Python 2.3. Он обеспечивает гораздо более эффективную сериализацию классов нового стиля. Дополнительную информацию об улучшениях, внесённых протоколом 2, см. в PEP 307.
• Протокол версии 3 был добавлен в Python 3. Он явно поддерживает объекты bytes и не может быть распакован Python 2.x. Это протокол по умолчанию и текущий рекомендуемый; используйте его по возможности.

11.1.3. Интерфейс модуля¶Module Interface

Для сериализации иерархии объектов достаточно вызвать функцию dumps(). Аналогично, для десериализации потока данных вызывается функция loads(). Однако если требуется более тонкий контроль над сериализацией и десериализацией, можно создать соответственно объект Pickler или Unpickler.

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

pickle.HIGHEST_PROTOCOL¶

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

pickle.DEFAULT_PROTOCOL¶

Протокол по умолчанию, используемый для упаковки. Может быть меньше HIGHEST_PROTOCOL. В настоящее время протокол по умолчанию – 3, новый протокол, разработанный для Python 3.0.

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

pickle.dump(obj, file, protocol=None, *, fix_imports=True)¶

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

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

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

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

Если fix_imports равен True и протокол меньше 3, pickle попытается отобразить новые имена Python 3.x на старые имена модулей, используемые в Python 2.x, чтобы поток данных pickle был читаем в Python 2.x.

pickle.dumps(obj, protocol=None, *, fix_imports=True)¶

Возвращает сериализованное представление объекта в виде объекта bytes вместо записи в файл.

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

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

Если fix_imports равен True и протокол меньше 3, pickle попытается отобразить новые имена Python 3.x на старые имена модулей, используемые в Python 2.x, чтобы поток данных pickle был читаем в Python 2.x.

pickle.load(file, *, fix_imports=True, encoding="ASCII", errors="strict")¶

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

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

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

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

pickle.loads(bytes_object, *, fix_imports=True, encoding="ASCII", errors="strict")¶

Читает сериализованную иерархию объектов из объекта bytes и возвращает восстановленную иерархию объектов, содержащуюся в нём.

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

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

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

exception pickle.PickleError¶

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

exception pickle.PicklingError¶

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

Обратитесь к разделу Какие объекты можно упаковывать и распаковывать?, чтобы узнать, какие объекты можно упаковывать.

exception pickle.UnpicklingError¶

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

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

Модуль pickle экспортирует два класса: Pickler и Unpickler.

class pickle.Pickler(file, protocol=None, *, fix_imports=True)¶

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

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

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

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

Если fix_imports равен True и протокол меньше 3, pickle попытается отобразить новые имена Python 3.x на старые имена модулей, используемые в Python 2.x, чтобы поток данных pickle был читаем в Python 2.x.

dump(obj)¶

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

persistent_id(obj)¶

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

Если persistent_id() возвращает None, obj упаковывается обычным образом. Любое другое значение заставляет Pickler выдать это значение как постоянный идентификатор для obj. Смысл этого постоянного идентификатора должен быть определён Unpickler.persistent_load(). Обратите внимание, что значение, возвращаемое persistent_id(), само не может иметь постоянный идентификатор.

См. Постоянство внешних объектов для подробностей и примеров использования.

fast¶

Устарело. При установке в истинное значение включает быстрый режим. Быстрый режим отключает использование memo, тем самым ускоряя процесс упаковки за счёт отсутствия лишних кодов операций PUT. Его не следует использовать с самореферентными объектами, иначе Pickler будет рекурсировать бесконечно.

Используйте pickletools.optimize(), если нужны более компактные упаковки.

class pickle.Unpickler(file, *, fix_imports=True, encoding="ASCII", errors="strict")¶

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

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

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

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

load()¶

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

persistent_load(pid)¶

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

Если определён, persistent_load() должен вернуть объект, заданный постоянным идентификатором pid. При обнаружении недопустимого постоянного идентификатора должно быть вызвано UnpicklingError.

См. Постоянство внешних объектов для подробностей и примеров использования.

find_class(module, name)¶

Импортирует модуль module при необходимости и возвращает из него объект с именем name. Аргументы module и name – строки (тип str). Обратите внимание: вопреки своему названию, find_class() также используется для поиска функций.

Подклассы могут переопределить этот метод для получения контроля над тем, объекты какого типа и каким образом могут быть загружены, что потенциально снижает риски безопасности. См. Ограничение глобальных объектов для подробностей.

11.1.4. Что можно упаковать и распаковать?¶What can be pickled and unpickled?

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

• None, True и False
• целые числа, числа с плавающей запятой, комплексные числа
• строки, байты, байтовые массивы
• кортежи, списки, множества и словари, содержащие только сериализуемые объекты
• Функции, определённые на верхнем уровне модуля.
• встроенные функции, определённые на верхнем уровне модуля
• классы, определённые на верхнем уровне модуля
• экземпляры таких классов, чьи __dict__ или результат вызова __getstate__() поддаются упаковке (см. раздел Упаковка экземпляров классов для подробностей).

Попытка запакетить (pickle) непиклируемый объект вызовет исключение PicklingError; при этом в базовый файл может быть уже записано некоторое количество байт. Попытка запакетить сильно рекурсивную структуру данных может превысить максимальную глубину рекурсии – в этом случае будет возбуждено RuntimeError. Можно аккуратно увеличить этот предел с помощью sys.setrecursionlimit().

Обратите внимание, что функции (встроенные и определённые пользователем) упаковываются по «полностью квалифицированному» имени, а не по значению. Это означает, что упаковывается только имя функции вместе с именем модуля, в котором функция определена. Ни код функции, ни какие-либо её атрибуты не упаковываются. Поэтому определяющий модуль должен быть импортируемым в среде распаковки, и модуль должен содержать именованный объект, иначе будет возбуждено исключение. [2]

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

class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)

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

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

11.1.5. Упаковка экземпляров классов¶Pickling Class Instances

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

В большинстве случаев для того, чтобы экземпляры можно было пиклить, дополнительный код не требуется. По умолчанию pickle извлекает класс и атрибуты экземпляра через интроспекцию. При распикливании экземпляра класса его метод __init__() обычно не вызывается. Стандартное поведение сначала создаёт неинициализированный экземпляр, а затем восстанавливает сохранённые атрибуты. Следующий код показывает реализацию этого поведения:

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

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

Классы могут изменить поведение по умолчанию, предоставив один или несколько специальных методов:

object.__getnewargs__()¶

Начиная с протокола 2, классы, реализующие метод __getnewargs__(), могут управлять значениями, передаваемыми методу __new__() при распаковке. Это часто необходимо для классов, метод __new__() которых требует аргументов.

object.__getstate__()¶

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

object.__setstate__(state)¶

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

Примечание

Если __getstate__() возвращает ложное значение, метод __setstate__() не будет вызываться при распикливании.

Обратитесь к разделу Handling Stateful Objects за дополнительной информацией об использовании методов __getstate__() и __setstate__().

Как мы увидим, pickle не использует напрямую описанные выше методы. На самом деле эти методы являются частью протокола копирования, который реализует специальный метод __reduce__(). Протокол копирования предоставляет единый интерфейс для получения данных, необходимых для упаковки и копирования объектов. [3]

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

object.__reduce__()¶

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

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

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

• Вызываемый объект, который будет вызван для создания начальной версии объекта.
• Кортеж аргументов для вызываемого объекта. Если вызываемый объект не принимает ни одного аргумента, должен быть передан пустой кортеж.
• Необязательно: состояние объекта, которое будет передано методу __setstate__() объекта, как описано ранее. Если у объекта нет такого метода, значение должно быть словарём, и оно будет добавлено в атрибут __dict__ объекта.
• Необязательно: итератор (не последовательность), возвращающий последовательные элементы. Эти элементы будут добавлены к объекту с помощью obj.append(item) или, пакетно, с помощью obj.extend(list_of_items). В основном это используется для подклассов списков, но может использоваться и другими классами, если у них есть методы append() и extend() с подходящей сигнатурой. (Используется ли append() или extend(), зависит от версии протокола pickle и количества добавляемых элементов, поэтому оба должны поддерживаться.)
• Необязательно: итератор (не последовательность), возвращающий последовательные пары «ключ-значение». Эти элементы будут сохранены в объекте с помощью obj[key] = value. В основном это используется для подклассов словарей, но может использоваться и другими классами, если они реализуют __setitem__().

object.__reduce_ex__(protocol)¶

В качестве альтернативы может быть определён метод __reduce_ex__(). Единственное отличие в том, что этот метод должен принимать один целочисленный аргумент – версию протокола. Если он определён, pickle будет предпочитать его методу __reduce__(). Кроме того, __reduce__() автоматически становится синонимом расширенной версии. Основное назначение этого метода – предоставление обратно совместимых reduce-значений для старых версий 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
    import 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()

class TextReader:
    """Вывести и пронумеровать строки в текстовом файле."""

    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):
        # Восстанавливает состояние ранее открытого файла. Для этого необходимо открыть его заново и читать, пока не будет восстановлено количество строк.
        # Наконец, сохраняет файл.
        # метод, чтобы избежать изменения исходного состояния.
        state = self.__dict__.copy()
        # Для любого другого объекта используйте обычную редукцию.
        del state['file']
        return state

    def __setstate__(self, state):
        # Восстановить атрибуты экземпляра (например, filename и lineno).
        self.__dict__.update(state)
        # Получить дескриптор исходного буферного объекта.
        # открыть его заново и читать, пока количество строк не восстановится.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Наконец, сохраните файл.
        self.file = file

>>> 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!'

11.1.6. Ограничение глобалов¶Restricting Globals

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

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

В этом примере анпиклер импортирует функцию os.system(), а затем применяет строковый аргумент «echo hello world». Хотя этот пример безобиден, нетрудно представить такой, который может повредить систему.

По этой причине, возможно, вы захотите контролировать, что распаковывается, настраивая Unpickler.find_class(). Вопреки своему названию, find_class() вызывается всякий раз, когда запрашивается глобал (то есть класс или функция). Таким образом, можно либо полностью запретить глобалы, либо ограничить их безопасным подмножеством.

Вот пример анпиклера, который разрешает загрузку только нескольких безопасных классов из модуля builtins:

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()

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

>>> 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 или сторонние решения.

11.1.7. Примеры¶Examples

Для простейшего кода используйте функции dump() и load().

import pickle

# Произвольный набор объектов, поддерживаемых pickle.
data = {
    'a': [1, 2.0, 3, 4+6j],
    'b': ("character string", b"byte string"),
    'c': set([None, True, False])
}

with open('data.pickle', 'wb') as f:
    # Запаковать словарь 'data', используя самый высокий доступный протокол.
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)

Следующий пример читает полученные сериализованные данные.

import pickle

with open('data.pickle', 'rb') as f:
    # Версия используемого протокола определяется автоматически, поэтому
    # указывать её не нужно.
    data = pickle.load(f)

Сноски