-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add special gen3 formatter for base.Packages
This formatter has a configurable write parameter to control yaml vs pickle format.
- Loading branch information
Showing
2 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# This file is part of obs_base. | ||
# | ||
# 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/>. | ||
|
||
__all__ = ("PackagesFormatter", ) | ||
|
||
import os.path | ||
|
||
from lsst.daf.butler.formatters.file import FileFormatter | ||
|
||
|
||
class PackagesFormatter(FileFormatter): | ||
"""Interface for reading and writing objects that support the standard | ||
afw I/O readFits/writeFits methods. | ||
""" | ||
supportedWriteParameters = frozenset({"format"}) | ||
supportedExtensions = frozenset({".yaml", ".pickle", ".pkl"}) | ||
|
||
@property | ||
def extension(self) -> str: | ||
# Default to YAML but allow configuration via write parameter | ||
format = self.writeParameters.get("format", "yaml") | ||
if format == "yaml": | ||
return ".yaml" | ||
elif format == "pickle": | ||
return ".pickle" | ||
raise RuntimeError(f"Requested file format '{format}' is not supported for Packages") | ||
|
||
def _readFile(self, path, pytype): | ||
"""Read a file from the path in FITS format. | ||
Parameters | ||
---------- | ||
path : `str` | ||
Path to use to open the file. | ||
pytype : `type` | ||
Class to use to read the serialized file. | ||
Returns | ||
------- | ||
data : `object` | ||
Instance of class ``pytype`` read from serialized file. None | ||
if the file could not be opened. | ||
""" | ||
if not os.path.exists(path): | ||
return None | ||
|
||
return pytype.read(path) | ||
|
||
def _writeFile(self, inMemoryDataset): | ||
"""Write the in memory dataset to file on disk. | ||
Parameters | ||
---------- | ||
inMemoryDataset : `object` | ||
Object to serialize. | ||
Raises | ||
------ | ||
Exception | ||
The file could not be written. | ||
""" | ||
inMemoryDataset.write(self.fileDescriptor.location.path) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters