リストオブジェクト¶
-
PyTypeObject PyList_Type¶
- 次に属します: Stable ABI.
この
PyTypeObject
のインスタンスは Python のリスト型を表現します。これは Python レイヤにおけるlist
と同じオブジェクトです。
-
PyObject *PyList_New(Py_ssize_t len)¶
- 戻り値: 新しい参照。 次に属します: Stable ABI.
サイズが len 新たなリストオブジェクトを返します。 失敗すると
NULL
を返します。注釈
If len is greater than zero, the returned list object's items are set to
NULL
. Thus you cannot use abstract API functions such asPySequence_SetItem()
or expose the object to Python code before setting all items to a real object withPyList_SetItem()
orPyList_SET_ITEM()
. The following APIs are safe APIs before the list is fully initialized:PyList_SetItem()
andPyList_SET_ITEM()
.
-
Py_ssize_t PyList_Size(PyObject *list)¶
- 次に属します: Stable ABI.
リストオブジェクト list の長さを返します; リストオブジェクトにおける
len(list)
と同じです。
-
Py_ssize_t PyList_GET_SIZE(PyObject *list)¶
PyList_Size()
に似ていますが、エラーチェックを行いません。
-
PyObject *PyList_GetItemRef(PyObject *list, Py_ssize_t index)¶
- 戻り値: 新しい参照。 次に属します: Stable ABI (バージョン 3.13 より).
Return the object at position index in the list pointed to by list. The position must be non-negative; indexing from the end of the list is not supported. If index is out of bounds (
<0 or >=len(list)
), returnNULL
and set anIndexError
exception.Added in version 3.13.
-
PyObject *PyList_GetItem(PyObject *list, Py_ssize_t index)¶
- 戻り値: 借用参照。 次に属します: Stable ABI.
Like
PyList_GetItemRef()
, but returns a borrowed reference instead of a strong reference.
-
PyObject *PyList_GET_ITEM(PyObject *list, Py_ssize_t i)¶
- 戻り値: 借用参照。
PyList_GetItem()
に似ていますが、エラーチェックを行いません。
-
int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)¶
- 次に属します: Stable ABI.
リストオブジェクト内の位置 index に、オブジェクト item を挿入します。 成功した場合には
0
を返します。 index が範囲を越えている場合、-1
を返してIndexError
をセットします。注釈
この関数は item への参照を "盗み取り" ます。また、変更先のインデクスにすでに別の要素が入っている場合、その要素に対する参照を放棄します。
-
void PyList_SET_ITEM(PyObject *list, Py_ssize_t i, PyObject *o)¶
PyList_SetItem()
をマクロによる実装で、エラーチェックを行いません。このマクロは、新たなリストのまだ要素を入れたことのない位置に要素を入れるときにのみ使います。Bounds checking is performed as an assertion if Python is built in debug mode or
with assertions
.注釈
このマクロは item への参照を "盗み取り" ます。また、
PyList_SetItem()
と違って、要素の置き換えが生じても置き換えられるオブジェクトへの参照を放棄 しません ; その結果、 list 中の位置 i で参照されていたオブジェクトがメモリリークを引き起こします。
-
int PyList_Insert(PyObject *list, Py_ssize_t index, PyObject *item)¶
- 次に属します: Stable ABI.
要素 item をリスト list のインデックス index の前に挿入します。成功すると
0
を返します。失敗すると-1
を返し、例外をセットします。list.insert(index, item)
に類似した機能です。
-
int PyList_Append(PyObject *list, PyObject *item)¶
- 次に属します: Stable ABI.
オブジェクト item を list の末尾に追加します。成功すると
0
を返します; 失敗すると-1
を返し、例外をセットします。list.append(item)
に類似した機能です。
-
PyObject *PyList_GetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high)¶
- 戻り値: 新しい参照。 次に属します: Stable ABI.
list 内の、low から high までの オブジェクトからなるリストを返します。 失敗すると
NULL
を返し、例外をセットします。list[low:high]
に類似した機能です。 ただし、リストの末尾からのインデックスはサポートされていません。
-
int PyList_SetSlice(PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)¶
- 次に属します: Stable ABI.
low から high までの list のスライスを、 itemlist の内容にします。
list[low:high] = itemlist
と類似の機能です。 itemlist はNULL
でもよく、空リストの代入 (指定スライスの削除) になります。 成功した場合には0
を、失敗した場合には-1
を返します。 ただし、リストの末尾からのインデックスはサポートされていません。
-
int PyList_Extend(PyObject *list, PyObject *iterable)¶
Extend list with the contents of iterable. This is the same as
PyList_SetSlice(list, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, iterable)
and analogous tolist.extend(iterable)
orlist += iterable
.Raise an exception and return
-1
if list is not alist
object. Return 0 on success.Added in version 3.13.
-
int PyList_Clear(PyObject *list)¶
Remove all items from list. This is the same as
PyList_SetSlice(list, 0, PY_SSIZE_T_MAX, NULL)
and analogous tolist.clear()
ordel list[:]
.Raise an exception and return
-1
if list is not alist
object. Return 0 on success.Added in version 3.13.
-
int PyList_Sort(PyObject *list)¶
- 次に属します: Stable ABI.
list の内容をインプレースでソートします。成功した場合には
0
を、失敗した場合には-1
を返します。list.sort()
と同じです。
-
int PyList_Reverse(PyObject *list)¶
- 次に属します: Stable ABI.
list の要素をインプレースで反転します。成功した場合には
0
を、失敗した場合には-1
を返します。list.reverse()
と同じです。
-
PyObject *PyList_AsTuple(PyObject *list)¶
- 戻り値: 新しい参照。 次に属します: Stable ABI.
list の内容が入った新たなタプルオブジェクトを返します;
tuple(list)
と同じです。