bpo-38353: Cleanup includes in the internal C API#16548
Merged
vstinner merged 2 commits intopython:masterfrom Oct 2, 2019
vstinner:pathconfig
Merged
bpo-38353: Cleanup includes in the internal C API#16548vstinner merged 2 commits intopython:masterfrom vstinner:pathconfig
vstinner merged 2 commits intopython:masterfrom
vstinner:pathconfig
Conversation
Use forward declaration of types to avoid includes in the internal C API. Add also comment to justify other includes.
brettcannon
approved these changes
Oct 2, 2019
Member
Author
|
@brettcannon: Thanks for the review ;-) |
|
ncoghlan
reviewed
Oct 4, 2019
| #include "pycore_pystate.h" | ||
| #include "pythread.h" | ||
| /* Forward declarations */ | ||
| typedef struct pyruntimestate _PyRuntimeState; |
Contributor
There was a problem hiding this comment.
The fact that 3 different headers need this same typedef makes me wonder if it might be worth having a short header called pycore_state_typedefs.h that was enough to allow declaration of APIs accepting state pointers, without needing to include the full state struct definitions.
Something like:
typedef struct _PyArgv _PyArgv;
typedef struct pyruntimestate _PyRuntimeState;
typedef struct _is PyInterpreterState;
struct _ceval_runtime_state;
Member
Author
Adding a new header file requires to modify the Unix (Makefile.pre.in) and the Windows (Visual Studio project files, at least 2 files) build systems. IMHO it's too annoying. I'm fine with duplicating these forward definitions. |
Contributor
|
Hmm, I thought it was only new C files that were that annoying to add, but I admit it's been ages since I added a new header file. |
jacobneiltaylor
pushed a commit
to jacobneiltaylor/cpython
that referenced
this pull request
Dec 5, 2019
Use forward declaration of types to avoid includes in the internal C API. Add also comment to justify other includes.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Use forward declaration of types to avoid includes in the internal C
API. Add also comment to justify other includes.
https://bugs.python.org/issue38353