Coverage for python/lsst/daf/butler/_exceptions.py: 82%

11 statements  

« prev     ^ index     » next       coverage.py v7.4.1, created at 2024-02-01 11:20 +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"""Specialized Butler exceptions.""" 

29__all__ = ("DatasetTypeNotSupportedError", "EmptyQueryResultError", "ValidationError") 

30 

31 

32class DatasetTypeNotSupportedError(RuntimeError): 

33 """A `DatasetType` is not handled by this routine. 

34 

35 This can happen in a `Datastore` when a particular `DatasetType` 

36 has no formatters associated with it. 

37 """ 

38 

39 pass 

40 

41 

42class ValidationError(RuntimeError): 

43 """Some sort of validation error has occurred.""" 

44 

45 pass 

46 

47 

48class EmptyQueryResultError(Exception): 

49 """Exception raised when query methods return an empty result and `explain` 

50 flag is set. 

51 

52 Parameters 

53 ---------- 

54 reasons : `list` [`str`] 

55 List of possible reasons for an empty query result. 

56 """ 

57 

58 def __init__(self, reasons: list[str]): 

59 self.reasons = reasons 

60 

61 def __str__(self) -> str: 

62 # There may be multiple reasons, format them into multiple lines. 

63 return "Possible reasons for empty result:\n" + "\n".join(self.reasons)