Skip to main content

A lightweight LaTeX-to-Python parser

Project description

LaTeX-to-Python Parser (latex2py)

This is a lightweight LaTeX-to-Python parser.

We needed a parser that could convert LaTeX math expressions into Python-like expressions. However, SymPy is an extremely large library (~50 MB) and leads to bundle size issues when deploying code as an AWS lambda function (max. size 250MB). This codebase strips out the minimal code that we need, and is around ~200kb in size.

The parser is inspired by the sympy LaTeX parser, but instead of returning symbolic SymPy expressions, we return lines of Python-like code which could can then be evaluated in the interpreter.

Setup

Run poetry install to create a virtual environment and install dependencies.

You can also run poetry shell to activate the virtual environment.

Usage

from latex2py.parser import parse_latex

latex = r'\frac{1}{2} + \frac{3}{4}'
python = parse_latex(latex)
print(python) # "(1 / 2) + (3 / 4)"

# You can also evaluate the expression
result = eval(python)
print(result) # 1.25

Important Notes

  • Integrals and derivatives are not supported yet.
  • The \\sum and \\prod commands are mapped to special Sum() and Product() functions that the calling code will have to implement. See the tests for examples.
  • Variables like HelloWorld, Hello_World, or even Hello.world are interpreted as Python-like variables and object properties. Usually, LaTeX would treat these as implicit multiplication. Multiplication must be made explicit using \\cdot or *.

You can also adjust the parsing behavior using the Config object - see latex2py/config.py for more details.

Tests

Run pytest tests to run the test suite. You can find examples of parseable LaTeX syntex there too.

Re-Generating the Grammar (Advanced)

If you make changes to LaTeX.g4, you will need to regenerate the parser using the following commands:

pip install antlr4-tools
# This will download the antlr4 jar file if you don't have it already.

cd src/latex2py/parser
antlr4 LaTeX.g4 -o gen

The generated files will be in the gen directory.

Publishing to PyPI (Maintainers)

  1. Update the version number in pyproject.toml.
  2. Run poetry build to build the package.
  3. Run poetry publish to publish the package to PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

latex2py-0.2.1.tar.gz (51.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

latex2py-0.2.1-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

Details for the file latex2py-0.2.1.tar.gz.

File metadata

  • Download URL: latex2py-0.2.1.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Darwin/23.3.0

File hashes

Hashes for latex2py-0.2.1.tar.gz
Algorithm Hash digest
SHA256 aff4226fedd457585ad4251d9c230259fc5dbbb89e0386f24c49d35d8f260555
MD5 8d43218b8721ccc41e3850000d720209
BLAKE2b-256 dd676fdf5edced7e0f1691cca287973683cae9dea6bf8572bea5c77875e43f25

See more details on using hashes here.

File details

Details for the file latex2py-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: latex2py-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 53.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Darwin/23.3.0

File hashes

Hashes for latex2py-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b254d5d606406a8645b8331f512af0acc4029a969bae147f6960bf0c9559d885
MD5 45e5adaf78f07895e55c1c922318d11e
BLAKE2b-256 f2a2a4b2391cacf086e571e2c6b8de7d378bd3720fea3d26386a6820ed2ed3bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page