funcparserlib

Recursive descent parsing library for Python based on functional combinators.

Description

Parser combinators are just higher-order functions that take parsers as their arguments and return them as result values. Parser combinators are:

• First-class values
• Extremely composable
• Tend to make the code quite compact
• Resemble the readable notation of xBNF grammars

Parsers made with funcparserlib are pure-Python LL(*) parsers. It means that it's very easy to write them without thinking about lookaheads and all that hardcore parsing stuff. However, the recursive descent parsing is a rather slow method compared to LL(k) or LR(k) algorithms.

So the primary domain for funcparserlib is parsing little languages or external DSLs (domain specific languages).

The library itself is very small. Its source code is only 600 lines of code, with lots of comments included. It features the longest parsed prefix error reporting, as well as a tiny lexer generator for token position tracking.

Show Me the Code

This is an excerpt from a JSON parser (RFC 4627) written using funcparserlib. This full example as well as others can be found here.

def parse(seq):
    """Sequence(Token) -> object"""
    ...
    n = lambda s: tok("Name", s)
    def make_array(values):
        if values is None:
            return []
        else:
            return [values[0]] + values[1]
    ...
    null = n("null") >> const(None)
    true = n("true") >> const(True)
    false = n("false") >> const(False)
    number = tok("Number") >> make_number
    string = tok("String") >> make_string
    value = forward_decl()
    member = string + -op(":") + value >> tuple
    object = (
        -op("{") +
        maybe(member + many(-op(",") + member)) +
        -op("}")
        >> make_object)
    array = (
        -op("[") +
        maybe(value + many(-op(",") + value)) +
        -op("]")
        >> make_array)
    value.define(
          null
        | true
        | false
        | object
        | array
        | number
        | string)
    json_text = object | array
    json_file = json_text + -finished

    return json_file.parse(seq)

Installation

You can install the funcparserlib library from PyPI via pip:

$ pip install funcparserlib

There are no dependencies on other libraries.

Documentation

• Nested Brackets Mini-HOWTO
  • A short intro to funcparserlib
• Tutorial
  • The comprehensive funcparserlib tutorial

See also comments inside the modules funcparserlib.parser and funcparserlib.lexer or generate the API docs from the modules using pydoc.

There a couple of examples available in the tests/ directory:

• GraphViz DOT parser
• JSON parser

See also the changelog and FAQ.

Performance and Code Size

Despite being an LL(*) parser, funcparserlib has a reasonable performance. For example, a JSON parser written using funcparserlib is 3 times faster than a parser using the popular pyparsing library and only 5 times slower than the specialized JSON library simplejson that uses ad hoc parsing. Here are some stats:

Both funcparserlib and pyparsing have the smallest user code size (that is a common feature of parsing libraries compared to ad hoc parsers). The library code of funcparserlib is 7 times smaller (and much cleaner) than pyparsing. The json-ply uses a LALR parser ply (similar to Yacc) and performs like funcparserlib. cjson is a C library, hence the incredible performance :)

Used By

Some open-source projects that use funcparserlib as an explicit dependency:

• https://github.com/hylang/hy
  • 3.8K stars, version >= 0.3.6, Python 3.6+
• https://github.com/scrapinghub/splash
  • 3.3K stars, version *. Python 3 in Docker
• https://github.com/klen/graphite-beacon
  • 460 stars, version ==0.3.6, Python 2 and 3
• https://github.com/blockdiag/blockdiag
  • 118 stars, version *, Python 3.5+
• https://github.com/pyta-uoft/pyta
  • 48 stars, version *, Python 3.8+

Usages in tests / secondary dependencies:

• https://github.com/buildbot/buildbot
  • 4.6K stars, version == 0.3.6
• https://github.com/quay/quay
  • 1.7K stars, version ==0.3.6

Similar Projects

• LEPL. A recursive descent parsing library that uses two-way generators for backtracking. Its source code is rather large: 17 KLOC.
• pyparsing. A recursive descent parsing library. Probably the most popular Python parsing library. Nevertheless, its source code is quite dirty (though 4 KLOC only).
• Monadic Parsing in Python. A series of blog entries on monadic parsing.
• Pysec (aka Parsec in Python). A blog entry on monadic parsing, with nice syntax for Python.