summaryrefslogtreecommitdiffstats
path: root/ipalib/exceptions.py
blob: 376a7a5670e36ee7d2ea8a5ba0dc945dd571c907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# Authors:
#   Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008  Red Hat
# see file 'COPYING' for use and warranty inmsgion
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 only
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
All custom exceptions raised by `ipalib` package.
"""

class IPAError(Exception):
	"""
	Use this base class for your custom IPA exceptions unless there is a
	specific reason to subclass from AttributeError, KeyError, etc.
	"""
	msg = None

	def __init__(self, *args, **kw):
		self.args = args
		self.kw = kw

	def __str__(self):
		"""
		Returns the string representation of this exception.
		"""
		if self.msg is None:
			if len(self.args) == 1:
				return unicode(self.args[0])
			return unicode(self.args)
		if len(self.args) > 0:
			return self.msg % self.args
		return self.msg % self.kw





class SetError(IPAError):
	msg = 'setting %r, but NameSpace does not allow attribute setting'







class RegistrationError(IPAError):
	"""
	Base class for errors that occur during plugin registration.
	"""


class SubclassError(RegistrationError):
	"""
	Raised when registering a plugin that is not a subclass of one of the
	allowed bases.
	"""
	msg = 'plugin %r not subclass of any base in %r'

	def __init__(self, cls, allowed):
		self.cls = cls
		self.allowed = allowed

	def __str__(self):
		return self.msg % (self.cls, self.allowed)


class DuplicateError(RegistrationError):
	"""
	Raised when registering a plugin whose exact class has already been
	registered.
	"""
	msg = '%r at %d was already registered'

	def __init__(self, cls):
		self.cls = cls

	def __str__(self):
		return self.msg % (self.cls, id(self.cls))


class OverrideError(RegistrationError):
	"""
	Raised when override=False yet registering a plugin that overrides an
	existing plugin in the same namespace.
	"""
	msg = 'unexpected override of %s.%s with %r (use override=True if intended)'

	def __init__(self, base, cls):
		self.base = base
		self.cls = cls

	def __str__(self):
		return self.msg % (self.base.__name__, self.cls.__name__, self.cls)


class MissingOverrideError(RegistrationError):
	"""
	Raised when override=True yet no preexisting plugin with the same name
	and base has been registered.
	"""
	msg = '%s.%s has not been registered, cannot override with %r'

	def __init__(self, base, cls):
		self.base = base
		self.cls = cls

	def __str__(self):
		return self.msg % (self.base.__name__, self.cls.__name__, self.cls)



class TwiceSetError(IPAError):
	msg = '%s.%s cannot be set twice'