python / python/cpython

Python.h conflicts with stdlib.h if included after that

Open
#155,321 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build type-bug
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Bug report

Bug description:

Issue: Inconsistent _POSIX_C_SOURCE definition causes compilation errors when Python.h is included after system headers

Environment:

  • Fedora 44
  • CPython 3.14 (distro-provided packages)
  • Go 1.26 with CGo

Description:

When Python.h is included after system headers such as stdlib.h, a compilation error occurs due to conflicting definitions of the _POSIX_C_SOURCE macro. The conflict arises because:

  • Python.h indirectly defines _POSIX_C_SOURCE via its inclusion of pyconfig-64.h (located at /usr/include/python3.14/pyconfig-64.h)
  • System headers like stdlib.h also define _POSIX_C_SOURCE via their inclusion of /usr/include/features.h
  • The two definitions differ, triggering a compiler diagnostic

Context:

While the official CPython documentation recommends including Python.h before any other headers, this is not always feasible. In my specific use case, I'm using the libpython3.so shared library from Go via CGo. The CGo toolchain automatically generates a C helper file that puts #include <stdlib.h> before any user-provided code, making it impossible to adhere to the "include Python.h first" recommendation.

Current workaround:

I'm currently using #undef _POSIX_C_SOURCE immediately before including Python.h:

#undef _POSIX_C_SOURCE
#include <Python.h>

However, this approach is fragile and potentially unsafe, as it may cause system headers to be compiled with different _POSIX_C_SOURCE values across translation units, leading to subtle ABI mismatches or undefined behavior.

Proposed fix:

Modify the generated pyconfig-*.h files to guard the _POSIX_C_SOURCE definition with #ifndef/#endif preprocessor directives, similar to how other feature test macros are often handled:

#ifndef _POSIX_C_SOURCE
#define _POSIX_C_SOURCE 200809L  /* or whatever version is currently used */
#endif

This change would make the definition idempotent and prevent compilation errors regardless of include order, while maintaining the intended feature test macro settings.

Impact:

This issue affects any project that:

  • Uses CPython's C API
  • Cannot control the include order of system headers (e.g., via CGo, SWIG, or other binding generators)
  • Builds on platforms where _POSIX_C_SOURCE is defined by system headers

Cc: @sobolevn

CPython versions tested on:

3.14

Operating systems tested on:

Linux

Linked PRs
  • gh-155343

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the issue's linked PR, gh-155343, and the generated pyconfig-*.h files involved in the _POSIX_C_SOURCE definition. Compare how Python.h behaves when included after stdlib.h, then use the reported Fedora 44 and CPython 3.14 setup to reproduce the compilation error. Done means the include-order case no longer produces conflicting macro diagnostics without introducing inconsistent feature-test settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.