1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
# (C) Copyright 2005-2025 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" The base class for all object serializers. """
# Standard library imports.
import logging
from traceback import print_exc
from os.path import splitext
import pickle
# Enthought library imports.
from apptools.persistence.versioned_unpickler import VersionedUnpickler
from traits.api import HasTraits, Str
# Setup a logger for this module.
logger = logging.getLogger(__name__)
class ObjectSerializer(HasTraits):
""" The base class for all object serializers. """
#### 'ObjectSerializer' interface #########################################
# The file extension recognized by this serializer.
ext = Str(".pickle")
###########################################################################
# 'ObjectSerializer' interface.
###########################################################################
def can_load(self, path):
""" Returns True if the serializer can load a file. """
rest, ext = splitext(path)
return ext == self.ext
def load(self, path):
""" Loads an object from a file. """
# Unpickle the object.
f = open(path, "rb")
try:
try:
obj = VersionedUnpickler(f).load()
except Exception as ex:
print_exc()
logger.exception(
"Failed to load pickle file: %s, %s" % (path, ex)
)
raise
finally:
f.close()
return obj
def can_save(self, obj):
""" Returns True if the serializer can save an object. """
return True
def save(self, path, obj):
""" Saves an object to a file. """
if not path.endswith(self.ext):
actual_path = path + self.ext
else:
actual_path = path
# Pickle the object.
f = open(actual_path, "wb")
try:
pickle.dump(obj, f, 1)
except Exception as ex:
logger.exception(
"Failed to pickle into file: %s, %s, object:%s"
% (path, ex, obj)
)
print_exc()
f.close()
return actual_path
|