Coverage for python / lsst / daf / butler / formatters / astropyTable.py: 0%

1# This file is part of daf_butler. 

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 

28__all__ = ("AstropyTableFormatter",) 

29 

30from typing import Any 

31 

32import astropy.table 

33 

34from lsst.daf.butler import FormatterV2 

35from lsst.resources import ResourcePath 

36 

37 

38class AstropyTableFormatter(FormatterV2): 

39 """Read and write `astropy.table.Table` objects. 

40 

41 Currently assumes only local file reads are possible. 

42 """ 

43 

44 supported_write_parameters = frozenset({"format"}) 

45 supported_extensions = frozenset({".ecsv"}) 

46 can_read_from_local_file = True 

47 

48 def get_write_extension(self) -> str: 

49 # Default to ECSV but allow configuration via write parameter 

50 format = self.write_parameters.get("format", "ecsv") 

51 if format == "ecsv": 

52 return ".ecsv" 

53 # Other supported formats can be added here 

54 raise RuntimeError(f"Requested file format '{format}' is not supported for Table") 

55 

56 def read_from_local_file(self, path: str, component: str | None = None, expected_size: int = -1) -> Any: 

57 pytype = self.file_descriptor.storageClass.pytype 

58 if not issubclass(pytype, astropy.table.Table): 

59 raise TypeError(f"Python type {pytype} does not seem to be a astropy Table type") 

60 return pytype.read(path) # type: ignore 

61 

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

63 """Serialize the in memory dataset to a local file. 

64 

65 Parameters 

66 ---------- 

67 in_memory_dataset : `typing.Any` 

68 The Python object to serialize. 

69 uri : `lsst.resources.ResourcePath` 

70 The location to write the local file. 

71 

72 Notes 

73 ----- 

74 By default the file will be written in ECSV format. 

75 """ 

76 in_memory_dataset.write(uri.ospath)