マップ型プロトコル (mapping protocol)

PyObject_GetItem(), PyObject_SetItem(), PyObject_DelItem() も参照してください。

int PyMapping_Check(PyObject *o)

次に属します: Stable ABI.

オブジェクトがマッピングプロトコルを提供するかスライスをサポートする場合は 1 を返し、それ以外の場合は 0 を返します。 クラスがサポートするキーの型を判定することは一般には不可能なため、__getitem__() メソッドを持つ Python クラスのオブジェクトに対しても 1 を返します。 この関数は常に成功します。

Py_ssize_t PyMapping_Size(PyObject *o)

Py_ssize_t PyMapping_Length(PyObject *o)

次に属します: Stable ABI.

成功するとオブジェクト o 中のキーの数を返し、失敗すると -1 を返します。これは、Python の式 len(o) と同じになります。

PyObject *PyMapping_GetItemString(PyObject *o, const char *key)

戻り値: 新しい参照。 次に属します: Stable ABI.

PyObject_GetItem() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)

次に属します: Stable ABI (バージョン 3.13 より).

キーが見つからない場合に KeyError を送出しない PyObject_GetItem() の変種です。

キーが見つかった場合は 1 を返し、対応する値への新しい 強参照 を *result に設定します。 キーが見つからない場合は 0 を返し、*result を NULL に設定して KeyError を抑制します。 KeyError 以外のエラーが発生した場合は -1 を返し、*result を NULL に設定します。

Added in version 3.13.

int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)

次に属します: Stable ABI (バージョン 3.13 より).

PyMapping_GetOptionalItem() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

Added in version 3.13.

int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)

次に属します: Stable ABI.

PyObject_SetItem() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

int PyMapping_DelItem(PyObject *o, PyObject *key)

PyObject_DelItem() の別名です。

int PyMapping_DelItemString(PyObject *o, const char *key)

PyObject_DelItem() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)

次に属します: Stable ABI (バージョン 3.13 より).

マッピングオブジェクトがキー key を持つ場合は 1 を返し、それ以外の場合は 0 を返します。 Python の式 key in o と同等です。 失敗した場合は -1 を返します。

Added in version 3.13.

int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)

次に属します: Stable ABI (バージョン 3.13 より).

PyMapping_HasKeyWithError() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

Added in version 3.13.

int PyMapping_HasKey(PyObject *o, PyObject *key)

次に属します: Stable ABI.

マップ型オブジェクトがキー key を持つ場合に 1 を返し、そうでないときには 0 を返します。これは、Python の式 key in o と等価です。この関数呼び出しは常に成功します。

注釈

__getitem__() メソッドの呼び出し中に発生した例外は、通知せずに無視します。 エラーを適切に処理するには、代わりに PyMapping_HasKeyWithError()、PyMapping_GetOptionalItem()、PyObject_GetItem() を使ってください。

int PyMapping_HasKeyString(PyObject *o, const char *key)

次に属します: Stable ABI.

PyMapping_HasKey() と同じですが、key は PyObject* ではなく、UTF-8 でエンコードした const char* のバイト列で指定します。

注釈

__getitem__() メソッドの呼び出し中や、一時的な str オブジェクトの作成中に発生した例外は、通知せずに無視します。 エラーを適切に処理するには、代わりに PyMapping_HasKeyStringWithError()、PyMapping_GetOptionalItemString()、PyMapping_GetItemString() を使ってください。

PyObject *PyMapping_Keys(PyObject *o)

戻り値: 新しい参照。 次に属します: Stable ABI.

成功するとオブジェクト o のキーからなるリストを返します。 失敗すると NULL を返します。

バージョン 3.7 で変更: 以前は、関数はリストもしくはタプルを返していました。

PyObject *PyMapping_Values(PyObject *o)

戻り値: 新しい参照。 次に属します: Stable ABI.

成功するとオブジェクト o の値からなるリストを返します。 失敗すると NULL を返します。

バージョン 3.7 で変更: 以前は、関数はリストもしくはタプルを返していました。

PyObject *PyMapping_Items(PyObject *o)

戻り値: 新しい参照。 次に属します: Stable ABI.

成功するとオブジェクト o の要素からなるリストを返し、各要素はキーと値のペアが入ったタプルになっています。 失敗すると NULL を返します。

バージョン 3.7 で変更: 以前は、関数はリストもしくはタプルを返していました。