Class SpellRead

object --+    
         |    
     Spell --+
             |
            SpellRead

Known Subclasses:

SpellReadWrite

A spell which does nothing, besides reading the file.

Instance Methods

[hide private]

bool

dataentry(self)
Called before all blocks are recursed.

source code

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]

Inherited from Spell: get_toast_stream, toastentry, toastexit

Class Variables

[hide private]

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

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

Inherited from Spell: changed, data, stream, toaster

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

dataentry(self)

source code

Called before all blocks are recursed. The default implementation simply returns True. You can access the data via data, and unlike in the datainspect method, the full file has been processed at this stage.

Typically, you will override this function to perform a global operation on the file data.

Returns: bool: True if the children must be processed, False otherwise.
Overrides: Spell.dataentry: (inherited documentation)

Home

Trees

Indices

Help