ASTEVAL

.. image:: https://github.com/lmfit/asteval/actions/workflows/ubuntu_numpy.yml/badge.svg :target: https://github.com/lmfit/asteval/actions/workflows/ubuntu_numpy.yml

.. image:: https://github.com/lmfit/asteval/actions/workflows/ubuntu_nonumpy.yml/badge.svg :target: https://github.com/lmfit/asteval/actions/workflows/ubuntu_nonumpy.yml

.. image:: https://github.com/lmfit/asteval/actions/workflows/macos_numpy.yml/badge.svg :target: https://github.com/lmfit/asteval/actions/workflows/macos_numpy.yml

.. image:: https://github.com/lmfit/asteval/actions/workflows/windows_numpy.yml/badge.svg :target: https://github.com/lmfit/asteval/actions/workflows/windows_numpy.yml

.. image:: https://codecov.io/gh/lmfit/asteval/branch/master/graph/badge.svg :target: https://codecov.io/gh/lmfit/asteval

.. image:: https://img.shields.io/pypi/v/asteval.svg :target: https://pypi.org/project/asteval

.. image:: https://img.shields.io/pypi/dm/asteval.svg :target: https://pypi.org/project/asteval

.. image:: https://img.shields.io/badge/docs-read-brightgreen :target: https://lmfit.github.io/asteval/

.. image:: https://zenodo.org/badge/4185/newville/asteval.svg :target: https://zenodo.org/badge/latestdoi/4185/newville/asteval

Links

• Documentation: https://lmfit.github.io/asteval/
• PyPI installation: https://pypi.org/project/asteval/
• Development Code: https://github.com/lmfit/asteval
• Issue Tracker: https://github.com/lmfit/asteval/issues

Installation

Use pip install asteval to install the asteval library.

Asteval requires Python 3.8 or higher. If installed, many functions and constants from Numpy will be used by default.

About ASTEVAL

ASTEVAL is a safe(ish) evaluator of Python expressions and statements, using Python's ast module. The idea is to provide a simple, safe, and robust miniature mathematical language that can handle user input. The emphasis here is on mathematical expressions so that many functions from numpy are imported and used if available.

Many Python language constructs are supported by default, These include slicing, subscripting, list comprehension, conditionals (if-elif-else blocks and if expressions), flow control (for loops, while loops, and try-except-finally blocks). All data are Python objects and built-in data structures (dictionaries, tuples, lists, Numpy arrays, strings) are fully supported by default.

Many of the standard built-in Python functions are available, as are all mathematical functions from the math module. If the Numpy module is installed, many of its functions will also be available. Users can define and run their own functions within the confines of the limitations of Asteval.

There are several absences and differences with Python, and Asteval is by no means an attempt to reproduce Python with its own ast module. Some of the most important differences and absences are:

1. Variable and function symbol names are held in a simple symbol table (a single dictionary), giving a flat namespace.
2. creating classes is not supported.
3. importing modules is not supported by default - it can be enabled.
4. function decorators, yield, lambda, exec, and eval are not supported.
5. files can only be opened in read-only mode.

In addition, accessing many internal methods and classes of objects is forbidden in order to strengthen Asteval against malicious user code.

Matt Newville newville@cars.uchicago.edu Last Update: 30-June-2024