ZestyParser.Tokens.TokenSequence

Package ZestyParser :: Module Tokens :: Class TokenSequence

[show private | hide private]

Class TokenSequence

AbstractToken --+
                |
               TokenSequence

A class whose instances match a sequence of tokens. Returns a corresponding list of return values from ZestyParser.scan.

Two special types, Skip and Omit, are allowed in the sequence. These are wrappers for other token objects adding special behaviours. If it encounters a Skip token, it will process it with ZestyParser.skip, ignore whether it matched, and not include it in the list. If it encounters a Omit token, it will still require that it match (the default behaviour), but it will not be included in the list.

Method Summary
	`__add__(self, other)` Allows you to construct `TokenSequence`s with the + operator.
	`__call__(self, parser, origCursor)`
	`__iadd__(self, other)`
	`__str__(self)`
Inherited from AbstractToken
	`__init__(self, desc, callback, as, name)`
	`__or__(self, other)` Allows you to construct `CompositeToken`s with the \| operator.
	`__repr__(self)`
	`__rshift__(self, callback)` Convenience overloading for setting the `callback` of a token whose initializer you do not call directly, such as the result of combining tokens with `+` or `\|`.
	`__xor__(self, message)` Overloading for setting the `failMessage` of a token.
	`preprocessResult(self, parser, data, origCursor)` Method called by subclasses' `__call__` methods to add uniform support for the `callback` and `as` parameters.

Instance Variable Summary
iterable	`desc`: An iterable returning token objects.
Inherited from AbstractToken
	`as`: An optional callable which, if not None, will be called in the same manner as a callback (after any callback and before returning to the parser instance), but will be passed only one argument: the data matched (or returned by the callback, if any).
	`callback`: An optional callable which, if not None, will be called whenever an instance matches successfully.

Class Variable Summary
Inherited from AbstractToken
`NoneType`	`failMessage` = None

Method Details

add(self, other)
(Addition operator)

Allows you to construct TokenSequences with the + operator.

Overrides:: ZestyParser.Tokens.AbstractToken.__add__ (inherited documentation)

Instance Variable Details

desc

An iterable returning token objects.

Type:: iterable

Generated by Epydoc 2.1 on Thu Jan 11 23:26:09 2007

http://epydoc.sf.net

Class TokenSequence

__add__(self, other) (Addition operator)

desc

add(self, other)
(Addition operator)