Install Include/internal/ header files

[vstinner]

BPO	35296
Nosy	@nascheme, @ncoghlan, @vstinner, @ericsnowcurrently
PRs	bpo-35296: make install now installs the internal API #10665 [3.7] bpo-35296: make install now installs the internal API (GH-10665) #10897

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-12-04.20:30:54.981>
created_at = <Date 2018-11-22.17:33:21.462>
labels = ['interpreter-core', '3.7', '3.8']
title = 'Install Include/internal/ header files'
updated_at = <Date 2021-05-28.18:33:59.287>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2021-05-28.18:33:59.287>
actor = 'mark.dickinson'
assignee = 'none'
closed = True
closed_date = <Date 2018-12-04.20:30:54.981>
closer = 'vstinner'
components = ['Interpreter Core']
creation = <Date 2018-11-22.17:33:21.462>
creator = 'vstinner'
dependencies = []
files = []
hgrepos = []
issue_num = 35296
keywords = ['patch']
message_count = 7.0
messages = ['330271', '330274', '330275', '330332', '330333', '331060', '331076']
nosy_count = 5.0
nosy_names = ['nascheme', 'ncoghlan', 'vstinner', 'eric.snow', 'ponnuchamy4929']
pr_nums = ['10665', '10897']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue35296'
versions = ['Python 3.7', 'Python 3.8']

[vstinner]

For some very specific use cases (ex: debuggers), it can be interesting to access the internal API of CPython. I propose to install the internal API: Include/internal/*.h header files.

Attached PR implements this idea.

[vstinner]

Example of debuggers: vmprof or faulthandler (now part of the stdlib).

[vstinner]

TODO: Update the Windows installer:
#10624 (comment)

[vstinner]

New changeset f653fd4 by Victor Stinner in branch 'master':
bpo-35296: make install now installs the internal API (GH-10665)
f653fd4

[vstinner]

I decided to merge my PR because I started to *remove* functions from the public C API to move them to the CPython internal API: _PyObject_GC_TRACK() and _PyObject_GC_UNTRACK() are two examples from bpo-35081. So some people might want even more to use the internal API. The main issue with this API is the requirement to use the same compiler with the same compilation options, especially to access atomic variables.

[vstinner]

I reopen the issue since I'm now also interested to make the change in Python 3.7. I wrote PR 10897.

See discussion on python-dev:
https://mail.python.org/pipermail/python-dev/2018-December/155921.html

[vstinner]

New changeset b02774f by Victor Stinner in branch '3.7':
bpo-35296: make install now installs the internal API (GH-10665) (GH-10897)
b02774f