Coverage for python/lsst/daf/butler/formatters/matplotlib.py: 100%

11 statements  

« prev     ^ index     » next       coverage.py v7.4.3, created at 2024-03-12 10:05 +0000

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 .file import FileFormatter 

37 

38 

39class MatplotlibFormatter(FileFormatter): 

40 """Interface for writing matplotlib figures.""" 

41 

42 extension = ".png" 

43 """Matplotlib figures are always written in PNG format.""" 

44 

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

46 # docstring inherited from FileFormatter._readFile 

47 raise NotImplementedError(f"matplotlib figures cannot be read by the butler; path is {path}") 

48 

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

50 # docstring inherited from FileFormatter._writeFile 

51 inMemoryDataset.savefig(self.fileDescriptor.location.path)