mirror of https://github.com/python/cpython
gh-78612: Mark up eval() using param list (#115212)
Also mention that the 'expression' parameter can be a string.
This commit is contained in:
parent
7acf1fb5a7
commit
a71e32ce8e
|
@ -526,9 +526,20 @@ are always available. They are listed here in alphabetical order.
|
||||||
|
|
||||||
.. function:: eval(expression, globals=None, locals=None)
|
.. function:: eval(expression, globals=None, locals=None)
|
||||||
|
|
||||||
The arguments are a string and optional globals and locals. If provided,
|
:param expression:
|
||||||
*globals* must be a dictionary. If provided, *locals* can be any mapping
|
A Python expression.
|
||||||
object.
|
:type expression: :class:`str` | :ref:`code object <code-objects>`
|
||||||
|
|
||||||
|
:param globals:
|
||||||
|
The global namespace (default: ``None``).
|
||||||
|
:type globals: :class:`dict` | ``None``
|
||||||
|
|
||||||
|
:param locals:
|
||||||
|
The local namespace (default: ``None``).
|
||||||
|
:type locals: :term:`mapping` | ``None``
|
||||||
|
|
||||||
|
:returns: The result of the evaluated expression.
|
||||||
|
:raises: Syntax errors are reported as exceptions.
|
||||||
|
|
||||||
The *expression* argument is parsed and evaluated as a Python expression
|
The *expression* argument is parsed and evaluated as a Python expression
|
||||||
(technically speaking, a condition list) using the *globals* and *locals*
|
(technically speaking, a condition list) using the *globals* and *locals*
|
||||||
|
@ -545,8 +556,7 @@ are always available. They are listed here in alphabetical order.
|
||||||
:term:`nested scopes <nested scope>` (non-locals) in the enclosing
|
:term:`nested scopes <nested scope>` (non-locals) in the enclosing
|
||||||
environment.
|
environment.
|
||||||
|
|
||||||
The return value is the result of
|
Example:
|
||||||
the evaluated expression. Syntax errors are reported as exceptions. Example:
|
|
||||||
|
|
||||||
>>> x = 1
|
>>> x = 1
|
||||||
>>> eval('x+1')
|
>>> eval('x+1')
|
||||||
|
|
Loading…
Reference in New Issue