はじめに¶
Python のアプリケーションプログラマ用インタフェース (Application Programmer's Interface, API) は、 Python インタプリタに対する様々なレベルでのアクセス手段を C や C++ のプログラマに提供しています。この API は通常 C++ からも全く同じように利用できるのですが、簡潔な呼び名にするために Python/C API と名づけられています。根本的に異なる二つの目的から、 Python/C API が用いられます。第一は、特定用途の 拡張モジュール (extension module) 、すなわち Python インタプリタを拡張する C で書かれたモジュールを記述する、という目的です。第二は、より大規模なアプリケーション内で Python を構成要素 (component) として利用するという目的です; このテクニックは、一般的にはアプリケーションへの Python の埋め込み (embedding) と呼びます。
拡張モジュールの作成は比較的わかりやすいプロセスで、 "手引書 (cookbook)" 的なアプローチでうまく実現できます。作業をある程度まで自動化してくれるツールもいくつかあります。一方、他のアプリケーションへの Python の埋め込みは、Python ができてから早い時期から行われてきましたが、拡張モジュールの作成に比べるとやや難解です。
多くの API 関数は、Python の埋め込みであるか拡張であるかに関わらず役立ちます; とはいえ、Python を埋め込んでいるほとんどのアプリケーションは、同時に自作の拡張モジュールも提供する必要が生じることになるでしょうから、Python を実際にアプリケーションに埋め込んでみる前に拡張モジュールの書き方に詳しくなっておくのはよい考えだと思います。
コーディング基準¶
CPython に含める C コードを書いている場合は、 PEP 7 のガイドラインと基準に従わなければ なりません 。 このガイドラインは、コントリビュート対象の Python のバージョンに関係無く適用されます。 自身のサードパーティーのモジュールでは、それをいつか Python にコントリビュートするつもりでなければ、この慣習に従う必要はありません。
インクルードファイル¶
Python/C API を使うために必要な、関数、型およびマクロの全ての定義をインクルードするには、以下の行:
#define PY_SSIZE_T_CLEAN
#include <Python.h>
をソースコードに記述します。この行を記述すると、標準ヘッダ: <stdio.h>
, <string.h>
, <errno.h>
, <limits.h>
, <assert.h>
, <stdlib.h>
を (利用できれば) インクルードします。
注釈
Python は、システムによっては標準ヘッダの定義に影響するようなプリプロセッサ定義を行っているので、 Python.h
をいずれの標準ヘッダよりも前にインクルード せねばなりません 。
Python.h
をインクルードする前に、常に PY_SSIZE_T_CLEAN
を定義することが推奨されます。
このマクロの解説については 引数の解釈と値の構築 を参照してください。
Python.h で定義されている、ユーザから見える名前全て (Python.h がインクルードしている標準ヘッダの名前は除きます) には、接頭文字列 Py
または _Py
が付きます。_Py
で始まる名前は Python 実装で内部使用するための名前で、拡張モジュールの作者は使ってはなりません。構造体のメンバには予約済みの接頭文字列はありません。
注釈
API のユーザは、Py
や _Py
で始まる名前を定義するコードを絶対に書いてはなりません。
後からコードを読む人を混乱させたり、将来の Python のバージョンで同じ名前が定義されて、ユーザの書いたコードの可搬性を危うくする可能性があります。
ヘッダファイル群は通常 Python と共にインストールされます。 Unixでは prefix/include/pythonversion/
および exec_prefix/include/pythonversion/
に置かれます。 prefix
と exec_prefix
は Python をビルドする際の configure スクリプトに与えたパラメタに対応し、 version は '%d.%d' % sys.version_info[:2]
に対応します。 Windows では、ヘッダは prefix/include
に置かれます。 prefix
はインストーラに指定したインストールディレクトリです。
ヘッダをインクルードするには、各ヘッダの入ったディレクトリ (別々のディレクトリの場合は両方) を、コンパイラがインクルードファイルを検索するためのパスに入れます。親ディレクトリをサーチパスに入れて、 #include <pythonX.Y/Python.h>
のようにしては なりません ; prefix
内のプラットフォームに依存しないヘッダは、 exec_prefix
からプラットフォーム依存のヘッダをインクルードしているので、このような操作を行うと複数のプラットフォームでのビルドができなくなります。
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++.
便利なマクロ¶
Python のヘッダーファイルには便利なマクロがいくつか定義されています。
多くのマクロは、それが役に立つところ (例えば、 Py_RETURN_NONE
) の近くに定義があります。
より一般的な使われかたをする他のマクロはこれらのヘッダーファイルに定義されています。
ただし、ここで完全に列挙されているとは限りません。
-
Py_UNREACHABLE
()¶ Use this when you have a code path that cannot be reached by design. For example, in the
default:
clause in aswitch
statement for which all possible values are covered incase
statements. Use this in places where you might be tempted to put anassert(0)
orabort()
call.In release mode, the macro helps the compiler to optimize the code, and avoids a warning about unreachable code. For example, the macro is implemented with
__builtin_unreachable()
on GCC in release mode.A use for
Py_UNREACHABLE()
is following a call a function that never returns but that is not declared_Py_NO_RETURN
.If a code path is very unlikely code but can be reached under exceptional case, this macro must not be used. For example, under low memory condition or if a system call returns a value out of the expected range. In this case, it's better to report the error to the caller. If the error cannot be reported to caller,
Py_FatalError()
can be used.バージョン 3.7 で追加.
-
Py_ABS
(x)¶ x
の絶対値を返します。バージョン 3.3 で追加.
-
Py_MIN
(x, y)¶ x
とy
の最小値を返します。バージョン 3.3 で追加.
-
Py_MAX
(x, y)¶ x
とy
の最大値を返します。バージョン 3.3 で追加.
-
Py_STRINGIFY
(x)¶ x
を C 文字列へ変換します。 例えば、Py_STRINGIFY(123)
は"123"
を返します。バージョン 3.4 で追加.
-
Py_MEMBER_SIZE
(type, member)¶ (
type
) 構造体のmember
のサイズをバイト単位で返します。バージョン 3.6 で追加.
-
Py_CHARMASK
(c)¶ 引数は文字か、[-128, 127] あるいは [0, 255] の範囲の整数でなければなりません。 このマクロは
符号なし文字
にキャストしたc
を返します。
-
Py_GETENV
(s)¶ getenv(s)
に似ていますが、コマンドラインで-E
が渡された場合 (つまりPy_IgnoreEnvironmentFlag
が設定された場合)NULL
を返します。
-
Py_UNUSED
(arg)¶ Use this for unused arguments in a function definition to silence compiler warnings. Example:
int func(int a, int Py_UNUSED(b)) { return a; }
.バージョン 3.4 で追加.
-
Py_DEPRECATED
(version)¶ Use this for deprecated declarations. The macro must be placed before the symbol name.
以下はプログラム例です:
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
バージョン 3.8 で変更: MSVC サポートが追加されました。
-
PyDoc_STRVAR
(name, str)¶ Creates a variable with name
name
that can be used in docstrings. If Python is built without docstrings, the value will be empty.Use
PyDoc_STRVAR
for docstrings to support building Python without docstrings, as specified in PEP 7.以下はプログラム例です:
PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element."); static PyMethodDef deque_methods[] = { // ... {"pop", (PyCFunction)deque_pop, METH_NOARGS, pop_doc}, // ... }
-
PyDoc_STR
(str)¶ Creates a docstring for the given input string or an empty string if docstrings are disabled.
Use
PyDoc_STR
in specifying docstrings to support building Python without docstrings, as specified in PEP 7.以下はプログラム例です:
static PyMethodDef pysqlite_row_methods[] = { {"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS, PyDoc_STR("Returns the keys of the row.")}, {NULL, NULL} };
オブジェクト、型および参照カウント¶
Most Python/C API functions have one or more arguments as well as a return value
of type PyObject*
. This type is a pointer to an opaque data type
representing an arbitrary Python object. Since all Python object types are
treated the same way by the Python language in most situations (e.g.,
assignments, scope rules, and argument passing), it is only fitting that they
should be represented by a single C type. Almost all Python objects live on the
heap: you never declare an automatic or static variable of type
PyObject
, only pointer variables of type PyObject*
can be
declared. The sole exception are the type objects; since these must never be
deallocated, they are typically static PyTypeObject
objects.
全ての Python オブジェクトには (Python 整数型ですら) 型 (type) と参照カウント (reference count) があります。あるオブジェクトの型は、そのオブジェクトがどの種類のオブジェクトか (例えば整数、リスト、ユーザ定義関数、など; その他多数については 標準型の階層 で説明しています) を決定します。よく知られている型については、各々マクロが存在して、あるオブジェクトがその型かどうか調べられます; 例えば、 PyList_Check(a)
は、 a で示されたオブジェクトが Python リスト型のとき (かつそのときに限り) 真値を返します。
参照カウント法¶
今日の計算機は有限の (しばしば非常に限られた) メモリサイズしか持たないので、参照カウントは重要な概念です; 参照カウントは、あるオブジェクトに対して参照を行っている場所が何箇所あるかを数える値です。参照を行っている場所とは、別のオブジェクトであったり、グローバルな (あるいは静的な) C 変数であったり、何らかの C 関数内にあるローカルな変数だったりします。あるオブジェクトの参照カウントがゼロになると、そのオブジェクトは解放されます。そのオブジェクトに他のオブジェクトへの参照が入っていれば、他のオブジェクトの参照カウントはデクリメントされます。デクリメントの結果、他のオブジェクトの参照カウントがゼロになると、今度はそのオブジェクトが解放される、といった具合に以後続きます。(言うまでもなく、互いを参照しあうオブジェクトについて問題があります; 現状では、解決策は "何もしない" です。)
参照カウントは、常に明示的なやり方で操作されます。通常の方法では、 Py_INCREF()
マクロでオブジェクトの参照を 1 インクリメントし、 Py_DECREF()
マクロで 1 デクリメントします。 Py_DECREF()
マクロは、incref よりもかなり複雑です。というのは、 Py_DECREF マクロは参照カウントがゼロになったかどうかを調べて、なった場合にはオブジェクトのメモリ解放関数 (deallocator) を呼び出さなければならないからです。メモリ解放関数とは、オブジェクトの型を定義している構造体内にある関数へのポインタです。型固有のメモリ解放関数は、その型が複合オブジェクト (compound object) 型である場合には、オブジェクト内の他のオブジェクトに対する参照カウントをデクリメントするよう気を配るとともに、その他の必要なファイナライズ (finalize) 処理を実行します。参照カウントがオーバフローすることはありません; というのも、仮想メモリ空間には、(sizeof(Py_ssize_t) >= sizeof(void*)
と仮定した場合) 少なくとも参照カウントの記憶に使われるビット数と同じだけのメモリ上の位置があるからです。従って、参照カウントのインクリメントは単純な操作になります。
オブジェクトへのポインタが入っているローカルな変数全てについて、オブジェクトの参照カウントを必ずインクリメントしなければならないわけではありません。理論上は、オブジェクトの参照カウントは、オブジェクトを指し示す変数が生成されたときに 1 増やされ、その変数がスコープから出て行った際に 1 減らされます。しかしこの場合、二つの操作は互いに相殺するので、結果的に参照カウントは変化しません。参照カウントを使う真の意義とは、手持ちの何らかの変数がオブジェクトを指している間はオブジェクトがデアロケートされないようにすることにあります。オブジェクトに対して、一つでも別の参照が行われていて、その参照が手持ちの変数と同じ間維持されるのなら、参照カウントを一時的に増やす必要はありません。参照カウント操作の必要性が浮き彫りになる重要な局面とは、Python から呼び出された拡張モジュール内の C 関数にオブジェクトを引数として渡すときです; 呼び出しメカニズムは、呼び出しの間全ての引数に対する参照を保証します。
しかしながら、よく陥る過ちとして、あるオブジェクトをリストから得たときに、参照カウントをインクリメントせずにしばらく放っておくというのがあります。他の操作がオブジェクトをリストから除去してしまい、参照カウントがデクリメントされてデアロケートされてしまうことが考えられます。本当に危険なのは、まったく無害そうにみえる操作が、上記の動作を引き起こす何らかの Python コードを呼び出しかねないということです; Py_DECREF()
からユーザへ制御を戻せるようなコードパスが存在するため、ほとんど全ての操作が潜在的に危険をはらむことになります。
安全に参照カウントを操作するアプローチは、汎用の操作 (関数名が PyObject_
, PyNumber_
, PySequence_
, および PyMapping_
で始まる関数) の利用です。これらの操作は常に戻り値となるオブジェクトの参照カウントをインクリメントします。ユーザには戻り値が不要になったら Py_DECREF()
を呼ぶ責任が残されています; とはいえ、すぐにその習慣は身に付くでしょう。
参照カウントの詳細¶
Python/C API の各関数における参照カウントの振る舞いは、説明するには、 参照の所有権 (ownership of references) という言葉でうまく説明できます。所有権は参照に対するもので、オブジェクトに対するものではありません (オブジェクトは誰にも所有されず、常に共有されています)。ある "参照の所有" は、その参照が必要なくなった時点で Py_DECREF を呼び出す役割を担うことを意味します。所有権は委譲でき、あるコードが委譲によって所有権を得ると、今度はそのコードが参照が必要なくなった際に最終的に Py_DECREF()
や Py_XDECREF()
を呼び出して、参照カウンタを1つ減らす役割を担います --- あるいは、その役割を (通常はコードを呼び出した元に) 受け渡します。ある関数が、関数の呼び出し側に対して参照の所有権を渡すと、呼び出し側は 新たな 参照 (new reference) を得る、と言います。所有権が渡されない場合、呼び出し側は参照を 借りる (borrow) といいます。借りた参照に対しては、何もする必要はありません。
逆に、ある関数呼び出しで、あるオブジェクトへの参照を呼び出される関数に渡す際には、二つの可能性: 関数がオブジェクトへの参照を 盗み取る (steal) 場合と、そうでない場合があります。参照を盗む とは、関数に参照を渡したときに、参照の所有者がその関数になったと仮定し、関数の呼び出し元には所有権がなくなるということです。
参照を盗み取る関数はほとんどありません; 例外としてよく知られているのは、 PyList_SetItem()
と PyTuple_SetItem()
で、これらはシーケンスに入れる要素に対する参照を盗み取ります (しかし、要素の入る先のタプルやリストの参照は盗み取りません!)。これらの関数は、リストやタプルの中に新たに作成されたオブジェクトを入れていく際の常套的な書き方をしやすくするために、参照を盗み取るように設計されています; 例えば、 (1, 2, "three")
というタプルを生成するコードは以下のようになります (とりあえず例外処理のことは忘れておきます; もっとよい書き方を後で示します):
PyObject *t;
t = PyTuple_New(3);
PyTuple_SetItem(t, 0, PyLong_FromLong(1L));
PyTuple_SetItem(t, 1, PyLong_FromLong(2L));
PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));
ここで、 PyLong_FromLong()
は新しい参照を返し、すぐに PyTuple_SetItem()
に盗まれます。参照が盗まれた後もそのオブジェクトを利用したい場合は、参照盗む関数を呼び出す前に、 Py_INCREF()
を利用してもう一つの参照を取得してください。
ちなみに、 PyTuple_SetItem()
はタプルに値をセットするための 唯一の 方法です; タプルは変更不能なデータ型なので、 PySequence_SetItem()
や PyObject_SetItem()
を使うと上の操作は拒否されてしまいます。自分でタプルの値を入れていくつもりなら、 PyTuple_SetItem()
だけしか使えません。
同じく、リストに値を入れていくコードは PyList_New()
と PyList_SetItem()
で書けます。
しかし実際には、タプルやリストを生成して値を入れる際には、上記のような方法はほとんど使いません。より汎用性のある関数、 Py_BuildValue()
があり、ほとんどの主要なオブジェクトをフォーマット文字列 format string の指定に基づいて C の値から生成できます。例えば、上の二種類のコードブロックは、以下のように置き換えられます (エラーチェックにも配慮しています):
PyObject *tuple, *list;
tuple = Py_BuildValue("(iis)", 1, 2, "three");
list = Py_BuildValue("[iis]", 1, 2, "three");
自作の関数に渡す引数のように、単に参照を借りるだけの要素に対しては、 PyObject_SetItem()
とその仲間を使うのがはるかに一般的です。その場合、参照カウントをインクリメントする必要がなく、参照を引き渡せる ("参照を盗み取らせられる") ので、参照カウントに関する動作はより健全になります。例えば、以下の関数は与えられた要素をリスト中の全ての要素の値にセットします:
int
set_all(PyObject *target, PyObject *item)
{
Py_ssize_t i, n;
n = PyObject_Length(target);
if (n < 0)
return -1;
for (i = 0; i < n; i++) {
PyObject *index = PyLong_FromSsize_t(i);
if (!index)
return -1;
if (PyObject_SetItem(target, index, item) < 0) {
Py_DECREF(index);
return -1;
}
Py_DECREF(index);
}
return 0;
}
関数の戻り値の場合には、状況は少し異なります。ほとんどの関数については、参照を渡してもその参照に対する所有権が変わることがない一方で、あるオブジェクトに対する参照を返すような多くの関数は、参照に対する所有権を呼び出し側に与えます。理由は簡単です: 多くの場合、関数が返すオブジェクトはその場で (on the fly) 生成されるため、呼び出し側が得る参照は生成されたオブジェクトに対する唯一の参照になるからです。従って、 PyObject_GetItem()
や PySequence_GetItem()
のように、オブジェクトに対する参照を返す汎用の関数は、常に新たな参照を返します (呼び出し側が参照の所有者になります)。
重要なのは、関数が返す参照の所有権を持てるかどうかは、どの関数を呼び出すかだけによる、と理解することです --- 関数呼び出し時の お飾り (関数に引数として渡したオブジェクトの型) は この問題には関係ありません! 従って、 PyList_GetItem()
を使ってリスト内の要素を得た場合には、参照の所有者にはなりません --- が、同じ要素を同じリストから PySequence_GetItem()
(図らずもこの関数は全く同じ引数をとります) を使って取り出すと、返されたオブジェクトに対する参照を得ます。
以下は、整数からなるリストに対して各要素の合計を計算する関数をどのようにして書けるかを示した例です; 一つは PyList_GetItem()
を使っていて、もう一つは PySequence_GetItem()
を使っています。
long
sum_list(PyObject *list)
{
Py_ssize_t i, n;
long total = 0, value;
PyObject *item;
n = PyList_Size(list);
if (n < 0)
return -1; /* Not a list */
for (i = 0; i < n; i++) {
item = PyList_GetItem(list, i); /* Can't fail */
if (!PyLong_Check(item)) continue; /* Skip non-integers */
value = PyLong_AsLong(item);
if (value == -1 && PyErr_Occurred())
/* Integer too big to fit in a C long, bail out */
return -1;
total += value;
}
return total;
}
long
sum_sequence(PyObject *sequence)
{
Py_ssize_t i, n;
long total = 0, value;
PyObject *item;
n = PySequence_Length(sequence);
if (n < 0)
return -1; /* Has no length */
for (i = 0; i < n; i++) {
item = PySequence_GetItem(sequence, i);
if (item == NULL)
return -1; /* Not a sequence, or other failure */
if (PyLong_Check(item)) {
value = PyLong_AsLong(item);
Py_DECREF(item);
if (value == -1 && PyErr_Occurred())
/* Integer too big to fit in a C long, bail out */
return -1;
total += value;
}
else {
Py_DECREF(item); /* Discard reference ownership */
}
}
return total;
}
型¶
There are few other data types that play a significant role in the Python/C
API; most are simple C types such as int
, long
,
double
and char*
. A few structure types are used to
describe static tables used to list the functions exported by a module or the
data attributes of a new object type, and another is used to describe the value
of a complex number. These will be discussed together with the functions that
use them.
-
Py_ssize_t
¶ A signed integral type such that
sizeof(Py_ssize_t) == sizeof(size_t)
. C99 doesn't define such a thing directly (size_t is an unsigned integral type). See PEP 353 for details.PY_SSIZE_T_MAX
is the largest positive value of typePy_ssize_t
.
例外¶
Python プログラマは、特定のエラー処理が必要なときだけしか例外を扱う必要はありません; 処理しなかった例外は、処理の呼び出し側、そのまた呼び出し側、といった具合に、トップレベルのインタプリタ層まで自動的に伝播します。インタプリタ層は、スタックトレースバックと合わせて例外をユーザに報告します。
ところが、 C プログラマの場合、エラーチェックは常に明示的に行わねばなりません。 Python/C API の全ての関数は、関数のドキュメントで明確に説明がない限り例外を発行する可能性があります。一般的な話として、ある関数が何らかのエラーに遭遇すると、関数は例外を設定して、関数内における参照の所有権を全て放棄し、エラー値 (error indicator) を返します。ドキュメントに書かれてない場合、このエラー値は関数の戻り値の型によって、 NULL
か -1
のどちらかになります。いくつかの関数ではブール型で真/偽を返し、偽はエラーを示します。きわめて少数の関数では明確なエラー指標を返さなかったり、あいまいな戻り値を返したりするので、 PyErr_Occurred()
で明示的にエラーテストを行う必要があります。これらの例外は常に明示的にドキュメント化されます。
例外時の状態情報 (exception state)は、スレッド単位に用意された記憶領域 (per-thread storage) 内で管理されます (この記憶領域は、スレッドを使わないアプリケーションではグローバルな記憶領域と同じです)。一つのスレッドは二つの状態のどちらか: 例外が発生したか、まだ発生していないか、をとります。関数 PyErr_Occurred()
を使うと、この状態を調べられます: この関数は例外が発生した際にはその例外型オブジェクトに対する借用参照 (borrowed reference) を返し、そうでないときには NULL
を返します。例外状態を設定する関数は数多くあります: PyErr_SetString()
はもっともよく知られている (が、もっとも汎用性のない) 例外を設定するための関数で、 PyErr_Clear()
は例外状態情報を消し去る関数です。
完全な例外状態情報は、3 つのオブジェクト: 例外の型、例外の値、そしてトレースバック、からなります (どのオブジェクトも NULL
を取り得ます)。これらの情報は、 Python の sys.exc_info()
の結果と同じ意味を持ちます; とはいえ、 C と Python の例外状態情報は全く同じではありません: Python における例外オブジェクトは、Python の try
... except
文で最近処理したオブジェクトを表す一方、 C レベルの例外状態情報が存続するのは、渡された例外情報を sys.exc_info()
その他に転送するよう取り計らう Python のバイトコードインタプリタのメインループに到達するまで、例外が関数の間で受け渡しされている間だけです。
Python 1.5 からは、Python で書かれたコードから例外状態情報にアクセスする方法として、推奨されていてスレッドセーフな方法は sys.exc_info()
になっているので注意してください。この関数は Python コードの実行されているスレッドにおける例外状態情報を返します。また、これらの例外状態情報に対するアクセス手段は、両方とも意味づけ (semantics) が変更され、ある関数が例外を捕捉すると、その関数を実行しているスレッドの例外状態情報を保存して、呼び出し側の例外状態情報を維持するようになりました。この変更によって、無害そうに見える関数が現在扱っている例外を上書きすることで引き起こされる、例外処理コードでよくおきていたバグを抑止しています; また、トレースバック内のスタックフレームで参照されているオブジェクトがしばしば不必要に寿命を永らえていたのをなくしています。
一般的な原理として、ある関数が別の関数を呼び出して何らかの作業をさせるとき、呼び出し先の関数が例外を送出していないか調べなくてはならず、もし送出していれば、その例外状態情報は呼び出し側に渡されなければなりません。呼び出し元の関数はオブジェクト参照の所有権をすべて放棄し、エラー指標を返さなくてはなりませんが、余計に例外を設定する必要は ありません --- そんなことをすれば、たった今送出されたばかりの例外を上書きしてしまい、エラーの原因そのものに関する重要な情報を失うことになります。
例外を検出して渡す例は、上の sum_sequence()
で示しています。偶然にも、この例ではエラーを検出した際に何ら参照を放棄する必要がありません。以下の関数の例では、エラーに対する後始末について示しています。まず、どうして Python で書くのが好きか思い出してもらうために、等価な Python コードを示します:
def incr_item(dict, key):
try:
item = dict[key]
except KeyError:
item = 0
dict[key] = item + 1
以下は対応するコードを C で完璧に書いたものです:
int
incr_item(PyObject *dict, PyObject *key)
{
/* Objects all initialized to NULL for Py_XDECREF */
PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
int rv = -1; /* Return value initialized to -1 (failure) */
item = PyObject_GetItem(dict, key);
if (item == NULL) {
/* Handle KeyError only: */
if (!PyErr_ExceptionMatches(PyExc_KeyError))
goto error;
/* Clear the error and use zero: */
PyErr_Clear();
item = PyLong_FromLong(0L);
if (item == NULL)
goto error;
}
const_one = PyLong_FromLong(1L);
if (const_one == NULL)
goto error;
incremented_item = PyNumber_Add(item, const_one);
if (incremented_item == NULL)
goto error;
if (PyObject_SetItem(dict, key, incremented_item) < 0)
goto error;
rv = 0; /* Success */
/* Continue with cleanup code */
error:
/* Cleanup code, shared by success and failure path */
/* Use Py_XDECREF() to ignore NULL references */
Py_XDECREF(item);
Py_XDECREF(const_one);
Py_XDECREF(incremented_item);
return rv; /* -1 for error, 0 for success */
}
なんとこの例は C で goto
文を使うお勧めの方法まで示していますね! この例では、特定の例外を処理するために PyErr_ExceptionMatches()
および PyErr_Clear()
をどう使うかを示しています。また、所有権を持っている参照で、値が NULL
になるかもしれないものを捨てるために Py_XDECREF()
をどう使うかも示しています (関数名に 'X'
が付いていることに注意してください; Py_DECREF()
は NULL
参照に出くわすとクラッシュします)。正しく動作させるためには、所有権を持つ参照を保持するための変数を NULL
で初期化することが重要です; 同様に、あらかじめ戻り値を定義する際には値を -1
(失敗) で初期化しておいて、最後の関数呼び出しまでうまくいった場合にのみ 0
(成功) に設定します。
Python の埋め込み¶
Python インタプリタの埋め込みを行う人 (いわば拡張モジュールの書き手の対極) が気にかけなければならない重要なタスクは、Python インタプリタの初期化処理 (initialization)、そしておそらくは終了処理 (finalization) です。インタプリタのほとんどの機能は、インタプリタの起動後しか使えません。
基本的な初期化処理を行う関数は Py_Initialize()
です。この関数はロード済みのモジュールからなるテーブルを作成し、土台となるモジュール builtins
, __main__
, および sys
を作成します。また、モジュール検索パス (sys.path
) の初期化も行います。
Py_Initialize()
の中では、 "スクリプトへの引数リスト" (script argument list, sys.argv
のこと) を設定しません。この変数が後に実行される Python コード中で必要なら、 Py_Initialize()
の後で PySys_SetArgvEx(argc, argv, updatepath)
を呼び出して明示的に設定しなければなりません。
ほとんどのシステムでは (特に Unix と Windows は、詳細がわずかに異なりはしますが)、 Py_Initialize()
は標準の Python インタプリタ実行形式の場所に対する推定結果に基づいて、 Python のライブラリが Python インタプリタ実行形式からの相対パスで見つかるという仮定の下にモジュール検索パスを計算します。とりわけこの検索では、シェルコマンド検索パス (環境変数 PATH
) 上に見つかった python
という名前の実行ファイルの置かれているディレクトリの親ディレクトリからの相対で、 lib/pythonX.Y
という名前のディレクトリを探します。
例えば、 Python 実行形式が /usr/local/bin/python
で見つかったとすると、 Py_Initialize()
はライブラリが /usr/local/lib/pythonX.Y
にあるものと仮定します。 (実際には、このパスは "フォールバック (fallback)" のライブラリ位置でもあり、 python
が PATH
上に無い場合に使われます。) ユーザは PYTHONHOME
を設定することでこの動作をオーバライドしたり、 PYTHONPATH
を設定して追加のディレクトリを標準モジュール検索パスの前に挿入したりできます。
埋め込みを行うアプリケーションでは、 Py_Initialize()
を呼び出す 前に Py_SetProgramName(file)
を呼び出すことで、上記の検索を操作できます。この埋め込みアプリケーションでの設定は依然として PYTHONHOME
でオーバライドでき、標準のモジュール検索パスの前には以前として PYTHONPATH
が挿入されるので注意してください。アプリケーションでモジュール検索パスを完全に制御したいのなら、独自に Py_GetPath()
, Py_GetPrefix()
, Py_GetExecPrefix()
, および Py_GetProgramFullPath()
の実装を提供しなければなりません (これらは全て Modules/getpath.c
で定義されています)。
たまに、 Python を初期化前の状態にもどしたいことがあります。例えば、あるアプリケーションでは実行を最初からやりなおし (start over) させる (Py_Initialize()
をもう一度呼び出させる) ようにしたいかもしれません。あるいは、アプリケーションが Python を一旦使い終えて、Python が確保したメモリを解放させたいかもしれません。 Py_FinalizeEx()
を使うとこうした処理を実現できます。また、関数 Py_IsInitialized()
は、Python が現在初期化済みの状態にある場合に真を返します。これらの関数についてのさらなる情報は、後の章で説明します。 Py_FinalizeEx()
がPythonインタプリタに確保された全てのメモリを 解放するわけではない ことに注意してください。例えば、拡張モジュールによって確保されたメモリは、現在のところ解放する事ができません。
デバッグ版ビルド (Debugging Builds)¶
インタプリタと拡張モジュールに対しての追加チェックをするためのいくつかのマクロを有効にしてPythonをビルドすることができます。これらのチェックは、実行時に大きなオーバーヘッドを生じる傾向があります。なので、デフォルトでは有効にされていません。
Pythonデバッグ版ビルドの全ての種類のリストが、Pythonソース配布(source distribution)の中の Misc/SpecialBuilds.txt
にあります。参照カウントのトレース、メモリアロケータのデバッグ、インタプリタのメインループの低レベルプロファイリングが利用可能です。よく使われるビルドについてのみ、この節の残りの部分で説明します。
インタプリタを Py_DEBUG
マクロを有効にしてコンパイルすると、一般的に「デバッグビルド」といわれるPythonができます。 Unix では、 ./configure
コマンドに --with-pydebug
を追加することで、 Py_DEBUG
が有効になります。その場合、暗黙的にPython専用ではない _DEBUG
も有効になります。 Unix ビルドでは、 Py_DEBUG
が有効な場合、コンパイラの最適化が無効になります。
あとで説明する参照カウントデバッグの他に、以下の追加チェックも有効になります:
object allocator に対する追加チェック。
パーサーとコンパイラに対する追加チェック。
情報損失のために、大きい型から小さい型へのダウンキャストに対するチェック。
辞書(dict)と集合(set)の実装に対する、いくつもの assertion の追加。加えて、集合オブジェクトに
test_c_api()
メソッドが追加されます。フレームを作成する時の、引数の健全性チェック。
初期化されていない数に対する参照を検出するために、整数のストレージが特定の妥当でないパターンで初期化されます。
低レベルトレースと追加例外チェックがVM runtimeに追加されます。
メモリアリーナ(memory arena)の実装に対する追加チェック。
threadモジュールに対する追加デバッグ機能.
ここで言及されていない追加チェックもあるでしょう。
Py_TRACE_REFS
を宣言すると、参照トレースが有効になります。全ての PyObject
に二つのフィールドを追加することで、使用中のオブジェクトの循環二重連結リストが管理されます。全ての割り当て(allocation)がトレースされます。終了時に、全ての残っているオブジェクトが表示されます。 (インタラクティブモードでは、インタプリタによる文の実行のたびに表示されます) Py_TRACE_REFS は Py_DEBUG
によって暗黙的に有効になります。
より詳しい情報については、Pythonのソース配布(source distribution)の中の Misc/SpecialBuilds.txt
を参照してください。