Table of Contents

Class: PseudoModule em.py

A pseudomodule for the builtin empy routines.

Methods   
__init__
addHook
atExit
clearHooks
escape
expand
flatten
flush
getAllDiversions
getCurrentDiversion
getFilter
getHooks
getPrefix
identify
include
invokeHook
nullFilter
playAllDiversions
playDiversion
purgeAllDiversions
purgeDiversion
quote
removeHook
replayAllDiversions
replayDiversion
resetFilter
setFilter
setLine
setName
setPrefix
startDiversion
stopDiverting
string
  __init__ 
__init__ ( self,  interpreter )

  addHook 
addHook (
        self,
        name,
        hook,
        prepend=False,
        )

Add a new hook; optionally insert it rather than appending it.

  atExit 
atExit ( self,  callable )

Register a function to be called at exit.

  clearHooks 
clearHooks ( self,  name )

Clear all hooks associated with the name.

  escape 
escape (
        self,
        data,
        more='',
        )

Wrapper around escape.

  expand 
expand (
        self,
        data,
        locals=None,
        )

Wrapper around expand.

  flatten 
flatten ( self,  keys=None )

Flatten the contents of the pseudo-module into the globals namespace.

  flush 
flush ( self )

Wrapper around flush.

  getAllDiversions 
getAllDiversions ( self )

Get the names of all existing diversions.

  getCurrentDiversion 
getCurrentDiversion ( self )

Get the name of the current diversion.

  getFilter 
getFilter ( self )

Get the current filter.

  getHooks 
getHooks ( self,  name )

Get the hooks associated with the name.

  getPrefix 
getPrefix ( self )

Get the current prefix.

  identify 
identify ( self )

Identify the topmost context with a 2-tuple of the name and line number.

  include 
include (
        self,
        fileOrFilename,
        locals=None,
        processBangpaths=True,
        )

Wrapper around include.

  invokeHook 
invokeHook (
        self,
        name_,
        **keywords,
        )

Manually invoke a hook.

  nullFilter 
nullFilter ( self )

Install a filter that will consume all text.

  playAllDiversions 
playAllDiversions ( self )

Play all existing diversions and then purge them.

  playDiversion 
playDiversion ( self,  diversion )

Play the given diversion and then purge it.

  purgeAllDiversions 
purgeAllDiversions ( self )

Purge all existing diversions.

  purgeDiversion 
purgeDiversion ( self,  diversion )

Eliminate the given diversion.

  quote 
quote ( self,  data )

Wrapper around quote.

  removeHook 
removeHook (
        self,
        name,
        hook,
        )

Remove a particular hook.

Exceptions   
HookError, "could not remove hook: %s" % name
  replayAllDiversions 
replayAllDiversions ( self )

Replay all existing diversions without purging them.

  replayDiversion 
replayDiversion ( self,  diversion )

Replay the diversion without purging it.

  resetFilter 
resetFilter ( self )

Reset the filter so that it does no filtering.

  setFilter 
setFilter ( self,  filter )

Set the filter.

  setLine 
setLine ( self,  line )

Set the name of the topmost context.

  setName 
setName ( self,  name )

Set the name of the topmost context.

  setPrefix 
setPrefix ( self,  prefix )

Set the prefix.

  startDiversion 
startDiversion ( self,  diversion )

Start diverting to the given diversion name.

  stopDiverting 
stopDiverting ( self )

Stop any diverting.

  string 
string (
        self,
        data,
        name='<string>',
        locals=None,
        )

Wrapper around string.


Table of Contents

This document was automatically generated on Fri Oct 18 20:03:43 2002 by HappyDoc version 2.0.1