python.ExitCodes Namespace Reference

Functions
	what (code)

Variables
int	ALL_OK = 0
	successful run
int	BEGIN_RUN_EXCEPTION = 0x10
	runtime/processing errors
int	BEGIN_RUN_FAILURE = 0x11
int	INI_ALG_EXCEPTION = 0x20
int	INI_ALG_FAILURE = 0x21
int	REINI_ALG_EXCEPTION = 0x30
int	REINI_ALG_FAILURE = 0x31
int	EXE_ALG_EXCEPTION = 0x40
int	EXE_ALG_FAILURE = 0x41
int	END_RUN_EXCEPTION = 0x50
int	END_RUN_FAILURE = 0x51
int	FIN_ALG_EXCEPTION = 0x60
int	FIN_ALG_FAILURE = 0x61
int	OPTIONS_UNKNOWN = 0x01
	RESERVED RANGE: 0x81 - 0xff reserved as to not overlap with the Transforms' report of signals causing exit.
int	INCLUDE_ERROR = 0x02
int	IMPORT_ERROR = 0x03
int	DATA_INFILE_ERROR = 0x04
int	DATA_OUTFILE_ERROR = 0x05
int	HISTO_OUTFILE_ERROR = 0x06
int	DATABASE_ERROR = 0x07
int	UNKNOWN_EXCEPTION = 0x08
int	CONFIGURATION_ERROR = 0x09
dict	codes
	helper to get a human-readable string

Detailed Description

Conventional exit codes, returned to shell.

Function Documentation

what()

python.ExitCodes.what

(

code

)

Definition at line 73 of file ExitCodes.py.

def what( code ):
   try:
      return codes[ code ]
   except KeyError:
      return "unknown"

Variable Documentation

ALL_OK

int python.ExitCodes.ALL_OK = 0

successful run

Definition at line 10 of file ExitCodes.py.

BEGIN_RUN_EXCEPTION

int python.ExitCodes.BEGIN_RUN_EXCEPTION = 0x10

runtime/processing errors

Definition at line 14 of file ExitCodes.py.

BEGIN_RUN_FAILURE

int python.ExitCodes.BEGIN_RUN_FAILURE = 0x11

Definition at line 15 of file ExitCodes.py.

codes

dict python.ExitCodes.codes

Initial value:

=  {
   ALL_OK              : "successful run",
   BEGIN_RUN_EXCEPTION : "exception raised during beginRun()",
   BEGIN_RUN_FAILURE   : "failure in beginRun()",
   INI_ALG_EXCEPTION   : "exception raised during initialization",
   INI_ALG_FAILURE     : "failure in initialization",
   REINI_ALG_EXCEPTION : "exception raised during an algorithm re-initialization",
   REINI_ALG_FAILURE   : "failure in an algorithm re-initialization",
   EXE_ALG_EXCEPTION   : "exception raised during an algorithm execute",
   EXE_ALG_FAILURE     : "failure in an algorithm execute",
   END_RUN_EXCEPTION   : "exception raised during endRun()",
   END_RUN_FAILURE     : "failure in endRun()",
   FIN_ALG_EXCEPTION   : "exception raised during finalization",
   FIN_ALG_FAILURE     : "failure in finalization",
   OPTIONS_UNKNOWN     : "unknown options supplied",
   INCLUDE_ERROR       : "an error occurred when including a file",
   IMPORT_ERROR        : "an error occurred when importing a file",
   DATA_INFILE_ERROR   : "an error occurred when reading a data file",
   DATA_OUTFILE_ERROR  : "an error occurred when writing a data file",
   HISTO_OUTFILE_ERROR : "an error occurred when writing a histogram file",
   DATABASE_ERROR      : "a database error occurred",
   UNKNOWN_EXCEPTION   : "an unknown exception occurred"
}

helper to get a human-readable string

Definition at line 49 of file ExitCodes.py.

CONFIGURATION_ERROR

int python.ExitCodes.CONFIGURATION_ERROR = 0x09

Definition at line 45 of file ExitCodes.py.

DATA_INFILE_ERROR

int python.ExitCodes.DATA_INFILE_ERROR = 0x04

Definition at line 40 of file ExitCodes.py.

DATA_OUTFILE_ERROR

int python.ExitCodes.DATA_OUTFILE_ERROR = 0x05

Definition at line 41 of file ExitCodes.py.

DATABASE_ERROR

int python.ExitCodes.DATABASE_ERROR = 0x07

Definition at line 43 of file ExitCodes.py.

END_RUN_EXCEPTION

int python.ExitCodes.END_RUN_EXCEPTION = 0x50

Definition at line 26 of file ExitCodes.py.

END_RUN_FAILURE

int python.ExitCodes.END_RUN_FAILURE = 0x51

Definition at line 27 of file ExitCodes.py.

EXE_ALG_EXCEPTION

int python.ExitCodes.EXE_ALG_EXCEPTION = 0x40

Definition at line 23 of file ExitCodes.py.

EXE_ALG_FAILURE

int python.ExitCodes.EXE_ALG_FAILURE = 0x41

Definition at line 24 of file ExitCodes.py.

FIN_ALG_EXCEPTION

int python.ExitCodes.FIN_ALG_EXCEPTION = 0x60

Definition at line 29 of file ExitCodes.py.

FIN_ALG_FAILURE

int python.ExitCodes.FIN_ALG_FAILURE = 0x61

Definition at line 30 of file ExitCodes.py.

HISTO_OUTFILE_ERROR

int python.ExitCodes.HISTO_OUTFILE_ERROR = 0x06

Definition at line 42 of file ExitCodes.py.

IMPORT_ERROR

int python.ExitCodes.IMPORT_ERROR = 0x03

Definition at line 39 of file ExitCodes.py.

INCLUDE_ERROR

int python.ExitCodes.INCLUDE_ERROR = 0x02

Definition at line 38 of file ExitCodes.py.

INI_ALG_EXCEPTION

int python.ExitCodes.INI_ALG_EXCEPTION = 0x20

Definition at line 17 of file ExitCodes.py.

INI_ALG_FAILURE

int python.ExitCodes.INI_ALG_FAILURE = 0x21

Definition at line 18 of file ExitCodes.py.

OPTIONS_UNKNOWN

int python.ExitCodes.OPTIONS_UNKNOWN = 0x01

RESERVED RANGE: 0x81 - 0xff reserved as to not overlap with the Transforms' report of signals causing exit.

miscellaneous error codes

Definition at line 37 of file ExitCodes.py.

REINI_ALG_EXCEPTION

int python.ExitCodes.REINI_ALG_EXCEPTION = 0x30

Definition at line 20 of file ExitCodes.py.

REINI_ALG_FAILURE

int python.ExitCodes.REINI_ALG_FAILURE = 0x31

Definition at line 21 of file ExitCodes.py.

UNKNOWN_EXCEPTION

int python.ExitCodes.UNKNOWN_EXCEPTION = 0x08

Definition at line 44 of file ExitCodes.py.