LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
wrappers.py
Go to the documentation of this file.
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/>.
21
22__all__ = ["register", "ExceptionMeta", "Exception", "LogicError",
23 "DomainError", "InvalidParameterError", "LengthError",
24 "OutOfRangeError", "RuntimeError", "RangeError", "OverflowError",
25 "UnderflowError", "NotFoundError", "IoError", "TypeError",
26 "translate", "declare"]
27
28import warnings
29import builtins
30
31from . import exceptions
32
33registry = {}
34
35
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
42
43
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 """
48
49 def __getattr__(cls, name):
50 return getattr(cls.WrappedClass, name)
51
52
53@register
54class Exception(builtins.Exception, metaclass=ExceptionMeta):
55 """The base class for Python-wrapped LSST C++ exceptions.
56 """
57
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"
61
62 WrappedClass = exceptions.Exception
63
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.WrappedClassWrappedClass(message, *args, **kwds)
71 super(Exception, self).__init__(message)
72 self.cpp = cpp
73
74 def __getattr__(self, name):
75 return getattr(self.cpp, name)
76
77 def __repr__(self):
78 return "%s('%s')" % (type(self).__name__, self.cpp.what())
79
80 def __str__(self):
81 return self.cpp.asString()
82
83
84@register
86 WrappedClass = exceptions.LogicError
87
88
89@register
92
93
94@register
102
103
104@register
107
108
109@register
110class RuntimeError(Exception, builtins.RuntimeError):
112
113
114@register
117
118
119@register
120class OverflowError(RuntimeError, builtins.OverflowError):
122
123
124@register
125class UnderflowError(RuntimeError, builtins.ArithmeticError):
127
128
129@register
130class NotFoundError(Exception, builtins.LookupError):
132
133
134@register
135class IoError(RuntimeError, builtins.IOError):
136 WrappedClass = exceptions.IoError
137
138
139@register
140class TypeError(LogicError, builtins.TypeError):
141 WrappedClass = exceptions.TypeError
142
143
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)
151
152
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))))
Reports arguments outside the domain of an operation.
Definition Runtime.h:57
Provides consistent interface for LSST exceptions.
Definition Exception.h:107
Reports invalid arguments.
Definition Runtime.h:66
Reports errors in external input/output operations.
Definition Runtime.h:160
Reports attempts to exceed implementation-defined length limits for some classes.
Definition Runtime.h:76
Reports errors in the logical structure of the program.
Definition Runtime.h:46
Reports attempts to access elements using an invalid key.
Definition Runtime.h:151
Reports attempts to access elements outside a valid range of indices.
Definition Runtime.h:89
Reports when the result of an arithmetic operation is too large for the destination type.
Definition Runtime.h:124
Reports when the result of an operation cannot be represented by the destination type.
Definition Runtime.h:115
Reports errors that are due to events beyond the control of the program.
Definition Runtime.h:104
Reports errors from accepting an object of an unexpected or inappropriate type.
Definition Runtime.h:167
Reports when the result of an arithmetic operation is too small for the destination type.
Definition Runtime.h:133
__init__(self, arg, *args, **kwds)
Definition wrappers.py:64
declare(module, exception_name, base, wrapped_class)
Definition wrappers.py:153