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

5 statements  

« prev     ^ index     » next       coverage.py v7.5.1, created at 2024-05-11 03:15 -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/>. 

27 

28__all__ = ("DataIdError", "DatasetTypeError", "RegistryError") 

29 

30# The classes in this file exist only for backwards compatibility. New 

31# exception types should not inherit from these. 

32 

33 

34class RegistryError(Exception): 

35 """Base class for many exception classes produced by Registry methods. 

36 

37 Notes 

38 ----- 

39 The client code that needs to handle exceptions generated by the Registry 

40 methods can catch this class or one of its many subclasses as described by 

41 the particular method documentation. While most of the Registry methods 

42 should only raise the exceptions of this type, it is hard to guarantee 

43 that they will never raise other exception types. If the client needs to 

44 handle all possible exceptions, then it should also catch a standard 

45 `Exception` type as well. Additionally, some Registry methods can be 

46 explicitly documented to raise exceptions outside this class hierarchy. 

47 """ 

48 

49 

50class DataIdError(RegistryError): 

51 """Exception raised for incorrect data IDs, this is a base class for other 

52 specific error types. 

53 """ 

54 

55 

56class DatasetTypeError(RegistryError): 

57 """Exception raised for problems with dataset types.""" 

58 

59 

60class CollectionError(RegistryError): 

61 """Exception raised for collection-related errors."""