Coverage for python/lsst/daf/butler/_exceptions.py: 77%
35 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-03-26 02:48 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-03-26 02:48 -0700
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/>.
28"""Specialized Butler exceptions."""
29__all__ = (
30 "CalibrationLookupError",
31 "DatasetNotFoundError",
32 "DimensionNameError",
33 "ButlerUserError",
34 "DatasetTypeNotSupportedError",
35 "EmptyQueryResultError",
36 "MissingDatasetTypeError",
37 "ValidationError",
38)
40from ._exceptions_legacy import DataIdError, DatasetTypeError
43class ButlerUserError(Exception):
44 """Base class for Butler exceptions that contain a user-facing error
45 message.
47 Parameters
48 ----------
49 detail : `str`
50 Details about the error that occurred.
51 """
53 # When used with Butler server, exceptions inheriting from
54 # this class will be sent to the client side and re-raised by RemoteButler
55 # there. Be careful that error messages do not contain security-sensitive
56 # information.
57 #
58 # This should only be used for "expected" errors that occur because of
59 # errors in user-supplied data passed to Butler methods. It should not be
60 # used for any issues caused by the Butler configuration file, errors in
61 # the library code itself or the underlying databases.
62 #
63 # When you create a new subclass of this type, add it to the list in
64 # _USER_ERROR_TYPES below.
66 error_type: str
67 """Unique name for this error type, used to identify it when sending
68 information about the error to the client.
69 """
71 def __init__(self, detail: str):
72 return super().__init__(detail)
75class CalibrationLookupError(LookupError, ButlerUserError):
76 """Exception raised for failures to look up a calibration dataset."""
78 error_type = "calibration_lookup"
81class DatasetNotFoundError(LookupError, ButlerUserError):
82 """The requested dataset could not be found."""
84 error_type = "dataset_not_found"
87class DimensionNameError(KeyError, DataIdError, ButlerUserError):
88 """Exception raised when a dimension specified in a data ID does not exist
89 or required dimension is not provided.
90 """
92 error_type = "dimension_name"
95class MissingDatasetTypeError(DatasetTypeError, KeyError, ButlerUserError):
96 """Exception raised when a dataset type does not exist."""
98 error_type = "missing_dataset_type"
101class DatasetTypeNotSupportedError(RuntimeError):
102 """A `DatasetType` is not handled by this routine.
104 This can happen in a `Datastore` when a particular `DatasetType`
105 has no formatters associated with it.
106 """
108 pass
111class ValidationError(RuntimeError):
112 """Some sort of validation error has occurred."""
114 pass
117class EmptyQueryResultError(Exception):
118 """Exception raised when query methods return an empty result and `explain`
119 flag is set.
121 Parameters
122 ----------
123 reasons : `list` [`str`]
124 List of possible reasons for an empty query result.
125 """
127 def __init__(self, reasons: list[str]):
128 self.reasons = reasons
130 def __str__(self) -> str:
131 # There may be multiple reasons, format them into multiple lines.
132 return "Possible reasons for empty result:\n" + "\n".join(self.reasons)
135class UnknownButlerUserError(ButlerUserError):
136 """Raised when the server sends an ``error_type`` for which we don't know
137 the corresponding exception type. (This may happen if an old version of
138 the Butler client library connects to a new server).
139 """
141 error_type = "unknown"
144_USER_ERROR_TYPES: tuple[type[ButlerUserError], ...] = (
145 CalibrationLookupError,
146 DimensionNameError,
147 DatasetNotFoundError,
148 MissingDatasetTypeError,
149 UnknownButlerUserError,
150)
151_USER_ERROR_MAPPING = {e.error_type: e for e in _USER_ERROR_TYPES}
152assert len(_USER_ERROR_MAPPING) == len(
153 _USER_ERROR_TYPES
154), "Subclasses of ButlerUserError must have unique 'error_type' property"
157def create_butler_user_error(error_type: str, message: str) -> ButlerUserError:
158 """Instantiate one of the subclasses of `ButlerUserError` based on its
159 ``error_type`` string.
161 Parameters
162 ----------
163 error_type : `str`
164 The value from the ``error_type`` class attribute on the exception
165 subclass you wish to instantiate.
166 message : `str`
167 Detailed error message passed to the exception constructor.
168 """
169 cls = _USER_ERROR_MAPPING.get(error_type)
170 if cls is None:
171 raise UnknownButlerUserError(f"Unknown exception type '{error_type}': {message}")
172 return cls(message)