Using XIR

Development

API

  1. Docs
  2. Module code
  3. xir

Source code for xir

from functools import lru_cache
from pathlib import Path

from lark import lark

from ._version import __version__
from .decimal_complex import DecimalComplex
from .parser import Transformer
from .program import Declaration, ObservableFactor, ObservableStmt, Program, Statement
from .validator import Validator

__all__ = [
    "DecimalComplex",
    "Declaration",
    "ObservableFactor",
    "ObservableStmt",
    "Program",
    "Statement",
    "Transformer",
]


def _read_lark_file() -> str:
    """Reads the contents of the XIR Lark grammar file."""
    path = Path(__file__).parent / "xir.lark"
    with path.open("r") as file:
        return file.read()


@lru_cache()
def _get_parser(debug: bool = False, **kwargs):
    """Create parser from options.

    Args:
        debug (bool): if false lark tree building will be skipped, and lark rule collisions
        will not be given a warning
        kwargs: options to be passed to the transformer
    Returns:
        a parsing function
    """

    parser = lark.Lark(
        grammar=_read_lark_file(),
        maybe_placeholders=True,
        start="program",
        parser="lalr",
        debug=debug,
    )

    # TODO: for non-debug mode, add the transformer as an argument to the parser.
    # This change would produce an additional speedup,
    # although requires changing the Transformer class to be
    # stateless. (would need to remove self._program)

    def _inner_script_parser(script):
        """Parse a script.

        Args:
            script (str): XIR script as a string

        Returns:
            xir.Program: program representation of the script
        """

        tree = parser.parse(script)
        return Transformer(**kwargs).transform(tree)

    return _inner_script_parser



[docs]def parse_script(script: str, debug: bool = False, **kwargs) -> Program:
    """Parses an XIR script into a structured :class:`xir.Program`.

    Args:
        script (str): XIR script as a string.
        debug (bool): if false lark tree building will be skipped, and lark rule collisions
            will not be given a warning

    Returns:
        xir.Program: program representation of the script
    """
    return _get_parser(debug, **kwargs)(script)