/usr/lib/python2.7/dist-packages/simpleeval-0.9.5.egg-info/PKG-INFO is in python-simpleeval 0.9.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | Metadata-Version: 1.1
Name: simpleeval
Version: 0.9.5
Summary: A simple, safe single expression evaluator library.
Home-page: https://github.com/danthedeckie/simpleeval
Author: Daniel Fairhead
Author-email: danthedeckie@gmail.com
License: UNKNOWN
Download-URL: https://github.com/danthedeckie/simpleeval/tarball/0.9.5
Description-Content-Type: UNKNOWN
Description: simpleeval (Simple Eval)
========================
.. image:: https://travis-ci.org/danthedeckie/simpleeval.svg?branch=master
:target: https://travis-ci.org/danthedeckie/simpleeval
:alt: Build Status
.. image:: https://coveralls.io/repos/github/danthedeckie/simpleeval/badge.svg?branch=master
:target: https://coveralls.io/r/danthedeckie/simpleeval?branch=master
:alt: Coverage Status
.. image:: https://badge.fury.io/py/simpleeval.svg
:target: https://badge.fury.io/py/simpleeval
:alt: PyPI Version
A quick single file library for easily adding evaluatable expressions into
python projects. Say you want to allow a user to set an alarm volume, which
could depend on the time of day, alarm level, how many previous alarms had gone
off, and if there is music playing at the time.
Or if you want to allow simple formulae in a web application, but don't want to
give full eval() access, or don't want to run in javascript on the client side.
It's deliberately very simple, pull it in from PyPI (pip or easy_install), or
even just a single file you can dump into a project.
Internally, it's using the amazing python ``ast`` module to parse the
expression, which allows very fine control of what is and isn't allowed. It
should be completely safe in terms of what operations can be performed by the
expression.
The only issue I know to be aware of is that you can create an expression which
takes a long time to evaluate, or which evaluating requires an awful lot of
memory, which leaves the potential for DOS attacks. There is basic protection
against this, and you can lock it down further if you desire. (see the
Operators_ section below)
You should be aware of this when deploying in a public setting.
The defaults are pretty locked down and basic, and it's very easy to add
whatever extra specific functionality you need (your own functions,
variable/name lookup, etc).
Basic Usage
-----------
To get very simple evaluating:
.. code-block:: python
from simpleeval import simple_eval
simple_eval("21 + 21")
returns ``42``.
Expressions can be as complex and convoluted as you want:
.. code-block:: python
simple_eval("21 + 19 / 7 + (8 % 3) ** 9")
returns ``535.714285714``.
You can add your own functions in as well.
.. code-block:: python
simple_eval("square(11)", functions={"square": lambda x: x*x})
returns ``121``.
For more details of working with functions, read further down.
Note:
~~~~~
all further examples use ``>>>`` to designate python code, as if you are using
the python interactive prompt.
.. _Operators:
Operators
---------
You can add operators yourself, using the ``operators`` argument, but these are
the defaults:
+--------+------------------------------------+
| ``+`` | add two things. ``x + y`` |
| | ``1 + 1`` -> ``2`` |
+--------+------------------------------------+
| ``-`` | subtract two things ``x - y`` |
| | ``100 - 1`` -> ``99`` |
+--------+------------------------------------+
| ``/`` | divide one thing by another |
| | ``x / y`` |
| | ``100/10`` -> ``10`` |
+--------+------------------------------------+
| ``*`` | multiple one thing by another |
| | ``x * y`` |
| | ``10 * 10`` -> ``100`` |
+--------+------------------------------------+
| ``**`` | 'to the power of' ``x**y`` |
| | ``2 ** 10`` -> ``1024`` |
+--------+------------------------------------+
| ``%`` | modulus. (remainder) ``x % y`` |
| | ``15 % 4`` -> ``3`` |
+--------+------------------------------------+
| ``==`` | equals ``x == y`` |
| | ``15 == 4`` -> ``False`` |
+--------+------------------------------------+
| ``<`` | Less than. ``x < y`` |
| | ``1 < 4`` -> ``True`` |
+--------+------------------------------------+
| ``>`` | Greater than. ``x > y`` |
| | ``1 > 4`` -> ``False`` |
+--------+------------------------------------+
| ``<=`` | Less than or Equal to. ``x <= y`` |
| | ``1 < 4`` -> ``True`` |
+--------+------------------------------------+
| ``>=`` | Greater or Equal to ``x >= 21`` |
| | ``1 >= 4`` -> ``False`` |
+--------+------------------------------------+
| ``in`` | is something contained within |
| | something else. |
| | ``"spam" in "my breakfast"`` |
| | -> ``False`` |
+--------+------------------------------------+
The ``^`` operator is notably missing - not because it's hard, but because it
is often mistaken for a exponent operator, not the bitwise operation that it is
in python. It's trivial to add back in again if you wish (using the class
based evaluator explained below):
.. code-block:: python
>>> import ast
>>> import operator
>>> s = SimpleEval()
>>> s.operators[ast.BitXor] = operator.xor
>>> s.eval("2 ^ 10")
8
Limited Power
~~~~~~~~~~~~~
Also note, the ``**`` operator has been locked down by default to have a
maximum input value of ``4000000``, which makes it somewhat harder to make
expressions which go on for ever. You can change this limit by changing the
``simpleeval.POWER_MAX`` module level value to whatever is an appropriate value
for you (and the hardware that you're running on) or if you want to completely
remove all limitations, you can set the ``s.operators[ast.Pow] = operator.pow``
or make your own function.
On my computer, ``9**9**5`` evaluates almost instantly, but ``9**9**6`` takes
over 30 seconds. Since ``9**7`` is ``4782969``, and so over the ``POWER_MAX``
limit, it throws a ``NumberTooHigh`` exception for you. (Otherwise it would go
on for hours, or until the computer runs out of memory)
Strings (and other Iterables) Safety
~~~~~~~~~~~~~
There are also limits on string length (100000 characters,
``MAX_STRING_LENGTH``). This can be changed if you wish.
Related to this, if you try to create a silly long string/bytes/list, by doing
``'i want to break free'.split() * 9999999999`` for instance, it will block you.
If Expressions
--------------
You can use python style ``if x then y else z`` type expressions:
.. code-block:: python
>>> simple_eval("'equal' if x == y else 'not equal'",
names={"x": 1, "y": 2})
'not equal'
which, of course, can be nested:
.. code-block:: python
>>> simple_eval("'a' if 1 == 2 else 'b' if 2 == 3 else 'c'")
'c'
Functions
---------
You can define functions which you'd like the expresssions to have access to:
.. code-block:: python
>>> simple_eval("double(21)", functions={"double": lambda x:x*2})
42
You can define "real" functions to pass in rather than lambdas, of course too,
and even re-name them so that expressions can be shorter
.. code-block:: python
>>> def double(x):
return x * 2
>>> simple_eval("d(100) + double(1)", functions={"d": double, "double":double})
202
If you don't provide your own ``functions`` dict, then the the following defaults
are provided in the ``DEFAULT_FUNCTIONS`` dict:
+----------------+--------------------------------------------------+
| ``randint(x)`` | Return a random ``int`` below ``x`` |
+----------------+--------------------------------------------------+
| ``rand()`` | Return a random ``float`` between 0 and 1 |
+----------------+--------------------------------------------------+
| ``int(x)`` | Convert ``x`` to an ``int``. |
+----------------+--------------------------------------------------+
| ``float(x)`` | Convert ``x`` to a ``float``. |
+----------------+--------------------------------------------------+
| ``str(x)`` | Convert ``x`` to a ``str`` (``unicode`` in py2) |
+----------------+--------------------------------------------------+
If you want to provide a list of functions, but want to keep these as well,
then you can do a normal python ``.copy()`` & ``.update``:
.. code-block:: python
>>> my_functions = simpleeval.DEFAULT_FUNCTIONS.copy()
>>> my_functions.update(
square=(lambda x:x*x),
double=(lambda x:x+x),
)
>>> simple_eval('square(randint(100))', functions=my_functions)
Names
-----
Sometimes it's useful to have variables available, which in python terminology
are called 'names'.
.. code-block:: python
>>> simple_eval("a + b", names={"a": 11, "b": 100})
111
You can also hand the handling of names over to a function, if you prefer:
.. code-block:: python
>>> def name_handler(node):
return ord(node.id[0].lower(a))-96
>>> simple_eval('a + b', names=name_handler)
3
That was a bit of a silly example, but you could use this for pulling values
from a database or file, say, or doing some kind of caching system.
The two default names that are provided are ``True`` and ``False``. So if you want to provide your own names, but want ``True`` and ``False`` to keep working, either provide them yourself, or ``.copy()`` and ``.update`` the ``DEFAULT_NAMES``. (See functions example above).
Creating an Evaluator Class
---------------------------
Rather than creating a new evaluator each time, if you are doing a lot of
evaluations, you can create a SimpleEval object, and pass it expressions each
time (which should be a bit quicker, and certainly more convenient for some use
cases):
.. code-block:: python
>>> s = SimpleEval()
>>> s.eval("1 + 1")
2
>>> s.eval('100 * 10')
1000
# and so on...
You can assign / edit the various options of the ``SimpleEval`` object if you
want to. Either assign them during creation (like the ``simple_eval``
function)
.. code-block:: python
def boo():
return 'Boo!'
s = SimpleEval(functions={"boo": boo})
or edit them after creation:
.. code-block:: python
s.names['fortytwo'] = 42
this actually means you can modify names (or functions) with functions, if you
really feel so inclined:
.. code-block:: python
s = SimpleEval()
def set_val(name, value):
s.names[name.value] = value.value
return value.value
s.functions = {'set': set_val}
s.eval("set('age', 111)")
Say. This would allow a certain level of 'scriptyness' if you had these
evaluations happening as callbacks in a program. Although you really are
reaching the end of what this library is intended for at this stage.
Compound Types
--------------
Compound types (``dict``, ``tuple``, ``list``, ``set``) in general just work if
you pass them in as named objects. If you want to allow creation of these, the
``EvalWithCompoundTypes`` class works. Just replace any use of ``SimpleEval`` with
that.
Extending
---------
The ``SimpleEval`` class is pretty easy to extend. For instance, to create a
version that disallows method invocation on objects:
.. code-block:: python
import ast
import simpleeval
class EvalNoMethods(simpleeval.SimpleEval):
def _eval_call(self, node):
if isinstance(node.func, ast.Attribute):
raise simpleeval.FeatureNotAvailable("No methods please, we're British")
return super(EvalNoMethods, self)._eval_call(node)
and then use ``EvalNoMethods`` instead of the ``SimpleEval`` class.
Other...
--------
The library supports both python 2 and 3.
Object attributes that start with ``_`` or ``func_`` are disallowed by default.
If you really need that (BE CAREFUL!), then modify the module global
``simpleeval.DISALLOW_PREFIXES``.
Please read the ``test_simpleeval.py`` file for other potential gotchas or
details. I'm very happy to accept pull requests, suggestions, or other issues.
Enjoy!
Keywords: eval,simple,expression,parse,ast
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python
|