-
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.
Relocate pexConfig formatter to here from daf_butler and test it
- Loading branch information
Showing
2 changed files
with
116 additions
and
1 deletion.
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,98 @@ | ||
# 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/>. | ||
|
||
from __future__ import annotations | ||
|
||
__all__ = ("PexConfigFormatter", ) | ||
|
||
import os.path | ||
|
||
from typing import ( | ||
Any, | ||
Optional, | ||
Type, | ||
) | ||
|
||
from lsst.utils import doImport | ||
from lsst.daf.butler.formatters.file import FileFormatter | ||
|
||
|
||
class PexConfigFormatter(FileFormatter): | ||
"""Interface for reading and writing pex.config.Config objects from disk. | ||
""" | ||
extension = ".py" | ||
|
||
def _readFile(self, path: str, pytype: Optional[Type[Any]] = None) -> Any: | ||
"""Read a pex.config.Config instance from the given file. | ||
Parameters | ||
---------- | ||
path : `str` | ||
Path to use to open the file. | ||
pytype : `class` | ||
Class to use to read the config file. | ||
Returns | ||
------- | ||
data : `lsst.pex.config.Config` | ||
Instance of class `pytype` read from config file. None | ||
if the file could not be opened. | ||
""" | ||
if pytype is None: | ||
raise RuntimeError("A python type is always required for reading pex_config Config files") | ||
|
||
if not os.path.exists(path): | ||
return None | ||
instance = pytype() | ||
# Configs can only be loaded if you use the correct derived type, | ||
# but we can't really store the correct derive type in the StorageClass | ||
# because that"d be a huge proliferation of StorageClasses. | ||
# Instead, we use a bit of a hack: try to load using the base-class | ||
# Config, inspect the exception message to obtain the class we should | ||
# have used, import that, and try it instead. | ||
# TODO: clean this up, somehow. | ||
try: | ||
instance.load(path) | ||
return instance | ||
except AssertionError as err: | ||
msg = str(err) | ||
if not msg.startswith("config is of type"): | ||
raise RuntimeError("Unexpected assertion; cannot infer Config class type.") from err | ||
actualPyTypeStr = msg.split()[-1] | ||
actualPyType = doImport(actualPyTypeStr) | ||
instance = actualPyType() | ||
instance.load(path) | ||
return instance | ||
|
||
def _writeFile(self, inMemoryDataset: Any) -> None: | ||
"""Write the in memory dataset to file on disk. | ||
Parameters | ||
---------- | ||
inMemoryDataset : `object` | ||
Object to serialize. | ||
Raises | ||
------ | ||
Exception | ||
The file could not be written. | ||
""" | ||
inMemoryDataset.save(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