Coverage for python / lsst / daf / butler / formatters / matplotlib.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"""Support for writing matplotlib figures.""" 

29 

30from __future__ import annotations 

31 

32__all__ = ("MatplotlibFormatter",) 

33 

34from typing import Any 

35 

36from lsst.daf.butler import FormatterV2 

37from lsst.resources import ResourcePath 

38 

39 

40class MatplotlibFormatter(FormatterV2): 

41 """Format matplotlib figures. 

42 

43 Does not support writes. 

44 """ 

45 

46 default_extension = ".png" 

47 

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

49 """Serialize the in memory dataset to a local image file. 

50 

51 Parameters 

52 ---------- 

53 in_memory_dataset : `typing.Any` 

54 The Python object to serialize. 

55 uri : `lsst.resources.ResourcePath` 

56 The location to write the local file. 

57 """ 

58 # Format is not forced so if there is no extension in uri one will 

59 # be added and the datastore will not know what happened. 

60 # The fname for savefig can take a file descriptor. If it works 

61 # with ResourcePath handles then it may be possible to do direct 

62 # writes. Alternatively, implement with BytesIO and do direct put. 

63 

64 metadata = {} 

65 if hasattr(in_memory_dataset, "metadata"): 

66 metadata = in_memory_dataset.metadata 

67 

68 in_memory_dataset.savefig(uri.ospath, metadata=metadata)