NIPY logo

Site Navigation

NIPY Community

Table Of Contents

Next topic

io.imageformats.binaryheaders

This Page

io.imageformats.batteryrunners

Module: io.imageformats.batteryrunners

Inheritance diagram for nipy.io.imageformats.batteryrunners:

Battery runner classes and Report classes

Classes

BatteryRunner

class nipy.io.imageformats.batteryrunners.BatteryRunner(checks)

Bases: object

__init__(checks)
check_fix(obj)
check_only(obj)

Report

class nipy.io.imageformats.batteryrunners.Report(obj=None, error=None, problem_level=0, problem_msg='', fix_msg='')

Bases: object

__init__(obj=None, error=None, problem_level=0, problem_msg='', fix_msg='')

Initialize report with values

Parameters :

obj : object

object tested, possibly fixed. Default is None

error : None or Exception

Error to raise if raising error for this check. If None, no error can be raised for this check (it was probably normal).

problem_level : int

level of problem. From 0 (no problem) to 50 (severe problem). If the report originates from a fix, then this is the level of the problem remaining after the fix. Default is 0

problem_msg : string

String describing problem detected. Default is ‘’

fix_msg : string

String describing any fix applied. Default is ‘’.

Examples

>>> rep = Report()
>>> rep.problem_level
0
>>> rep = Report((), TypeError, 10)
>>> rep.problem_level
10
log_raise(logger, error_level=40)

Log problem, raise error if problem >= error_level

Parameters :

logger : log

log object, implementing log method

error_level : int, optional

If self.problem_level >= error_level, raise error

message

formatted message string, including fix message if present

write_raise(stream, error_level=40, log_level=30)