Hide keyboard shortcuts

Hot-keys 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

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__all__ = ("FormatterTest", "DoNothingFormatter", "LenientYamlFormatter") 

25 

26from typing import ( 

27 TYPE_CHECKING, 

28 Any, 

29 Mapping, 

30 Optional, 

31) 

32 

33from ..core import Formatter 

34from ..formatters.yaml import YamlFormatter 

35 

36if TYPE_CHECKING: 36 ↛ 37line 36 didn't jump to line 37, because the condition on line 36 was never true

37 from ..core import Location 

38 

39 

40class DoNothingFormatter(Formatter): 

41 """A test formatter that does not need to format anything and has 

42 parameters.""" 

43 

44 def read(self, component: Optional[str] = None) -> Any: 

45 raise NotImplementedError("Type does not support reading") 

46 

47 def write(self, inMemoryDataset: Any) -> str: 

48 raise NotImplementedError("Type does not support writing") 

49 

50 

51class FormatterTest(Formatter): 

52 """A test formatter that does not need to format anything.""" 

53 

54 supportedWriteParameters = frozenset({"min", "max", "median", "comment", "extra", "recipe"}) 

55 

56 def read(self, component: Optional[str] = None) -> Any: 

57 raise NotImplementedError("Type does not support reading") 

58 

59 def write(self, inMemoryDataset: Any) -> str: 

60 raise NotImplementedError("Type does not support writing") 

61 

62 @staticmethod 

63 def validateWriteRecipes(recipes: Optional[Mapping[str, Any]]) -> Optional[Mapping[str, Any]]: 

64 if not recipes: 

65 return recipes 

66 for recipeName in recipes: 

67 if "mode" not in recipes[recipeName]: 

68 raise RuntimeError("'mode' is a required write recipe parameter") 

69 return recipes 

70 

71 

72class LenientYamlFormatter(YamlFormatter): 

73 """A test formatter that allows any file extension but always reads and 

74 writes YAML.""" 

75 extension = ".yaml" 

76 

77 @classmethod 

78 def validateExtension(cls, location: Location) -> None: 

79 return