Coverage for python/lsst/pipe/base/formatters/pexConfig.py: 90%
16 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-01-06 01:57 -0800
« prev ^ index » next coverage.py v6.5.0, created at 2023-01-06 01:57 -0800
1# This file is part of pipe_base.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
22from __future__ import annotations
24__all__ = ("PexConfigFormatter",)
26import os.path
27from typing import Any, Optional, Type
29from lsst.daf.butler.formatters.file import FileFormatter
30from lsst.pex.config import Config
33class PexConfigFormatter(FileFormatter):
34 """Formatter implementation for reading and writing
35 `lsst.pex.config.Config` instances."""
37 extension = ".py"
39 def _readFile(self, path: str, pytype: Optional[Type[Any]] = None) -> Any:
40 """Read a pex.config.Config instance from the given file.
42 Parameters
43 ----------
44 path : `str`
45 Path to use to open the file.
46 pytype : `type`, optional
47 Class to use to read the config file.
49 Returns
50 -------
51 data : `lsst.pex.config.Config`
52 Instance of class ``pytype`` read from config file. `None`
53 if the file could not be opened.
54 """
55 if not os.path.exists(path): 55 ↛ 56line 55 didn't jump to line 56, because the condition on line 55 was never true
56 return None
58 # Automatically determine the Config class from the serialized form
59 with open(path, "r") as fd:
60 config_py = fd.read()
61 return Config._fromPython(config_py)
63 def _writeFile(self, inMemoryDataset: Any) -> None:
64 """Write the in memory dataset to file on disk.
66 Parameters
67 ----------
68 inMemoryDataset : `object`
69 Object to serialize.
71 Raises
72 ------
73 Exception
74 The file could not be written.
75 """
76 inMemoryDataset.save(self.fileDescriptor.location.path)