Python runtime package

The runtime package for Python is called antlr3. It can be found in the runtime/Python directory of the ANTLR3 source distribution.
FIXME: standalone download?

Installation

There is a setup.py script in the runtime/Python directory. Use it to install the runtime just like any other Python package.

$ python setup.py install

The package is pure Python and does not have any dependencies to non-standard modules.

Differences from Java runtime

The package structure tries to mimic the Java runtime as close as possible. Translating import statements from Java to Python should be straight forward:

import org.antlr.runtime.*;
import org.antlr.runtime.tree.CommonTree;

from antlr3 import *
from antlr3.tree import CommonTree

The only difference is that a number of static names, which are members of various Java classes, are defined in the module namespace:

The API should be mostly identical to Java, with a few exceptions:

• The CommonToken constructor has a different signature than the (overloaded) Java version. It is advised to call it always with keyword arguments to avoid confusion:
  • CommonToken(type=None, channel=DEFAULT_CHANNEL, text=None, input=None, start=None, stop=None, oldToken=None)
• The overloaded TreeAdaptor.create() is available, but should not be used directly. Instead you should use
  • TreeAdaptor.createWithPayload(token)
  • TreeAdaptor.createFromToken(typeType, fromToken, text=None)
  • TreeAdaptor.createFromType(typeType, text)