https://github.com/python/cpython/commit/a71e32ce8e183023fc1ee401c22ebe35e4832f09
commit: a71e32ce8e183023fc1ee401c22ebe35e4832f09
branch: main
author: Erlend E. Aasland <erl...@python.org>
committer: erlend-aasland <erlend.aasl...@protonmail.com>
date: 2024-02-28T14:03:50+01:00
summary:
gh-78612: Mark up eval() using param list (#115212)
Also mention that the 'expression' parameter can be a string.
files:
M Doc/library/functions.rst
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index a4852b922b65b3..e598ef423de497 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -526,9 +526,20 @@ are always available. They are listed here in
alphabetical order.
.. function:: eval(expression, globals=None, locals=None)
- The arguments are a string and optional globals and locals. If provided,
- *globals* must be a dictionary. If provided, *locals* can be any mapping
- object.
+ :param expression:
+ A Python expression.
+ :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
(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
environment.
- The return value is the result of
- the evaluated expression. Syntax errors are reported as exceptions.
Example:
+ Example:
>>> x = 1
>>> eval('x+1')
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
