https://github.com/python/cpython/commit/626668912f3102a96d3f251f5304ad2f8326f3cc
commit: 626668912f3102a96d3f251f5304ad2f8326f3cc
branch: main
author: Emily Morehouse <[email protected]>
committer: emilyemorehouse <[email protected]>
date: 2024-09-27T13:59:26-07:00
summary:
gh-81263: Add assignment expressions to `help` (#124641)
* Add assignment expression (:=) to `help`
* Update index for Assignment Expressions to include pair of `assignment;
expression`
files:
M Doc/reference/expressions.rst
M Lib/pydoc.py
M Lib/pydoc_data/topics.py
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index f734221a2cdec5..ab72ad49d041e1 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -1807,6 +1807,7 @@ returns a boolean value regardless of the type of its
argument
single: assignment expression
single: walrus operator
single: named expression
+ pair: assignment; expression
Assignment expressions
======================
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index d376592d69d40d..eec7b0770f56ca 100644
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -1870,6 +1870,7 @@ class Helper:
':': 'SLICINGS DICTIONARYLITERALS',
'@': 'def class',
'\\': 'STRINGS',
+ ':=': 'ASSIGNMENTEXPRESSIONS',
'_': 'PRIVATENAMES',
'__': 'PRIVATENAMES SPECIALMETHODS',
'`': 'BACKQUOTES',
@@ -1963,6 +1964,7 @@ class Helper:
'ASSERTION': 'assert',
'ASSIGNMENT': ('assignment', 'AUGMENTEDASSIGNMENT'),
'AUGMENTEDASSIGNMENT': ('augassign', 'NUMBERMETHODS'),
+ 'ASSIGNMENTEXPRESSIONS': ('assignment-expressions', ''),
'DELETION': 'del',
'RETURNING': 'return',
'IMPORTING': 'import',
diff --git a/Lib/pydoc_data/topics.py b/Lib/pydoc_data/topics.py
index 4643df80e44aaf..97bb4eb52f4386 100644
--- a/Lib/pydoc_data/topics.py
+++ b/Lib/pydoc_data/topics.py
@@ -416,6 +416,34 @@
'some expressions (like un-parenthesized tuple expressions) '
'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',
'async': 'Coroutines\n'
'**********\n'
'\n'
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
