マップ型プロトコル (mapping protocol)¶
PyObject_GetItem()
, PyObject_SetItem()
, PyObject_DelItem()
も参照してください。
-
int PyMapping_Check(PyObject *o)¶
- 次に属します: Stable ABI.
Return
1
if the object provides the mapping protocol or supports slicing, and0
otherwise. Note that it returns1
for Python classes with a__getitem__()
method, since in general it is impossible to determine what type of keys the class supports. This function always succeeds.
-
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.
This is the same as
PyObject_GetItem()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.
-
int PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)¶
- 次に属します: Stable ABI (バージョン 3.13 より).
Variant of
PyObject_GetItem()
which doesn't raiseKeyError
if the key is not found.If the key is found, return
1
and set *result to a new strong reference to the corresponding value. If the key is not found, return0
and set *result toNULL
; theKeyError
is silenced. If an error other thanKeyError
is raised, return-1
and set *result toNULL
.Added in version 3.13.
-
int PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **result)¶
- 次に属します: Stable ABI (バージョン 3.13 より).
This is the same as
PyMapping_GetOptionalItem()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Added in version 3.13.
-
int PyMapping_SetItemString(PyObject *o, const char *key, PyObject *v)¶
- 次に属します: Stable ABI.
This is the same as
PyObject_SetItem()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.
-
int PyMapping_DelItem(PyObject *o, PyObject *key)¶
This is an alias of
PyObject_DelItem()
.
-
int PyMapping_DelItemString(PyObject *o, const char *key)¶
This is the same as
PyObject_DelItem()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.
-
int PyMapping_HasKeyWithError(PyObject *o, PyObject *key)¶
- 次に属します: Stable ABI (バージョン 3.13 より).
Return
1
if the mapping object has the key key and0
otherwise. This is equivalent to the Python expressionkey in o
. On failure, return-1
.Added in version 3.13.
-
int PyMapping_HasKeyStringWithError(PyObject *o, const char *key)¶
- 次に属します: Stable ABI (バージョン 3.13 より).
This is the same as
PyMapping_HasKeyWithError()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.Added in version 3.13.
-
int PyMapping_HasKey(PyObject *o, PyObject *key)¶
- 次に属します: Stable ABI.
マップ型オブジェクトがキー key を持つ場合に
1
を返し、そうでないときには0
を返します。これは、Python の式key in o
と等価です。この関数呼び出しは常に成功します。注釈
Exceptions which occur when this calls
__getitem__()
method are silently ignored. For proper error handling, usePyMapping_HasKeyWithError()
,PyMapping_GetOptionalItem()
orPyObject_GetItem()
instead.
-
int PyMapping_HasKeyString(PyObject *o, const char *key)¶
- 次に属します: Stable ABI.
This is the same as
PyMapping_HasKey()
, but key is specified as a const char* UTF-8 encoded bytes string, rather than a PyObject*.注釈
Exceptions that occur when this calls
__getitem__()
method or while creating the temporarystr
object are silently ignored. For proper error handling, usePyMapping_HasKeyStringWithError()
,PyMapping_GetOptionalItemString()
orPyMapping_GetItemString()
instead.
-
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 で変更: 以前は、関数はリストもしくはタプルを返していました。