aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/tools/cython/Cython/Includes/cpython/iterobject.pxd
blob: a70aeccb097f3b8ff2b93d31e7752cbf3008dd88 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
cdef extern from "Python.h":

    ###########################################################################
    # Iterator Objects
    ###########################################################################

    bint PySeqIter_Check(object op)
    # Return true if the type of op is PySeqIter_Type.

    object PySeqIter_New(object seq)
    # Return value: New reference.
    # Return an iterator that works with a general sequence object, seq. The
    # iteration ends when the sequence raises IndexError for the subscripting
    # operation.

    bint PyCallIter_Check(object op)
    # Return true if the type of op is PyCallIter_Type.

    object PyCallIter_New(object callable, object sentinel)
    # Return value: New reference.
    # Return a new iterator. The first parameter, callable, can be any Python
    # callable object that can be called with no parameters; each call to it
    # should return the next item in the iteration. When callable returns a
    # value equal to sentinel, the iteration will be terminated.