マッピングプロトコル—Pythonドキュメント

提供:Dev Guides
< PythonPython/docs/3.8/c-api/mapping
移動先:案内検索

マッピングプロトコル

PyObject_GetItem()PyObject_SetItem()、および PyObject_DelItem()も参照してください。

int PyMapping_Check(PyObject *o)
オブジェクトがマッピングプロトコルを提供するか、スライスをサポートする場合は1を返し、それ以外の場合は0を返します。 __getitem__()メソッドを使用するPythonクラスの場合は1を返すことに注意してください。これは、通常、サポートするキーのタイプを判別できないためです。 この関数は常に成功します。
Py_ssize_t PyMapping_Size(PyObject *o)


Py_ssize_t PyMapping_Length(PyObject *o)

成功した場合はオブジェクト o のキーの数を返し、失敗した場合は-1のキーの数を返します。 これは、Python式len(o)と同等です。
PyObject *PyMapping_GetItemString(PyObject *o, const char *key)
失敗した場合、文字列 key またはNULLに対応する o の要素を返します。 これは、Python式o[key]と同等です。 PyObject_GetItem()も参照してください。
int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)
文字列キーをオブジェクト o の値 v にマップします。 失敗すると-1を返します。 これは、Pythonステートメントo[key] = vと同等です。 PyObject_SetItem()も参照してください。 この関数v への参照を盗みません
int PyMapping_DelItem(PyObject *o, PyObject *key)
オブジェクトキーのマッピングをオブジェクト o から削除します。 失敗した場合は-1を返します。 これは、Pythonステートメントdel o[key]と同等です。 これは PyObject_DelItem()のエイリアスです。
int PyMapping_DelItemString(PyObject *o, const char *key)
文字列 key のマッピングをオブジェクト o から削除します。 失敗した場合は-1を返します。 これは、Pythonステートメントdel o[key]と同等です。
int PyMapping_HasKey(PyObject *o, PyObject *key)

マッピングオブジェクトにキー key がある場合は1を返し、そうでない場合は0を返します。 これは、Python式key in oと同等です。 この関数は常に成功します。

__getitem__()メソッドの呼び出し中に発生する例外は抑制されることに注意してください。 エラー報告を取得するには、代わりに PyObject_GetItem()を使用してください。

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

マッピングオブジェクトにキー key がある場合は1を返し、そうでない場合は0を返します。 これは、Python式key in oと同等です。 この関数は常に成功します。

__getitem__()メソッドを呼び出して一時文字列オブジェクトを作成しているときに発生する例外は、抑制されることに注意してください。 エラー報告を取得するには、代わりに PyMapping_GetItemString()を使用してください。

PyObject *PyMapping_Keys(PyObject *o)

成功すると、オブジェクト o のキーのリストを返します。 失敗した場合は、NULLを返します。

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

PyObject *PyMapping_Values(PyObject *o)

成功すると、オブジェクト o の値のリストを返します。 失敗した場合は、NULLを返します。

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

PyObject *PyMapping_Items(PyObject *o)

成功すると、オブジェクト o 内のアイテムのリストを返します。各アイテムは、キーと値のペアを含むタプルです。 失敗した場合は、NULLを返します。

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