sourcer 0.5.0
simple parsing library
License: MIT License
Requires Python: >=3.6
Keywords: packrat,parser,peg

# Sourcer

A parsing library for Python.


## What's it look like?

First, define your grammar:

```python
from sourcer import Grammar
g = Grammar(r'''
    class Greeting {
        salutation: "Hello" | "Hi"i
        audience: Punctuation* >> Word << Punctuation*
    }

    Word = /[a-z]+/i
    Punctuation = "." | "!" | "?" | ","

    ignore /\s+/
    start = Greeting
''')
```

Sourcer compiles your grammar to a Python module.

Then, use your grammar to parse things:

```python
>>> g.parse('Hello, World!')
Greeting(salutation='Hello', audience='World')

>>> g.parse('Hello?? Anybody?!')
Greeting(salutation='Hello', audience='Anybody')

>>> g.parse('hi all')
Greeting(salutation='hi', audience='all')
```


## Installation

Use pip:

```console
$ python3 -m pip install sourcer
```

Sourcer requires Python version 3.6 or later.


## Examples


### Arithmetic Expressions

```python
from sourcer import Grammar

# The Grammar is compiled to a Python module and assigned to "g".
g = Grammar(r'''
    start = Expr

    # Define operatator precedence, from highest to lowest. Use "left" for
    # left associative operators, and "right" for right associative operators.
    Expr = Int between {
        mixfix: '(' >> Expr << ')'
        prefix: '+', '-'
        right: '^'
        postfix: '%'
        left: '*', '/'
        left: '+', '-'
    }

    # Turn integers into Python int objects.
    Int = /\d+/ |> `int`

    # Ignore whitespace.
    ignore /\s+/
''')

# Some examples:

assert g.parse('1 + 2 + 3') == g.Infix(g.Infix(1, '+', 2), '+', 3)

assert g.parse('4 + -5 / 6') == g.Infix(4, '+', g.Infix(g.Prefix('-', 5), '/', 6))

assert g.parse('7 * (8 + 9)') == g.Infix(7, '*', g.Infix(8, '+', 9))
```


### Something Like JSON

Maybe you have to parse something that is a little bit like JSON, but different
enough that you can't use a real JSON parser.

Here's a simple example that you can start with and work from, and build it up
into what you need.

```python
from sourcer import Grammar

g = Grammar(r'''
    # Import Python modules by quoting your import statement in backticks.
    # (You can also use triple backticks to quote multiple lines at once.)
    `from ast import literal_eval`

    # This grammar parses one value.
    start = Value

    # A value is one of these things.
    Value = Object | Array | String | Number | Keyword

    # An object is zero or more members separated by commas, enclosed in
    # curly braces. Convert each into a Python dict.
    Object = "{" >> (Member // ",") << "}" |> `dict`

    # A member is a pair of string literal and value, separated by a colon.
    Member = [String, ":" >> Value]

    # An array is zero or more values separated by commas, enclosed in
    # square braces.
    Array = "[" >> (Value // ",") << "]"

    # Interpret each string as a Python literal string.
    String = /"(?:[^\\"]|\\.)*"/ |> `literal_eval`

    # Interpret each number as a Python float literal.
    Number = /-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?/ |> `float`

    # Convert boolean literals to Python booleans, and "null" to None.
    Keyword = "true" >> `True` | "false" >> `False` | "null" >> `None`

    ignore /\s+/
''')

# Notice that we get back Python dicts, lists, strings, booleans, etc.
result = g.parse('{"foo": "bar", "baz": true}')
assert result == {'foo': 'bar', 'baz': True}

result = g.parse('[12, -34, {"56": 78, "foo": null}]')
assert result == [12, -34, {'56': 78, 'foo': None}]
```

### Using Classes

Classes let you define the types of objects in your parse tree.

```python
from sourcer import Grammar

g = Grammar(r'''
    # A list of commands separated by semicolons.
    start = Command /? ";"

    # A pair of action and range.
    class Command {
        action: "Copy" | "Delete" | "Print"
        range: Range
    }

    # A range (which can be open or closed on either end).
    class Range {
        start: "(" | "["
        left: Int << ","
        right: Int
        end: "]" | ")"
    }

    # Integers.
    Int = /\d+/ |> `int`

    ignore /\s+/
''')

result = g.parse('Print [10, 20); Delete (33, 44];')
assert result == [
    g.Command(action='Print', range=g.Range('[', 10, 20, ')')),
    g.Command(action='Delete', range=g.Range('(', 33, 44, ']')),
]

cmd = result[1]
assert cmd.action == 'Delete'

# The Command objects have position information:
info = cmd._metadata.position_info
assert info.start == g._Position(index=16, line=1, column=17)
assert info.end == g._Position(index=30, line=1, column=31)
```


### Something Like XML

Maybe you have to parse something where you have matching start and end tags.
Here's a simple example that you can work from.

```python
from sourcer import Grammar

g = Grammar(r'''
    # A document is a list of one or more items:
    Document = Item+

    # An item is either an element or some text:
    Item = Element | Text

    # Text goes until it sees a "<" character:
    class Text {
        content: /[^<]+/
    }

    # An element is a pair of matching tags, and zero or more items:
    class Element {
        open: "<" >> Word << ">"
        items: Item*
        close: "</" >> Word << ">" where `lambda x: x == open`
    }

    # A word doesn't have special characters, and doesn't start with a digit:
    Word = /[_a-zA-Z][_a-zA-Z0-9]*/
''')

# We can use the "Document" rule directly:
result = g.Document.parse('To: <party><b>Second</b> Floor Only</party>')

assert result == [
    g.Text('To: '),
    g.Element(
        open='party',
        items=[
            g.Element('b', [g.Text('Second')], 'b'),
            g.Text(' Floor Only'),
        ],
        close='party',
    ),
]

# Similarly, we can use any of our other rules directly, too. For example, maybe
# we just want to parse a single word:
result = g.Word.parse('booyah')
assert result == 'booyah' # (But yes, this doesn't really accomplish anything...)
```


### Significant Indentation

If you ever need to parse something with significant indentation, you can start
with this example and build it up.

```python
from sourcer import Grammar

g = Grammar(r'''
    ignore /[ \t]+/

    Indent = /\n[ \t]*/

    MatchIndent(i) =>
        Indent where `lambda x: x == i`

    IncreaseIndent(i) =>
        Indent where `lambda x: len(x) > len(i)`

    Body(current_indent) =>
        let i = IncreaseIndent(current_indent) in
        Statement(i) // MatchIndent(i)

    Statement(current_indent) =>
        If(current_indent) | Print

    class If(current_indent) {
        test: "if" >> Name
        body: Body(current_indent)
    }

    class Print {
        name: "print" >> Name
    }

    Name = /[a-zA-Z]+/
    Newline = /[\r\n]+/

    Start = Opt(Newline) >> (Statement('') /? Newline)
''')

from textwrap import dedent

result = g.parse('print ok\nprint bye')
assert result == [g.Print('ok'), g.Print('bye')]

result = g.parse('if foo\n  print bar')
assert result == [g.If('foo', [g.Print('bar')])]

result = g.parse(dedent('''
    print ok
    if foo
        if bar
            print baz
            print fiz
        print buz
    print zim
'''))
assert result == [
    g.Print('ok'),
    g.If('foo', [
        g.If('bar', [
            g.Print('baz'),
            g.Print('fiz'),
        ]),
        g.Print('buz'),
    ]),
    g.Print('zim'),
]
```


### More Examples

[Excel formula](https://github.com/jvs/sourcer/tree/master/examples)
and some corresponding
[test cases](https://github.com/jvs/sourcer/blob/master/tests/test_excel.py)


## Background
[Parsing expression grammar](http://en.wikipedia.org/wiki/Parsing_expression_grammar>)

The main thing to know is that the `|` operator represents an ordered choice.


## Parsing Expressions

This is work in progress. The goal is to provide examples of each of the
different parsing expressions.

For now, here's a list of the supported expressions:

- Binding:

    - `let foo = bar in baz` -- parses bar, binding the result to foo, then
      parses baz.

- Class:

    - `class Foo { bar: Bar; baz: Baz }` -- defines a sequence of named elements.

- Expectation (Lookahead):

    - `Expect(foo)` -- parses foo without consuming any input.
    - `ExpectNot(foo)` -- fails if it can parse foo.

- Failure:

    - `Fail(message)` -- fails with the provided error message.

- Function Application:

    - `foo |> bar` -- parses foo then parses bar, then returns `bar(foo)`.
    - `foo <| bar` -- parses foo then parses bar, then returns `foo(bar)`.

- Operator Precedence:

    - `foo between { ... }` -- defines an operator precedence table.

- Option:

    - `foo?` -- parse foo, if that fails then return `None`.
    - `Opt(foo)` -- verbose form of `foo?`.

- Ordered Choice:

    - `foo | bar` -- parses foo, and if that fails, then tries bar.

- Python Expression:

    - `` `foo` `` -- returns the Python value `foo`, without consuming any input.

- Predicate:

    - `foo where bar` -- parses foo, then bar, returning foo only if
      `bar(foo)` returns `True` (or some other truthy value).

- Projection:

    - `foo >> bar` -- parses foo, then parses bar, returning only bar.
    - `foo << bar` -- parses foo, then parses bar, returning only foo.

- Regular Expression:

    - `/foo/` -- matches the regular expression foo.
    - `/foo/i` -- matches the regular expression foo, ignoring case.
    - `/(?i)foo/` -- matches the regular expression foo, also ignoring case.

- Repetition:

    - `foo*` -- parses foo zero or more times, returning the results in a list.
    - `foo+` -- parses foo one or more times.
    - `List(foo)` -- verbose form of `foo*`.
    - `Some(foo)` -- verbose form of `foo+`.

- Separated List:

    - `foo /? bar` -- parses a list of foo separated by bar, consuming
      an optional trailing separator.
    - `foo // bar` -- parses a list of foo separated by bar, and does
      not consume a trailing separator.
    - In both cases, returns the list of foo values and discards the bar
      values.

- Sequence:

    - `[foo, bar, baz]` -- parses foo, then bar, then baz, returning the
      results in a list.

- String Matching:

    - `'foo'` -- matches the string "foo".
    - `'foo'i` -- matches the string "foo", ignoring case.

- Template Instatiation:

    - `foo(bar)` -- parses the rule foo using the parsing expression bar.


### Generating A Python File

Really quickly, if you want to generate Python source code from your grammar,
and perhaps save the source to a file, here's an example:

```python
from sourcer import Grammar

g = Grammar(
    r'''
        start = "Hello" >> /[a-zA-Z]+/

        ignore /[ \t]+/
        ignore "," | "." | "!" | "?"
    ''',

    # Add the optional "include_source" flag:
    include_source=True,
)

# The Python code is in the `_source_code` field:
assert 'def parse' in g._source_code
```

You can then take the `_source_code` field of your grammar and write it to a
file as part of your build.


## Why does this exist?

Sometimes you have to parse things, and sometimes a regex won't cut it.

Things you might have to parse someday:

- log files
- business rules
- market data feeds
- equations
- queries
- user input
- domain specific languages
- obscure data formats
- legacy source code

So that's what this library is for. It's for when you have to take some text
and turn it into a tree of Python objects.


#### But aren't there a ton of parsing libraries for Python already?

Yes, there are. Most of them focus on different problems. Sourcer focuses on the
output of parsing, rather than the means. The main point of Sourcer is that you
can just define the thing that you really want, and then get on with your life.


## Features

- Supports Python version 3.6 and later.
- Create parsers at runtime, or generate Python source code as part of your build.
- Implements [Parsing Expression Grammars](http://en.wikipedia.org/wiki/Parsing_expression_grammar)
  (where "|" represents ordered choice).
- Built-in support for operator precedence parsing.
- Supports inline Python, for defining predicates and transformations directly
  within grammars.
- Supports class definitions for defining the structure of your parse trees.
- Each rule in a grammar becomes a top-level function in the generated Python
  module, so you can use a grammar as a parsing library, rather than just a
  monolithic "parse" function.
- Supports data dependent rules, for things like:
    - significant indentation
    - matching start and end tags