Coverage for python/lsst/daf/butler/tests/testFormatters.py : 43%

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/>.
22from __future__ import annotations
24__all__ = ("FormatterTest", "DoNothingFormatter")
26from typing import (
27 Any,
28 Mapping,
29 Optional,
30)
32from ..core import Formatter
35class DoNothingFormatter(Formatter):
36 """A test formatter that does not need to format anything and has
37 parameters."""
39 def read(self, component: Optional[str] = None) -> Any:
40 raise NotImplementedError("Type does not support reading")
42 def write(self, inMemoryDataset: Any) -> str:
43 raise NotImplementedError("Type does not support writing")
46class FormatterTest(Formatter):
47 """A test formatter that does not need to format anything."""
49 supportedWriteParameters = frozenset({"min", "max", "median", "comment", "extra", "recipe"})
51 def read(self, component: Optional[str] = None) -> Any:
52 raise NotImplementedError("Type does not support reading")
54 def write(self, inMemoryDataset: Any) -> str:
55 raise NotImplementedError("Type does not support writing")
57 @staticmethod
58 def validateWriteRecipes(recipes: Optional[Mapping[str, Any]]) -> Optional[Mapping[str, Any]]:
59 if not recipes:
60 return recipes
61 for recipeName in recipes:
62 if "mode" not in recipes[recipeName]:
63 raise RuntimeError("'mode' is a required write recipe parameter")
64 return recipes