pyffi.spells.check.SpellReadWrite

Class SpellReadWrite

object --+ | Spell --+ | SpellRead --+ | SpellReadWrite

False

Instance Methods

Inherited from SpellRead: dataentry

Inherited from Spell: __init__, branchentry, branchexit, branchinspect, dataexit, datainspect, recurse

Inherited from Spell (private): _branchinspect, _datainspect

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

[hide private]

bool

toastentry(cls, toaster)
Called just before the toaster starts processing all files.

source code

Inherited from Spell: get_toast_stream, toastexit

Class Variables

[hide private]

SPELLNAME = 'check_readwrite'
A str describing how to refer to the spell from the command line.

READONLY = False
A bool which determines whether the spell is read only or not.

changed = True
Whether the spell changed the data.

Inherited from Spell: data, stream, toaster

Properties

[hide private]

Inherited from object: __class__

toastentry(cls, toaster)
Class Method

source code

Called just before the toaster starts processing all files. If it returns False, then the spell is not used. The default implementation simply returns True.

For example, if the spell only acts on a particular block type, but that block type is excluded, then you can use this function to flag that this spell can be skipped. You can also use this function to initialize statistics data to be aggregated from files, to initialize a log file, and so.

Parameters:

toaster - The toaster this spell is called from.

Returns: bool

True if the spell applies, False otherwise.

Overrides: Spell.toastentry

(inherited documentation)

Class SpellReadWrite

toastentry(cls, toaster) Class Method

toastentry(cls, toaster)
Class Method