Skip to content

Commit 73dc0ed

Browse files
committed
Merge branch 'main' into inlinecomp2
* main: (67 commits) pythongh-99108: Add missing md5/sha1 defines to Modules/Setup (python#102308) pythongh-100227: Move _str_replace_inf to PyInterpreterState (pythongh-102333) pythongh-100227: Move the dtoa State to PyInterpreterState (pythongh-102331) pythonGH-102305: Expand some macros in generated_cases.c.h (python#102309) Migrate to new PSF mailgun account (python#102284) pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives (in Python/) (python#102193) pythonGH-90744: Fix erroneous doc links in the sys module (python#101319) pythongh-87092: Make jump target label equal to the offset of the target in the instructions sequence (python#102093) pythongh-101101: Unstable C API tier (PEP 689) (pythonGH-101102) IDLE: Simplify DynOptionsMenu __init__code (python#101371) pythongh-101561: Add typing.override decorator (python#101564) pythongh-101825: Clarify that as_integer_ratio() output is always normalized (python#101843) pythongh-101773: Optimize creation of Fractions in private methods (python#101780) pythongh-102251: Updates to test_imp Toward Fixing Some Refleaks (pythongh-102254) pythongh-102296 Document that inspect.Parameter kinds support ordering (pythonGH-102297) pythongh-102250: Fix double-decref in COMPARE_AND_BRANCH error case (pythonGH-102287) pythongh-101100: Fix sphinx warnings in `types` module (python#102274) pythongh-91038: Change default argument value to `False` instead of `0` (python#31621) pythongh-101765: unicodeobject: use Py_XDECREF correctly (python#102283) [doc] Improve grammar/fix missing word (pythonGH-102060) ...
2 parents 67f50ba + 360ef84 commit 73dc0ed

File tree

199 files changed

+6464
-3116
lines changed

Some content is hidden

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

199 files changed

+6464
-3116
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,13 +162,11 @@ jobs:
162162
- uses: actions/checkout@v3
163163
- name: Install Homebrew dependencies
164164
run: brew install pkg-config [email protected] xz gdbm tcl-tk
165-
- name: Prepare Homebrew environment variables
166-
run: |
167-
echo "CFLAGS=-I$(brew --prefix gdbm)/include -I$(brew --prefix xz)/include" >> $GITHUB_ENV
168-
echo "LDFLAGS=-L$(brew --prefix gdbm)/lib -I$(brew --prefix xz)/lib" >> $GITHUB_ENV
169-
echo "PKG_CONFIG_PATH=$(brew --prefix [email protected])/lib/pkgconfig:$(brew --prefix tcl-tk)/lib/pkgconfig" >> $GITHUB_ENV
170165
- name: Configure CPython
171166
run: |
167+
CFLAGS="-I$(brew --prefix gdbm)/include -I$(brew --prefix xz)/include" \
168+
LDFLAGS="-L$(brew --prefix gdbm)/lib -I$(brew --prefix xz)/lib" \
169+
PKG_CONFIG_PATH="$(brew --prefix tcl-tk)/lib/pkgconfig" \
172170
./configure \
173171
--with-pydebug \
174172
--prefix=/opt/python-dev \

.github/workflows/new-bugs-announce-notifier.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ jobs:
1919
- name: Send notification
2020
uses: actions/github-script@v6
2121
env:
22-
MAILGUN_API_KEY: ${{ secrets.PSF_MAILGUN_KEY }}
22+
MAILGUN_API_KEY: ${{ secrets.MAILGUN_PYTHON_ORG_MAILGUN_KEY }}
2323
with:
2424
script: |
2525
const Mailgun = require("mailgun.js");
2626
const formData = require('form-data');
2727
const mailgun = new Mailgun(formData);
28-
const DOMAIN = "mg.python.org";
28+
const DOMAIN = "mailgun.python.org";
2929
const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY});
3030
github.rest.issues.get({
3131
issue_number: context.issue.number,
@@ -44,7 +44,7 @@ jobs:
4444
};
4545
4646
const data = {
47-
from: "CPython Issues <github@mg.python.org>",
47+
from: "CPython Issues <github@mailgun.python.org>",
4848
4949
subject: `[Issue ${issue.data.number}] ${issue.data.title}`,
5050
template: "new-github-issue",

Doc/bugs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Click on the "New issue" button in the top bar to report a new issue.
7070
The submission form has two fields, "Title" and "Comment".
7171

7272
For the "Title" field, enter a *very* short description of the problem;
73-
less than ten words is good.
73+
fewer than ten words is good.
7474

7575
In the "Comment" field, describe the problem in detail, including what you
7676
expected to happen and what did happen. Be sure to include whether any

Doc/c-api/code.rst

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,28 +33,47 @@ bound into a function.
3333
3434
Return the number of free variables in *co*.
3535
36-
.. c:function:: PyCodeObject* PyCode_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
36+
.. c:function:: PyCodeObject* PyUnstable_Code_New(int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
3737
3838
Return a new code object. If you need a dummy code object to create a frame,
39-
use :c:func:`PyCode_NewEmpty` instead. Calling :c:func:`PyCode_New` directly
40-
will bind you to a precise Python version since the definition of the bytecode
41-
changes often. The many arguments of this function are inter-dependent in complex
39+
use :c:func:`PyCode_NewEmpty` instead.
40+
41+
Since the definition of the bytecode changes often, calling
42+
:c:func:`PyCode_New` directly can bind you to a precise Python version.
43+
44+
The many arguments of this function are inter-dependent in complex
4245
ways, meaning that subtle changes to values are likely to result in incorrect
4346
execution or VM crashes. Use this function only with extreme care.
4447
4548
.. versionchanged:: 3.11
4649
Added ``exceptiontable`` parameter.
4750
48-
.. c:function:: PyCodeObject* PyCode_NewWithPosOnlyArgs(int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
51+
.. index:: single: PyCode_New
52+
53+
.. versionchanged:: 3.12
54+
55+
Renamed from ``PyCode_New`` as part of :ref:`unstable-c-api`.
56+
The old name is deprecated, but will remain available until the
57+
signature changes again.
58+
59+
.. c:function:: PyCodeObject* PyUnstable_Code_NewWithPosOnlyArgs(int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, int firstlineno, PyObject *linetable, PyObject *exceptiontable)
4960
5061
Similar to :c:func:`PyCode_New`, but with an extra "posonlyargcount" for positional-only arguments.
5162
The same caveats that apply to ``PyCode_New`` also apply to this function.
5263
53-
.. versionadded:: 3.8
64+
.. index:: single: PyCode_NewWithPosOnlyArgs
65+
66+
.. versionadded:: 3.8 as ``PyCode_NewWithPosOnlyArgs``
5467
5568
.. versionchanged:: 3.11
5669
Added ``exceptiontable`` parameter.
5770
71+
.. versionchanged:: 3.12
72+
73+
Renamed to ``PyUnstable_Code_NewWithPosOnlyArgs``.
74+
The old name is deprecated, but will remain available until the
75+
signature changes again.
76+
5877
.. c:function:: PyCodeObject* PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno)
5978
6079
Return a new empty code object with the specified filename,
@@ -165,3 +184,70 @@ bound into a function.
165184
:c:func:`PyErr_WriteUnraisable`. Otherwise it should return ``0``.
166185
167186
.. versionadded:: 3.12
187+
188+
189+
Extra information
190+
-----------------
191+
192+
To support low-level extensions to frame evaluation, such as external
193+
just-in-time compilers, it is possible to attach arbitrary extra data to
194+
code objects.
195+
196+
These functions are part of the unstable C API tier:
197+
this functionality is a CPython implementation detail, and the API
198+
may change without deprecation warnings.
199+
200+
.. c:function:: Py_ssize_t PyUnstable_Eval_RequestCodeExtraIndex(freefunc free)
201+
202+
Return a new an opaque index value used to adding data to code objects.
203+
204+
You generally call this function once (per interpreter) and use the result
205+
with ``PyCode_GetExtra`` and ``PyCode_SetExtra`` to manipulate
206+
data on individual code objects.
207+
208+
If *free* is not ``NULL``: when a code object is deallocated,
209+
*free* will be called on non-``NULL`` data stored under the new index.
210+
Use :c:func:`Py_DecRef` when storing :c:type:`PyObject`.
211+
212+
.. index:: single: _PyEval_RequestCodeExtraIndex
213+
214+
.. versionadded:: 3.6 as ``_PyEval_RequestCodeExtraIndex``
215+
216+
.. versionchanged:: 3.12
217+
218+
Renamed to ``PyUnstable_Eval_RequestCodeExtraIndex``.
219+
The old private name is deprecated, but will be available until the API
220+
changes.
221+
222+
.. c:function:: int PyUnstable_Code_GetExtra(PyObject *code, Py_ssize_t index, void **extra)
223+
224+
Set *extra* to the extra data stored under the given index.
225+
Return 0 on success. Set an exception and return -1 on failure.
226+
227+
If no data was set under the index, set *extra* to ``NULL`` and return
228+
0 without setting an exception.
229+
230+
.. index:: single: _PyCode_GetExtra
231+
232+
.. versionadded:: 3.6 as ``_PyCode_GetExtra``
233+
234+
.. versionchanged:: 3.12
235+
236+
Renamed to ``PyUnstable_Code_GetExtra``.
237+
The old private name is deprecated, but will be available until the API
238+
changes.
239+
240+
.. c:function:: int PyUnstable_Code_SetExtra(PyObject *code, Py_ssize_t index, void *extra)
241+
242+
Set the extra data stored under the given index to *extra*.
243+
Return 0 on success. Set an exception and return -1 on failure.
244+
245+
.. index:: single: _PyCode_SetExtra
246+
247+
.. versionadded:: 3.6 as ``_PyCode_SetExtra``
248+
249+
.. versionchanged:: 3.12
250+
251+
Renamed to ``PyUnstable_Code_SetExtra``.
252+
The old private name is deprecated, but will be available until the API
253+
changes.

Doc/c-api/exceptions.rst

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,9 @@ Querying the error indicator
438438
439439
.. c:function:: void PyErr_Fetch(PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
440440
441-
As of 3.12, this function is deprecated. Use :c:func:`PyErr_GetRaisedException` instead.
441+
.. deprecated:: 3.12
442+
443+
Use :c:func:`PyErr_GetRaisedException` instead.
442444
443445
Retrieve the error indicator into three variables whose addresses are passed.
444446
If the error indicator is not set, set all three variables to ``NULL``. If it is
@@ -447,8 +449,10 @@ Querying the error indicator
447449
448450
.. note::
449451
450-
This function is normally only used by code that needs to catch exceptions or
451-
by code that needs to save and restore the error indicator temporarily, e.g.::
452+
This function is normally only used by legacy code that needs to catch
453+
exceptions or save and restore the error indicator temporarily.
454+
455+
For example::
452456
453457
{
454458
PyObject *type, *value, *traceback;
@@ -459,15 +463,17 @@ Querying the error indicator
459463
PyErr_Restore(type, value, traceback);
460464
}
461465
462-
.. deprecated:: 3.12
463-
464466
465467
.. c:function:: void PyErr_Restore(PyObject *type, PyObject *value, PyObject *traceback)
466468
467-
As of 3.12, this function is deprecated. Use :c:func:`PyErr_SetRaisedException` instead.
469+
.. deprecated:: 3.12
470+
471+
Use :c:func:`PyErr_SetRaisedException` instead.
468472
469-
Set the error indicator from the three objects. If the error indicator is
470-
already set, it is cleared first. If the objects are ``NULL``, the error
473+
Set the error indicator from the three objects,
474+
*type*, *value*, and *traceback*,
475+
clearing the existing exception if one is set.
476+
If the objects are ``NULL``, the error
471477
indicator is cleared. Do not pass a ``NULL`` type and non-``NULL`` value or
472478
traceback. The exception type should be a class. Do not pass an invalid
473479
exception type or value. (Violating these rules will cause subtle problems
@@ -478,18 +484,17 @@ Querying the error indicator
478484
479485
.. note::
480486
481-
This function is normally only used by code that needs to save and restore the
482-
error indicator temporarily. Use :c:func:`PyErr_Fetch` to save the current
483-
error indicator.
484-
485-
.. deprecated:: 3.12
487+
This function is normally only used by legacy code that needs to
488+
save and restore the error indicator temporarily.
489+
Use :c:func:`PyErr_Fetch` to save the current error indicator.
486490
487491
488492
.. c:function:: void PyErr_NormalizeException(PyObject **exc, PyObject **val, PyObject **tb)
489493
490-
As of 3.12, this function is deprecated.
491-
Use :c:func:`PyErr_GetRaisedException` instead of :c:func:`PyErr_Fetch` to avoid
492-
any possible de-normalization.
494+
.. deprecated:: 3.12
495+
496+
Use :c:func:`PyErr_GetRaisedException` instead,
497+
to avoid any possible de-normalization.
493498
494499
Under certain circumstances, the values returned by :c:func:`PyErr_Fetch` below
495500
can be "unnormalized", meaning that ``*exc`` is a class object but ``*val`` is
@@ -507,8 +512,6 @@ Querying the error indicator
507512
PyException_SetTraceback(val, tb);
508513
}
509514
510-
.. deprecated:: 3.12
511-
512515
513516
.. c:function:: PyObject* PyErr_GetHandledException(void)
514517
@@ -756,14 +759,12 @@ Exception Objects
756759
757760
.. c:function:: PyObject* PyException_GetArgs(PyObject *ex)
758761
759-
Return args of the given exception as a new reference,
760-
as accessible from Python through :attr:`args`.
762+
Return :attr:`~BaseException.args` of exception *ex*.
761763
762764
763765
.. c:function:: void PyException_SetArgs(PyObject *ex, PyObject *args)
764766
765-
Set the args of the given exception,
766-
as accessible from Python through :attr:`args`.
767+
Set :attr:`~BaseException.args` of exception *ex* to *args*.
767768
768769
769770
.. _unicodeexceptions:

Doc/c-api/init.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ Process-wide parameters
818818
.. deprecated:: 3.11
819819
820820
821-
.. c:function:: w_char* Py_GetPythonHome()
821+
.. c:function:: wchar_t* Py_GetPythonHome()
822822
823823
Return the default "home", that is, the value set by a previous call to
824824
:c:func:`Py_SetPythonHome`, or the value of the :envvar:`PYTHONHOME`

Doc/c-api/stable.rst

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
C API Stability
77
***************
88

9-
Python's C API is covered by the Backwards Compatibility Policy, :pep:`387`.
10-
While the C API will change with every minor release (e.g. from 3.9 to 3.10),
11-
most changes will be source-compatible, typically by only adding new API.
9+
Unless documented otherwise, Python's C API is covered by the Backwards
10+
Compatibility Policy, :pep:`387`.
11+
Most changes to it are source-compatible (typically by only adding new API).
1212
Changing existing API or removing API is only done after a deprecation period
1313
or to fix serious issues.
1414

@@ -18,8 +18,38 @@ way; see :ref:`stable-abi-platform` below).
1818
So, code compiled for Python 3.10.0 will work on 3.10.8 and vice versa,
1919
but will need to be compiled separately for 3.9.x and 3.10.x.
2020

21+
There are two tiers of C API with different stability exepectations:
22+
23+
- *Unstable API*, may change in minor versions without a deprecation period.
24+
It is marked by the ``PyUnstable`` prefix in names.
25+
- *Limited API*, is compatible across several minor releases.
26+
When :c:macro:`Py_LIMITED_API` is defined, only this subset is exposed
27+
from ``Python.h``.
28+
29+
These are discussed in more detail below.
30+
2131
Names prefixed by an underscore, such as ``_Py_InternalState``,
2232
are private API that can change without notice even in patch releases.
33+
If you need to use this API, consider reaching out to
34+
`CPython developers <https://discuss.python.org/c/core-dev/c-api/30>`_
35+
to discuss adding public API for your use case.
36+
37+
.. _unstable-c-api:
38+
39+
Unstable C API
40+
==============
41+
42+
.. index:: single: PyUnstable
43+
44+
Any API named with the ``PyUnstable`` prefix exposes CPython implementation
45+
details, and may change in every minor release (e.g. from 3.9 to 3.10) without
46+
any deprecation warnings.
47+
However, it will not change in a bugfix release (e.g. from 3.10.0 to 3.10.1).
48+
49+
It is generally intended for specialized, low-level tools like debuggers.
50+
51+
Projects that use this API are expected to follow
52+
CPython development and spend extra effort adjusting to changes.
2353

2454

2555
Stable Application Binary Interface

Doc/data/refcounts.dat

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,8 @@ PyEval_EvalFrameEx:int:throwflag::
839839
PyEval_MergeCompilerFlags:int:::
840840
PyEval_MergeCompilerFlags:PyCompilerFlags*:cf::
841841

842+
PyException_GetArgs:PyObject*::+1:
843+
842844
PyException_GetCause:PyObject*::+1:
843845
PyException_GetCause:PyObject*:ex:0:
844846

Doc/howto/logging-cookbook.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2538,7 +2538,7 @@ should be logged, or the ``extra`` keyword parameter to indicate additional
25382538
contextual information to be added to the log). So you cannot directly make
25392539
logging calls using :meth:`str.format` or :class:`string.Template` syntax,
25402540
because internally the logging package uses %-formatting to merge the format
2541-
string and the variable arguments. There would no changing this while preserving
2541+
string and the variable arguments. There would be no changing this while preserving
25422542
backward compatibility, since all logging calls which are out there in existing
25432543
code will be using %-format strings.
25442544

Doc/library/asyncio-eventloop.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -524,8 +524,8 @@ Opening network connections
524524
When a server's IPv4 path and protocol are working, but the server's
525525
IPv6 path and protocol are not working, a dual-stack client
526526
application experiences significant connection delay compared to an
527-
IPv4-only client. This is undesirable because it causes the dual-
528-
stack client to have a worse user experience. This document
527+
IPv4-only client. This is undesirable because it causes the
528+
dual-stack client to have a worse user experience. This document
529529
specifies requirements for algorithms that reduce this user-visible
530530
delay and provides an algorithm.
531531

0 commit comments

Comments
 (0)