シーケンス型プロトコル (sequence protocol)¶
-
int
PySequence_Check(PyObject *o)¶ Return
1if the object provides sequence protocol, and0otherwise. This function always succeeds.
-
Py_ssize_t
PySequence_Size(PyObject *o)¶ -
Py_ssize_t
PySequence_Length(PyObject *o)¶ 成功するとシーケンス o 中のオブジェクトの数を返し、失敗すると
-1を返します。これは、Python の式len(o)と同じになります。
-
PyObject*
PySequence_Concat(PyObject *o1, PyObject *o2)¶ - Return value: New reference.
成功すると o1 と o2 の連結 (concatenation) を返し、失敗すると NULL を返します。Python の式
o1 + o2と同じです。
-
PyObject*
PySequence_Repeat(PyObject *o, Py_ssize_t count)¶ - Return value: New reference.
成功するとオブジェクト o の count 回繰り返しを返し、失敗すると NULL を返します。Python の式
o * countと同じです。
-
PyObject*
PySequence_InPlaceConcat(PyObject *o1, PyObject *o2)¶ - Return value: New reference.
成功すると o1 と o2 の連結 (concatenation) を返し、失敗すると NULL を返します。o1 が in-place 演算をサポートする場合、in-place 演算を行います。Python の式
o1 += o2と同じです。
-
PyObject*
PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)¶ - Return value: New reference.
成功するとオブジェクト o の count 回繰り返しを返し、失敗すると NULL を返します。o が in-place 演算をサポートする場合、in-place 演算を行います。Python の式
o *= countと同じです。
-
PyObject*
PySequence_GetItem(PyObject *o, Py_ssize_t i)¶ - Return value: New reference.
成功すると o の i 番目の要素を返し、失敗すると NULL を返します。Python の式
o[i]と同じです。
-
PyObject*
PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶ - Return value: New reference.
成功すると o の i1 から i2 までの間のスライスを返し、失敗すると NULL を返します。Python の式
o[i1:i2]と同じです。
-
int
PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v)¶ o の i 番目の要素に v を代入します。 失敗すると、例外を送出し
-1を返します; 成功すると0を返します。 これは Python の文o[i] = vと同じです。 この関数は v への参照を 盗み取りません 。v が NULL の場合はその要素が削除されますが、この機能は非推奨であり、
PyObject_DelAttr()を使うのが望ましいです。
-
int
PySequence_DelItem(PyObject *o, Py_ssize_t i)¶ o の i 番目の要素を削除します。失敗すると
-1を返します。Python の文del o[i]と同じです。
-
int
PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)¶ o の i1 から i2 までの間のスライスに v を代入します。Python の文
o[i1:i2] = vと同じです。
-
int
PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2)¶ シーケンスオブジェクト o の i1 から i2 までの間のスライスを削除します。失敗すると
-1を返します。Python の文del o[i1:i2]と同じです。
-
Py_ssize_t
PySequence_Count(PyObject *o, PyObject *value)¶ o における value の出現回数、すなわち
o[key] == valueとなる key の個数を返します。失敗すると-1を返します。Python の式o.count(value)と同じです。
-
int
PySequence_Contains(PyObject *o, PyObject *value)¶ o に value が入っているか判定します。o のある要素が value と等価 (equal) ならば
1を返し、それ以外の場合には0を返します。エラーが発生すると-1を返します。Python の式value in oと同じです。
-
Py_ssize_t
PySequence_Index(PyObject *o, PyObject *value)¶ o[i] == valueとなる最初に見つかったインデクス i を返します。エラーが発生すると-1を返します。Python の式o.index(value)と同じです。
-
PyObject*
PySequence_List(PyObject *o)¶ - Return value: New reference.
シーケンスもしくはイテラブル o と同じ内容を持つリストオブジェクトを返します。 失敗したら NULL を返します。 返されるリストは新しく作られたことが保証されています。 これは Python の式
list(o)と同等です。
-
PyObject*
PySequence_Tuple(PyObject *o)¶ - Return value: New reference.
Return a tuple object with the same contents as the arbitrary sequence o or NULL on failure. If o is a tuple, a new reference will be returned, otherwise a tuple will be constructed with the appropriate contents. This is equivalent to the Python expression
tuple(o).
-
PyObject*
PySequence_Fast(PyObject *o, const char *m)¶ - Return value: New reference.
Return the sequence o as a list, unless it is already a tuple or list, in which case o is returned. Use
PySequence_Fast_GET_ITEM()to access the members of the result. Returns NULL on failure. If the object is not a sequence, raisesTypeErrorwith m as the message text.
-
PyObject*
PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)¶ - Return value: Borrowed reference.
o が NULL でなく、
PySequence_Fast()が返したオブジェクトであり、かつ i がインデクスの範囲内にあると仮定して、 o の i 番目の要素を返します。
-
PyObject**
PySequence_Fast_ITEMS(PyObject *o)¶ PyObject ポインタの背後にあるアレイを返します。この関数では、 o は
PySequence_Fast()の返したオブジェクトであり、 NULL でないものと仮定しています。リストのサイズが変更されるとき、メモリ再確保が要素の配列を再配置するかもしれないことに注意してください。そのため、シーケンスの変更が発生しないコンテキストでのみ背後にあるポインタを使ってください。
-
PyObject*
PySequence_ITEM(PyObject *o, Py_ssize_t i)¶ - Return value: New reference.
成功すると o の i 番目の要素を返し、失敗すると NULL を返します。
PySequence_GetItem()ですが、 o へのPySequence_Check()が真になるかチェックせず、負のインデクスに対する調整を行いません。
-
Py_ssize_t
PySequence_Fast_GET_SIZE(PyObject *o)¶ o が NULL でなく、
PySequence_Fast()が返したオブジェクトであると仮定して、 o の長さを返します。 o のサイズはPySequence_Size()を呼び出しても得られますが、PySequence_Fast_GET_SIZE()の方が o をリストかタプルであると仮定して処理するため、より高速です。