Visitar URL original
Docs: Add reST directives to c-api/intro#Include_Files by aeros · Pull Request #14698 · python/cpython · GitHub
Skip to content

Docs: Add reST directives to c-api/intro#Include_Files #14698

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.

Sign up for GitHub

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

Merged
benjaminp merged 6 commits into from
Sep 10, 2019
Merged

Docs: Add reST directives to c-api/intro#Include_Files #14698

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3e4e456
Merge pull request #1 from python/master
aeros Jul 4, 2019
60df01a
Merge remote-tracking branch 'upstream/master'
aeros Jul 9, 2019
42c11cf
Docs: Add RST directives to c-api/intro#Include_Files
aeros Jul 11, 2019
5924d1d
Remove trailing whitespace
aeros Jul 11, 2019
5997dd1
Apply suggestions
aeros Sep 10, 2019
e378f3e
Fix words per line
aeros Sep 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ Include Files
=============

All function, type and macro definitions needed to use the Python/C API are
included in your code by the following line::
included in your code by the following line:

.. code:: c
Comment thread
aeros marked this conversation as resolved.
Outdated

#define PY_SSIZE_T_CLEAN
#include <Python.h>
Expand All @@ -69,10 +71,12 @@ standard headers) have one of the prefixes ``Py`` or ``_Py``. Names beginning
with ``_Py`` are for internal use by the Python implementation and should not be
used by extension writers. Structure member names do not have a reserved prefix.

**Important:** user code should never define names that begin with ``Py`` or
``_Py``. This confuses the reader, and jeopardizes the portability of the user
code to future Python versions, which may define additional names beginning with
one of these prefixes.
.. important::

User code should never define names that begin with ``Py`` or
Comment thread
aeros marked this conversation as resolved.
Outdated
``_Py``. This confuses the reader, and jeopardizes the portability of the user
code to future Python versions, which may define additional names beginning with
one of these prefixes.

The header files are typically installed with Python. On Unix, these are
located in the directories :file:`{prefix}/include/pythonversion/` and
Expand All @@ -90,9 +94,11 @@ multi-platform builds since the platform independent headers under
:envvar:`prefix` include the platform specific headers from
:envvar:`exec_prefix`.

C++ users should note that though the API is defined entirely using C, the
header files do properly declare the entry points to be ``extern "C"``, so there
is no need to do anything special to use the API from C++.
.. note::
Comment thread
aeros marked this conversation as resolved.
Outdated

C++ users should note that although the API is defined entirely using C, the
header files properly declare the entry points to be ``extern "C"``. As a result,
there is no need to do anything special to use the API from C++.


Useful macros
Expand Down