Parse and compile Excel formulas and workbooks in python code.
Project description
What is formulas?
formulas implements an interpreter for Excel formulas, which parses and compile Excel formulas expressions.
Moreover, it compiles Excel workbooks to python and executes without using the Excel COM server. Hence, Excel is not needed.
Installation
To install it use (with root privileges):
$ pip install formulas
Or download the last git version and use (with root privileges):
$ python setup.py install
Install extras
Some additional functionality is enabled installing the following extras:
- excel: enables to compile Excel workbooks to python and execute
using: ExcelModel.
plot: enables to plot the formula ast and the Excel model.
To install formulas and all extras, do:
$ pip install formulas[all]
Basic Examples
The following sections will show how to:
parse a Excel formulas;
load, compile, and execute a Excel workbook;
extract a sub-model from a Excel workbook;
add a custom function.
Parsing formula
An example how to parse and execute an Excel formula is the following:
>>> import formulas
>>> func = formulas.Parser().ast('=(1 + 1) + B3 / A2')[1].compile()
To visualize formula model and get the input order you can do the following:
>>> list(func.inputs) ['A2', 'B3'] >>> func.plot(view=False) # Set view=True to plot in the default browser. SiteMap([(=((1 + 1) + (B3 / A2)), SiteMap())])[graph]
Finally to execute the formula and plot the workflow:
>>> func(1, 5) OperatorArray(7.0, dtype=object) >>> func.plot(workflow=True, view=False) # Set view=True to plot in the default browser. SiteMap([(=((1 + 1) + (B3 / A2)), SiteMap())])[graph]
Excel workbook
An example how to load, calculate, and write an Excel workbook is the following:
>>> import formulas
>>> fpath = 'file.xlsx'
>>> xl_model = formulas.ExcelModel().loads(fpath).finish()
>>> xl_model.calculate()
Solution(...)
>>> xl_model.write()
{'EXCEL.XLSX': {Book: <openpyxl.workbook.workbook.Workbook ...>}}
- Tip: If you have or could have circular references, add
circular=True to finish method.
To plot the dependency graph that depict relationships between Excel cells:
>>> dsp = xl_model.dsp >>> dsp.plot(view=False) # Set view=True to plot in the default browser. SiteMap([(Dispatcher ..., SiteMap())])[graph]
To compile, execute, and plot a Excel sub-model you can do the following:
>>> inputs = ["'[EXCEL.XLSX]DATA'!A2"] # input cells >>> outputs = ["'[EXCEL.XLSX]DATA'!C2"] # output cells >>> func = xl_model.compile(inputs, outputs) >>> func(2).value[0,0] 4.0 >>> func.plot(view=False) # Set view=True to plot in the default browser. SiteMap([(Dispatcher ..., SiteMap())])[graph]
Custom functions
An example how to add a custom function to the formula parser is the following:
>>> import formulas
>>> FUNCTIONS = formulas.get_functions()
>>> FUNCTIONS['MYFUNC'] = lambda x, y: 1 + y + x
>>> func = formulas.Parser().ast('=MYFUNC(1, 2)')[1].compile()
>>> func()
4
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file formulas-0.1.4.tar.gz.
File metadata
- Download URL: formulas-0.1.4.tar.gz
- Upload date:
- Size: 169.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ff33d7fee80dbbb250c3598821168b59e5b5454faf2da322563dc5000832a23d |
|
| MD5 | 6f15328ddec3017ab1956ee2d4bfa557 |
|
| BLAKE2b-256 | 09677254441608492a1c2010819732d66255b2fe7ebc34d28d17d9d86e463083 |
File details
Details for the file formulas-0.1.4-py3-none-any.whl.
File metadata
- Download URL: formulas-0.1.4-py3-none-any.whl
- Upload date:
- Size: 36.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e9d883f7f90e2f4fbef6b2889e2fd43506db7b0d591333dcabf8aeea5fe99fc7 |
|
| MD5 | 6c783f715ad72b173ff4a1f4ec86e404 |
|
| BLAKE2b-256 | b7eaacc06c8b5f29edd5ae14f626c2bb01d7327b7e0e4b0755474008fc57b5a3 |
