-
-
Notifications
You must be signed in to change notification settings - Fork 29.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-78612: Mark up eval() using param list #115212
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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 |
---|---|---|
|
@@ -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. | ||
Comment on lines
+541
to
+542
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These two sentences were copied verbatim from the original text. I don't think it makes sense to expand the scope of this PR to include tweaking the wording in these two sentences. |
||
|
||
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') | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is currently the only function in the page to use
:param:
. Are you planning to update some/all the others as well?If not, I think it might be better to keep the original paragraph. Mentioning that it accepts code objects and adding links to that and to "mapping" are good changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it matters that only one function is marked up better. In any case, there are other good candidates:
compile()
exec()
open()
print()
__import__()
Possibly also:
setattr()
sorted()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FTR, I'd suggest adapting one at the time.