hotxlfp

hotxlfp intends to be a python version of the javascript handsontable excel formula parser differences are acceptable to make it more pythonic or the function implementations more correct.

Install

You can install using pip

pip install hotxlfp

Usage

Create a Parser

import hotxlfp
p = hotxlfp.Parser()

Parse excel formulas

p.parse('SUM(1,2,3)') # returns {'result': 6, 'error': None}

It's also fine to use semi-colons as separators (they're used by excel depending on your locale)

p.parse('SUM(1;2;3)') # returns {'result': 6, 'error': None}

Custom functions

Say you have a function called triple:

def triple(x):
    return x*3

You can teach the parser to use it with set_function

p.set_function('TRIPLE', triple)
p.parse('TRIPLE(2)') # returns {'result': 6, 'error': None}

Variables

You can also set variables that you can then use in your formulas

p.set_variable('foo', 33)
p.parse('foo/3') # returns {'result': 11.0, 'error': None}

Contributing

Fork the project

Installing Dependencies

Depends on ply and python-dateutil.

This project uses uv to manage dependencies and the virtual environment. To install dependencies automatically run:

uv sync

Updating Dependencies

To upgrade ply/python-dateutil to their latest compatible versions and update uv.lock accordingly:

uv lock --upgrade

Commit the updated uv.lock along with your change.

Testing

uv run python -m unittest discover

Coverage

uv run coverage run --source hotxlfp -m unittest discover

Update SUPPORTED_FORMULAS.md

Inside the project directory run:

uv run python -m "scripts.update_supported_formulas"