Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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

This commit is contained in:
Emily Morehouse 2024-10-07 16:51:14 -06:00 committed by GitHub
parent a7f0727ca5
commit 447a15190d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 41 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/reference/expressions.rst
View File

@ -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
======================

4
Doc/tools/extensions/pyspecific.py
View File

@ -353,8 +353,8 @@ class MiscNews(SphinxDirective):
# 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',

64
Lib/pydoc_data/topics.py
View File

@ -417,33 +417,43 @@ topics = {'assert': 'The "assert" statement\n'
'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'
'\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'