HWRF  trunk@4391
Public Member Functions | Public Attributes | List of all members
produtil.run.ExitStatusException Class Reference

Raised to indicate that a program generated an invalid return code. More...

Detailed Description

Raised to indicate that a program generated an invalid return code.

Examine the "returncode" member variable for the returncode value. Negative values indicate the program was terminated by a signal while zero and positive values indicate the program exited. The highest exit status of the pipeline is returned when a pipeline is used.

For MPI programs, the exit status is generally unreliable due to implementation-dependent issues, but this package attempts to return the highest exit status seen. Generally, you can count on MPI implementations to return zero if you call MPI_Finalize() and exit normally, and non-zero if you call MPI_Abort with a non-zero argument. Any other situation will produce unpredictable results.

Definition at line 179 of file run.py.

Inheritance diagram for produtil.run.ExitStatusException:

Public Member Functions

def __init__ (self, message, status)
 ExitStatusException constructor. More...
 
def status (self)
 An alias for self.returncode: the exit status. More...
 
def __str__ (self)
 A string description of the error. More...
 
def __repr__ (self)
 A pythonic description of the error for debugging. More...
 

Public Attributes

 message
 A string description for what went wrong.
 
 returncode
 The return code, including signal information. More...
 

Constructor & Destructor Documentation

def produtil.run.ExitStatusException.__init__ (   self,
  message,
  status 
)

ExitStatusException constructor.

Parameters
messagea description of what went wrong
statusthe exit status

Definition at line 201 of file run.py.

Member Function Documentation

def produtil.run.ExitStatusException.__repr__ (   self)

A pythonic description of the error for debugging.

Definition at line 216 of file run.py.

def produtil.run.ExitStatusException.__str__ (   self)

A string description of the error.

Definition at line 213 of file run.py.

def produtil.run.ExitStatusException.status (   self)

An alias for self.returncode: the exit status.

Definition at line 209 of file run.py.

Member Data Documentation

produtil.run.ExitStatusException.returncode

The return code, including signal information.

Definition at line 206 of file run.py.

Referenced by produtil.run.ExitStatusException.__repr__(), produtil.run.ExitStatusException.__str__(), and produtil.run.ExitStatusException.status().


The documentation for this class was generated from the following file: