Coverage for python/lsst/pipe/base/formatters/pexConfig.py: 90%
16 statements
« prev ^ index » next coverage.py v7.4.2, created at 2024-02-21 10:57 +0000
« prev ^ index » next coverage.py v7.4.2, created at 2024-02-21 10:57 +0000
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 software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28from __future__ import annotations
30__all__ = ("PexConfigFormatter",)
32import os.path
33from typing import Any
35from lsst.daf.butler.formatters.file import FileFormatter
36from lsst.pex.config import Config
39class PexConfigFormatter(FileFormatter):
40 """Formatter implementation for reading and writing
41 `lsst.pex.config.Config` instances.
42 """
44 extension = ".py"
46 def _readFile(self, path: str, pytype: type[Any] | None = None) -> Any:
47 """Read a pex.config.Config instance from the given file.
49 Parameters
50 ----------
51 path : `str`
52 Path to use to open the file.
53 pytype : `type`, optional
54 Class to use to read the config file.
56 Returns
57 -------
58 data : `lsst.pex.config.Config`
59 Instance of class ``pytype`` read from config file. `None`
60 if the file could not be opened.
61 """
62 if not os.path.exists(path): 62 ↛ 63line 62 didn't jump to line 63, because the condition on line 62 was never true
63 return None
65 # Automatically determine the Config class from the serialized form
66 with open(path, "r") as fd:
67 config_py = fd.read()
68 return Config._fromPython(config_py)
70 def _writeFile(self, inMemoryDataset: Any) -> None:
71 """Write the in memory dataset to file on disk.
73 Parameters
74 ----------
75 inMemoryDataset : `object`
76 Object to serialize.
78 Raises
79 ------
80 Exception
81 The file could not be written.
82 """
83 inMemoryDataset.save(self.fileDescriptor.location.path)