Coverage for python/lsst/daf/butler/formatters/pickleFormatter.py : 80%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
# This file is part of daf_butler. # # Developed for the LSST Data Management System. # This product includes software developed by the LSST Project # (http://www.lsst.org). # See the COPYRIGHT file at the top-level directory of this distribution # for details of code ownership. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Interface for reading and writing Python objects to and from pickle files. """
"""This formatter does not support any parameters"""
"""Read a file from the path in pickle format.
Parameters ---------- path : `str` Path to use to open the file. pytype : `class`, optional Not used by this implementation.
Returns ------- data : `object` Either data as Python object read from the pickle file, or None if the file could not be opened. """ except FileNotFoundError: data = None
"""Write the in memory dataset to file on disk.
Parameters ---------- inMemoryDataset : `object` Object to serialize.
Raises ------ Exception The file could not be written. """
"""Read the bytes object as a python object.
Parameters ---------- serializedDataset : `bytes` Bytes object to unserialize. pytype : `class`, optional Not used by this implementation.
Returns ------- inMemoryDataset : `object` The requested data as a object, or None if the string could not be read. """ except pickle.PicklingError: data = None
"""Write the in memory dataset to a bytestring.
Parameters ---------- inMemoryDataset : `object` Object to serialize
Returns ------- serializedDataset : `bytes` Bytes object representing the pickled object.
Raises ------ Exception The object could not be pickled. """ return pickle.dumps(inMemoryDataset, protocol=-1) |