FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-35134: Create Include/cpython/ subdirectory by vstinner · Pull Request #10624 · python/cpython · GitHub

/ cpython Public

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

Merged
vstinner merged 1 commit into
python:masterfrom
vstinner:unstable_api
Nov 23, 2018
ConversationCommits (1)ChecksFiles changed
Merged

bpo-35134: Create Include/cpython/ subdirectory#10624
vstinner merged 1 commit into
python:masterfrom
vstinner:unstable_api

Conversation

vstinner commented Nov 20, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

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 requested a review from a team as a code owner November 20, 2018 22:37
vstinner mentioned this pull request Nov 20, 2018
Closed

vstinner commented Nov 20, 2018

Copy link
Copy Markdown
Member Author

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

vstinner commented Nov 21, 2018

Copy link
Copy Markdown
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 commented Nov 21, 2018

Copy link
Copy Markdown
Member Author

I plan to merge this PR next week.

ncoghlan approved these changes Nov 22, 2018
View reviewed changes
Comment thread Include/unstable/objimpl.h Outdated

ncoghlan Nov 22, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

vstinner Nov 22, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

vstinner commented Nov 22, 2018

Copy link
Copy Markdown
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 commented Nov 22, 2018

Copy link
Copy Markdown
Member Author

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

zooba commented Nov 22, 2018

Copy link
Copy Markdown
Member

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 commented Nov 22, 2018

Copy link
Copy Markdown
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 changed the title bpo-35134: Create Include/unstable/ subdirectory bpo-35134: Create Include/cpython/ subdirectory Nov 23, 2018

vstinner commented Nov 23, 2018

Copy link
Copy Markdown
Member Author

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

zooba commented Nov 23, 2018

Copy link
Copy Markdown
Member

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

bpo-35134: Create Include/cpython/ subdirectory
9aa3567 
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 commented Nov 23, 2018

Copy link
Copy Markdown
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 merged commit e421106 into python:master Nov 23, 2018
vstinner deleted the unstable_api branch November 23, 2018 16:00

ncoghlan commented Nov 24, 2018

Copy link
Copy Markdown
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 :)

vstinner mentioned this pull request Apr 10, 2022
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ncoghlan ncoghlan approved these changes
serhiy-storchaka Awaiting requested review from serhiy-storchaka
ericsnowcurrently Awaiting requested review from ericsnowcurrently

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL