Source code for file_config.handlers.pickle

# Copyright (c) 2019 Stephen Bunn <stephen@bunn.io>
# ISC License <https://choosealicense.com/licenses/isc>

from ._common import BaseHandler



[docs]class PickleHandler(BaseHandler):
    """ The Pickle serialization handler.
    """

    name = "pickle"
    packages = ("pickle",)
    options = {}


[docs]    def on_pickle_dumps(self, pickle, config, dictionary, **kwargs):
        """ The :mod:`pickle` dumps method.

        :param module pickle: The ``pickle`` module
        :param class config: The instance's config class
        :param dict dictionary: The dictionary instance to serailize
        :returns: The serialized content
        :rtype: str
        """

        return pickle.dumps(dictionary, protocol=pickle.HIGHEST_PROTOCOL)



[docs]    def on_pickle_loads(self, pickle, config, content, **kwargs):
        """ The :mod:`pickle` loads method.

        :param module pickle: The ``pickle`` module
        :param class config: The loading config class
        :param str content: The content to deserialize
        :returns: The deserialized dictionary
        :rtype: dict
        """

        return pickle.loads(content)