2.2 Sablot functions and variables

CreateProcessor ()

Create and return a Processor object.

getMsgText (messageno)

Return the error message text for a Sablotron error number. This calls SablotGetMsgText() which currently returns a string with formatting arguments (eg. ``%s'').

processStrings (stylesheet, xmltext)

this function is kept here for compatibility with the older Sab-pyth-0.1 module. In general, this module exports the low level APIs of Sablotron, processStrings() is a high level API which can be emulated with calls to the lower level APIs (which provide more flexibility but are harder to use).

Note: unlike in the original module, processStrings is spelled with a lower case p at the beginning to enforce the convention that all types begin with capital letters and all functions or methods with lower case.

Process the argument string xmltext with the argument string stylesheet. Return the processor's output.

The following constant valus are defined for use with the regHandler and unregHandler methods of Processor objects:

The following are passed to the Processor methods regHandler and unregHandler as the handler's type:

HLR_MESSAGE
HLR_MISC
HLR_SAX
HLR_SCHEME

The following are used as error parameters when raising a Sablot.SchemeHandlerError exception:

SH_ERR_OK
SH_ERR_NOT_OK
SH_ERR_UNSUPPORTED_SCHEME

The following constants are used in message handlers:

MH_FACILITY_SABLOTRON
MH_LEVEL_CRITICAL
MH_LEVEL_DEBUG
MH_LEVEL_ERROR
MH_LEVEL_INFO
MH_LEVEL_WARN

Sablot defines the following exceptions:

Sablot.error is raised by the Sablot module when Sablotron returns an error code. A tuple consisting of the Sablotron's error code and error String (from SablotGetMsgText()) is the exception parameter.

Sablot.SchemeHandlerError is raised in scheme handler methods to return one of the error codes SH_ERR_NOT_OK, SH_ERR_UNSUPPORTED_SCHEMEback to the Sablotron processor.