Coverage for python/lsst/pipe/base/formatters/pexConfig.py: 90%

16 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-11 02:00 -0700

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/>. 

21 

22from __future__ import annotations 

23 

24__all__ = ("PexConfigFormatter",) 

25 

26import os.path 

27from typing import Any 

28 

29from lsst.daf.butler.formatters.file import FileFormatter 

30from lsst.pex.config import Config 

31 

32 

33class PexConfigFormatter(FileFormatter): 

34 """Formatter implementation for reading and writing 

35 `lsst.pex.config.Config` instances. 

36 """ 

37 

38 extension = ".py" 

39 

40 def _readFile(self, path: str, pytype: type[Any] | None = None) -> Any: 

41 """Read a pex.config.Config instance from the given file. 

42 

43 Parameters 

44 ---------- 

45 path : `str` 

46 Path to use to open the file. 

47 pytype : `type`, optional 

48 Class to use to read the config file. 

49 

50 Returns 

51 ------- 

52 data : `lsst.pex.config.Config` 

53 Instance of class ``pytype`` read from config file. `None` 

54 if the file could not be opened. 

55 """ 

56 if not os.path.exists(path): 56 ↛ 57line 56 didn't jump to line 57, because the condition on line 56 was never true

57 return None 

58 

59 # Automatically determine the Config class from the serialized form 

60 with open(path, "r") as fd: 

61 config_py = fd.read() 

62 return Config._fromPython(config_py) 

63 

64 def _writeFile(self, inMemoryDataset: Any) -> None: 

65 """Write the in memory dataset to file on disk. 

66 

67 Parameters 

68 ---------- 

69 inMemoryDataset : `object` 

70 Object to serialize. 

71 

72 Raises 

73 ------ 

74 Exception 

75 The file could not be written. 

76 """ 

77 inMemoryDataset.save(self.fileDescriptor.location.path)