Skip to content

Commit 3dad413

Browse files
rockleonarockleona
committed
Deploying to gh-pages from @ a7734ef 🚀
1 parent 38472a4 commit 3dad413

File tree

559 files changed

+6900
-5360
lines changed

Some content is hidden

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

559 files changed

+6900
-5360
lines changed

‎.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 428fb59b07d7987e9a164e042f17489c
3+
config: 9927ee8aab92132ec275b56418e742fb
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ without intermediate copying.
2929
Python provides such a facility at the C level in the form of the :ref:`buffer
3030
protocol <bufferobjects>`. This protocol has two sides:
3131

32-
.. index:: single: PyBufferProcs
32+
.. index:: single: PyBufferProcs (C type)
3333

3434
- on the producer side, a type can export a "buffer interface" which allows
3535
objects of that type to expose information about their underlying buffer.

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,13 @@ bound into a function.
2222
.. c:var:: PyTypeObject PyCode_Type
2323
2424
This is an instance of :c:type:`PyTypeObject` representing the Python
25-
:class:`code` type.
25+
:ref:`code object <code-objects>`.
2626

2727

2828
.. c:function:: int PyCode_Check(PyObject *co)
2929
30-
Return true if *co* is a :class:`code` object. This function always succeeds.
30+
Return true if *co* is a :ref:`code object <code-objects>`.
31+
This function always succeeds.
3132
3233
.. c:function:: int PyCode_GetNumFree(PyCodeObject *co)
3334
@@ -48,7 +49,7 @@ bound into a function.
4849
.. versionchanged:: 3.11
4950
Added ``qualname`` and ``exceptiontable`` parameters.
5051
51-
.. index:: single: PyCode_New
52+
.. index:: single: PyCode_New (C function)
5253
5354
.. versionchanged:: 3.12
5455
@@ -61,7 +62,7 @@ bound into a function.
6162
Similar to :c:func:`PyUnstable_Code_New`, but with an extra "posonlyargcount" for positional-only arguments.
6263
The same caveats that apply to ``PyUnstable_Code_New`` also apply to this function.
6364
64-
.. index:: single: PyCode_NewWithPosOnlyArgs
65+
.. index:: single: PyCode_NewWithPosOnlyArgs (C function)
6566
6667
.. versionadded:: 3.8 as ``PyCode_NewWithPosOnlyArgs``
6768
@@ -220,7 +221,7 @@ may change without deprecation warnings.
220221
*free* will be called on non-``NULL`` data stored under the new index.
221222
Use :c:func:`Py_DecRef` when storing :c:type:`PyObject`.
222223
223-
.. index:: single: _PyEval_RequestCodeExtraIndex
224+
.. index:: single: _PyEval_RequestCodeExtraIndex (C function)
224225
225226
.. versionadded:: 3.6 as ``_PyEval_RequestCodeExtraIndex``
226227
@@ -238,7 +239,7 @@ may change without deprecation warnings.
238239
If no data was set under the index, set *extra* to ``NULL`` and return
239240
0 without setting an exception.
240241
241-
.. index:: single: _PyCode_GetExtra
242+
.. index:: single: _PyCode_GetExtra (C function)
242243
243244
.. versionadded:: 3.6 as ``_PyCode_GetExtra``
244245
@@ -253,7 +254,7 @@ may change without deprecation warnings.
253254
Set the extra data stored under the given index to *extra*.
254255
Return 0 on success. Set an exception and return -1 on failure.
255256
256-
.. index:: single: _PyCode_SetExtra
257+
.. index:: single: _PyCode_SetExtra (C function)
257258
258259
.. versionadded:: 3.6 as ``_PyCode_SetExtra``
259260

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

Lines changed: 77 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ For convenience, some of these functions will always return a
167167
168168
.. c:function:: PyObject* PyErr_SetFromErrno(PyObject *type)
169169
170-
.. index:: single: strerror()
170+
.. index:: single: strerror (C function)
171171
172172
This is a convenience function to raise an exception when a C library function
173173
has returned an error and set the C variable :c:data:`errno`. It constructs a
@@ -383,7 +383,7 @@ an error value).
383383
.. c:function:: int PyErr_ResourceWarning(PyObject *source, Py_ssize_t stack_level, const char *format, ...)
384384
385385
Function similar to :c:func:`PyErr_WarnFormat`, but *category* is
386-
:exc:`ResourceWarning` and it passes *source* to :func:`warnings.WarningMessage`.
386+
:exc:`ResourceWarning` and it passes *source* to :class:`!warnings.WarningMessage`.
387387
388388
.. versionadded:: 3.6
389389
@@ -622,7 +622,7 @@ Signal Handling
622622
623623
.. index::
624624
pair: module; signal
625-
single: SIGINT
625+
single: SIGINT (C macro)
626626
single: KeyboardInterrupt (built-in exception)
627627
628628
This function interacts with Python's signal handling.
@@ -653,7 +653,7 @@ Signal Handling
653653
654654
.. index::
655655
pair: module; signal
656-
single: SIGINT
656+
single: SIGINT (C macro)
657657
single: KeyboardInterrupt (built-in exception)
658658
659659
Simulate the effect of a :c:macro:`!SIGINT` signal arriving.
@@ -719,7 +719,7 @@ Exception Classes
719719
This creates a class object derived from :exc:`Exception` (accessible in C as
720720
:c:data:`PyExc_Exception`).
721721
722-
The :attr:`__module__` attribute of the new class is set to the first part (up
722+
The :attr:`!__module__` attribute of the new class is set to the first part (up
723723
to the last dot) of the *name* argument, and the class name is set to the last
724724
part (after the last dot). The *base* argument can be used to specify alternate
725725
base classes; it can either be only one class or a tuple of classes. The *dict*
@@ -891,8 +891,8 @@ because the :ref:`call protocol <call>` takes care of recursion handling.
891891
892892
Marks a point where a recursive C-level call is about to be performed.
893893
894-
If :c:macro:`USE_STACKCHECK` is defined, this function checks if the OS
895-
stack overflowed using :c:func:`PyOS_CheckStack`. In this is the case, it
894+
If :c:macro:`!USE_STACKCHECK` is defined, this function checks if the OS
895+
stack overflowed using :c:func:`PyOS_CheckStack`. If this is the case, it
896896
sets a :exc:`MemoryError` and returns a nonzero value.
897897
898898
The function then checks if the recursion limit is reached. If this is the
@@ -955,59 +955,59 @@ All standard Python exceptions are available as global variables whose names are
955955
the variables:
956956
957957
.. index::
958-
single: PyExc_BaseException
959-
single: PyExc_Exception
960-
single: PyExc_ArithmeticError
961-
single: PyExc_AssertionError
962-
single: PyExc_AttributeError
963-
single: PyExc_BlockingIOError
964-
single: PyExc_BrokenPipeError
965-
single: PyExc_BufferError
966-
single: PyExc_ChildProcessError
967-
single: PyExc_ConnectionAbortedError
968-
single: PyExc_ConnectionError
969-
single: PyExc_ConnectionRefusedError
970-
single: PyExc_ConnectionResetError
971-
single: PyExc_EOFError
972-
single: PyExc_FileExistsError
973-
single: PyExc_FileNotFoundError
974-
single: PyExc_FloatingPointError
975-
single: PyExc_GeneratorExit
976-
single: PyExc_ImportError
977-
single: PyExc_IndentationError
978-
single: PyExc_IndexError
979-
single: PyExc_InterruptedError
980-
single: PyExc_IsADirectoryError
981-
single: PyExc_KeyError
982-
single: PyExc_KeyboardInterrupt
983-
single: PyExc_LookupError
984-
single: PyExc_MemoryError
985-
single: PyExc_ModuleNotFoundError
986-
single: PyExc_NameError
987-
single: PyExc_NotADirectoryError
988-
single: PyExc_NotImplementedError
989-
single: PyExc_OSError
990-
single: PyExc_OverflowError
991-
single: PyExc_PermissionError
992-
single: PyExc_ProcessLookupError
993-
single: PyExc_RecursionError
994-
single: PyExc_ReferenceError
995-
single: PyExc_RuntimeError
996-
single: PyExc_StopAsyncIteration
997-
single: PyExc_StopIteration
998-
single: PyExc_SyntaxError
999-
single: PyExc_SystemError
1000-
single: PyExc_SystemExit
1001-
single: PyExc_TabError
1002-
single: PyExc_TimeoutError
1003-
single: PyExc_TypeError
1004-
single: PyExc_UnboundLocalError
1005-
single: PyExc_UnicodeDecodeError
1006-
single: PyExc_UnicodeEncodeError
1007-
single: PyExc_UnicodeError
1008-
single: PyExc_UnicodeTranslateError
1009-
single: PyExc_ValueError
1010-
single: PyExc_ZeroDivisionError
958+
single: PyExc_BaseException (C var)
959+
single: PyExc_Exception (C var)
960+
single: PyExc_ArithmeticError (C var)
961+
single: PyExc_AssertionError (C var)
962+
single: PyExc_AttributeError (C var)
963+
single: PyExc_BlockingIOError (C var)
964+
single: PyExc_BrokenPipeError (C var)
965+
single: PyExc_BufferError (C var)
966+
single: PyExc_ChildProcessError (C var)
967+
single: PyExc_ConnectionAbortedError (C var)
968+
single: PyExc_ConnectionError (C var)
969+
single: PyExc_ConnectionRefusedError (C var)
970+
single: PyExc_ConnectionResetError (C var)
971+
single: PyExc_EOFError (C var)
972+
single: PyExc_FileExistsError (C var)
973+
single: PyExc_FileNotFoundError (C var)
974+
single: PyExc_FloatingPointError (C var)
975+
single: PyExc_GeneratorExit (C var)
976+
single: PyExc_ImportError (C var)
977+
single: PyExc_IndentationError (C var)
978+
single: PyExc_IndexError (C var)
979+
single: PyExc_InterruptedError (C var)
980+
single: PyExc_IsADirectoryError (C var)
981+
single: PyExc_KeyError (C var)
982+
single: PyExc_KeyboardInterrupt (C var)
983+
single: PyExc_LookupError (C var)
984+
single: PyExc_MemoryError (C var)
985+
single: PyExc_ModuleNotFoundError (C var)
986+
single: PyExc_NameError (C var)
987+
single: PyExc_NotADirectoryError (C var)
988+
single: PyExc_NotImplementedError (C var)
989+
single: PyExc_OSError (C var)
990+
single: PyExc_OverflowError (C var)
991+
single: PyExc_PermissionError (C var)
992+
single: PyExc_ProcessLookupError (C var)
993+
single: PyExc_RecursionError (C var)
994+
single: PyExc_ReferenceError (C var)
995+
single: PyExc_RuntimeError (C var)
996+
single: PyExc_StopAsyncIteration (C var)
997+
single: PyExc_StopIteration (C var)
998+
single: PyExc_SyntaxError (C var)
999+
single: PyExc_SystemError (C var)
1000+
single: PyExc_SystemExit (C var)
1001+
single: PyExc_TabError (C var)
1002+
single: PyExc_TimeoutError (C var)
1003+
single: PyExc_TypeError (C var)
1004+
single: PyExc_UnboundLocalError (C var)
1005+
single: PyExc_UnicodeDecodeError (C var)
1006+
single: PyExc_UnicodeEncodeError (C var)
1007+
single: PyExc_UnicodeError (C var)
1008+
single: PyExc_UnicodeTranslateError (C var)
1009+
single: PyExc_ValueError (C var)
1010+
single: PyExc_ZeroDivisionError (C var)
10111011
10121012
+-----------------------------------------+---------------------------------+----------+
10131013
| C Name | Python Name | Notes |
@@ -1138,18 +1138,18 @@ the variables:
11381138
These are compatibility aliases to :c:data:`PyExc_OSError`:
11391139
11401140
.. index::
1141-
single: PyExc_EnvironmentError
1142-
single: PyExc_IOError
1143-
single: PyExc_WindowsError
1141+
single: PyExc_EnvironmentError (C var)
1142+
single: PyExc_IOError (C var)
1143+
single: PyExc_WindowsError (C var)
11441144
11451145
+-------------------------------------+----------+
11461146
| C Name | Notes |
11471147
+=====================================+==========+
1148-
| :c:data:`PyExc_EnvironmentError` | |
1148+
| :c:data:`!PyExc_EnvironmentError` | |
11491149
+-------------------------------------+----------+
1150-
| :c:data:`PyExc_IOError` | |
1150+
| :c:data:`!PyExc_IOError` | |
11511151
+-------------------------------------+----------+
1152-
| :c:data:`PyExc_WindowsError` | [2]_ |
1152+
| :c:data:`!PyExc_WindowsError` | [2]_ |
11531153
+-------------------------------------+----------+
11541154
11551155
.. versionchanged:: 3.3
@@ -1175,17 +1175,17 @@ names are ``PyExc_`` followed by the Python exception name. These have the type
11751175
the variables:
11761176
11771177
.. index::
1178-
single: PyExc_Warning
1179-
single: PyExc_BytesWarning
1180-
single: PyExc_DeprecationWarning
1181-
single: PyExc_FutureWarning
1182-
single: PyExc_ImportWarning
1183-
single: PyExc_PendingDeprecationWarning
1184-
single: PyExc_ResourceWarning
1185-
single: PyExc_RuntimeWarning
1186-
single: PyExc_SyntaxWarning
1187-
single: PyExc_UnicodeWarning
1188-
single: PyExc_UserWarning
1178+
single: PyExc_Warning (C var)
1179+
single: PyExc_BytesWarning (C var)
1180+
single: PyExc_DeprecationWarning (C var)
1181+
single: PyExc_FutureWarning (C var)
1182+
single: PyExc_ImportWarning (C var)
1183+
single: PyExc_PendingDeprecationWarning (C var)
1184+
single: PyExc_ResourceWarning (C var)
1185+
single: PyExc_RuntimeWarning (C var)
1186+
single: PyExc_SyntaxWarning (C var)
1187+
single: PyExc_UnicodeWarning (C var)
1188+
single: PyExc_UserWarning (C var)
11891189
11901190
+------------------------------------------+---------------------------------+----------+
11911191
| C Name | Python Name | Notes |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ the :mod:`io` APIs instead.
9595
9696
.. c:function:: int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)
9797
98-
.. index:: single: Py_PRINT_RAW
98+
.. index:: single: Py_PRINT_RAW (C macro)
9999
100100
Write object *obj* to file object *p*. The only supported flag for *flags* is
101101
:c:macro:`Py_PRINT_RAW`; if given, the :func:`str` of the object is written

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,15 @@ rules:
8383
.. versionadded:: 3.12
8484
8585
86-
.. c:function:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)
86+
.. c:macro:: PyObject_GC_Resize(TYPE, op, newsize)
8787
88-
Resize an object allocated by :c:macro:`PyObject_NewVar`. Returns the
89-
resized object or ``NULL`` on failure. *op* must not be tracked by the collector yet.
88+
Resize an object allocated by :c:macro:`PyObject_NewVar`.
89+
Returns the resized object of type ``TYPE*`` (refers to any C type)
90+
or ``NULL`` on failure.
91+
92+
*op* must be of type :c:expr:`PyVarObject *`
93+
and must not be tracked by the collector yet.
94+
*newsize* must be of type :c:type:`Py_ssize_t`.
9095
9196
9297
.. c:function:: void PyObject_GC_Track(PyObject *op)

0 commit comments

Comments
 (0)