summaryrefslogtreecommitdiffstats
path: root/Lib/pydoc_data/topics.py
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/pydoc_data/topics.py')
-rw-r--r--Lib/pydoc_data/topics.py304
1 files changed, 176 insertions, 128 deletions
diff --git a/Lib/pydoc_data/topics.py b/Lib/pydoc_data/topics.py
index 14c6dc2..7bba5cb 100644
--- a/Lib/pydoc_data/topics.py
+++ b/Lib/pydoc_data/topics.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# Autogenerated by Sphinx on Sun Sep 11 20:22:13 2022
+# Autogenerated by Sphinx on Mon Oct 24 18:35:07 2022
topics = {'assert': 'The "assert" statement\n'
'**********************\n'
'\n'
@@ -1671,10 +1671,26 @@ topics = {'assert': 'The "assert" statement\n'
'If the syntax "**expression" appears in the function call,\n'
'"expression" must evaluate to a *mapping*, the contents of which '
'are\n'
- 'treated as additional keyword arguments. If a keyword is already\n'
- 'present (as an explicit keyword argument, or from another '
- 'unpacking),\n'
- 'a "TypeError" exception is raised.\n'
+ 'treated as additional keyword arguments. If a parameter matching a '
+ 'key\n'
+ 'has already been given a value (by an explicit keyword argument, '
+ 'or\n'
+ 'from another unpacking), a "TypeError" exception is raised.\n'
+ '\n'
+ 'When "**expression" is used, each key in this mapping must be a\n'
+ 'string. Each value from the mapping is assigned to the first '
+ 'formal\n'
+ 'parameter eligible for keyword assignment whose name is equal to '
+ 'the\n'
+ 'key. A key need not be a Python identifier (e.g. ""max-temp °F"" '
+ 'is\n'
+ 'acceptable, although it will not match any formal parameter that '
+ 'could\n'
+ 'be declared). If there is no match to a formal parameter the '
+ 'key-value\n'
+ 'pair is collected by the "**" parameter, if there is one, or if '
+ 'there\n'
+ 'is not, a "TypeError" exception is raised.\n'
'\n'
'Formal parameters using the syntax "*identifier" or "**identifier"\n'
'cannot be used as positional argument slots or as keyword argument\n'
@@ -2022,7 +2038,7 @@ topics = {'assert': 'The "assert" statement\n'
'\n'
'* Mappings (instances of "dict") compare equal if and only if '
'they\n'
- ' have equal *(key, value)* pairs. Equality comparison of the '
+ ' have equal "(key, value)" pairs. Equality comparison of the '
'keys and\n'
' values enforces reflexivity.\n'
'\n'
@@ -2398,35 +2414,43 @@ topics = {'assert': 'The "assert" statement\n'
' try3_stmt ::= "try" ":" suite\n'
' "finally" ":" suite\n'
'\n'
+ 'Additional information on exceptions can be found in section\n'
+ 'Exceptions, and information on using the "raise" statement to '
+ 'generate\n'
+ 'exceptions may be found in section The raise statement.\n'
+ '\n'
+ '\n'
+ '"except" clause\n'
+ '---------------\n'
+ '\n'
'The "except" clause(s) specify one or more exception handlers. '
'When no\n'
'exception occurs in the "try" clause, no exception handler is\n'
'executed. When an exception occurs in the "try" suite, a search '
'for an\n'
- 'exception handler is started. This search inspects the except '
- 'clauses\n'
- 'in turn until one is found that matches the exception. An '
- 'expression-\n'
- 'less except clause, if present, must be last; it matches any\n'
- 'exception. For an except clause with an expression, that '
- 'expression\n'
- 'is evaluated, and the clause matches the exception if the '
- 'resulting\n'
- 'object is “compatible” with the exception. An object is '
- 'compatible\n'
- 'with an exception if the object is the class or a *non-virtual '
- 'base\n'
- 'class* of the exception object, or a tuple containing an item '
- 'that is\n'
- 'the class or a non-virtual base class of the exception object.\n'
- '\n'
- 'If no except clause matches the exception, the search for an '
+ 'exception handler is started. This search inspects the "except"\n'
+ 'clauses in turn until one is found that matches the exception. '
+ 'An\n'
+ 'expression-less "except" clause, if present, must be last; it '
+ 'matches\n'
+ 'any exception. For an "except" clause with an expression, that\n'
+ 'expression is evaluated, and the clause matches the exception if '
+ 'the\n'
+ 'resulting object is “compatible” with the exception. An object '
+ 'is\n'
+ 'compatible with an exception if the object is the class or a '
+ '*non-\n'
+ 'virtual base class* of the exception object, or a tuple '
+ 'containing an\n'
+ 'item that is the class or a non-virtual base class of the '
'exception\n'
- 'handler continues in the surrounding code and on the invocation '
- 'stack.\n'
- '[1]\n'
+ 'object.\n'
+ '\n'
+ 'If no "except" clause matches the exception, the search for an\n'
+ 'exception handler continues in the surrounding code and on the\n'
+ 'invocation stack. [1]\n'
'\n'
- 'If the evaluation of an expression in the header of an except '
+ 'If the evaluation of an expression in the header of an "except" '
'clause\n'
'raises an exception, the original search for a handler is '
'canceled and\n'
@@ -2436,24 +2460,24 @@ topics = {'assert': 'The "assert" statement\n'
'raised\n'
'the exception).\n'
'\n'
- 'When a matching except clause is found, the exception is '
+ 'When a matching "except" clause is found, the exception is '
'assigned to\n'
- 'the target specified after the "as" keyword in that except '
- 'clause, if\n'
- 'present, and the except clause’s suite is executed. All except\n'
- 'clauses must have an executable block. When the end of this '
+ 'the target specified after the "as" keyword in that "except" '
+ 'clause,\n'
+ 'if present, and the "except" clause’s suite is executed. All '
+ '"except"\n'
+ 'clauses must have an executable block. When the end of this '
'block is\n'
- 'reached, execution continues normally after the entire try '
- 'statement.\n'
- '(This means that if two nested handlers exist for the same '
- 'exception,\n'
- 'and the exception occurs in the try clause of the inner handler, '
- 'the\n'
- 'outer handler will not handle the exception.)\n'
+ 'reached, execution continues normally after the entire "try"\n'
+ 'statement. (This means that if two nested handlers exist for the '
+ 'same\n'
+ 'exception, and the exception occurs in the "try" clause of the '
+ 'inner\n'
+ 'handler, the outer handler will not handle the exception.)\n'
'\n'
'When an exception has been assigned using "as target", it is '
'cleared\n'
- 'at the end of the except clause. This is as if\n'
+ 'at the end of the "except" clause. This is as if\n'
'\n'
' except E as N:\n'
' foo\n'
@@ -2468,7 +2492,7 @@ topics = {'assert': 'The "assert" statement\n'
'\n'
'This means the exception must be assigned to a different name to '
'be\n'
- 'able to refer to it after the except clause. Exceptions are '
+ 'able to refer to it after the "except" clause. Exceptions are '
'cleared\n'
'because with the traceback attached to them, they form a '
'reference\n'
@@ -2476,7 +2500,8 @@ topics = {'assert': 'The "assert" statement\n'
'alive\n'
'until the next garbage collection occurs.\n'
'\n'
- 'Before an except clause’s suite is executed, details about the\n'
+ 'Before an "except" clause’s suite is executed, details about '
+ 'the\n'
'exception are stored in the "sys" module and can be accessed '
'via\n'
'"sys.exc_info()". "sys.exc_info()" returns a 3-tuple consisting '
@@ -2512,6 +2537,10 @@ topics = {'assert': 'The "assert" statement\n'
' >>> print(sys.exc_info())\n'
' (None, None, None)\n'
'\n'
+ '\n'
+ '"except*" clause\n'
+ '----------------\n'
+ '\n'
'The "except*" clause(s) are used for handling "ExceptionGroup"s. '
'The\n'
'exception type for matching is interpreted as in the case of '
@@ -2520,12 +2549,13 @@ topics = {'assert': 'The "assert" statement\n'
'when\n'
'the type matches some of the exceptions in the group. This means '
'that\n'
- 'multiple except* clauses can execute, each handling part of the\n'
+ 'multiple "except*" clauses can execute, each handling part of '
+ 'the\n'
'exception group. Each clause executes once and handles an '
'exception\n'
'group of all matching exceptions. Each exception in the group '
'is\n'
- 'handled by at most one except* clause, the first that matches '
+ 'handled by at most one "except*" clause, the first that matches '
'it.\n'
'\n'
' >>> try:\n'
@@ -2548,22 +2578,26 @@ topics = {'assert': 'The "assert" statement\n'
' +-+---------------- 1 ----------------\n'
' | ValueError: 1\n'
' +------------------------------------\n'
- ' >>>\n'
'\n'
- ' Any remaining exceptions that were not handled by any except* '
- 'clause\n'
- ' are re-raised at the end, combined into an exception group '
- 'along with\n'
- ' all exceptions that were raised from within except* clauses.\n'
- '\n'
- ' An except* clause must have a matching type, and this type '
- 'cannot be a\n'
- ' subclass of :exc:`BaseExceptionGroup`. It is not possible to '
- 'mix except\n'
- ' and except* in the same :keyword:`try`. :keyword:`break`,\n'
- ' :keyword:`continue` and :keyword:`return` cannot appear in an '
- 'except*\n'
- ' clause.\n'
+ ' Any remaining exceptions that were not handled by any '
+ ':keyword:`!except*`\n'
+ ' clause are re-raised at the end, combined into an exception '
+ 'group along with\n'
+ ' all exceptions that were raised from within '
+ ':keyword:`!except*` clauses.\n'
+ '\n'
+ ' An :keyword:`!except*` clause must have a matching type,\n'
+ ' and this type cannot be a subclass of '
+ ':exc:`BaseExceptionGroup`.\n'
+ ' It is not possible to mix :keyword:`except` and '
+ ':keyword:`!except*`\n'
+ ' in the same :keyword:`try`.\n'
+ ' :keyword:`break`, :keyword:`continue` and :keyword:`return`\n'
+ ' cannot appear in an :keyword:`!except*` clause.\n'
+ '\n'
+ '\n'
+ '"else" clause\n'
+ '-------------\n'
'\n'
'The optional "else" clause is executed if the control flow '
'leaves the\n'
@@ -2573,6 +2607,10 @@ topics = {'assert': 'The "assert" statement\n'
'are\n'
'not handled by the preceding "except" clauses.\n'
'\n'
+ '\n'
+ '"finally" clause\n'
+ '----------------\n'
+ '\n'
'If "finally" is present, it specifies a ‘cleanup’ handler. The '
'"try"\n'
'clause is executed, including any "except" and "else" clauses. '
@@ -2626,11 +2664,6 @@ topics = {'assert': 'The "assert" statement\n'
' >>> foo()\n'
" 'finally'\n"
'\n'
- 'Additional information on exceptions can be found in section\n'
- 'Exceptions, and information on using the "raise" statement to '
- 'generate\n'
- 'exceptions may be found in section The raise statement.\n'
- '\n'
'Changed in version 3.8: Prior to Python 3.8, a "continue" '
'statement\n'
'was illegal in the "finally" clause due to a problem with the\n'
@@ -5540,9 +5573,10 @@ topics = {'assert': 'The "assert" statement\n'
'\n'
' * "for" loop header,\n'
'\n'
- ' * after "as" in a "with" statement, "except" clause or in the '
- 'as-\n'
- ' pattern in structural pattern matching,\n'
+ ' * after "as" in a "with" statement, "except" clause, '
+ '"except*"\n'
+ ' clause, or in the as-pattern in structural pattern '
+ 'matching,\n'
'\n'
' * in a capture pattern in structural pattern matching\n'
'\n'
@@ -7657,9 +7691,8 @@ topics = {'assert': 'The "assert" statement\n'
'\n'
' * "for" loop header,\n'
'\n'
- ' * after "as" in a "with" statement, "except" clause or in the '
- 'as-\n'
- ' pattern in structural pattern matching,\n'
+ ' * after "as" in a "with" statement, "except" clause, "except*"\n'
+ ' clause, or in the as-pattern in structural pattern matching,\n'
'\n'
' * in a capture pattern in structural pattern matching\n'
'\n'
@@ -8232,8 +8265,9 @@ topics = {'assert': 'The "assert" statement\n'
'the syntax is explicitly given, operators are binary. '
'Operators in\n'
'the same box group left to right (except for '
- 'exponentiation, which\n'
- 'groups from right to left).\n'
+ 'exponentiation and\n'
+ 'conditional expressions, which group from right to '
+ 'left).\n'
'\n'
'Note that comparisons, membership tests, and identity '
'tests, all have\n'
@@ -12500,31 +12534,39 @@ topics = {'assert': 'The "assert" statement\n'
' try3_stmt ::= "try" ":" suite\n'
' "finally" ":" suite\n'
'\n'
+ 'Additional information on exceptions can be found in section\n'
+ 'Exceptions, and information on using the "raise" statement to '
+ 'generate\n'
+ 'exceptions may be found in section The raise statement.\n'
+ '\n'
+ '\n'
+ '"except" clause\n'
+ '===============\n'
+ '\n'
'The "except" clause(s) specify one or more exception handlers. When '
'no\n'
'exception occurs in the "try" clause, no exception handler is\n'
'executed. When an exception occurs in the "try" suite, a search for '
'an\n'
- 'exception handler is started. This search inspects the except '
- 'clauses\n'
- 'in turn until one is found that matches the exception. An '
- 'expression-\n'
- 'less except clause, if present, must be last; it matches any\n'
- 'exception. For an except clause with an expression, that expression\n'
- 'is evaluated, and the clause matches the exception if the resulting\n'
- 'object is “compatible” with the exception. An object is compatible\n'
- 'with an exception if the object is the class or a *non-virtual base\n'
- 'class* of the exception object, or a tuple containing an item that '
- 'is\n'
- 'the class or a non-virtual base class of the exception object.\n'
+ 'exception handler is started. This search inspects the "except"\n'
+ 'clauses in turn until one is found that matches the exception. An\n'
+ 'expression-less "except" clause, if present, must be last; it '
+ 'matches\n'
+ 'any exception. For an "except" clause with an expression, that\n'
+ 'expression is evaluated, and the clause matches the exception if the\n'
+ 'resulting object is “compatible” with the exception. An object is\n'
+ 'compatible with an exception if the object is the class or a *non-\n'
+ 'virtual base class* of the exception object, or a tuple containing '
+ 'an\n'
+ 'item that is the class or a non-virtual base class of the exception\n'
+ 'object.\n'
'\n'
- 'If no except clause matches the exception, the search for an '
- 'exception\n'
- 'handler continues in the surrounding code and on the invocation '
- 'stack.\n'
- '[1]\n'
+ 'If no "except" clause matches the exception, the search for an\n'
+ 'exception handler continues in the surrounding code and on the\n'
+ 'invocation stack. [1]\n'
'\n'
- 'If the evaluation of an expression in the header of an except clause\n'
+ 'If the evaluation of an expression in the header of an "except" '
+ 'clause\n'
'raises an exception, the original search for a handler is canceled '
'and\n'
'a search starts for the new exception in the surrounding code and on\n'
@@ -12532,21 +12574,20 @@ topics = {'assert': 'The "assert" statement\n'
'raised\n'
'the exception).\n'
'\n'
- 'When a matching except clause is found, the exception is assigned to\n'
- 'the target specified after the "as" keyword in that except clause, '
- 'if\n'
- 'present, and the except clause’s suite is executed. All except\n'
- 'clauses must have an executable block. When the end of this block '
- 'is\n'
- 'reached, execution continues normally after the entire try '
- 'statement.\n'
- '(This means that if two nested handlers exist for the same '
- 'exception,\n'
- 'and the exception occurs in the try clause of the inner handler, the\n'
- 'outer handler will not handle the exception.)\n'
+ 'When a matching "except" clause is found, the exception is assigned '
+ 'to\n'
+ 'the target specified after the "as" keyword in that "except" clause,\n'
+ 'if present, and the "except" clause’s suite is executed. All '
+ '"except"\n'
+ 'clauses must have an executable block. When the end of this block is\n'
+ 'reached, execution continues normally after the entire "try"\n'
+ 'statement. (This means that if two nested handlers exist for the '
+ 'same\n'
+ 'exception, and the exception occurs in the "try" clause of the inner\n'
+ 'handler, the outer handler will not handle the exception.)\n'
'\n'
'When an exception has been assigned using "as target", it is cleared\n'
- 'at the end of the except clause. This is as if\n'
+ 'at the end of the "except" clause. This is as if\n'
'\n'
' except E as N:\n'
' foo\n'
@@ -12560,12 +12601,13 @@ topics = {'assert': 'The "assert" statement\n'
' del N\n'
'\n'
'This means the exception must be assigned to a different name to be\n'
- 'able to refer to it after the except clause. Exceptions are cleared\n'
+ 'able to refer to it after the "except" clause. Exceptions are '
+ 'cleared\n'
'because with the traceback attached to them, they form a reference\n'
'cycle with the stack frame, keeping all locals in that frame alive\n'
'until the next garbage collection occurs.\n'
'\n'
- 'Before an except clause’s suite is executed, details about the\n'
+ 'Before an "except" clause’s suite is executed, details about the\n'
'exception are stored in the "sys" module and can be accessed via\n'
'"sys.exc_info()". "sys.exc_info()" returns a 3-tuple consisting of '
'the\n'
@@ -12597,16 +12639,20 @@ topics = {'assert': 'The "assert" statement\n'
' >>> print(sys.exc_info())\n'
' (None, None, None)\n'
'\n'
+ '\n'
+ '"except*" clause\n'
+ '================\n'
+ '\n'
'The "except*" clause(s) are used for handling "ExceptionGroup"s. The\n'
'exception type for matching is interpreted as in the case of '
'"except",\n'
'but in the case of exception groups we can have partial matches when\n'
'the type matches some of the exceptions in the group. This means '
'that\n'
- 'multiple except* clauses can execute, each handling part of the\n'
+ 'multiple "except*" clauses can execute, each handling part of the\n'
'exception group. Each clause executes once and handles an exception\n'
'group of all matching exceptions. Each exception in the group is\n'
- 'handled by at most one except* clause, the first that matches it.\n'
+ 'handled by at most one "except*" clause, the first that matches it.\n'
'\n'
' >>> try:\n'
' ... raise ExceptionGroup("eg",\n'
@@ -12626,22 +12672,25 @@ topics = {'assert': 'The "assert" statement\n'
' +-+---------------- 1 ----------------\n'
' | ValueError: 1\n'
' +------------------------------------\n'
- ' >>>\n'
'\n'
- ' Any remaining exceptions that were not handled by any except* '
- 'clause\n'
- ' are re-raised at the end, combined into an exception group along '
- 'with\n'
- ' all exceptions that were raised from within except* clauses.\n'
+ ' Any remaining exceptions that were not handled by any '
+ ':keyword:`!except*`\n'
+ ' clause are re-raised at the end, combined into an exception group '
+ 'along with\n'
+ ' all exceptions that were raised from within :keyword:`!except*` '
+ 'clauses.\n'
+ '\n'
+ ' An :keyword:`!except*` clause must have a matching type,\n'
+ ' and this type cannot be a subclass of :exc:`BaseExceptionGroup`.\n'
+ ' It is not possible to mix :keyword:`except` and '
+ ':keyword:`!except*`\n'
+ ' in the same :keyword:`try`.\n'
+ ' :keyword:`break`, :keyword:`continue` and :keyword:`return`\n'
+ ' cannot appear in an :keyword:`!except*` clause.\n'
+ '\n'
'\n'
- ' An except* clause must have a matching type, and this type cannot '
- 'be a\n'
- ' subclass of :exc:`BaseExceptionGroup`. It is not possible to mix '
- 'except\n'
- ' and except* in the same :keyword:`try`. :keyword:`break`,\n'
- ' :keyword:`continue` and :keyword:`return` cannot appear in an '
- 'except*\n'
- ' clause.\n'
+ '"else" clause\n'
+ '=============\n'
'\n'
'The optional "else" clause is executed if the control flow leaves '
'the\n'
@@ -12650,6 +12699,10 @@ topics = {'assert': 'The "assert" statement\n'
'"break" statement was executed. Exceptions in the "else" clause are\n'
'not handled by the preceding "except" clauses.\n'
'\n'
+ '\n'
+ '"finally" clause\n'
+ '================\n'
+ '\n'
'If "finally" is present, it specifies a ‘cleanup’ handler. The '
'"try"\n'
'clause is executed, including any "except" and "else" clauses. If '
@@ -12697,11 +12750,6 @@ topics = {'assert': 'The "assert" statement\n'
' >>> foo()\n'
" 'finally'\n"
'\n'
- 'Additional information on exceptions can be found in section\n'
- 'Exceptions, and information on using the "raise" statement to '
- 'generate\n'
- 'exceptions may be found in section The raise statement.\n'
- '\n'
'Changed in version 3.8: Prior to Python 3.8, a "continue" statement\n'
'was illegal in the "finally" clause due to a problem with the\n'
'implementation.\n',
@@ -12901,7 +12949,7 @@ topics = {'assert': 'The "assert" statement\n'
' points. All the code points in the range "U+0000 - '
'U+10FFFF"\n'
' can be represented in a string. Python doesn’t have a '
- '*char*\n'
+ 'char\n'
' type; instead, every code point in the string is '
'represented\n'
' as a string object with length "1". The built-in '