Home | History | Annotate | only in /external/antlr/runtime/Python3
Up to higher level directory
NameDateSize
antlr3/22-Oct-2020
AUTHORS22-Oct-2020260
ChangeLog22-Oct-20202.1K
doxyfile22-Oct-20209.8K
ez_setup.py22-Oct-202015.4K
LICENSE22-Oct-20201.4K
mkdoxy.sh22-Oct-2020414
pylintrc22-Oct-20207.4K
README22-Oct-20202.6K
setup.py22-Oct-20208.5K
tests/22-Oct-2020
unittests/22-Oct-2020

README

      1 1) ABOUT
      2 ========
      3 
      4 This is the Python3 package 'antlr3', which is required to use parsers created
      5 by the ANTLR3 tool. See <http://www.antlr.org/> for more information about
      6 ANTLR3.
      7 
      8 
      9 2) STATUS
     10 =========
     11 
     12 The Python3 target for ANTLR3 is still in beta. Documentation is lacking, some
     13 bits of the code is not yet done, some functionality has not been tested yet.
     14 Also the API might change a bit - it currently mimics the Java implementation,
     15 but it may be made a bit more pythonic here and there.
     16 
     17 WARNING: The runtime library is not compatible with recognizers generated by
     18 ANTLR versions preceding V3.4.x. If you are an application developer,
     19 then the suggested way to solve this is to package the correct runtime with
     20 your application. Installing the runtime in the global site-packages directory
     21 may not be a good idea.
     22 Sorry for the inconvenience.
     23 
     24 
     25 3) DOWNLOAD
     26 ===========
     27 
     28 This runtime is part of the ANTLR distribution. The latest version can be found
     29 at <http://www.antlr.org/download.html>.
     30 
     31 If you are interested in the latest, most bleeding edge version, have a look at
     32 the git repository at <http://github.com/antlr/antlr3>.
     33 
     34 
     35 4) INSTALLATION
     36 ===============
     37 
     38 Just like any other Python package:
     39 $ python3 setup.py install
     40 
     41 See <http://docs.python.org/inst/> for more information.
     42 
     43 
     44 5) DOCUMENTATION
     45 ================
     46 
     47 Documentation (as far as it exists) can be found in the wiki
     48 <http://www.antlr.org/wiki/display/ANTLR3/Antlr3Python3Target>
     49 
     50 
     51 6) REPORTING BUGS
     52 =================
     53 
     54 Please file bug reports on github: <http://github.com/antlr/antlr3>.
     55 
     56 
     57 7) HACKING
     58 ==========
     59 
     60 Only the runtime package can be found here. There are also some StringTemplate
     61 files in 'src/org/antlr/codegen/templates/Python3/' and some Java code in
     62 'src/org/antlr/codegen/Python3Target.java' (of the main ANTLR3 source
     63 distribution).
     64 
     65 If there are no directories 'tests' and 'unittests' in 'runtime/Python3', you
     66 should fetch the latest ANTLR3 version from the perforce depot. See section
     67 DOWNLOAD.
     68 You'll need java and ant in order to compile and use the tool.
     69 Be sure to properly setup your CLASSPATH.
     70 (FIXME: is there some generic information, how to build it yourself? I should
     71 point to it to avoid duplication.)
     72 
     73 You can then use the commands
     74 $ python3 setup.py unittest
     75 $ python3 setup.py functest
     76 to ensure that changes do not break existing behaviour.
     77 
     78 Please send patches as pull requests on github. For larger code contributions
     79 you'll have to sign the "Developer's Certificate of Origin", which can be
     80 found on <http://www.antlr.org/license.html> or use the feedback form at
     81 <http://www.antlr.org/misc/feedback>.
     82