This document is for an old version of Python that is no longer supported. You should upgrade and read the Python documentation for the current stable release.

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

int `PyMapping_Check`(PyObject *o)

  オブジェクトがマップ型プロトコルを提供している場合に `1` を返し、そうでないときには `0` を返します。この関数呼び出しは常に成功します。

Py_ssize_t `PyMapping_Size`(PyObject *o)
Py_ssize_t `PyMapping_Length`(PyObject *o)

  成功するとオブジェクト o 中のキーの数を返し、失敗すると `-1` を返します。マップ型プロトコルを提供していないオブジェクトに対しては、Python の式 `len(o)` と同じになります。

  バージョン 2.5 で変更: これらの関数は以前は `int` を返していました。この変更により、 64bit システムを正しくサポートするには修正が必要になります。

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

  オブジェクト o から key に関する対応付けを削除します。失敗すると `-1` を返します。Python の文 `del o[key]` と同じです。

int `PyMapping_DelItem`(PyObject *o, PyObject *key)

  オブジェクト o から key に関する対応付けを削除します。失敗すると `-1` を返します。Python の文 `del o[key]` と同じです。

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

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

int `PyMapping_HasKey`(PyObject *o, PyObject *key)

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

PyObject* `PyMapping_Keys`(PyObject *o)
  Return value: New reference.

  成功するとオブジェクト o のキーからなるリストを返します。失敗すると NULL を返します。 Python の式 `o.keys()` と同じです。

PyObject* `PyMapping_Values`(PyObject *o)
  Return value: New reference.

  成功するとオブジェクト o のキーに対応する値からなるリストを返します。失敗すると NULL を返します。 Python の式 `o.values()` と同じです。

PyObject* `PyMapping_Items`(PyObject *o)
  Return value: New reference.

  成功するとオブジェクト o の要素対、すなわちキーと値のペアが入ったタプルからなるリストを返します。失敗すると NULL を返します。 Python の式 `o.items()` と同じです。

PyObject* `PyMapping_GetItemString`(PyObject *o, char *key)
  Return value: New reference.

  オブジェクト key に対応する o の要素を返します。失敗すると NULL を返します。Python の式 `o[key]` と同じです。

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

  オブジェクト o で key を値 v に対応付けます。失敗すると `-1` を返します。Python の文 `o[key] = v` と同じです。