Coverage for python/lsst/pex/exceptions/wrappers.py : 81%

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 pex_exceptions.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://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 <https://www.gnu.org/licenses/>.
22__all__ = ["register", "ExceptionMeta", "Exception", "LogicError",
23 "DomainError", "InvalidParameterError", "LengthError",
24 "OutOfRangeError", "RuntimeError", "RangeError", "OverflowError",
25 "UnderflowError", "NotFoundError", "IoError", "TypeError",
26 "translate", "declare"]
28import warnings
29import builtins
31from . import exceptions
33registry = {}
36def register(cls):
37 """A Python decorator that adds a Python exception wrapper to the registry that maps C++ Exceptions
38 to their Python wrapper classes.
39 """
40 registry[cls.WrappedClass] = cls
41 return cls
44class ExceptionMeta(type):
45 """A metaclass for custom exception wrappers, which adds lookup of class attributes
46 by delegating to the Swig-generated wrapper.
47 """
49 def __getattr__(cls, name):
50 return getattr(cls.WrappedClass, name)
53@register
54class Exception(builtins.Exception, metaclass=ExceptionMeta):
55 """The base class for Python-wrapped LSST C++ exceptions.
56 """
58 # wrappers.py is an implementation detail, not a public namespace, so we pretend this is defined
59 # in the package for pretty-printing purposes
60 __module__ = "lsst.pex.exceptions"
62 WrappedClass = exceptions.Exception
64 def __init__(self, arg, *args, **kwds):
65 if isinstance(arg, exceptions.Exception):
66 cpp = arg
67 message = cpp.what()
68 else:
69 message = arg
70 cpp = self.WrappedClass(message, *args, **kwds)
71 super(Exception, self).__init__(message)
72 self.cpp = cpp
74 def __getattr__(self, name):
75 return getattr(self.cpp, name)
77 def __repr__(self):
78 return "%s('%s')" % (type(self).__name__, self.cpp.what())
80 def __str__(self):
81 return self.cpp.asString()
84@register
85class LogicError(Exception):
86 WrappedClass = exceptions.LogicError
89@register
90class DomainError(LogicError):
91 WrappedClass = exceptions.DomainError
94@register
95class InvalidParameterError(LogicError):
96 WrappedClass = exceptions.InvalidParameterError
99@register
100class LengthError(LogicError):
101 WrappedClass = exceptions.LengthError
104@register
105class OutOfRangeError(LogicError):
106 WrappedClass = exceptions.OutOfRangeError
109@register
110class RuntimeError(Exception, builtins.RuntimeError):
111 WrappedClass = exceptions.RuntimeError
114@register
115class RangeError(RuntimeError):
116 WrappedClass = exceptions.RangeError
119@register
120class OverflowError(RuntimeError, builtins.OverflowError):
121 WrappedClass = exceptions.OverflowError
124@register
125class UnderflowError(RuntimeError, builtins.ArithmeticError):
126 WrappedClass = exceptions.UnderflowError
129@register
130class NotFoundError(Exception, builtins.LookupError):
131 WrappedClass = exceptions.NotFoundError
134@register
135class IoError(RuntimeError, builtins.IOError):
136 WrappedClass = exceptions.IoError
139@register
140class TypeError(LogicError, builtins.TypeError):
141 WrappedClass = exceptions.TypeError
144def translate(cpp):
145 """Translate a C++ Exception instance to Python and return it."""
146 PyType = registry.get(type(cpp), None)
147 if PyType is None:
148 warnings.warn("Could not find appropriate Python type for C++ Exception")
149 PyType = Exception
150 return PyType(cpp)
153def declare(module, exception_name, base, wrapped_class):
154 """Declare a new exception."""
155 setattr(module, exception_name, register(ExceptionMeta(exception_name, (base, ),
156 dict(WrappedClass=wrapped_class))))