Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-08 06:10:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
cpython/Doc/extending/building.rst

31 lines
860 B
ReStructuredText
Raw Normal View History

Doc: Replace the deprecated highlightlang directive by highlight. (#13377) highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 11:55:34 +02:00
.. highlight:: c
Move the 3k reST doc tree in place.
2007-08-15 14:28:22 +00:00
.. _building:
Close #24458: PEP 489 documentation Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
*****************************
Building C and C++ Extensions
*****************************
Move the 3k reST doc tree in place.
2007-08-15 14:28:22 +00:00
gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) Document behaviour of single-phase init. Call it "legacy". Reorganize PyModule docs. Move PyInit_modulename docs from the tutorial to reference documentation. Move PyMODINIT_FUNC docs from generic macros to the new page. Add doc stubs for `PYTHON_API_VERSION` & `PYTHON_ABI_VERSION` Remove incorrect refcounts.dat entry for `PyModuleDef_Init`. This removes the "Return value: Borrowed reference." note. Instead, note that the function sometimes returns a borrowed reference, sometimes as strong one. (IMO, it's best to not think of `PyModuleDef` as a `PyObject` at all, and act like it can't be reference-counted.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-06-13 16:39:35 +02:00
A C extension for CPython is a shared library (for example, a ``.so`` file on
Linux, ``.pyd`` on Windows), which exports an *initialization function*.
Close #24458: PEP 489 documentation Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) Document behaviour of single-phase init. Call it "legacy". Reorganize PyModule docs. Move PyInit_modulename docs from the tutorial to reference documentation. Move PyMODINIT_FUNC docs from generic macros to the new page. Add doc stubs for `PYTHON_API_VERSION` & `PYTHON_ABI_VERSION` Remove incorrect refcounts.dat entry for `PyModuleDef_Init`. This removes the "Return value: Borrowed reference." note. Instead, note that the function sometimes returns a borrowed reference, sometimes as strong one. (IMO, it's best to not think of `PyModuleDef` as a `PyObject` at all, and act like it can't be reference-counted.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-06-13 16:39:35 +02:00
See :ref:`extension-modules` for details.
Close #24458: PEP 489 documentation Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
Doc: Replace the deprecated highlightlang directive by highlight. (#13377) highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 11:55:34 +02:00
.. highlight:: c
Close #24458: PEP 489 documentation Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
GH-92584: Remove Installing Python Modules (Distutils version) (#108020)
2023-08-16 22:06:56 +01:00
.. _install-index:
gh-85454: Remove distutils documentation (#95239) Most places now refer to setuptools or link to setuptools documentation. Some examples like zipapp need to be updated later.
2022-07-25 15:50:46 +02:00
.. _setuptools-index:
Close #24458: PEP 489 documentation Patch by Petr Viktorin.
2015-07-03 19:49:15 +10:00
gh-85454: Remove distutils documentation (#95239) Most places now refer to setuptools or link to setuptools documentation. Some examples like zipapp need to be updated later.
2022-07-25 15:50:46 +02:00
Building C and C++ Extensions with setuptools
=============================================
Move the 3k reST doc tree in place.
2007-08-15 14:28:22 +00:00
gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) Document behaviour of single-phase init. Call it "legacy". Reorganize PyModule docs. Move PyInit_modulename docs from the tutorial to reference documentation. Move PyMODINIT_FUNC docs from generic macros to the new page. Add doc stubs for `PYTHON_API_VERSION` & `PYTHON_ABI_VERSION` Remove incorrect refcounts.dat entry for `PyModuleDef_Init`. This removes the "Return value: Borrowed reference." note. Instead, note that the function sometimes returns a borrowed reference, sometimes as strong one. (IMO, it's best to not think of `PyModuleDef` as a `PyObject` at all, and act like it can't be reference-counted.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2025-06-13 16:39:35 +02:00
Building, packaging and distributing extension modules is best done with
third-party tools, and is out of scope of this document.
One suitable tool is Setuptools, whose documentation can be found at
https://setuptools.pypa.io/en/latest/setuptools.html.
The :mod:`distutils` module, which was included in the standard library
until Python 3.12, is now maintained as part of Setuptools.
Reference in a new issue Copy permalink