Commit 57b7dbc4 authored by Matti Picus's avatar Matti Picus Committed by Benjamin Peterson

Emphasize the need to always call PySequence_Fast. (GH-11140)

parent 088b63ea
...@@ -130,10 +130,17 @@ Sequence Protocol ...@@ -130,10 +130,17 @@ Sequence Protocol
.. c:function:: PyObject* PySequence_Fast(PyObject *o, const char *m) .. c:function:: PyObject* PySequence_Fast(PyObject *o, const char *m)
Return the sequence or iterable *o* as a list, unless it is already a tuple or list, in Return the sequence or iterable *o* as an object usable by the other
which case *o* is returned. Use :c:func:`PySequence_Fast_GET_ITEM` to access ``PySequence_Fast*`` family of functions. If the object is not a sequence or
the members of the result. Returns *NULL* on failure. If the object is not iterable, raises :exc:`TypeError` with *m* as the message text. Returns
a sequence or iterable, raises :exc:`TypeError` with *m* as the message text. *NULL* on failure.
The ``PySequence_Fast*`` functions are thus named because they assume
*o* is a :c:type:`PyTupleObject` or a :c:type:`PyListObject` and access
the data fields of *o* directly.
As a CPython implementation detail, if *o* is already a sequence or list, it
will be returned.
.. c:function:: Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o) .. c:function:: Py_ssize_t PySequence_Fast_GET_SIZE(PyObject *o)
...@@ -141,8 +148,8 @@ Sequence Protocol ...@@ -141,8 +148,8 @@ Sequence Protocol
Returns the length of *o*, assuming that *o* was returned by Returns the length of *o*, assuming that *o* was returned by
:c:func:`PySequence_Fast` and that *o* is not *NULL*. The size can also be :c:func:`PySequence_Fast` and that *o* is not *NULL*. The size can also be
gotten by calling :c:func:`PySequence_Size` on *o*, but gotten by calling :c:func:`PySequence_Size` on *o*, but
:c:func:`PySequence_Fast_GET_SIZE` is faster because it can assume *o* is a list :c:func:`PySequence_Fast_GET_SIZE` is faster because it can assume *o* is a
or tuple. list or tuple.
.. c:function:: PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i) .. c:function:: PyObject* PySequence_Fast_GET_ITEM(PyObject *o, Py_ssize_t i)
...@@ -163,7 +170,7 @@ Sequence Protocol ...@@ -163,7 +170,7 @@ Sequence Protocol
.. c:function:: PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i) .. c:function:: PyObject* PySequence_ITEM(PyObject *o, Py_ssize_t i)
Return the *i*\ th element of *o* or *NULL* on failure. Macro form of Return the *i*\ th element of *o* or *NULL* on failure. Faster form of
:c:func:`PySequence_GetItem` but without checking that :c:func:`PySequence_GetItem` but without checking that
:c:func:`PySequence_Check` on *o* is true and without adjustment for negative :c:func:`PySequence_Check` on *o* is true and without adjustment for negative
indices. indices.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment