2 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
4 # Permission is hereby granted, free of charge, to any person obtaining
5 # a copy of this software and associated documentation files (the
6 # "Software"), to deal in the Software without restriction, including
7 # without limitation the rights to use, copy, modify, merge, publish,
8 # distribute, sublicense, and/or sell copies of the Software, and to
9 # permit persons to whom the Software is furnished to do so, subject to
10 # the following conditions:
12 # The above copyright notice and this permission notice shall be included
13 # in all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
16 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
17 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 This file contains the exception classes used to handle internal
27 and user errors in SCons.
31 __revision__ = "src/engine/SCons/Errors.py 3842 2008/12/20 22:59:52 scons"
37 class BuildError(Exception):
38 """ Errors occuring while building.
40 BuildError have the following attributes:
42 Information about the cause of the build error:
43 -----------------------------------------------
45 errstr : a description of the error message
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.
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
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
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.
73 Information about the cause of the location of the error:
74 ---------------------------------------------------------
76 node : the error occured while building this target node(s)
78 executor : the executor that caused the build to fail (might
79 be None if the build failures is not due to the
82 action : the action that caused the build to fail (might be
83 None if the build failures is not due to the an
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)
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)):
98 self.exitstatus = exitstatus
99 self.filename = filename
100 self.exc_info = exc_info
103 self.executor = executor
105 self.command = command
107 Exception.__init__(self, node, errstr, status, exitstatus, filename,
108 executor, action, command, exc_info)
112 return self.filename + ': ' + self.errstr
116 class InternalError(Exception):
119 class UserError(Exception):
122 class StopError(Exception):
125 class EnvironmentError(Exception):
128 class ExplicitExit(Exception):
129 def __init__(self, node=None, status=None, *args):
132 self.exitstatus = status
133 apply(Exception.__init__, (self,) + args)
135 def convert_to_BuildError(status, exc_info=None):
137 Convert any return code a BuildError Exception.
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.
143 if not exc_info and isinstance(status, Exception):
144 exc_info = (status.__class__, status, None)
146 if isinstance(status, BuildError):
148 buildError.exitstatus = 2 # always exit with 2 on build errors
149 elif isinstance(status, ExplicitExit):
150 status = status.status
151 errstr = 'Explicit exit, status %s' % status
152 buildError = BuildError(
154 status=status, # might be 0, OK here
155 exitstatus=status, # might be 0, OK here
158 #elif isinstance(status, (StopError, UserError)):
159 elif isinstance(status, StopError) or isinstance(status, UserError):
160 buildError = BuildError(
165 elif isinstance(status, exceptions.EnvironmentError):
166 # If an IOError/OSError happens, raise a BuildError.
167 # Report the name of the file or directory that caused the
168 # error, which might be different from the target being built
169 # (for example, failure to create the directory in which the
170 # target file will appear).
171 try: filename = status.filename
172 except AttributeError: filename = None
173 buildError = BuildError(
174 errstr=status.strerror,
179 elif isinstance(status, Exception):
180 buildError = BuildError(
181 errstr='%s : %s' % (status.__class__.__name__, status),
185 elif SCons.Util.is_String(status):
186 buildError = BuildError(
191 buildError = BuildError(
192 errstr="Error %s" % status,
197 #sys.stderr.write("convert_to_BuildError: status %s => (errstr %s, status %s)"%(status,buildError.errstr, buildError.status))