Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-35134: Create Include/cpython/ subdirectory #10624

Merged
merged 1 commit into from
Nov 23, 2018
Merged

bpo-35134: Create Include/cpython/ subdirectory #10624

merged 1 commit into from
Nov 23, 2018

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Nov 20, 2018

Include/.h should be the "portable Python API", whereas
Include/cpython/
.h should be the "CPython API": CPython
implementation details.

Changes:

  • Create Include/cpython/ subdirectory
  • "make install" now creates $prefix/include/cpython and copy
    Include/cpython/* to $prefix/include/cpython
  • Create Include/cpython/objimpl.h: move objimpl.h code
    surrounded by "#ifndef Py_LIMITED_API" to cpython/objimpl.h.
  • objimpl.h now includes cpython/objimpl.h

https://bugs.python.org/issue35134

@vstinner
Copy link
Member Author

I rebased my change on top of master to retrieve PR #10626 bugfix.

@vstinner
Copy link
Member Author

@ncoghlan, @serhiy-storchaka, @pitrou, @zooba, @ericsnowcurrently: Would you mind to review this PR? I created a new Include/unstable/ subdirectory for all "#ifndef Py_LIMITED_API" APIs. See https://bugs.python.org/issue35134 for the rationale.

@vstinner
Copy link
Member Author

I plan to merge this PR next week.

#endif

#ifndef _Py_UNSTABLE_OBJIMPL_H
# error "this header file must not be included directly"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to quibble about the directory name, but given this style of inclusion (i.e. only implicitly via the public header file when Py_LIMITED_API is not defined), I think 'unstable' is OK.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mostly wrote this #error to prevent the risk of bikeshedding, LOL!

@vstinner
Copy link
Member Author

@ncoghlan: You approved the PR but proposed a different directory name. Are you ok with "unstable" name? https://bugs.python.org/issue35134#msg330261

@vstinner
Copy link
Member Author

Note: this PR is my second attempt, the first one was PR #10285 which wasn't properly designed.

@zooba
Copy link
Member

zooba commented Nov 22, 2018

There's no real easy way to test it, but Tools/msi/dev/dev.wixproj is going to need its <InstallFiles Include="$(PySourcePath)include\*.h"> line changed to <InstallFiles Include="$(PySourcePath)include\**\*.h"> (or a semi-colon separated list of directories to include in the installer).

Better to make the change now and cause the installer build to break than to accidentally ship without necessary headers. If it doesn't work, I'll fix it up.

@vstinner
Copy link
Member Author

@zooba: Aha, I was looking for the code of the Windows installer.

Tools/msi/dev/dev.wixproj is going to need its line changed to

Right now, Include/internal/ is not installed (on Unix at least). I just proposed to install these headers as well: https://bugs.python.org/issue35296

Would it be possible to only update the MSI installer once this PR and PR #10665 are merged?

@vstinner vstinner changed the title bpo-35134: Create Include/unstable/ subdirectory bpo-35134: Create Include/cpython/ subdirectory Nov 23, 2018
@vstinner
Copy link
Member Author

I renamed the subdirectory from Include/unstable/ to Include/cpython/.

@zooba
Copy link
Member

zooba commented Nov 23, 2018

@vstinner If you're willing to keep reminding me to do it once this is merged until it's done, sure.

Include/*.h should be the "portable Python API", whereas
Include/cpython/*.h should be the "CPython API": CPython
implementation details.

Changes:

* Create Include/cpython/ subdirectory
* "make install" now creates $prefix/include/cpython and copy
  Include/cpython/* to $prefix/include/cpython
* Create Include/cpython/objimpl.h: move objimpl.h code
  surrounded by "#ifndef Py_LIMITED_API" to cpython/objimpl.h.
* objimpl.h now includes cpython/objimpl.h
* Windows installer (MSI) now also install Include/ subdirectories:
  Include/cpython/ and Include/internal/.
@vstinner
Copy link
Member Author

@vstinner If you're willing to keep reminding me to do it once this is merged until it's done, sure.

I merged my PR #10665 (make install now installs the internal API) and I udpated this PR to apply your proposed change in MSI (copy Include/**/*.h).

@vstinner vstinner merged commit e421106 into python:master Nov 23, 2018
@vstinner vstinner deleted the unstable_api branch November 23, 2018 16:00
@ncoghlan
Copy link
Contributor

@vstinner While I preferred "cpython" as the directory name, I was OK with "unstable", hence the original approval. I'm happy you decided to switch the name anyway, though :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants