Skip to content

gh-125072: Add label for assignment expressions; update tracked section for assignment expression topic #125074

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2024
Merged

gh-125072: Add label for assignment expressions; update tracked section for assignment expression topic #125074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/reference/expressions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1809,6 +1809,8 @@ returns a boolean value regardless of the type of its argument
single: named expression
pair: assignment; expression

.. _assignment-expressions:

Assignment expressions
======================

Expand Down
4 changes: 2 additions & 2 deletions Doc/tools/extensions/pyspecific.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,8 +353,8 @@ def run(self):
# Support for building "topic help" for pydoc

pydoc_topic_labels = [
'assert', 'assignment', 'async', 'atom-identifiers', 'atom-literals',
'attribute-access', 'attribute-references', 'augassign', 'await',
'assert', 'assignment', 'assignment-expressions', 'async', 'atom-identifiers',
'atom-literals', 'attribute-access', 'attribute-references', 'augassign', 'await',
'binary', 'bitwise', 'bltin-code-objects', 'bltin-ellipsis-object',
'bltin-null-object', 'bltin-type-objects', 'booleans',
'break', 'callable-types', 'calls', 'class', 'comparisons', 'compound',
Expand Down
64 changes: 37 additions & 27 deletions Lib/pydoc_data/topics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,33 +417,43 @@
'caused a\n'
'syntax error.\n',
'assignment-expressions': 'Assignment expressions\n'
'**********************\n'
'\n'
'An assignment expression (sometimes also called a “named expression”'
'\nor “walrus”) assigns an expression to an identifier, while also\n'
'returning the value of the expression.\n'
'\n'
'One common use case is when handling matched regular expressions:\n'
'\n'
' if matching := pattern.search(data):\n'
' do_something(matching)\n'
'\n'
'Or, when processing a file stream in chunks:\n'
'\n'
' while chunk := file.read(9000):\n'
' process(chunk)\n'
'\n'
'Assignment expressions must be surrounded by parentheses when used as\n'
'expression statements and when used as sub-expressions in slicing,\n'
'conditional, lambda, keyword-argument, and comprehension-if\n'
'expressions and in assert, with, and assignment statements. In all\n'
'other places where they can be used, parentheses are not required,\n'
'including in if and while statements.\n'
'\n'
'Added in version 3.8.\n'
'See also:\n'
'\n'
' **PEP 572** - Assignment Expressions\n',
'**********************\n'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems more indented than the lines above -- intentional?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, the original version was incorrect! The new one is actually auto-generated.

'\n'
' assignment_expression ::= [identifier ":="] '
'expression\n'
'\n'
'An assignment expression (sometimes also called a '
'“named expression”\n'
'or “walrus”) assigns an "expression" to an '
'"identifier", while also\n'
'returning the value of the "expression".\n'
'\n'
'One common use case is when handling matched '
'regular expressions:\n'
'\n'
' if matching := pattern.search(data):\n'
' do_something(matching)\n'
'\n'
'Or, when processing a file stream in chunks:\n'
'\n'
' while chunk := file.read(9000):\n'
' process(chunk)\n'
'\n'
'Assignment expressions must be surrounded by '
'parentheses when used as\n'
'expression statements and when used as '
'sub-expressions in slicing,\n'
'conditional, lambda, keyword-argument, and '
'comprehension-if\n'
'expressions and in "assert", "with", and '
'"assignment" statements. In\n'
'all other places where they can be used, '
'parentheses are not required,\n'
'including in "if" and "while" statements.\n'
'\n'
'Added in version 3.8: See **PEP 572** for more '
'details about\n'
'assignment expressions.\n',
'async': 'Coroutines\n'
'**********\n'
'\n'
Expand Down
Loading