1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 """SCons.Errors
25
26 This file contains the exception classes used to handle internal
27 and user errors in SCons.
28
29 """
30
31 __revision__ = "src/engine/SCons/Errors.py 3842 2008/12/20 22:59:52 scons"
32
33 import SCons.Util
34
35 import exceptions
36
38 """ Errors occuring while building.
39
40 BuildError have the following attributes:
41
42 Information about the cause of the build error:
43 -----------------------------------------------
44
45 errstr : a description of the error message
46
47 status : the return code of the action that caused the build
48 error. Must be set to a non-zero value even if the
49 build error is not due to an action returning a
50 non-zero returned code.
51
52 exitstatus : SCons exit status due to this build error.
53 Must be nonzero unless due to an explicit Exit()
54 call. Not always the same as status, since
55 actions return a status code that should be
56 respected, but SCons typically exits with 2
57 irrespective of the return value of the failed
58 action.
59
60 filename : The name of the file or directory that caused the
61 build error. Set to None if no files are associated with
62 this error. This might be different from the target
63 being built. For example, failure to create the
64 directory in which the target file will appear. It
65 can be None if the error is not due to a particular
66 filename.
67
68 exc_info : Info about exception that caused the build
69 error. Set to (None, None, None) if this build
70 error is not due to an exception.
71
72
73 Information about the cause of the location of the error:
74 ---------------------------------------------------------
75
76 node : the error occured while building this target node(s)
77
78 executor : the executor that caused the build to fail (might
79 be None if the build failures is not due to the
80 executor failing)
81
82 action : the action that caused the build to fail (might be
83 None if the build failures is not due to the an
84 action failure)
85
86 command : the command line for the action that caused the
87 build to fail (might be None if the build failures
88 is not due to the an action failure)
89 """
90
91 - def __init__(self,
92 node=None, errstr="Unknown error", status=2, exitstatus=2,
93 filename=None, executor=None, action=None, command=None,
94 exc_info=(None, None, None)):
95
96 self.errstr = errstr
97 self.status = status
98 self.exitstatus = exitstatus
99 self.filename = filename
100 self.exc_info = exc_info
101
102 self.node = node
103 self.executor = executor
104 self.action = action
105 self.command = command
106
107 Exception.__init__(self, node, errstr, status, exitstatus, filename,
108 executor, action, command, exc_info)
109
111 if self.filename:
112 return self.filename + ': ' + self.errstr
113 else:
114 return self.errstr
115
118
121
124
127
129 - def __init__(self, node=None, status=None, *args):
130 self.node = node
131 self.status = status
132 self.exitstatus = status
133 apply(Exception.__init__, (self,) + args)
134
136 """
137 Convert any return code a BuildError Exception.
138
139 `status' can either be a return code or an Exception.
140 The buildError.status we set here will normally be
141 used as the exit status of the "scons" process.
142 """
143 if not exc_info and isinstance(status, Exception):
144 exc_info = (status.__class__, status, None)
145
146 if isinstance(status, BuildError):
147 buildError = status
148 buildError.exitstatus = 2
149 elif isinstance(status, ExplicitExit):
150 status = status.status
151 errstr = 'Explicit exit, status %s' % status
152 buildError = BuildError(
153 errstr=errstr,
154 status=status,
155 exitstatus=status,
156 exc_info=exc_info)
157
158
159 elif isinstance(status, StopError) or isinstance(status, UserError):
160 buildError = BuildError(
161 errstr=str(status),
162 status=2,
163 exitstatus=2,
164 exc_info=exc_info)
165 elif isinstance(status, exceptions.EnvironmentError):
166
167
168
169
170
171 try: filename = status.filename
172 except AttributeError: filename = None
173 buildError = BuildError(
174 errstr=status.strerror,
175 status=status.errno,
176 exitstatus=2,
177 filename=filename,
178 exc_info=exc_info)
179 elif isinstance(status, Exception):
180 buildError = BuildError(
181 errstr='%s : %s' % (status.__class__.__name__, status),
182 status=2,
183 exitstatus=2,
184 exc_info=exc_info)
185 elif SCons.Util.is_String(status):
186 buildError = BuildError(
187 errstr=status,
188 status=2,
189 exitstatus=2)
190 else:
191 buildError = BuildError(
192 errstr="Error %s" % status,
193 status=status,
194 exitstatus=2)
195
196
197
198 return buildError
199