Package pyffi :: Package spells :: Package cgf :: Module dump :: Class SpellDumpAll
[hide private]
[frames] | no frames]

Class SpellDumpAll

source code

object --+        
         |        
     Spell --+    
             |    
      CgfSpell --+
                 |
                SpellDumpAll

Dump the whole file.
Instance Methods [hide private]
bool
branchentry(self, branch)
Cast the spell on the given branch.
source code

Inherited from CgfSpell: inspectblocktype

Inherited from CgfSpell (private): _datainspect

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

Inherited from Spell (private): _branchinspect

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 = 'dump'
A str describing how to refer to the spell from the command line.

Inherited from Spell: READONLY, changed, data, stream, toaster

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

branchentry(self, branch)

source code 

Cast the spell on the given branch. First called with branch equal to data's children, then the grandchildren, and so on. The default implementation simply returns True.

Typically, you will override this function to perform an operation on a particular block type and/or to stop recursion at particular block types.

Parameters:
  • branch - The branch to cast the spell on.
Returns: bool
True if the children must be processed, False otherwise.
Overrides: Spell.branchentry
(inherited documentation)