Skip to content

Commit 03207d2

Browse files
github-actions[bot]github-actions[bot]
committed
deploy: 17c7304 
1 parent d86a5a5 commit 03207d2

File tree

542 files changed

+4489
-5021
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

542 files changed

+4489
-5021
lines changed

‎_sources/c-api/code.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ bound into a function.
7777
7878
Returns ``1`` if the function succeeds and 0 otherwise.
7979
80+
.. versionadded:: 3.11
81+
8082
.. c:function:: PyObject* PyCode_GetCode(PyCodeObject *co)
8183
8284
Equivalent to the Python code ``getattr(co, 'co_code')``.

‎_sources/library/array.rst.txt

+89-90
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Notes:
6060

6161
The actual representation of values is determined by the machine architecture
6262
(strictly speaking, by the C implementation). The actual size can be accessed
63-
through the :attr:`itemsize` attribute.
63+
through the :attr:`array.itemsize` attribute.
6464

6565
The module defines the following item:
6666

@@ -85,161 +85,160 @@ The module defines the following type:
8585
to add initial items to the array. Otherwise, the iterable initializer is
8686
passed to the :meth:`extend` method.
8787

88-
.. audit-event:: array.__new__ typecode,initializer array.array
88+
Array objects support the ordinary sequence operations of indexing, slicing,
89+
concatenation, and multiplication. When using slice assignment, the assigned
90+
value must be an array object with the same type code; in all other cases,
91+
:exc:`TypeError` is raised. Array objects also implement the buffer interface,
92+
and may be used wherever :term:`bytes-like objects <bytes-like object>` are supported.
8993

94+
.. audit-event:: array.__new__ typecode,initializer array.array
9095

91-
Array objects support the ordinary sequence operations of indexing, slicing,
92-
concatenation, and multiplication. When using slice assignment, the assigned
93-
value must be an array object with the same type code; in all other cases,
94-
:exc:`TypeError` is raised. Array objects also implement the buffer interface,
95-
and may be used wherever :term:`bytes-like objects <bytes-like object>` are supported.
9696

97-
The following data items and methods are also supported:
97+
.. attribute:: typecode
9898

99-
.. attribute:: array.typecode
99+
The typecode character used to create the array.
100100

101-
The typecode character used to create the array.
102101

102+
.. attribute:: itemsize
103103

104-
.. attribute:: array.itemsize
104+
The length in bytes of one array item in the internal representation.
105105

106-
The length in bytes of one array item in the internal representation.
107106

107+
.. method:: append(x)
108108

109-
.. method:: array.append(x)
109+
Append a new item with value *x* to the end of the array.
110110

111-
Append a new item with value *x* to the end of the array.
112111

112+
.. method:: buffer_info()
113113

114-
.. method:: array.buffer_info()
114+
Return a tuple ``(address, length)`` giving the current memory address and the
115+
length in elements of the buffer used to hold array's contents. The size of the
116+
memory buffer in bytes can be computed as ``array.buffer_info()[1] *
117+
array.itemsize``. This is occasionally useful when working with low-level (and
118+
inherently unsafe) I/O interfaces that require memory addresses, such as certain
119+
:c:func:`!ioctl` operations. The returned numbers are valid as long as the array
120+
exists and no length-changing operations are applied to it.
115121

116-
Return a tuple ``(address, length)`` giving the current memory address and the
117-
length in elements of the buffer used to hold array's contents. The size of the
118-
memory buffer in bytes can be computed as ``array.buffer_info()[1] *
119-
array.itemsize``. This is occasionally useful when working with low-level (and
120-
inherently unsafe) I/O interfaces that require memory addresses, such as certain
121-
:c:func:`ioctl` operations. The returned numbers are valid as long as the array
122-
exists and no length-changing operations are applied to it.
122+
.. note::
123123

124-
.. note::
124+
When using array objects from code written in C or C++ (the only way to
125+
effectively make use of this information), it makes more sense to use the buffer
126+
interface supported by array objects. This method is maintained for backward
127+
compatibility and should be avoided in new code. The buffer interface is
128+
documented in :ref:`bufferobjects`.
125129

126-
When using array objects from code written in C or C++ (the only way to
127-
effectively make use of this information), it makes more sense to use the buffer
128-
interface supported by array objects. This method is maintained for backward
129-
compatibility and should be avoided in new code. The buffer interface is
130-
documented in :ref:`bufferobjects`.
131130

131+
.. method:: byteswap()
132132

133-
.. method:: array.byteswap()
133+
"Byteswap" all items of the array. This is only supported for values which are
134+
1, 2, 4, or 8 bytes in size; for other types of values, :exc:`RuntimeError` is
135+
raised. It is useful when reading data from a file written on a machine with a
136+
different byte order.
134137

135-
"Byteswap" all items of the array. This is only supported for values which are
136-
1, 2, 4, or 8 bytes in size; for other types of values, :exc:`RuntimeError` is
137-
raised. It is useful when reading data from a file written on a machine with a
138-
different byte order.
139138

139+
.. method:: count(x)
140140

141-
.. method:: array.count(x)
141+
Return the number of occurrences of *x* in the array.
142142

143-
Return the number of occurrences of *x* in the array.
144143

144+
.. method:: extend(iterable)
145145

146-
.. method:: array.extend(iterable)
146+
Append items from *iterable* to the end of the array. If *iterable* is another
147+
array, it must have *exactly* the same type code; if not, :exc:`TypeError` will
148+
be raised. If *iterable* is not an array, it must be iterable and its elements
149+
must be the right type to be appended to the array.
147150

148-
Append items from *iterable* to the end of the array. If *iterable* is another
149-
array, it must have *exactly* the same type code; if not, :exc:`TypeError` will
150-
be raised. If *iterable* is not an array, it must be iterable and its elements
151-
must be the right type to be appended to the array.
152151

152+
.. method:: frombytes(s)
153153

154-
.. method:: array.frombytes(s)
154+
Appends items from the string, interpreting the string as an array of machine
155+
values (as if it had been read from a file using the :meth:`fromfile` method).
155156

156-
Appends items from the string, interpreting the string as an array of machine
157-
values (as if it had been read from a file using the :meth:`fromfile` method).
157+
.. versionadded:: 3.2
158+
:meth:`!fromstring` is renamed to :meth:`frombytes` for clarity.
158159

159-
.. versionadded:: 3.2
160-
:meth:`fromstring` is renamed to :meth:`frombytes` for clarity.
161160

161+
.. method:: fromfile(f, n)
162162

163-
.. method:: array.fromfile(f, n)
163+
Read *n* items (as machine values) from the :term:`file object` *f* and append
164+
them to the end of the array. If less than *n* items are available,
165+
:exc:`EOFError` is raised, but the items that were available are still
166+
inserted into the array.
164167

165-
Read *n* items (as machine values) from the :term:`file object` *f* and append
166-
them to the end of the array. If less than *n* items are available,
167-
:exc:`EOFError` is raised, but the items that were available are still
168-
inserted into the array.
169168

169+
.. method:: fromlist(list)
170170

171-
.. method:: array.fromlist(list)
171+
Append items from the list. This is equivalent to ``for x in list:
172+
a.append(x)`` except that if there is a type error, the array is unchanged.
172173

173-
Append items from the list. This is equivalent to ``for x in list:
174-
a.append(x)`` except that if there is a type error, the array is unchanged.
175174

175+
.. method:: fromunicode(s)
176176

177-
.. method:: array.fromunicode(s)
177+
Extends this array with data from the given unicode string. The array must
178+
be a type ``'u'`` array; otherwise a :exc:`ValueError` is raised. Use
179+
``array.frombytes(unicodestring.encode(enc))`` to append Unicode data to an
180+
array of some other type.
178181

179-
Extends this array with data from the given unicode string. The array must
180-
be a type ``'u'`` array; otherwise a :exc:`ValueError` is raised. Use
181-
``array.frombytes(unicodestring.encode(enc))`` to append Unicode data to an
182-
array of some other type.
183182

183+
.. method:: index(x[, start[, stop]])
184184

185-
.. method:: array.index(x[, start[, stop]])
185+
Return the smallest *i* such that *i* is the index of the first occurrence of
186+
*x* in the array. The optional arguments *start* and *stop* can be
187+
specified to search for *x* within a subsection of the array. Raise
188+
:exc:`ValueError` if *x* is not found.
186189

187-
Return the smallest *i* such that *i* is the index of the first occurrence of
188-
*x* in the array. The optional arguments *start* and *stop* can be
189-
specified to search for *x* within a subsection of the array. Raise
190-
:exc:`ValueError` if *x* is not found.
190+
.. versionchanged:: 3.10
191+
Added optional *start* and *stop* parameters.
191192

192-
.. versionchanged:: 3.10
193-
Added optional *start* and *stop* parameters.
194193

195-
.. method:: array.insert(i, x)
194+
.. method:: insert(i, x)
196195

197-
Insert a new item with value *x* in the array before position *i*. Negative
198-
values are treated as being relative to the end of the array.
196+
Insert a new item with value *x* in the array before position *i*. Negative
197+
values are treated as being relative to the end of the array.
199198

200199

201-
.. method:: array.pop([i])
200+
.. method:: pop([i])
202201

203-
Removes the item with the index *i* from the array and returns it. The optional
204-
argument defaults to ``-1``, so that by default the last item is removed and
205-
returned.
202+
Removes the item with the index *i* from the array and returns it. The optional
203+
argument defaults to ``-1``, so that by default the last item is removed and
204+
returned.
206205

207206

208-
.. method:: array.remove(x)
207+
.. method:: remove(x)
209208

210-
Remove the first occurrence of *x* from the array.
209+
Remove the first occurrence of *x* from the array.
211210

212211

213-
.. method:: array.reverse()
212+
.. method:: reverse()
214213

215-
Reverse the order of the items in the array.
214+
Reverse the order of the items in the array.
216215

217216

218-
.. method:: array.tobytes()
217+
.. method:: tobytes()
219218

220-
Convert the array to an array of machine values and return the bytes
221-
representation (the same sequence of bytes that would be written to a file by
222-
the :meth:`tofile` method.)
219+
Convert the array to an array of machine values and return the bytes
220+
representation (the same sequence of bytes that would be written to a file by
221+
the :meth:`tofile` method.)
223222

224-
.. versionadded:: 3.2
225-
:meth:`tostring` is renamed to :meth:`tobytes` for clarity.
223+
.. versionadded:: 3.2
224+
:meth:`!tostring` is renamed to :meth:`tobytes` for clarity.
226225

227226

228-
.. method:: array.tofile(f)
227+
.. method:: tofile(f)
229228

230-
Write all items (as machine values) to the :term:`file object` *f*.
229+
Write all items (as machine values) to the :term:`file object` *f*.
231230

232231

233-
.. method:: array.tolist()
232+
.. method:: tolist()
234233

235-
Convert the array to an ordinary list with the same items.
234+
Convert the array to an ordinary list with the same items.
236235

237236

238-
.. method:: array.tounicode()
237+
.. method:: tounicode()
239238

240-
Convert the array to a unicode string. The array must be a type ``'u'`` array;
241-
otherwise a :exc:`ValueError` is raised. Use ``array.tobytes().decode(enc)`` to
242-
obtain a unicode string from an array of some other type.
239+
Convert the array to a unicode string. The array must be a type ``'u'`` array;
240+
otherwise a :exc:`ValueError` is raised. Use ``array.tobytes().decode(enc)`` to
241+
obtain a unicode string from an array of some other type.
243242

244243

245244
When an array object is printed or converted to a string, it is represented as

‎_sources/library/asyncio-stream.rst.txt

+8-2
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,8 @@ StreamWriter
295295

296296
The method closes the stream and the underlying socket.
297297

298-
The method should be used along with the ``wait_closed()`` method::
298+
The method should be used, though not mandatory,
299+
along with the ``wait_closed()`` method::
299300

300301
stream.close()
301302
await stream.wait_closed()
@@ -364,7 +365,8 @@ StreamWriter
364365
Wait until the stream is closed.
365366

366367
Should be called after :meth:`close` to wait until the underlying
367-
connection is closed.
368+
connection is closed, ensuring that all data has been flushed
369+
before e.g. exiting the program.
368370

369371
.. versionadded:: 3.7
370372

@@ -394,6 +396,7 @@ TCP echo client using the :func:`asyncio.open_connection` function::
394396

395397
print('Close the connection')
396398
writer.close()
399+
await writer.wait_closed()
397400

398401
asyncio.run(tcp_echo_client('Hello World!'))
399402

@@ -426,6 +429,7 @@ TCP echo server using the :func:`asyncio.start_server` function::
426429

427430
print("Close the connection")
428431
writer.close()
432+
await writer.wait_closed()
429433

430434
async def main():
431435
server = await asyncio.start_server(
@@ -482,6 +486,7 @@ Simple example querying HTTP headers of the URL passed on the command line::
482486

483487
# Ignore the body, close the socket
484488
writer.close()
489+
await writer.wait_closed()
485490

486491
url = sys.argv[1]
487492
asyncio.run(print_http_headers(url))
@@ -527,6 +532,7 @@ Coroutine waiting until a socket receives data using the
527532
# Got data, we are done: close the socket
528533
print("Received:", data.decode())
529534
writer.close()
535+
await writer.wait_closed()
530536

531537
# Close the second socket
532538
wsock.close()

‎_sources/library/enum.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -914,6 +914,6 @@ Notes
914914

915915
or you can reassign the appropriate :meth:`str`, etc., in your enum::
916916

917-
>>> from enum import IntEnum
917+
>>> from enum import Enum, IntEnum
918918
>>> class MyIntEnum(IntEnum):
919-
... __str__ = IntEnum.__str__
919+
... __str__ = Enum.__str__

‎_sources/library/faulthandler.rst.txt

+9-1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,13 @@ Python is deadlocked.
4343
The :ref:`Python Development Mode <devmode>` calls :func:`faulthandler.enable`
4444
at Python startup.
4545

46+
.. seealso::
47+
48+
Module :mod:`pdb`
49+
Interactive source code debugger for Python programs.
50+
51+
Module :mod:`traceback`
52+
Standard interface to extract, format and print stack traces of Python programs.
4653

4754
Dumping the traceback
4855
---------------------
@@ -52,6 +59,8 @@ Dumping the traceback
5259
Dump the tracebacks of all threads into *file*. If *all_threads* is
5360
``False``, dump only the current thread.
5461

62+
.. seealso:: :func:`traceback.print_tb`, which can be used to print a traceback object.
63+
5564
.. versionchanged:: 3.5
5665
Added support for passing file descriptor to this function.
5766

@@ -178,4 +187,3 @@ handler:
178187
File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
179188
File "<stdin>", line 1 in <module>
180189
Segmentation fault
181-

‎_sources/library/pdb.rst.txt

+9
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ The debugger is extensible -- it is actually defined as the class :class:`Pdb`.
2727
This is currently undocumented but easily understood by reading the source. The
2828
extension interface uses the modules :mod:`bdb` and :mod:`cmd`.
2929

30+
.. seealso::
31+
32+
Module :mod:`faulthandler`
33+
Used to dump Python tracebacks explicitly, on a fault, after a timeout,
34+
or on a user signal.
35+
36+
Module :mod:`traceback`
37+
Standard interface to extract, format and print stack traces of Python programs.
38+
3039
The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control
3140
of the debugger is::
3241

‎_sources/library/sqlite3.rst.txt

+7-4
Original file line numberDiff line numberDiff line change
@@ -299,10 +299,13 @@ Module functions
299299
:type isolation_level: str | None
300300

301301
:param bool check_same_thread:
302-
If ``True`` (default), only the creating thread may use the connection.
303-
If ``False``, the connection may be shared across multiple threads;
304-
if so, write operations should be serialized by the user to avoid data
305-
corruption.
302+
If ``True`` (default), :exc:`ProgrammingError` will be raised
303+
if the database connection is used by a thread
304+
other than the one that created it.
305+
If ``False``, the connection may be accessed in multiple threads;
306+
write operations may need to be serialized by the user
307+
to avoid data corruption.
308+
See :attr:`threadsafety` for more information.
306309

307310
:param Connection factory:
308311
A custom subclass of :class:`Connection` to create the connection with,

0 commit comments

Comments
 (0)