1# 2# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 The SCons Foundation 3# 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: 11# 12# The above copyright notice and this permission notice shall be included 13# in all copies or substantial portions of the Software. 14# 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. 22# 23 24"""SCons.Errors 25 26This file contains the exception classes used to handle internal 27and user errors in SCons. 28 29""" 30 31__revision__="src/engine/SCons/Errors.py issue-2856:2676:d23b7a2f45e8 2012/08/05 15:38:28 garyo" 32 33importSCons.Util 34 35importexceptions 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

139"""140 Convert any return code a BuildError Exception.141142 `status' can either be a return code or an Exception.143 The buildError.status we set here will normally be144 used as the exit status of the "scons" process.145 """146ifnotexc_infoandisinstance(status,Exception):147exc_info=(status.__class__,status,None)148149ifisinstance(status,BuildError):150buildError=status151buildError.exitstatus=2# always exit with 2 on build errors152elifisinstance(status,ExplicitExit):153status=status.status154errstr='Explicit exit, status %s'%status155buildError=BuildError(156errstr=errstr,157status=status,# might be 0, OK here158exitstatus=status,# might be 0, OK here159exc_info=exc_info)160elifisinstance(status,(StopError,UserError)):161buildError=BuildError(162errstr=str(status),163status=2,164exitstatus=2,165exc_info=exc_info)166elifisinstance(status,exceptions.EnvironmentError):167# If an IOError/OSError happens, raise a BuildError.168# Report the name of the file or directory that caused the169# error, which might be different from the target being built170# (for example, failure to create the directory in which the171# target file will appear).172try:filename=status.filename173exceptAttributeError:filename=None174buildError=BuildError(175errstr=status.strerror,176status=status.errno,177exitstatus=2,178filename=filename,179exc_info=exc_info)180elifisinstance(status,Exception):181buildError=BuildError(182errstr='%s : %s'%(status.__class__.__name__,status),183status=2,184exitstatus=2,185exc_info=exc_info)186elifSCons.Util.is_String(status):187buildError=BuildError(188errstr=status,189status=2,190exitstatus=2)191else:192buildError=BuildError(193errstr="Error %s"%status,194status=status,195exitstatus=2)196197#import sys198#sys.stderr.write("convert_to_BuildError: status %s => (errstr %s, status %s)"%(status,buildError.errstr, buildError.status))199returnbuildError