SCons :: Errors :: BuildError :: Class BuildError
[hide private]
[frames] | no frames]

Class BuildError

source code

              object --+        
                       |        
exceptions.BaseException --+    
                           |    
        exceptions.Exception --+
                               |
                              BuildError

Errors occuring while building.

BuildError have the following attributes:

    Information about the cause of the build error:
    -----------------------------------------------

    errstr : a description of the error message

    status : the return code of the action that caused the build
             error. Must be set to a non-zero value even if the
             build error is not due to an action returning a
             non-zero returned code.

    exitstatus : SCons exit status due to this build error.
                 Must be nonzero unless due to an explicit Exit()
                 call.  Not always the same as status, since
                 actions return a status code that should be
                 respected, but SCons typically exits with 2
                 irrespective of the return value of the failed
                 action.

    filename : The name of the file or directory that caused the
               build error. Set to None if no files are associated with
               this error. This might be different from the target
               being built. For example, failure to create the
               directory in which the target file will appear. It
               can be None if the error is not due to a particular
               filename.

    exc_info : Info about exception that caused the build
               error. Set to (None, None, None) if this build
               error is not due to an exception.


    Information about the cause of the location of the error:
    ---------------------------------------------------------

    node : the error occured while building this target node(s)
    
    executor : the executor that caused the build to fail (might
               be None if the build failures is not due to the
               executor failing)
    
    action : the action that caused the build to fail (might be
             None if the build failures is not due to the an
             action failure)

    command : the command line for the action that caused the
              build to fail (might be None if the build failures
              is not due to the an action failure)
    



Instance Methods [hide private]
 
__init__(self, node=False, errstr='Unknown error', status=2, exitstatus=2, filename=False, executor=False, action=False, command=False, exc_info=(None, None, None))
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__str__(self)
str(x)
source code

Inherited from exceptions.Exception: __new__

Inherited from exceptions.BaseException: __delattr__, __getattribute__, __getitem__, __getslice__, __reduce__, __repr__, __setattr__, __setstate__

Inherited from object: __hash__, __reduce_ex__

Properties [hide private]

Inherited from exceptions.BaseException: args, message

Inherited from object: __class__

Method Details [hide private]

__init__(self, node=False, errstr='Unknown error', status=2, exitstatus=2, filename=False, executor=False, action=False, command=False, exc_info=(None, None, None))
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: exceptions.Exception.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 
str(x)

Overrides: exceptions.BaseException.__str__
(inherited documentation)