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

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

27 

28from __future__ import annotations 

29 

30__all__ = ("PexConfigFormatter",) 

31 

32from typing import Any, BinaryIO 

33 

34from lsst.daf.butler import FormatterV2 

35from lsst.pex.config import Config 

36from lsst.resources import ResourceHandleProtocol, ResourcePath 

37 

38 

39class PexConfigFormatter(FormatterV2): 

40 """Formatter implementation for reading and writing 

41 `lsst.pex.config.Config` instances. 

42 """ 

43 

44 default_extension = ".py" 

45 can_read_from_stream = True 

46 

47 def read_from_stream( 

48 self, stream: BinaryIO | ResourceHandleProtocol, component: str | None = None, expected_size: int = -1 

49 ) -> Any: 

50 # Automatically determine the Config class from the serialized form 

51 return Config._fromPython(stream.read().decode()) 

52 

53 def write_local_file(self, in_memory_dataset: Any, uri: ResourcePath) -> None: 

54 in_memory_dataset.save(uri.ospath)