mirror of
https://github.com/python/cpython.git
synced 2025-11-01 18:51:43 +00:00
Document the rule that Python.h must be included before any standard
headers. This is the final checkin for SF bug #458768.
This commit is contained in:
parent
9b88b4c9e8
commit
396ca574dd
2 changed files with 7 additions and 2 deletions
|
|
@ -76,6 +76,9 @@ API are included in your code by the following line:
|
|||
This implies inclusion of the following standard headers:
|
||||
\code{<stdio.h>}, \code{<string.h>}, \code{<errno.h>},
|
||||
\code{<limits.h>}, and \code{<stdlib.h>} (if available).
|
||||
Since Python may define some pre-processor definitions which affect
|
||||
the standard headers on some systems, you must include \file{Python.h}
|
||||
before any standard headers are included.
|
||||
|
||||
All user visible names defined by Python.h (except those defined by
|
||||
the included standard headers) have one of the prefixes \samp{Py} or
|
||||
|
|
|
|||
|
|
@ -46,8 +46,11 @@ The first line of our file can be:
|
|||
|
||||
which pulls in the Python API (you can add a comment describing the
|
||||
purpose of the module and a copyright notice if you like).
|
||||
Since Python may define some pre-processor definitions which affect
|
||||
the standard headers on some systems, you must include \file{Python.h}
|
||||
before any standard headers are included.
|
||||
|
||||
All user-visible symbols defined by \code{"Python.h"} have a prefix of
|
||||
All user-visible symbols defined by \file{Python.h} have a prefix of
|
||||
\samp{Py} or \samp{PY}, except those defined in standard header files.
|
||||
For convenience, and since they are used extensively by the Python
|
||||
interpreter, \code{"Python.h"} includes a few standard header files:
|
||||
|
|
@ -951,7 +954,6 @@ Geoff Philbrick (\email{philbrick@hks.com}):%
|
|||
\index{Philbrick, Geoff}
|
||||
|
||||
\begin{verbatim}
|
||||
#include <stdio.h>
|
||||
#include "Python.h"
|
||||
|
||||
static PyObject *
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue