intro.md
1> **Источник:** https://python-all.ru/3.5/c-api/intro.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Введение89Интерфейс прикладного программирования Python предоставляет программистам на C и C++ доступ к интерпретатору Python на различных уровнях. API одинаково пригоден для использования из C++, но для краткости его обычно называют Python/C API. Есть две принципиально разные причины для использования Python/C API. Первая – написание *модулей расширения* для конкретных целей; это модули на C, которые расширяют интерпретатор Python. Вероятно, это наиболее распространённое применение. Вторая – использование Python как компонента в более крупном приложении; этот метод обычно называют *встраиванием* Python в приложение.1011Написание модуля расширения – процесс относительно хорошо понятный, и здесь хорошо работает подход «сборника рецептов». Существует несколько инструментов, которые автоматизируют процесс в той или иной степени. Хотя Python встраивали в другие приложения с самого его появления, процесс встраивания Python менее прямолинеен, чем написание расширения.1213Многие функции API полезны независимо от того, встраивается Python или расширяется; более того, большинство приложений, встраивающих Python, также должны предоставлять собственное расширение, поэтому, вероятно, стоит ознакомиться с написанием расширения, прежде чем пытаться встроить Python в реальное приложение.1415## Заголовочные файлы1617Все определения функций, типов и макросов, необходимые для использования Python/C API, включаются в код с помощью следующей строки:1819```c20#include "Python.h"21```2223Это подразумевает включение следующих стандартных заголовочных файлов: `<stdio.h>`, `<string.h>`, `<errno.h>`, `<limits.h>`, `<assert.h>` и `<stdlib.h>` (если доступны).2425> **Примечание**26>27> Поскольку Python может определять некоторые директивы препроцессора, которые влияют на стандартные заголовочные файлы в некоторых системах, *необходимо* включать `Python.h` до того, как будут включены любые стандартные заголовочные файлы.2829Все видимые пользователю имена, определённые Python.h (кроме тех, что определены включёнными стандартными заголовками), имеют один из префиксов `Py` или `_Py`. Имена, начинающиеся с `_Py`, предназначены для внутреннего использования реализацией Python и не должны использоваться разработчиками расширений. Имена членов структур не имеют зарезервированного префикса.3031**Важно:** пользовательский код никогда не должен определять имена, начинающиеся с `Py` или `_Py`. Это сбивает с толку читателя и ставит под угрозу переносимость пользовательского кода на будущие версии Python, которые могут определять дополнительные имена, начинающиеся с одного из этих префиксов.3233Заголовочные файлы обычно устанавливаются вместе с Python. В Unix они находятся в каталогах `prefix/include/pythonversion/` и `exec_prefix/include/pythonversion/`, где `prefix` и `exec_prefix` задаются соответствующими параметрами сценария Python **configure**, а *версия* – это `sys.version[:3]`. В Windows заголовочные файлы устанавливаются в `prefix/include`, где `prefix` – каталог установки, указанный в инсталляторе.3435Чтобы подключить заголовочные файлы, поместите оба каталога (если они разные) в путь поиска include вашего компилятора. *Не* помещайте родительские каталоги в путь поиска и затем используйте `#include <pythonX.Y/Python.h>`; это нарушит сборку на нескольких платформах, поскольку независимые от платформы заголовки в `prefix` включают платформозависимые заголовки из `exec_prefix`.3637Пользователям C++ следует отметить, что, хотя API целиком определён на C, заголовочные файлы правильно объявляют точки входа как `extern "C"`, поэтому нет необходимости делать что-то особенное для использования API из C++.3839## Объекты, типы и счетчики ссылок4041Большинство функций Python/C API принимают один или несколько аргументов и возвращают значение типа [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Этот тип является указателем на непрозрачный тип данных, представляющий произвольный объект Python. Поскольку все типы объектов Python в большинстве ситуаций обрабатываются одинаково (например, присваивание, правила видимости и передача аргументов), логично, что они должны быть представлены одним типом C. Почти все объекты Python находятся в куче: никогда не объявляется автоматическая или статическая переменная типа [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject), можно объявить только переменные-указатели типа [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Единственное исключение – объекты типов; поскольку они никогда не должны освобождаться, они обычно являются статическими объектами [`PyTypeObject`](https://python-all.ru/3.5/c-api/type.html#c.PyTypeObject).4243Все объекты Python (даже целые числа Python) имеют *тип* и *счетчик ссылок*. Тип объекта определяет, что это за объект (например, целое число, список или пользовательская функция; существует гораздо больше типов, как описано в [Стандартная иерархия типов](https://python-all.ru/3.5/reference/datamodel.html#types)). Для каждого из известных типов существует макрос, проверяющий, является ли объект объектом этого типа; например, `PyList_Check(a)` истинно тогда и только тогда, когда объект, на который указывает *a*, является списком Python.4445### Счетчики ссылок4647Счётчик ссылок важен, потому что у современных компьютеров конечный (и зачастую сильно ограниченный) объём памяти; он показывает, сколько разных мест содержат ссылку на объект. Таким местом может быть другой объект, глобальная (или статическая) переменная C или локальная переменная в какой-нибудь функции C. Когда счётчик ссылок объекта становится нулевым, объект освобождается. Если он содержит ссылки на другие объекты, их счётчик ссылок уменьшается. Эти другие объекты могут в свою очередь быть освобождены, если это уменьшение обнулит их счётчик ссылок, и так далее. (Здесь очевидна проблема с объектами, которые ссылаются друг на друга; пока решение – «не делайте так».)4849Счётчики ссылок всегда изменяются явно. Обычно используется макрос [`Py_INCREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_INCREF) для увеличения счётчика ссылок объекта на единицу и [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF) для уменьшения на единицу. Макрос [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF) значительно сложнее, чем макрос увеличения, поскольку он должен проверять, не стал ли счётчик ссылок нулевым, и затем вызывать деаллокатор объекта. Деаллокатор – это указатель на функцию, содержащийся в структуре типа объекта. Деаллокатор, специфичный для типа, занимается уменьшением счётчиков ссылок других объектов, содержащихся в данном объекте (если это составной тип, например список), а также выполняет любую дополнительную финализацию, если необходимо. Счётчик ссылок не может переполниться; для его хранения используется как минимум столько же битов, сколько уникальных адресов памяти в виртуальной памяти (при условии `sizeof(Py_ssize_t) >= sizeof(void*)`). Таким образом, увеличение счётчика ссылок – простая операция.5051Нет необходимости увеличивать счётчик ссылок объекта для каждой локальной переменной, содержащей указатель на объект. Теоретически, счётчик ссылок объекта увеличивается на единицу, когда переменная начинает на него указывать, и уменьшается на единицу, когда переменная выходит из области видимости. Однако эти изменения компенсируют друг друга, поэтому в итоге счётчик ссылок не меняется. Единственная реальная причина использовать счётчик ссылок – предотвратить освобождение объекта, пока наша переменная указывает на него. Если мы знаем, что существует хотя бы одна другая ссылка на объект, которая живёт как минимум столько же, сколько наша переменная, то нет необходимости временно увеличивать счётчик ссылок. Важная ситуация, где это возникает, – объекты, передаваемые в качестве аргументов функциям C в модуле расширения, вызываемом из Python; механизм вызова гарантирует удержание ссылки на каждый аргумент в течение всего вызова.5253Однако распространённая ловушка – извлечь объект из списка и удерживать его какое-то время, не увеличивая его счётчик ссылок. Другая операция может удалить объект из списка, уменьшив его счётчик ссылок и, возможно, освободив его. Реальная опасность в том, что безобидные операции могут вызвать произвольный код Python, способный это сделать; существует путь выполнения, позволяющий вернуть управление пользователю из [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF), поэтому практически любая операция потенциально опасна.5455Безопасный подход – всегда использовать общие операции (функции, имена которых начинаются с `PyObject_`, `PyNumber_`, `PySequence_` или `PyMapping_`). Эти операции всегда увеличивают счётчик ссылок возвращаемого объекта. Это оставляет вызывающей стороне обязанность вызвать [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF), когда результат больше не нужен; это быстро входит в привычку.5657#### Подробности о счетчиках ссылок5859Поведение счётчика ссылок у функций Python/C API лучше всего объяснять в терминах *владения ссылками*. Владение относится к ссылкам, а не к объектам (объектами не владеют: они всегда разделяются). «Владеть ссылкой» означает нести ответственность за вызов Py\_DECREF для неё, когда ссылка больше не нужна. Владение также может передаваться, то есть код, получивший владение ссылкой, становится ответственным за последующий вызов [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF) или [`Py_XDECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_XDECREF), когда она больше не нужна, или за передачу этой ответственности дальше (обычно своему вызывающему). Когда функция передаёт владение ссылкой своему вызывающему, говорят, что вызывающий получает *новую* ссылку. Если владение не передаётся, говорят, что вызывающий *заимствует* ссылку. С заимствованной ссылкой ничего делать не нужно.6061И наоборот, когда вызывающая функция передаёт ссылку на объект, есть две возможности: функция *крадёт* ссылку на объект, или нет. *Кража ссылки* означает, что при передаче ссылки функции эта функция считает, что теперь она владеет этой ссылкой, и вы больше не несёте за неё ответственность.6263Немногие функции крадут ссылки; двумя заметными исключениями являются [`PyList_SetItem()`](https://python-all.ru/3.5/c-api/list.html#c.PyList_SetItem) и [`PyTuple_SetItem()`](https://python-all.ru/3.5/c-api/tuple.html#c.PyTuple_SetItem), которые крадут ссылку на элемент (но не на кортеж или список, в который помещается элемент!). Эти функции были спроектированы так, чтобы красть ссылку из-за распространенного идиоматического приема заполнения кортежа или списка только что созданными объектами; например, код для создания кортежа `(1, 2, "three")` может выглядеть так (пока забывая об обработке ошибок; лучший способ написать это показан ниже):6465```c66PyObject *t;6768t = PyTuple_New(3);69PyTuple_SetItem(t, 0, PyLong_FromLong(1L));70PyTuple_SetItem(t, 1, PyLong_FromLong(2L));71PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));72```7374Здесь [`PyLong_FromLong()`](https://python-all.ru/3.5/c-api/long.html#c.PyLong_FromLong) возвращает новую ссылку, которая немедленно крадется [`PyTuple_SetItem()`](https://python-all.ru/3.5/c-api/tuple.html#c.PyTuple_SetItem). Если требуется продолжать использовать объект, хотя ссылка на него будет украдена, используйте [`Py_INCREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_INCREF), чтобы получить другую ссылку перед вызовом функции, крадущей ссылки.7576Кстати, [`PyTuple_SetItem()`](https://python-all.ru/3.5/c-api/tuple.html#c.PyTuple_SetItem) – это *единственный* способ задать элементы кортежа. [`PySequence_SetItem()`](https://python-all.ru/3.5/c-api/sequence.html#c.PySequence_SetItem) и [`PyObject_SetItem()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_SetItem) отказываются это делать, поскольку кортежи – неизменяемый тип данных. Используйте [`PyTuple_SetItem()`](https://python-all.ru/3.5/c-api/tuple.html#c.PyTuple_SetItem) только для кортежей, которые создаёте самостоятельно.7778Эквивалентный код для заполнения списка можно написать с помощью [`PyList_New()`](https://python-all.ru/3.5/c-api/list.html#c.PyList_New) и [`PyList_SetItem()`](https://python-all.ru/3.5/c-api/list.html#c.PyList_SetItem).7980Однако на практике эти способы создания и заполнения кортежа или списка используются редко. Существует универсальная функция [`Py_BuildValue()`](https://python-all.ru/3.5/c-api/arg.html#c.Py_BuildValue), которая может создавать большинство распространённых объектов из значений C, управляемая *строкой формата*. Например, два приведённых выше блока кода можно заменить следующим (который также выполняет проверку ошибок):8182```c83PyObject *tuple, *list;8485tuple = Py_BuildValue("(iis)", 1, 2, "three");86list = Py_BuildValue("[iis]", 1, 2, "three");87```8889Гораздо чаще используются [`PyObject_SetItem()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_SetItem) и подобные функции с элементами, ссылки на которые вы только заимствуете, например, с аргументами, переданными в вашу функцию. В этом случае их поведение в отношении счётчика ссылок гораздо разумнее, так как вам не нужно увеличивать счётчик ссылок, чтобы передать ссылку («дать её украсть»). Например, эта функция устанавливает все элементы списка (на самом деле любой изменяемой последовательности) в заданный элемент:9091```c92int93set_all(PyObject *target, PyObject *item)94{95 Py_ssize_t i, n;9697 n = PyObject_Length(target);98 if (n < 0)99 return -1;100 for (i = 0; i < n; i++) {101 PyObject *index = PyLong_FromSsize_t(i);102 if (!index)103 return -1;104 if (PyObject_SetItem(target, index, item) < 0) {105 Py_DECREF(index);106 return -1;107 }108 Py_DECREF(index);109 }110 return 0;111}112```113114Ситуация немного отличается для возвращаемых значений функций. Хотя передача ссылки большинству функций не меняет обязанности по владению этой ссылкой, многие функции, возвращающие ссылку на объект, передают владение ссылкой вызывающему. Причина проста: во многих случаях возвращаемый объект создаётся на лету, и полученная ссылка является единственной ссылкой на объект. Поэтому универсальные функции, возвращающие ссылки на объекты, такие как [`PyObject_GetItem()`](https://python-all.ru/3.5/c-api/object.html#c.PyObject_GetItem) и [`PySequence_GetItem()`](https://python-all.ru/3.5/c-api/sequence.html#c.PySequence_GetItem), всегда возвращают новую ссылку (вызывающий становится владельцем ссылки).115116Важно понимать, что владение ссылкой, возвращённой функцией, зависит только от того, какая функция вызывается – *оперение* (тип объекта, переданного в качестве аргумента функции) *не играет роли!* Таким образом, при извлечении элемента из списка с помощью [`PyList_GetItem()`](https://python-all.ru/3.5/c-api/list.html#c.PyList_GetItem) ссылка не переходит во владение – но при получении того же элемента из того же списка с помощью [`PySequence_GetItem()`](https://python-all.ru/3.5/c-api/sequence.html#c.PySequence_GetItem) (которая принимает точно такие же аргументы) возвращённая ссылка переходит во владение.117118Вот пример того, как можно написать функцию, вычисляющую сумму элементов списка целых чисел; один раз с помощью [`PyList_GetItem()`](https://python-all.ru/3.5/c-api/list.html#c.PyList_GetItem), и один раз с помощью [`PySequence_GetItem()`](https://python-all.ru/3.5/c-api/sequence.html#c.PySequence_GetItem).119120```c121long122sum_list(PyObject *list)123{124 Py_ssize_t i, n;125 long total = 0, value;126 PyObject *item;127128 n = PyList_Size(list);129 if (n < 0)130 return -1; /* Не список */131 for (i = 0; i < n; i++) {132 item = PyList_GetItem(list, i); /* Не может завершиться ошибкой */133 if (!PyLong_Check(item)) continue; /* Пропустить нецелые значения */134 value = PyLong_AsLong(item);135 if (value == -1 && PyErr_Occurred())136 /* Целое число слишком велико для C long, выход */137 return -1;138 total += value;139 }140 return total;141}142```143144```c145long146sum_sequence(PyObject *sequence)147{148 Py_ssize_t i, n;149 long total = 0, value;150 PyObject *item;151 n = PySequence_Length(sequence);152 if (n < 0)153 return -1; /* Не имеет длины */154 for (i = 0; i < n; i++) {155 item = PySequence_GetItem(sequence, i);156 if (item == NULL)157 return -1; /* Не последовательность или другая ошибка */158 if (PyLong_Check(item)) {159 value = PyLong_AsLong(item);160 Py_DECREF(item);161 if (value == -1 && PyErr_Occurred())162 /* Целое число слишком велико для C long, выход */163 return -1;164 total += value;165 }166 else {167 Py_DECREF(item); /* Отказ от владения ссылкой */168 }169 }170 return total;171}172```173174### Типы175176Есть ещё несколько типов данных, которые играют важную роль в Python/C API; большинство из них – простые типы C, такие как `int`, `long`, `double` и `char*`. Несколько структурных типов используются для описания статических таблиц, в которых перечисляются функции, экспортируемые модулем, или атрибуты данных нового типа объекта, а ещё один тип используется для описания значения комплексного числа. Они будут рассмотрены вместе с функциями, которые их используют.177178## Исключения179180Программисту на Python требуется обрабатывать исключения только в тех случаях, когда необходима специфическая обработка ошибок; необработанные исключения автоматически передаются вызывающему, затем вызывающему вызывающего и так далее, пока не достигнут интерпретатора верхнего уровня, где они сообщаются пользователю вместе с трассировкой стека.181182Однако для программистов на C проверка ошибок всегда должна быть явной. Все функции в Python/C API могут порождать исключения, если в документации функции не указано иное. В общем случае, когда функция встречает ошибку, она устанавливает исключение, освобождает все принадлежащие ей ссылки на объекты и возвращает индикатор ошибки. Если в документации не указано иное, этим индикатором является либо *NULL*, либо `-1`, в зависимости от типа возвращаемого значения функции. Некоторые функции возвращают логический результат true/false, где false указывает на ошибку. Очень немногие функции не возвращают явного индикатора ошибки или имеют неоднозначное возвращаемое значение и требуют явной проверки на ошибки с помощью [`PyErr_Occurred()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_Occurred). Эти исключения всегда явно задокументированы.183184Состояние исключения поддерживается в локальном хранилище потока (это эквивалентно использованию глобального хранилища в однопоточном приложении). Поток может находиться в одном из двух состояний: исключение произошло или нет. Функцию [`PyErr_Occurred()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_Occurred) можно использовать для проверки этого: она возвращает заимствованную ссылку на объект типа исключения, когда исключение произошло, и *NULL* в противном случае. Существует несколько функций для установки состояния исключения: [`PyErr_SetString()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_SetString) – самая распространённая (хотя и не самая общая) функция для установки состояния исключения, а [`PyErr_Clear()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_Clear) очищает состояние исключения.185186Полное состояние исключения состоит из трёх объектов (все они могут быть *NULL*): типа исключения, соответствующего значения исключения и трассировки. Они имеют те же значения, что и результат Python `sys.exc_info()`; однако они не совпадают: объекты Python представляют последнее исключение, обрабатываемое оператором Python [`try`](https://python-all.ru/3.5/reference/compound_stmts.html#try) … [`except`](https://python-all.ru/3.5/reference/compound_stmts.html#except), в то время как состояние исключения на уровне C существует только до тех пор, пока исключение передаётся между функциями C, пока не достигнет главного цикла интерпретатора байт-кода Python, который заботится о его передаче в `sys.exc_info()` и другие.187188Обратите внимание, что начиная с Python 1.5 предпочтительным потокобезопасным способом доступа к состоянию исключения из кода Python является вызов функции [`sys.exc_info()`](https://python-all.ru/3.5/library/sys.html#sys.exc_info), которая возвращает состояние исключения для текущего потока в коде Python. Кроме того, семантика обоих способов доступа к состоянию исключения была изменена таким образом, что функция, перехватывающая исключение, сохраняет и восстанавливает состояние исключения своего потока, чтобы сохранить состояние исключения вызывающей функции. Это предотвращает распространённые ошибки в коде обработки исключений, вызванные тем, что безобидная на вид функция перезаписывает обрабатываемое исключение; это также уменьшает часто нежелательное продление времени жизни объектов, на которые ссылаются кадры стека в трассировке.189190В качестве общего принципа: функция, которая вызывает другую функцию для выполнения некоторой задачи, должна проверять, вызвала ли вызываемая функция исключение, и если да, передавать состояние исключения своему вызывающему. Она должна отбрасывать все принадлежащие ей ссылки на объекты и возвращать индикатор ошибки, но *не* должна устанавливать другое исключение – это перезапишет только что вызванное исключение и приведёт к потере важной информации о точной причине ошибки.191192Простой пример обнаружения исключений и их передачи показан в примере `sum_sequence()` выше. Так получилось, что этому примеру не нужно очищать принадлежащие ссылки при обнаружении ошибки. Следующая примерная функция показывает некоторую очистку при ошибке. Сначала, чтобы напомнить о преимуществах Python, приведён эквивалентный код на Python:193194```c195def incr_item(dict, key):196 try:197 item = dict[key]198 except KeyError:199 item = 0200 dict[key] = item + 1201```202203А вот соответствующий код на C во всей своей красе:204205```c206int207incr_item(PyObject *dict, PyObject *key)208{209 /* Все объекты инициализированы в NULL для Py_XDECREF */210 PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;211 int rv = -1; /* Возвращаемое значение инициализировано как -1 (ошибка) */212213 item = PyObject_GetItem(dict, key);214 if (item == NULL) {215 /* Обрабатывать только KeyError: */216 if (!PyErr_ExceptionMatches(PyExc_KeyError))217 goto error;218219 /* Очистить ошибку и использовать ноль: */220 PyErr_Clear();221 item = PyLong_FromLong(0L);222 if (item == NULL)223 goto error;224 }225 const_one = PyLong_FromLong(1L);226 if (const_one == NULL)227 goto error;228229 incremented_item = PyNumber_Add(item, const_one);230 if (incremented_item == NULL)231 goto error;232233 if (PyObject_SetItem(dict, key, incremented_item) < 0)234 goto error;235 rv = 0; /* Успех */236 /* Продолжить с кодом очистки */237238 error:239 /* Код очистки, общий для путей успеха и ошибки */240241 /* Используйте Py_XDECREF() для игнорирования NULL-ссылок */242 Py_XDECREF(item);243 Py_XDECREF(const_one);244 Py_XDECREF(incremented_item);245246 return rv; /* -1 для ошибки, 0 для успеха */247}248```249250Этот пример представляет одобренный способ использования оператора `goto` в C! Он иллюстрирует использование [`PyErr_ExceptionMatches()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_ExceptionMatches) и [`PyErr_Clear()`](https://python-all.ru/3.5/c-api/exceptions.html#c.PyErr_Clear) для обработки конкретных исключений, а также использование [`Py_XDECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_XDECREF) для освобождения принадлежащих ссылок, которые могут быть *NULL* (обратите внимание на `'X'` в имени; [`Py_DECREF()`](https://python-all.ru/3.5/c-api/refcounting.html#c.Py_DECREF) бы аварийно завершилась при получении ссылки *NULL*). Важно, чтобы переменные, используемые для хранения принадлежащих ссылок, были инициализированы в *NULL* для корректной работы; аналогично предлагаемое возвращаемое значение инициализируется в `-1` (неудача) и устанавливается в успех только после успешного выполнения последнего вызова.251252## Встраивание Python253254Единственная важная задача, о которой должны беспокоиться только разработчики, встраивающие интерпретатор Python (в отличие от разработчиков расширений), – это инициализация и, возможно, финализация интерпретатора Python. Большинство функций интерпретатора могут использоваться только после его инициализации.255256Основная функция инициализации – [`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize). Она инициализирует таблицу загруженных модулей и создаёт фундаментальные модули [`builtins`](https://python-all.ru/3.5/library/builtins.html#module-builtins), [`__main__`](https://python-all.ru/3.5/library/__main__.html#module-__main__) и [`sys`](https://python-all.ru/3.5/library/sys.html#module-sys). Также она инициализирует путь поиска модулей (`sys.path`).257258[`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize) не устанавливает «список аргументов скрипта» (`sys.argv`). Если эта переменная понадобится коду Python, который будет выполняться позже, её необходимо явно установить с помощью вызова `PySys_SetArgvEx(argc, argv, updatepath)` после вызова [`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize).259260В большинстве систем (в частности, в Unix и Windows, хотя детали несколько различаются) [`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize) вычисляет путь поиска модулей, основываясь на наилучшем предположении о местоположении исполняемого файла стандартного интерпретатора Python, предполагая, что библиотека Python находится в фиксированном месте относительно исполняемого файла интерпретатора Python. В частности, он ищет каталог с именем `lib/pythonX.Y` относительно родительского каталога, где находится исполняемый файл с именем `python` в пути поиска команд оболочки (переменная окружения `PATH`).261262Например, если исполняемый файл Python находится в `/usr/local/bin/python`, то будет предполагаться, что библиотеки находятся в `/usr/local/lib/pythonX.Y`. (Фактически, этот конкретный путь также является «запасным» местоположением, используемым, когда исполняемый файл с именем `python` не найден вдоль `PATH`.) Пользователь может переопределить это поведение, установив переменную окружения [`PYTHONHOME`](https://python-all.ru/3.5/using/cmdline.html#envvar-PYTHONHOME), или вставить дополнительные каталоги в начало стандартного пути, установив [`PYTHONPATH`](https://python-all.ru/3.5/using/cmdline.html#envvar-PYTHONPATH).263264Встраивающее приложение может управлять поиском, вызвав `Py_SetProgramName(file)` *перед* вызовом [`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize). Обратите внимание, что [`PYTHONHOME`](https://python-all.ru/3.5/using/cmdline.html#envvar-PYTHONHOME) по-прежнему переопределяет это, а [`PYTHONPATH`](https://python-all.ru/3.5/using/cmdline.html#envvar-PYTHONPATH) всё ещё вставляется перед стандартным путём. Приложение, требующее полного контроля, должно предоставить собственную реализацию [`Py_GetPath()`](https://python-all.ru/3.5/c-api/init.html#c.Py_GetPath), [`Py_GetPrefix()`](https://python-all.ru/3.5/c-api/init.html#c.Py_GetPrefix), [`Py_GetExecPrefix()`](https://python-all.ru/3.5/c-api/init.html#c.Py_GetExecPrefix) и [`Py_GetProgramFullPath()`](https://python-all.ru/3.5/c-api/init.html#c.Py_GetProgramFullPath) (все они определены в `Modules/getpath.c`).265266Иногда бывает желательно «деинициализировать» Python. Например, приложение может захотеть начать заново (сделать ещё один вызов [`Py_Initialize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Initialize)) или просто завершить использование Python и освободить память, выделенную Python. Это можно сделать, вызвав [`Py_Finalize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Finalize). Функция [`Py_IsInitialized()`](https://python-all.ru/3.5/c-api/init.html#c.Py_IsInitialized) возвращает true, если Python в настоящее время находится в инициализированном состоянии. Дополнительная информация об этих функциях приведена в следующей главе. Обратите внимание, что [`Py_Finalize()`](https://python-all.ru/3.5/c-api/init.html#c.Py_Finalize) *не* освобождает всю память, выделенную интерпретатором Python, например, память, выделенная модулями расширения, в настоящее время не может быть освобождена.267268## Отладочные сборки269270Python может быть собран с несколькими макросами для включения дополнительных проверок интерпретатора и модулей расширения. Эти проверки, как правило, добавляют значительные накладные расходы во время выполнения, поэтому они не включены по умолчанию.271272Полный список различных типов отладочных сборок находится в файле `Misc/SpecialBuilds.txt` в дистрибутиве исходного кода Python. Доступны сборки, которые поддерживают трассировку счётчиков ссылок, отладку распределителя памяти или низкоуровневое профилирование основного цикла интерпретатора. В оставшейся части раздела будут описаны только наиболее часто используемые сборки.273274Компиляция интерпретатора с определённым макросом `Py_DEBUG` даёт то, что обычно называют «отладочной сборкой» Python. `Py_DEBUG` включается в сборке Unix добавлением `--with-pydebug` к команде `./configure`. Он также подразумевается наличием не связанного с Python макроса `_DEBUG`. Когда `Py_DEBUG` включён в сборке Unix, оптимизация компилятора отключается.275276В дополнение к отладке счётчика ссылок, описанной ниже, выполняются следующие дополнительные проверки:277278- Дополнительные проверки добавлены в распределитель объектов.279- Дополнительные проверки добавлены в синтаксический анализатор и компилятор.280- Проверяются понижающие приведения от широких типов к узким на предмет потери информации.281- В реализации словаря и множества добавлен ряд утверждений. Кроме того, объект множества получает метод `test_c_api()`.282- Проверки корректности входных аргументов добавлены при создании фрейма.283- Память для целых чисел инициализируется известным недопустимым шаблоном для выявления ссылок на неинициализированные разряды.284- Низкоуровневая трассировка и дополнительные проверки исключений добавлены в виртуальную машину времени выполнения.285- Дополнительные проверки добавлены в реализацию области памяти (arena).286- Дополнительная отладка добавлена в модуль thread.287288Могут быть и другие проверки, не упомянутые здесь.289290Определение `Py_TRACE_REFS` включает трассировку ссылок. При определении поддерживается циклический двусвязный список активных объектов за счёт добавления двух дополнительных полей к каждому [`PyObject`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject). Также отслеживается общее количество выделений. При выходе печатаются все существующие ссылки. (В интерактивном режиме это происходит после каждого оператора, выполненного интерпретатором.) Подразумевается определением `Py_DEBUG`.291292См. `Misc/SpecialBuilds.txt` в дистрибутиве исходных текстов Python для получения более подробной информации.293