← Back to branch summary

~ubuntu-branches/ubuntu/maverick/python3.1/maverick

« back to all changes in this revision

Viewing changes to Doc/c-api/tuple.rst

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2009-03-23 00:01:27 UTC
  • Revision ID: james.westby@ubuntu.com-20090323000127-5fstfxju4ufrhthq
Tags: upstream-3.1~a1+20090322
Import upstream version 3.1~a1+20090322

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doc/c-api/tuple.rst
 
1
.. highlightlang:: c
 
2
 
 
3
.. _tupleobjects:
 
4
 
 
5
Tuple Objects
 
6
-------------
 
7
 
 
8
.. index:: object: tuple
 
9
 
 
10
 
 
11
.. ctype:: PyTupleObject
 
12
 
 
13
   This subtype of :ctype:`PyObject` represents a Python tuple object.
 
14
 
 
15
 
 
16
.. cvar:: PyTypeObject PyTuple_Type
 
17
 
 
18
   .. index:: single: TupleType (in module types)
 
19
 
 
20
   This instance of :ctype:`PyTypeObject` represents the Python tuple type; it is
 
21
   the same object as ``tuple`` and ``types.TupleType`` in the Python layer..
 
22
 
 
23
 
 
24
.. cfunction:: int PyTuple_Check(PyObject *p)
 
25
 
 
26
   Return true if *p* is a tuple object or an instance of a subtype of the tuple
 
27
   type.
 
28
 
 
29
 
 
30
.. cfunction:: int PyTuple_CheckExact(PyObject *p)
 
31
 
 
32
   Return true if *p* is a tuple object, but not an instance of a subtype of the
 
33
   tuple type.
 
34
 
 
35
 
 
36
.. cfunction:: PyObject* PyTuple_New(Py_ssize_t len)
 
37
 
 
38
   Return a new tuple object of size *len*, or *NULL* on failure.
 
39
 
 
40
 
 
41
.. cfunction:: PyObject* PyTuple_Pack(Py_ssize_t n, ...)
 
42
 
 
43
   Return a new tuple object of size *n*, or *NULL* on failure. The tuple values
 
44
   are initialized to the subsequent *n* C arguments pointing to Python objects.
 
45
   ``PyTuple_Pack(2, a, b)`` is equivalent to ``Py_BuildValue("(OO)", a, b)``.
 
46
 
 
47
 
 
48
.. cfunction:: Py_ssize_t PyTuple_Size(PyObject *p)
 
49
 
 
50
   Take a pointer to a tuple object, and return the size of that tuple.
 
51
 
 
52
 
 
53
.. cfunction:: Py_ssize_t PyTuple_GET_SIZE(PyObject *p)
 
54
 
 
55
   Return the size of the tuple *p*, which must be non-*NULL* and point to a tuple;
 
56
   no error checking is performed.
 
57
 
 
58
 
 
59
.. cfunction:: PyObject* PyTuple_GetItem(PyObject *p, Py_ssize_t pos)
 
60
 
 
61
   Return the object at position *pos* in the tuple pointed to by *p*.  If *pos* is
 
62
   out of bounds, return *NULL* and sets an :exc:`IndexError` exception.
 
63
 
 
64
 
 
65
.. cfunction:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)
 
66
 
 
67
   Like :cfunc:`PyTuple_GetItem`, but does no checking of its arguments.
 
68
 
 
69
 
 
70
.. cfunction:: PyObject* PyTuple_GetSlice(PyObject *p, Py_ssize_t low, Py_ssize_t high)
 
71
 
 
72
   Take a slice of the tuple pointed to by *p* from *low* to *high* and return it
 
73
   as a new tuple.
 
74
 
 
75
 
 
76
.. cfunction:: int PyTuple_SetItem(PyObject *p, Py_ssize_t pos, PyObject *o)
 
77
 
 
78
   Insert a reference to object *o* at position *pos* of the tuple pointed to by
 
79
   *p*. Return ``0`` on success.
 
80
 
 
81
   .. note::
 
82
 
 
83
      This function "steals" a reference to *o*.
 
84
 
 
85
 
 
86
.. cfunction:: void PyTuple_SET_ITEM(PyObject *p, Py_ssize_t pos, PyObject *o)
 
87
 
 
88
   Like :cfunc:`PyTuple_SetItem`, but does no error checking, and should *only* be
 
89
   used to fill in brand new tuples.
 
90
 
 
91
   .. note::
 
92
 
 
93
      This function "steals" a reference to *o*.
 
94
 
 
95
 
 
96
.. cfunction:: int _PyTuple_Resize(PyObject **p, Py_ssize_t newsize)
 
97
 
 
98
   Can be used to resize a tuple.  *newsize* will be the new length of the tuple.
 
99
   Because tuples are *supposed* to be immutable, this should only be used if there
 
100
   is only one reference to the object.  Do *not* use this if the tuple may already
 
101
   be known to some other part of the code.  The tuple will always grow or shrink
 
102
   at the end.  Think of this as destroying the old tuple and creating a new one,
 
103
   only more efficiently.  Returns ``0`` on success. Client code should never
 
104
   assume that the resulting value of ``*p`` will be the same as before calling
 
105
   this function. If the object referenced by ``*p`` is replaced, the original
 
106
   ``*p`` is destroyed.  On failure, returns ``-1`` and sets ``*p`` to *NULL*, and
 
107
   raises :exc:`MemoryError` or :exc:`SystemError`.
 
108
 
 
109
.. cfunction:: int PyTuple_ClearFreeList(void)
 
110
 
 
111
   Clear the free list. Return the total number of freed items.