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.py134
1 files changed, 115 insertions, 19 deletions
diff --git a/Lib/pydoc_data/topics.py b/Lib/pydoc_data/topics.py
index fdbe810..839d454 100644
--- a/Lib/pydoc_data/topics.py
+++ b/Lib/pydoc_data/topics.py
@@ -1,4 +1,4 @@
-# Autogenerated by Sphinx on Fri Dec 5 17:06:29 2025
+# Autogenerated by Sphinx on Tue Feb 3 18:53:22 2026
# as part of the release process.
topics = {
@@ -1939,7 +1939,7 @@ ensures that the type of the target "e" is consistently
... except* BlockingIOError as e:
... print(repr(e))
...
- ExceptionGroup('', (BlockingIOError()))
+ ExceptionGroup('', (BlockingIOError(),))
"break", "continue" and "return" cannot appear in an "except*" clause.
@@ -5386,7 +5386,9 @@ The available presentation types for "float" and "Decimal" values are:
| | With no precision given, uses a precision of "6" digits |
| | after the decimal point for "float", and shows all |
| | coefficient digits for "Decimal". If "p=0", the decimal |
- | | point is omitted unless the "#" option is used. |
+ | | point is omitted unless the "#" option is used. For |
+ | | "float", the exponent always contains at least two digits, |
+ | | and is zero if the value is zero. |
+-----------+------------------------------------------------------------+
| "'E'" | Scientific notation. Same as "'e'" except it uses an upper |
| | case ‘E’ as the separator character. |
@@ -9053,7 +9055,12 @@ str.casefold()
it is intended to remove all case distinctions in a string. For
example, the German lowercase letter "'ß'" is equivalent to ""ss"".
Since it is already lowercase, "lower()" would do nothing to "'ß'";
- "casefold()" converts it to ""ss"".
+ "casefold()" converts it to ""ss"". For example:
+
+ >>> 'straße'.lower()
+ 'straße'
+ >>> 'straße'.casefold()
+ 'strasse'
The casefolding algorithm is described in section 3.13 ‘Default
Case Folding’ of the Unicode Standard.
@@ -9242,7 +9249,18 @@ str.format_map(mapping, /)
str.index(sub[, start[, end]])
Like "find()", but raise "ValueError" when the substring is not
- found.
+ found. For example:
+
+ >>> 'spam, spam, spam'.index('spam')
+ 0
+ >>> 'spam, spam, spam'.index('eggs')
+ Traceback (most recent call last):
+ File "<python-input-0>", line 1, in <module>
+ 'spam, spam, spam'.index('eggs')
+ ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
+ ValueError: substring not found
+
+ See also "rindex()".
str.isalnum()
@@ -9341,7 +9359,19 @@ str.isnumeric()
that have the Unicode numeric value property, e.g. U+2155, VULGAR
FRACTION ONE FIFTH. Formally, numeric characters are those with
the property value Numeric_Type=Digit, Numeric_Type=Decimal or
- Numeric_Type=Numeric.
+ Numeric_Type=Numeric. For example:
+
+ >>> '0123456789'.isnumeric()
+ True
+ >>> '٠١٢٣٤٥٦٧٨٩'.isnumeric() # Arabic-indic digit zero to nine
+ True
+ >>> '⅕'.isnumeric() # Vulgar fraction one fifth
+ True
+ >>> '²'.isdecimal(), '²'.isdigit(), '²'.isnumeric()
+ (False, True, True)
+
+ See also "isdecimal()" and "isdigit()". Numeric characters are a
+ superset of decimal numbers.
str.isprintable()
@@ -9359,6 +9389,13 @@ str.isprintable()
plus the ASCII space 0x20. Nonprintable characters are those in
group Separator or Other (Z or C), except the ASCII space.
+ For example:
+
+ >>> ''.isprintable(), ' '.isprintable()
+ (True, True)
+ >>> '\t'.isprintable(), '\n'.isprintable()
+ (False, False)
+
str.isspace()
Return "True" if there are only whitespace characters in the string
@@ -9424,10 +9461,24 @@ str.ljust(width, fillchar=' ', /)
space). The original string is returned if *width* is less than or
equal to "len(s)".
+ For example:
+
+ >>> 'Python'.ljust(10)
+ 'Python '
+ >>> 'Python'.ljust(10, '.')
+ 'Python....'
+ >>> 'Monty Python'.ljust(10, '.')
+ 'Monty Python'
+
+ See also "rjust()".
+
str.lower()
Return a copy of the string with all the cased characters [4]
- converted to lowercase.
+ converted to lowercase. For example:
+
+ >>> 'Lower Method Example'.lower()
+ 'lower method example'
The lowercasing algorithm used is described in section 3.13
‘Default Case Folding’ of the Unicode Standard.
@@ -9491,6 +9542,8 @@ str.removeprefix(prefix, /)
Added in version 3.9.
+ See also "removesuffix()" and "startswith()".
+
str.removesuffix(suffix, /)
If the string ends with the *suffix* string and that *suffix* is
@@ -9504,12 +9557,19 @@ str.removesuffix(suffix, /)
Added in version 3.9.
+ See also "removeprefix()" and "endswith()".
+
str.replace(old, new, /, count=-1)
Return a copy of the string with all occurrences of substring *old*
replaced by *new*. If *count* is given, only the first *count*
occurrences are replaced. If *count* is not specified or "-1", then
- all occurrences are replaced.
+ all occurrences are replaced. For example:
+
+ >>> 'spam, spam, spam'.replace('spam', 'eggs')
+ 'eggs, eggs, eggs'
+ >>> 'spam, spam, spam'.replace('spam', 'eggs', 1)
+ 'eggs, spam, spam'
Changed in version 3.13: *count* is now supported as a keyword
argument.
@@ -9519,12 +9579,30 @@ str.rfind(sub[, start[, end]])
Return the highest index in the string where substring *sub* is
found, such that *sub* is contained within "s[start:end]".
Optional arguments *start* and *end* are interpreted as in slice
- notation. Return "-1" on failure.
+ notation. Return "-1" on failure. For example:
+
+ >>> 'spam, spam, spam'.rfind('sp')
+ 12
+ >>> 'spam, spam, spam'.rfind('sp', 0, 10)
+ 6
+
+ See also "find()" and "rindex()".
str.rindex(sub[, start[, end]])
Like "rfind()" but raises "ValueError" when the substring *sub* is
- not found.
+ not found. For example:
+
+ >>> 'spam, spam, spam'.rindex('spam')
+ 12
+ >>> 'spam, spam, spam'.rindex('eggs')
+ Traceback (most recent call last):
+ File "<stdin-0>", line 1, in <module>
+ 'spam, spam, spam'.rindex('eggs')
+ ~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
+ ValueError: substring not found
+
+ See also "index()" and "find()".
str.rjust(width, fillchar=' ', /)
@@ -9541,6 +9619,17 @@ str.rpartition(sep, /)
found, return a 3-tuple containing two empty strings, followed by
the string itself.
+ For example:
+
+ >>> 'Monty Python'.rpartition(' ')
+ ('Monty', ' ', 'Python')
+ >>> "Monty Python's Flying Circus".rpartition(' ')
+ ("Monty Python's Flying", ' ', 'Circus')
+ >>> 'Monty Python'.rpartition('-')
+ ('', '', 'Monty Python')
+
+ See also "partition()".
+
str.rsplit(sep=None, maxsplit=-1)
Return a list of the words in the string, using *sep* as the
@@ -10227,7 +10316,7 @@ ensures that the type of the target "e" is consistently
... except* BlockingIOError as e:
... print(repr(e))
...
- ExceptionGroup('', (BlockingIOError()))
+ ExceptionGroup('', (BlockingIOError(),))
"break", "continue" and "return" cannot appear in an "except*" clause.
@@ -10611,6 +10700,10 @@ Special read-only attributes
+----------------------------------------------------+----------------------------------------------------+
| Attribute | Meaning |
|====================================================|====================================================|
+| function.__builtins__ | A reference to the "dictionary" that holds the |
+| | function’s builtins namespace. Added in version |
+| | 3.10. |
++----------------------------------------------------+----------------------------------------------------+
| function.__globals__ | A reference to the "dictionary" that holds the |
| | function’s global variables – the global namespace |
| | of the module in which the function was defined. |
@@ -11672,10 +11765,6 @@ class dict(iterable, /, **kwargs)
the keyword argument replaces the value from the positional
argument.
- Providing keyword arguments as in the first example only works for
- keys that are valid Python identifiers. Otherwise, any valid keys
- can be used.
-
Dictionaries compare equal if and only if they have the same "(key,
value)" pairs (regardless of ordering). Order comparisons (‘<’,
‘<=’, ‘>=’, ‘>’) raise "TypeError". To illustrate dictionary
@@ -12188,10 +12277,17 @@ Notes:
note that "-0" is still "0".
4. The slice of *s* from *i* to *j* is defined as the sequence of
- items with index *k* such that "i <= k < j". If *i* or *j* is
- greater than "len(s)", use "len(s)". If *i* is omitted or "None",
- use "0". If *j* is omitted or "None", use "len(s)". If *i* is
- greater than or equal to *j*, the slice is empty.
+ items with index *k* such that "i <= k < j".
+
+ * If *i* is omitted or "None", use "0".
+
+ * If *j* is omitted or "None", use "len(s)".
+
+ * If *i* or *j* is less than "-len(s)", use "0".
+
+ * If *i* or *j* is greater than "len(s)", use "len(s)".
+
+ * If *i* is greater than or equal to *j*, the slice is empty.
5. The slice of *s* from *i* to *j* with step *k* is defined as the
sequence of items with index "x = i + n*k" such that "0 <= n <