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

Shortcuts on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

10 statements  

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 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"""Support for writing matplotlib figures.""" 

25 

26__all__ = ("MatplotlibFormatter",) 

27 

28from typing import ( 

29 Any, 

30 Optional, 

31 Type, 

32) 

33 

34from .file import FileFormatter 

35 

36 

37class MatplotlibFormatter(FileFormatter): 

38 """Interface for writing matplotlib figures. 

39 """ 

40 

41 extension = ".png" 

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

43 

44 def _readFile(self, path: str, pytype: Optional[Type[Any]] = None) -> Any: 

45 # docstring inherited from FileFormatter._readFile 

46 raise NotImplementedError( 

47 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)