-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,40 +38,36 @@ Links | |
* Issue Tracker: https://github.com/lmfit/asteval/issues | ||
|
||
Installation | ||
---------- | ||
------------ | ||
|
||
To install the asteval module, use:: | ||
pip install asteval | ||
Use ``pip install asteval`` to install the asteval library. | ||
|
||
or download and unack the source package and use | ||
pip install . | ||
|
||
Asteval require Python 3.8 or higher. If installed, many functions and | ||
constants from numpy will be used by default. | ||
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, and so many functions from | ||
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 lanquage constructs are supported by default, These include | ||
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, tuple, lists, numpy arrays, strings) are fully | ||
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 builtin python functions are available, as are all | ||
mathemetical functions from the math module. If the numpy module is | ||
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. | ||
Asteval. | ||
|
||
There are several absences and differences with Python, and asteval is by | ||
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: | ||
|
||
|
@@ -83,7 +79,7 @@ the most important differences and absences are: | |
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. | ||
forbidden in order to strengthen Asteval against malicious user code. | ||
|
||
|
||
Matt Newville <[email protected]> | ||
|