1 /* Array object implementation */
3 /* An array is a uniform list -- all items have the same type.
4 The item type is restricted to simple C types like int or float */
6 #define PY_SSIZE_T_CLEAN
8 #include "structmember.h"
12 #else /* !STDC_HEADERS */
13 #ifdef HAVE_SYS_TYPES_H
14 #include <sys/types.h> /* For size_t */
15 #endif /* HAVE_SYS_TYPES_H */
16 #endif /* !STDC_HEADERS */
18 struct arrayobject
; /* Forward */
20 /* All possible arraydescr values are defined in the vector "descriptors"
21 * below. That's defined later because the appropriate get and set
22 * functions aren't visible yet.
27 PyObject
* (*getitem
)(struct arrayobject
*, Py_ssize_t
);
28 int (*setitem
)(struct arrayobject
*, Py_ssize_t
, PyObject
*);
31 typedef struct arrayobject
{
35 struct arraydescr
*ob_descr
;
36 PyObject
*weakreflist
; /* List of weak references */
39 static PyTypeObject Arraytype
;
41 #define array_Check(op) PyObject_TypeCheck(op, &Arraytype)
42 #define array_CheckExact(op) (Py_TYPE(op) == &Arraytype)
45 array_resize(arrayobject
*self
, Py_ssize_t newsize
)
50 /* Bypass realloc() when a previous overallocation is large enough
51 to accommodate the newsize. If the newsize is 16 smaller than the
52 current size, then proceed with the realloc() to shrink the list.
55 if (self
->allocated
>= newsize
&&
56 Py_SIZE(self
) < newsize
+ 16 &&
57 self
->ob_item
!= NULL
) {
58 Py_SIZE(self
) = newsize
;
62 /* This over-allocates proportional to the array size, making room
63 * for additional growth. The over-allocation is mild, but is
64 * enough to give linear-time amortized behavior over a long
65 * sequence of appends() in the presence of a poorly-performing
67 * The growth pattern is: 0, 4, 8, 16, 25, 34, 46, 56, 67, 79, ...
68 * Note, the pattern starts out the same as for lists but then
69 * grows at a smaller rate so that larger arrays only overallocate
70 * by about 1/16th -- this is done because arrays are presumed to be more
74 _new_size
= (newsize
>> 4) + (Py_SIZE(self
) < 8 ? 3 : 7) + newsize
;
75 items
= self
->ob_item
;
76 /* XXX The following multiplication and division does not optimize away
77 like it does for lists since the size is not known at compile time */
78 if (_new_size
<= ((~(size_t)0) / self
->ob_descr
->itemsize
))
79 PyMem_RESIZE(items
, char, (_new_size
* self
->ob_descr
->itemsize
));
86 self
->ob_item
= items
;
87 Py_SIZE(self
) = newsize
;
88 self
->allocated
= _new_size
;
92 /****************************************************************************
93 Get and Set functions for each type.
94 A Get function takes an arrayobject* and an integer index, returning the
95 array value at that index wrapped in an appropriate PyObject*.
96 A Set function takes an arrayobject, integer index, and PyObject*; sets
97 the array value at that index to the raw C data extracted from the PyObject*,
98 and returns 0 if successful, else nonzero on failure (PyObject* not of an
99 appropriate type or value).
100 Note that the basic Get and Set functions do NOT check that the index is
101 in bounds; that's the responsibility of the caller.
102 ****************************************************************************/
105 c_getitem(arrayobject
*ap
, Py_ssize_t i
)
107 return PyString_FromStringAndSize(&((char *)ap
->ob_item
)[i
], 1);
111 c_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
114 if (!PyArg_Parse(v
, "c;array item must be char", &x
))
117 ((char *)ap
->ob_item
)[i
] = x
;
122 b_getitem(arrayobject
*ap
, Py_ssize_t i
)
124 long x
= ((char *)ap
->ob_item
)[i
];
127 return PyInt_FromLong(x
);
131 b_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
134 /* PyArg_Parse's 'b' formatter is for an unsigned char, therefore
135 must use the next size up that is signed ('h') and manually do
136 the overflow checking */
137 if (!PyArg_Parse(v
, "h;array item must be integer", &x
))
140 PyErr_SetString(PyExc_OverflowError
,
141 "signed char is less than minimum");
145 PyErr_SetString(PyExc_OverflowError
,
146 "signed char is greater than maximum");
150 ((char *)ap
->ob_item
)[i
] = (char)x
;
155 BB_getitem(arrayobject
*ap
, Py_ssize_t i
)
157 long x
= ((unsigned char *)ap
->ob_item
)[i
];
158 return PyInt_FromLong(x
);
162 BB_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
165 /* 'B' == unsigned char, maps to PyArg_Parse's 'b' formatter */
166 if (!PyArg_Parse(v
, "b;array item must be integer", &x
))
169 ((char *)ap
->ob_item
)[i
] = x
;
173 #ifdef Py_USING_UNICODE
175 u_getitem(arrayobject
*ap
, Py_ssize_t i
)
177 return PyUnicode_FromUnicode(&((Py_UNICODE
*) ap
->ob_item
)[i
], 1);
181 u_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
186 if (!PyArg_Parse(v
, "u#;array item must be unicode character", &p
, &len
))
189 PyErr_SetString(PyExc_TypeError
,
190 "array item must be unicode character");
194 ((Py_UNICODE
*)ap
->ob_item
)[i
] = p
[0];
200 h_getitem(arrayobject
*ap
, Py_ssize_t i
)
202 return PyInt_FromLong((long) ((short *)ap
->ob_item
)[i
]);
206 h_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
209 /* 'h' == signed short, maps to PyArg_Parse's 'h' formatter */
210 if (!PyArg_Parse(v
, "h;array item must be integer", &x
))
213 ((short *)ap
->ob_item
)[i
] = x
;
218 HH_getitem(arrayobject
*ap
, Py_ssize_t i
)
220 return PyInt_FromLong((long) ((unsigned short *)ap
->ob_item
)[i
]);
224 HH_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
227 /* PyArg_Parse's 'h' formatter is for a signed short, therefore
228 must use the next size up and manually do the overflow checking */
229 if (!PyArg_Parse(v
, "i;array item must be integer", &x
))
232 PyErr_SetString(PyExc_OverflowError
,
233 "unsigned short is less than minimum");
236 else if (x
> USHRT_MAX
) {
237 PyErr_SetString(PyExc_OverflowError
,
238 "unsigned short is greater than maximum");
242 ((short *)ap
->ob_item
)[i
] = (short)x
;
247 i_getitem(arrayobject
*ap
, Py_ssize_t i
)
249 return PyInt_FromLong((long) ((int *)ap
->ob_item
)[i
]);
253 i_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
256 /* 'i' == signed int, maps to PyArg_Parse's 'i' formatter */
257 if (!PyArg_Parse(v
, "i;array item must be integer", &x
))
260 ((int *)ap
->ob_item
)[i
] = x
;
265 II_getitem(arrayobject
*ap
, Py_ssize_t i
)
267 return PyLong_FromUnsignedLong(
268 (unsigned long) ((unsigned int *)ap
->ob_item
)[i
]);
272 II_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
275 if (PyLong_Check(v
)) {
276 x
= PyLong_AsUnsignedLong(v
);
277 if (x
== (unsigned long) -1 && PyErr_Occurred())
282 if (!PyArg_Parse(v
, "l;array item must be integer", &y
))
285 PyErr_SetString(PyExc_OverflowError
,
286 "unsigned int is less than minimum");
289 x
= (unsigned long)y
;
293 PyErr_SetString(PyExc_OverflowError
,
294 "unsigned int is greater than maximum");
299 ((unsigned int *)ap
->ob_item
)[i
] = (unsigned int)x
;
304 l_getitem(arrayobject
*ap
, Py_ssize_t i
)
306 return PyInt_FromLong(((long *)ap
->ob_item
)[i
]);
310 l_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
313 if (!PyArg_Parse(v
, "l;array item must be integer", &x
))
316 ((long *)ap
->ob_item
)[i
] = x
;
321 LL_getitem(arrayobject
*ap
, Py_ssize_t i
)
323 return PyLong_FromUnsignedLong(((unsigned long *)ap
->ob_item
)[i
]);
327 LL_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
330 if (PyLong_Check(v
)) {
331 x
= PyLong_AsUnsignedLong(v
);
332 if (x
== (unsigned long) -1 && PyErr_Occurred())
337 if (!PyArg_Parse(v
, "l;array item must be integer", &y
))
340 PyErr_SetString(PyExc_OverflowError
,
341 "unsigned long is less than minimum");
344 x
= (unsigned long)y
;
348 PyErr_SetString(PyExc_OverflowError
,
349 "unsigned long is greater than maximum");
354 ((unsigned long *)ap
->ob_item
)[i
] = x
;
359 f_getitem(arrayobject
*ap
, Py_ssize_t i
)
361 return PyFloat_FromDouble((double) ((float *)ap
->ob_item
)[i
]);
365 f_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
368 if (!PyArg_Parse(v
, "f;array item must be float", &x
))
371 ((float *)ap
->ob_item
)[i
] = x
;
376 d_getitem(arrayobject
*ap
, Py_ssize_t i
)
378 return PyFloat_FromDouble(((double *)ap
->ob_item
)[i
]);
382 d_setitem(arrayobject
*ap
, Py_ssize_t i
, PyObject
*v
)
385 if (!PyArg_Parse(v
, "d;array item must be float", &x
))
388 ((double *)ap
->ob_item
)[i
] = x
;
392 /* Description of types */
393 static struct arraydescr descriptors
[] = {
394 {'c', sizeof(char), c_getitem
, c_setitem
},
395 {'b', sizeof(char), b_getitem
, b_setitem
},
396 {'B', sizeof(char), BB_getitem
, BB_setitem
},
397 #ifdef Py_USING_UNICODE
398 {'u', sizeof(Py_UNICODE
), u_getitem
, u_setitem
},
400 {'h', sizeof(short), h_getitem
, h_setitem
},
401 {'H', sizeof(short), HH_getitem
, HH_setitem
},
402 {'i', sizeof(int), i_getitem
, i_setitem
},
403 {'I', sizeof(int), II_getitem
, II_setitem
},
404 {'l', sizeof(long), l_getitem
, l_setitem
},
405 {'L', sizeof(long), LL_getitem
, LL_setitem
},
406 {'f', sizeof(float), f_getitem
, f_setitem
},
407 {'d', sizeof(double), d_getitem
, d_setitem
},
408 {'\0', 0, 0, 0} /* Sentinel */
411 /****************************************************************************
412 Implementations of array object methods.
413 ****************************************************************************/
416 newarrayobject(PyTypeObject
*type
, Py_ssize_t size
, struct arraydescr
*descr
)
422 PyErr_BadInternalCall();
426 nbytes
= size
* descr
->itemsize
;
427 /* Check for overflow */
428 if (nbytes
/ descr
->itemsize
!= (size_t)size
) {
429 return PyErr_NoMemory();
431 op
= (arrayobject
*) type
->tp_alloc(type
, 0);
435 op
->ob_descr
= descr
;
436 op
->allocated
= size
;
437 op
->weakreflist
= NULL
;
443 op
->ob_item
= PyMem_NEW(char, nbytes
);
444 if (op
->ob_item
== NULL
) {
446 return PyErr_NoMemory();
449 return (PyObject
*) op
;
453 getarrayitem(PyObject
*op
, Py_ssize_t i
)
455 register arrayobject
*ap
;
456 assert(array_Check(op
));
457 ap
= (arrayobject
*)op
;
458 assert(i
>=0 && i
<Py_SIZE(ap
));
459 return (*ap
->ob_descr
->getitem
)(ap
, i
);
463 ins1(arrayobject
*self
, Py_ssize_t where
, PyObject
*v
)
466 Py_ssize_t n
= Py_SIZE(self
);
468 PyErr_BadInternalCall();
471 if ((*self
->ob_descr
->setitem
)(self
, -1, v
) < 0)
474 if (array_resize(self
, n
+1) == -1)
476 items
= self
->ob_item
;
484 /* appends don't need to call memmove() */
486 memmove(items
+ (where
+1)*self
->ob_descr
->itemsize
,
487 items
+ where
*self
->ob_descr
->itemsize
,
488 (n
-where
)*self
->ob_descr
->itemsize
);
489 return (*self
->ob_descr
->setitem
)(self
, where
, v
);
495 array_dealloc(arrayobject
*op
)
497 if (op
->weakreflist
!= NULL
)
498 PyObject_ClearWeakRefs((PyObject
*) op
);
499 if (op
->ob_item
!= NULL
)
500 PyMem_DEL(op
->ob_item
);
501 Py_TYPE(op
)->tp_free((PyObject
*)op
);
505 array_richcompare(PyObject
*v
, PyObject
*w
, int op
)
507 arrayobject
*va
, *wa
;
513 if (!array_Check(v
) || !array_Check(w
)) {
514 Py_INCREF(Py_NotImplemented
);
515 return Py_NotImplemented
;
518 va
= (arrayobject
*)v
;
519 wa
= (arrayobject
*)w
;
521 if (Py_SIZE(va
) != Py_SIZE(wa
) && (op
== Py_EQ
|| op
== Py_NE
)) {
522 /* Shortcut: if the lengths differ, the arrays differ */
531 /* Search for the first index where items are different */
533 for (i
= 0; i
< Py_SIZE(va
) && i
< Py_SIZE(wa
); i
++) {
534 vi
= getarrayitem(v
, i
);
535 wi
= getarrayitem(w
, i
);
536 if (vi
== NULL
|| wi
== NULL
) {
541 k
= PyObject_RichCompareBool(vi
, wi
, Py_EQ
);
543 break; /* Keeping vi and wi alive! */
551 /* No more items to compare -- compare sizes */
552 Py_ssize_t vs
= Py_SIZE(va
);
553 Py_ssize_t ws
= Py_SIZE(wa
);
556 case Py_LT
: cmp
= vs
< ws
; break;
557 case Py_LE
: cmp
= vs
<= ws
; break;
558 case Py_EQ
: cmp
= vs
== ws
; break;
559 case Py_NE
: cmp
= vs
!= ws
; break;
560 case Py_GT
: cmp
= vs
> ws
; break;
561 case Py_GE
: cmp
= vs
>= ws
; break;
562 default: return NULL
; /* cannot happen */
572 /* We have an item that differs. First, shortcuts for EQ/NE */
577 else if (op
== Py_NE
) {
582 /* Compare the final item again using the proper operator */
583 res
= PyObject_RichCompare(vi
, wi
, op
);
591 array_length(arrayobject
*a
)
597 array_item(arrayobject
*a
, Py_ssize_t i
)
599 if (i
< 0 || i
>= Py_SIZE(a
)) {
600 PyErr_SetString(PyExc_IndexError
, "array index out of range");
603 return getarrayitem((PyObject
*)a
, i
);
607 array_slice(arrayobject
*a
, Py_ssize_t ilow
, Py_ssize_t ihigh
)
612 else if (ilow
> Py_SIZE(a
))
618 else if (ihigh
> Py_SIZE(a
))
620 np
= (arrayobject
*) newarrayobject(&Arraytype
, ihigh
- ilow
, a
->ob_descr
);
623 memcpy(np
->ob_item
, a
->ob_item
+ ilow
* a
->ob_descr
->itemsize
,
624 (ihigh
-ilow
) * a
->ob_descr
->itemsize
);
625 return (PyObject
*)np
;
629 array_copy(arrayobject
*a
, PyObject
*unused
)
631 return array_slice(a
, 0, Py_SIZE(a
));
634 PyDoc_STRVAR(copy_doc
,
637 Return a copy of the array.");
640 array_concat(arrayobject
*a
, PyObject
*bb
)
644 if (!array_Check(bb
)) {
645 PyErr_Format(PyExc_TypeError
,
646 "can only append array (not \"%.200s\") to array",
647 Py_TYPE(bb
)->tp_name
);
650 #define b ((arrayobject *)bb)
651 if (a
->ob_descr
!= b
->ob_descr
) {
655 if (Py_SIZE(a
) > PY_SSIZE_T_MAX
- Py_SIZE(b
)) {
656 return PyErr_NoMemory();
658 size
= Py_SIZE(a
) + Py_SIZE(b
);
659 np
= (arrayobject
*) newarrayobject(&Arraytype
, size
, a
->ob_descr
);
663 memcpy(np
->ob_item
, a
->ob_item
, Py_SIZE(a
)*a
->ob_descr
->itemsize
);
664 memcpy(np
->ob_item
+ Py_SIZE(a
)*a
->ob_descr
->itemsize
,
665 b
->ob_item
, Py_SIZE(b
)*b
->ob_descr
->itemsize
);
666 return (PyObject
*)np
;
671 array_repeat(arrayobject
*a
, Py_ssize_t n
)
680 if ((Py_SIZE(a
) != 0) && (n
> PY_SSIZE_T_MAX
/ Py_SIZE(a
))) {
681 return PyErr_NoMemory();
683 size
= Py_SIZE(a
) * n
;
684 np
= (arrayobject
*) newarrayobject(&Arraytype
, size
, a
->ob_descr
);
688 nbytes
= Py_SIZE(a
) * a
->ob_descr
->itemsize
;
689 for (i
= 0; i
< n
; i
++) {
690 memcpy(p
, a
->ob_item
, nbytes
);
693 return (PyObject
*) np
;
697 array_ass_slice(arrayobject
*a
, Py_ssize_t ilow
, Py_ssize_t ihigh
, PyObject
*v
)
700 Py_ssize_t n
; /* Size of replacement array */
701 Py_ssize_t d
; /* Change in size */
702 #define b ((arrayobject *)v)
705 else if (array_Check(v
)) {
708 /* Special case "a[i:j] = a" -- copy b first */
710 v
= array_slice(b
, 0, n
);
713 ret
= array_ass_slice(a
, ilow
, ihigh
, v
);
717 if (b
->ob_descr
!= a
->ob_descr
) {
723 PyErr_Format(PyExc_TypeError
,
724 "can only assign array (not \"%.200s\") to array slice",
725 Py_TYPE(v
)->tp_name
);
730 else if (ilow
> Py_SIZE(a
))
736 else if (ihigh
> Py_SIZE(a
))
739 d
= n
- (ihigh
-ilow
);
740 if (d
< 0) { /* Delete -d items */
741 memmove(item
+ (ihigh
+d
)*a
->ob_descr
->itemsize
,
742 item
+ ihigh
*a
->ob_descr
->itemsize
,
743 (Py_SIZE(a
)-ihigh
)*a
->ob_descr
->itemsize
);
745 PyMem_RESIZE(item
, char, Py_SIZE(a
)*a
->ob_descr
->itemsize
);
748 a
->allocated
= Py_SIZE(a
);
750 else if (d
> 0) { /* Insert d items */
751 PyMem_RESIZE(item
, char,
752 (Py_SIZE(a
) + d
)*a
->ob_descr
->itemsize
);
757 memmove(item
+ (ihigh
+d
)*a
->ob_descr
->itemsize
,
758 item
+ ihigh
*a
->ob_descr
->itemsize
,
759 (Py_SIZE(a
)-ihigh
)*a
->ob_descr
->itemsize
);
762 a
->allocated
= Py_SIZE(a
);
765 memcpy(item
+ ilow
*a
->ob_descr
->itemsize
, b
->ob_item
,
766 n
*b
->ob_descr
->itemsize
);
772 array_ass_item(arrayobject
*a
, Py_ssize_t i
, PyObject
*v
)
774 if (i
< 0 || i
>= Py_SIZE(a
)) {
775 PyErr_SetString(PyExc_IndexError
,
776 "array assignment index out of range");
780 return array_ass_slice(a
, i
, i
+1, v
);
781 return (*a
->ob_descr
->setitem
)(a
, i
, v
);
785 setarrayitem(PyObject
*a
, Py_ssize_t i
, PyObject
*v
)
787 assert(array_Check(a
));
788 return array_ass_item((arrayobject
*)a
, i
, v
);
792 array_iter_extend(arrayobject
*self
, PyObject
*bb
)
796 it
= PyObject_GetIter(bb
);
800 while ((v
= PyIter_Next(it
)) != NULL
) {
801 if (ins1(self
, (int) Py_SIZE(self
), v
) != 0) {
809 if (PyErr_Occurred())
815 array_do_extend(arrayobject
*self
, PyObject
*bb
)
819 if (!array_Check(bb
))
820 return array_iter_extend(self
, bb
);
821 #define b ((arrayobject *)bb)
822 if (self
->ob_descr
!= b
->ob_descr
) {
823 PyErr_SetString(PyExc_TypeError
,
824 "can only extend with array of same kind");
827 if ((Py_SIZE(self
) > PY_SSIZE_T_MAX
- Py_SIZE(b
)) ||
828 ((Py_SIZE(self
) + Py_SIZE(b
)) > PY_SSIZE_T_MAX
/ self
->ob_descr
->itemsize
)) {
832 size
= Py_SIZE(self
) + Py_SIZE(b
);
833 PyMem_RESIZE(self
->ob_item
, char, size
*self
->ob_descr
->itemsize
);
834 if (self
->ob_item
== NULL
) {
838 memcpy(self
->ob_item
+ Py_SIZE(self
)*self
->ob_descr
->itemsize
,
839 b
->ob_item
, Py_SIZE(b
)*b
->ob_descr
->itemsize
);
840 Py_SIZE(self
) = size
;
841 self
->allocated
= size
;
848 array_inplace_concat(arrayobject
*self
, PyObject
*bb
)
850 if (!array_Check(bb
)) {
851 PyErr_Format(PyExc_TypeError
,
852 "can only extend array with array (not \"%.200s\")",
853 Py_TYPE(bb
)->tp_name
);
856 if (array_do_extend(self
, bb
) == -1)
859 return (PyObject
*)self
;
863 array_inplace_repeat(arrayobject
*self
, Py_ssize_t n
)
868 if (Py_SIZE(self
) > 0) {
871 items
= self
->ob_item
;
872 if ((self
->ob_descr
->itemsize
!= 0) &&
873 (Py_SIZE(self
) > PY_SSIZE_T_MAX
/ self
->ob_descr
->itemsize
)) {
874 return PyErr_NoMemory();
876 size
= Py_SIZE(self
) * self
->ob_descr
->itemsize
;
879 self
->ob_item
= NULL
;
884 if (size
> PY_SSIZE_T_MAX
/ n
) {
885 return PyErr_NoMemory();
887 PyMem_Resize(items
, char, n
* size
);
889 return PyErr_NoMemory();
891 for (i
= 1; i
< n
; i
++) {
893 memcpy(p
, items
, size
);
895 self
->ob_item
= items
;
897 self
->allocated
= Py_SIZE(self
);
901 return (PyObject
*)self
;
906 ins(arrayobject
*self
, Py_ssize_t where
, PyObject
*v
)
908 if (ins1(self
, where
, v
) != 0)
915 array_count(arrayobject
*self
, PyObject
*v
)
917 Py_ssize_t count
= 0;
920 for (i
= 0; i
< Py_SIZE(self
); i
++) {
921 PyObject
*selfi
= getarrayitem((PyObject
*)self
, i
);
922 int cmp
= PyObject_RichCompareBool(selfi
, v
, Py_EQ
);
929 return PyInt_FromSsize_t(count
);
932 PyDoc_STRVAR(count_doc
,
935 Return number of occurences of x in the array.");
938 array_index(arrayobject
*self
, PyObject
*v
)
942 for (i
= 0; i
< Py_SIZE(self
); i
++) {
943 PyObject
*selfi
= getarrayitem((PyObject
*)self
, i
);
944 int cmp
= PyObject_RichCompareBool(selfi
, v
, Py_EQ
);
947 return PyInt_FromLong((long)i
);
952 PyErr_SetString(PyExc_ValueError
, "array.index(x): x not in list");
956 PyDoc_STRVAR(index_doc
,
959 Return index of first occurence of x in the array.");
962 array_contains(arrayobject
*self
, PyObject
*v
)
967 for (i
= 0, cmp
= 0 ; cmp
== 0 && i
< Py_SIZE(self
); i
++) {
968 PyObject
*selfi
= getarrayitem((PyObject
*)self
, i
);
969 cmp
= PyObject_RichCompareBool(selfi
, v
, Py_EQ
);
976 array_remove(arrayobject
*self
, PyObject
*v
)
980 for (i
= 0; i
< Py_SIZE(self
); i
++) {
981 PyObject
*selfi
= getarrayitem((PyObject
*)self
,i
);
982 int cmp
= PyObject_RichCompareBool(selfi
, v
, Py_EQ
);
985 if (array_ass_slice(self
, i
, i
+1,
986 (PyObject
*)NULL
) != 0)
994 PyErr_SetString(PyExc_ValueError
, "array.remove(x): x not in list");
998 PyDoc_STRVAR(remove_doc
,
1001 Remove the first occurence of x in the array.");
1004 array_pop(arrayobject
*self
, PyObject
*args
)
1008 if (!PyArg_ParseTuple(args
, "|n:pop", &i
))
1010 if (Py_SIZE(self
) == 0) {
1011 /* Special-case most common failure cause */
1012 PyErr_SetString(PyExc_IndexError
, "pop from empty array");
1017 if (i
< 0 || i
>= Py_SIZE(self
)) {
1018 PyErr_SetString(PyExc_IndexError
, "pop index out of range");
1021 v
= getarrayitem((PyObject
*)self
,i
);
1022 if (array_ass_slice(self
, i
, i
+1, (PyObject
*)NULL
) != 0) {
1029 PyDoc_STRVAR(pop_doc
,
1032 Return the i-th element and delete it from the array. i defaults to -1.");
1035 array_extend(arrayobject
*self
, PyObject
*bb
)
1037 if (array_do_extend(self
, bb
) == -1)
1043 PyDoc_STRVAR(extend_doc
,
1044 "extend(array or iterable)\n\
1046 Append items to the end of the array.");
1049 array_insert(arrayobject
*self
, PyObject
*args
)
1053 if (!PyArg_ParseTuple(args
, "nO:insert", &i
, &v
))
1055 return ins(self
, i
, v
);
1058 PyDoc_STRVAR(insert_doc
,
1061 Insert a new item x into the array before position i.");
1065 array_buffer_info(arrayobject
*self
, PyObject
*unused
)
1067 PyObject
* retval
= NULL
;
1068 retval
= PyTuple_New(2);
1072 PyTuple_SET_ITEM(retval
, 0, PyLong_FromVoidPtr(self
->ob_item
));
1073 PyTuple_SET_ITEM(retval
, 1, PyInt_FromLong((long)(Py_SIZE(self
))));
1078 PyDoc_STRVAR(buffer_info_doc
,
1079 "buffer_info() -> (address, length)\n\
1081 Return a tuple (address, length) giving the current memory address and\n\
1082 the length in items of the buffer used to hold array's contents\n\
1083 The length should be multiplied by the itemsize attribute to calculate\n\
1084 the buffer length in bytes.");
1088 array_append(arrayobject
*self
, PyObject
*v
)
1090 return ins(self
, (int) Py_SIZE(self
), v
);
1093 PyDoc_STRVAR(append_doc
,
1096 Append new value x to the end of the array.");
1100 array_byteswap(arrayobject
*self
, PyObject
*unused
)
1105 switch (self
->ob_descr
->itemsize
) {
1109 for (p
= self
->ob_item
, i
= Py_SIZE(self
); --i
>= 0; p
+= 2) {
1116 for (p
= self
->ob_item
, i
= Py_SIZE(self
); --i
>= 0; p
+= 4) {
1126 for (p
= self
->ob_item
, i
= Py_SIZE(self
); --i
>= 0; p
+= 8) {
1142 PyErr_SetString(PyExc_RuntimeError
,
1143 "don't know how to byteswap this array type");
1150 PyDoc_STRVAR(byteswap_doc
,
1153 Byteswap all items of the array. If the items in the array are not 1, 2,\n\
1154 4, or 8 bytes in size, RuntimeError is raised.");
1157 array_reduce(arrayobject
*array
)
1159 PyObject
*dict
, *result
;
1161 dict
= PyObject_GetAttrString((PyObject
*)array
, "__dict__");
1167 if (Py_SIZE(array
) > 0) {
1168 if (array
->ob_descr
->itemsize
1169 > PY_SSIZE_T_MAX
/ array
->ob_size
) {
1170 return PyErr_NoMemory();
1172 result
= Py_BuildValue("O(cs#)O",
1174 array
->ob_descr
->typecode
,
1176 Py_SIZE(array
) * array
->ob_descr
->itemsize
,
1179 result
= Py_BuildValue("O(c)O",
1181 array
->ob_descr
->typecode
,
1188 PyDoc_STRVAR(array_doc
, "Return state information for pickling.");
1191 array_reverse(arrayobject
*self
, PyObject
*unused
)
1193 register Py_ssize_t itemsize
= self
->ob_descr
->itemsize
;
1194 register char *p
, *q
;
1195 /* little buffer to hold items while swapping */
1196 char tmp
[256]; /* 8 is probably enough -- but why skimp */
1197 assert((size_t)itemsize
<= sizeof(tmp
));
1199 if (Py_SIZE(self
) > 1) {
1200 for (p
= self
->ob_item
,
1201 q
= self
->ob_item
+ (Py_SIZE(self
) - 1)*itemsize
;
1203 p
+= itemsize
, q
-= itemsize
) {
1204 /* memory areas guaranteed disjoint, so memcpy
1205 * is safe (& memmove may be slower).
1207 memcpy(tmp
, p
, itemsize
);
1208 memcpy(p
, q
, itemsize
);
1209 memcpy(q
, tmp
, itemsize
);
1217 PyDoc_STRVAR(reverse_doc
,
1220 Reverse the order of the items in the array.");
1223 array_fromfile(arrayobject
*self
, PyObject
*args
)
1228 if (!PyArg_ParseTuple(args
, "On:fromfile", &f
, &n
))
1230 fp
= PyFile_AsFile(f
);
1232 PyErr_SetString(PyExc_TypeError
, "arg1 must be open file");
1236 char *item
= self
->ob_item
;
1237 Py_ssize_t itemsize
= self
->ob_descr
->itemsize
;
1239 Py_ssize_t newlength
;
1241 /* Be careful here about overflow */
1242 if ((newlength
= Py_SIZE(self
) + n
) <= 0 ||
1243 (newbytes
= newlength
* itemsize
) / itemsize
!=
1246 PyMem_RESIZE(item
, char, newbytes
);
1252 self
->ob_item
= item
;
1254 self
->allocated
= Py_SIZE(self
);
1255 nread
= fread(item
+ (Py_SIZE(self
) - n
) * itemsize
,
1257 if (nread
< (size_t)n
) {
1258 Py_SIZE(self
) -= (n
- nread
);
1259 PyMem_RESIZE(item
, char, Py_SIZE(self
)*itemsize
);
1260 self
->ob_item
= item
;
1261 self
->allocated
= Py_SIZE(self
);
1262 PyErr_SetString(PyExc_EOFError
,
1263 "not enough items in file");
1271 PyDoc_STRVAR(fromfile_doc
,
1274 Read n objects from the file object f and append them to the end of the\n\
1275 array. Also called as read.");
1279 array_fromfile_as_read(arrayobject
*self
, PyObject
*args
)
1281 if (PyErr_WarnPy3k("array.read() not supported in 3.x; "
1282 "use array.fromfile()", 1) < 0)
1284 return array_fromfile(self
, args
);
1289 array_tofile(arrayobject
*self
, PyObject
*f
)
1293 fp
= PyFile_AsFile(f
);
1295 PyErr_SetString(PyExc_TypeError
, "arg must be open file");
1298 if (self
->ob_size
> 0) {
1299 if (fwrite(self
->ob_item
, self
->ob_descr
->itemsize
,
1300 self
->ob_size
, fp
) != (size_t)self
->ob_size
) {
1301 PyErr_SetFromErrno(PyExc_IOError
);
1310 PyDoc_STRVAR(tofile_doc
,
1313 Write all items (as machine values) to the file object f. Also called as\n\
1318 array_tofile_as_write(arrayobject
*self
, PyObject
*f
)
1320 if (PyErr_WarnPy3k("array.write() not supported in 3.x; "
1321 "use array.tofile()", 1) < 0)
1323 return array_tofile(self
, f
);
1328 array_fromlist(arrayobject
*self
, PyObject
*list
)
1331 Py_ssize_t itemsize
= self
->ob_descr
->itemsize
;
1333 if (!PyList_Check(list
)) {
1334 PyErr_SetString(PyExc_TypeError
, "arg must be list");
1337 n
= PyList_Size(list
);
1339 char *item
= self
->ob_item
;
1341 PyMem_RESIZE(item
, char, (Py_SIZE(self
) + n
) * itemsize
);
1346 self
->ob_item
= item
;
1348 self
->allocated
= Py_SIZE(self
);
1349 for (i
= 0; i
< n
; i
++) {
1350 PyObject
*v
= PyList_GetItem(list
, i
);
1351 if ((*self
->ob_descr
->setitem
)(self
,
1352 Py_SIZE(self
) - n
+ i
, v
) != 0) {
1354 if (itemsize
&& (self
->ob_size
> PY_SSIZE_T_MAX
/ itemsize
)) {
1355 return PyErr_NoMemory();
1357 PyMem_RESIZE(item
, char,
1358 Py_SIZE(self
) * itemsize
);
1359 self
->ob_item
= item
;
1360 self
->allocated
= Py_SIZE(self
);
1369 PyDoc_STRVAR(fromlist_doc
,
1372 Append items to array from list.");
1376 array_tolist(arrayobject
*self
, PyObject
*unused
)
1378 PyObject
*list
= PyList_New(Py_SIZE(self
));
1383 for (i
= 0; i
< Py_SIZE(self
); i
++) {
1384 PyObject
*v
= getarrayitem((PyObject
*)self
, i
);
1389 PyList_SetItem(list
, i
, v
);
1394 PyDoc_STRVAR(tolist_doc
,
1395 "tolist() -> list\n\
1397 Convert array to an ordinary list with the same items.");
1401 array_fromstring(arrayobject
*self
, PyObject
*args
)
1405 int itemsize
= self
->ob_descr
->itemsize
;
1406 if (!PyArg_ParseTuple(args
, "s#:fromstring", &str
, &n
))
1408 if (n
% itemsize
!= 0) {
1409 PyErr_SetString(PyExc_ValueError
,
1410 "string length not a multiple of item size");
1415 char *item
= self
->ob_item
;
1416 if ((n
> PY_SSIZE_T_MAX
- Py_SIZE(self
)) ||
1417 ((Py_SIZE(self
) + n
) > PY_SSIZE_T_MAX
/ itemsize
)) {
1418 return PyErr_NoMemory();
1420 PyMem_RESIZE(item
, char, (Py_SIZE(self
) + n
) * itemsize
);
1425 self
->ob_item
= item
;
1427 self
->allocated
= Py_SIZE(self
);
1428 memcpy(item
+ (Py_SIZE(self
) - n
) * itemsize
,
1435 PyDoc_STRVAR(fromstring_doc
,
1436 "fromstring(string)\n\
1438 Appends items from the string, interpreting it as an array of machine\n\
1439 values,as if it had been read from a file using the fromfile() method).");
1443 array_tostring(arrayobject
*self
, PyObject
*unused
)
1445 if (self
->ob_size
<= PY_SSIZE_T_MAX
/ self
->ob_descr
->itemsize
) {
1446 return PyString_FromStringAndSize(self
->ob_item
,
1447 Py_SIZE(self
) * self
->ob_descr
->itemsize
);
1449 return PyErr_NoMemory();
1453 PyDoc_STRVAR(tostring_doc
,
1454 "tostring() -> string\n\
1456 Convert the array to an array of machine values and return the string\n\
1461 #ifdef Py_USING_UNICODE
1463 array_fromunicode(arrayobject
*self
, PyObject
*args
)
1468 if (!PyArg_ParseTuple(args
, "u#:fromunicode", &ustr
, &n
))
1470 if (self
->ob_descr
->typecode
!= 'u') {
1471 PyErr_SetString(PyExc_ValueError
,
1472 "fromunicode() may only be called on "
1477 Py_UNICODE
*item
= (Py_UNICODE
*) self
->ob_item
;
1478 if (Py_SIZE(self
) > PY_SSIZE_T_MAX
- n
) {
1479 return PyErr_NoMemory();
1481 PyMem_RESIZE(item
, Py_UNICODE
, Py_SIZE(self
) + n
);
1486 self
->ob_item
= (char *) item
;
1488 self
->allocated
= Py_SIZE(self
);
1489 memcpy(item
+ Py_SIZE(self
) - n
,
1490 ustr
, n
* sizeof(Py_UNICODE
));
1497 PyDoc_STRVAR(fromunicode_doc
,
1498 "fromunicode(ustr)\n\
1500 Extends this array with data from the unicode string ustr.\n\
1501 The array must be a type 'u' array; otherwise a ValueError\n\
1502 is raised. Use array.fromstring(ustr.decode(...)) to\n\
1503 append Unicode data to an array of some other type.");
1507 array_tounicode(arrayobject
*self
, PyObject
*unused
)
1509 if (self
->ob_descr
->typecode
!= 'u') {
1510 PyErr_SetString(PyExc_ValueError
,
1511 "tounicode() may only be called on type 'u' arrays");
1514 return PyUnicode_FromUnicode((Py_UNICODE
*) self
->ob_item
, Py_SIZE(self
));
1517 PyDoc_STRVAR(tounicode_doc
,
1518 "tounicode() -> unicode\n\
1520 Convert the array to a unicode string. The array must be\n\
1521 a type 'u' array; otherwise a ValueError is raised. Use\n\
1522 array.tostring().decode() to obtain a unicode string from\n\
1523 an array of some other type.");
1525 #endif /* Py_USING_UNICODE */
1529 array_get_typecode(arrayobject
*a
, void *closure
)
1531 char tc
= a
->ob_descr
->typecode
;
1532 return PyString_FromStringAndSize(&tc
, 1);
1536 array_get_itemsize(arrayobject
*a
, void *closure
)
1538 return PyInt_FromLong((long)a
->ob_descr
->itemsize
);
1541 static PyGetSetDef array_getsets
[] = {
1542 {"typecode", (getter
) array_get_typecode
, NULL
,
1543 "the typecode character used to create the array"},
1544 {"itemsize", (getter
) array_get_itemsize
, NULL
,
1545 "the size, in bytes, of one array item"},
1549 static PyMethodDef array_methods
[] = {
1550 {"append", (PyCFunction
)array_append
, METH_O
,
1552 {"buffer_info", (PyCFunction
)array_buffer_info
, METH_NOARGS
,
1554 {"byteswap", (PyCFunction
)array_byteswap
, METH_NOARGS
,
1556 {"__copy__", (PyCFunction
)array_copy
, METH_NOARGS
,
1558 {"count", (PyCFunction
)array_count
, METH_O
,
1560 {"__deepcopy__",(PyCFunction
)array_copy
, METH_O
,
1562 {"extend", (PyCFunction
)array_extend
, METH_O
,
1564 {"fromfile", (PyCFunction
)array_fromfile
, METH_VARARGS
,
1566 {"fromlist", (PyCFunction
)array_fromlist
, METH_O
,
1568 {"fromstring", (PyCFunction
)array_fromstring
, METH_VARARGS
,
1570 #ifdef Py_USING_UNICODE
1571 {"fromunicode", (PyCFunction
)array_fromunicode
, METH_VARARGS
,
1574 {"index", (PyCFunction
)array_index
, METH_O
,
1576 {"insert", (PyCFunction
)array_insert
, METH_VARARGS
,
1578 {"pop", (PyCFunction
)array_pop
, METH_VARARGS
,
1580 {"read", (PyCFunction
)array_fromfile_as_read
, METH_VARARGS
,
1582 {"__reduce__", (PyCFunction
)array_reduce
, METH_NOARGS
,
1584 {"remove", (PyCFunction
)array_remove
, METH_O
,
1586 {"reverse", (PyCFunction
)array_reverse
, METH_NOARGS
,
1588 /* {"sort", (PyCFunction)array_sort, METH_VARARGS,
1590 {"tofile", (PyCFunction
)array_tofile
, METH_O
,
1592 {"tolist", (PyCFunction
)array_tolist
, METH_NOARGS
,
1594 {"tostring", (PyCFunction
)array_tostring
, METH_NOARGS
,
1596 #ifdef Py_USING_UNICODE
1597 {"tounicode", (PyCFunction
)array_tounicode
, METH_NOARGS
,
1600 {"write", (PyCFunction
)array_tofile_as_write
, METH_O
,
1602 {NULL
, NULL
} /* sentinel */
1606 array_repr(arrayobject
*a
)
1608 char buf
[256], typecode
;
1609 PyObject
*s
, *t
, *v
= NULL
;
1613 typecode
= a
->ob_descr
->typecode
;
1615 PyOS_snprintf(buf
, sizeof(buf
), "array('%c')", typecode
);
1616 return PyString_FromString(buf
);
1619 if (typecode
== 'c')
1620 v
= array_tostring(a
, NULL
);
1621 #ifdef Py_USING_UNICODE
1622 else if (typecode
== 'u')
1623 v
= array_tounicode(a
, NULL
);
1626 v
= array_tolist(a
, NULL
);
1627 t
= PyObject_Repr(v
);
1630 PyOS_snprintf(buf
, sizeof(buf
), "array('%c', ", typecode
);
1631 s
= PyString_FromString(buf
);
1632 PyString_ConcatAndDel(&s
, t
);
1633 PyString_ConcatAndDel(&s
, PyString_FromString(")"));
1638 array_subscr(arrayobject
* self
, PyObject
* item
)
1640 if (PyIndex_Check(item
)) {
1641 Py_ssize_t i
= PyNumber_AsSsize_t(item
, PyExc_IndexError
);
1642 if (i
==-1 && PyErr_Occurred()) {
1647 return array_item(self
, i
);
1649 else if (PySlice_Check(item
)) {
1650 Py_ssize_t start
, stop
, step
, slicelength
, cur
, i
;
1653 int itemsize
= self
->ob_descr
->itemsize
;
1655 if (PySlice_GetIndicesEx((PySliceObject
*)item
, Py_SIZE(self
),
1656 &start
, &stop
, &step
, &slicelength
) < 0) {
1660 if (slicelength
<= 0) {
1661 return newarrayobject(&Arraytype
, 0, self
->ob_descr
);
1663 else if (step
== 1) {
1664 PyObject
*result
= newarrayobject(&Arraytype
,
1665 slicelength
, self
->ob_descr
);
1668 memcpy(((arrayobject
*)result
)->ob_item
,
1669 self
->ob_item
+ start
* itemsize
,
1670 slicelength
* itemsize
);
1674 result
= newarrayobject(&Arraytype
, slicelength
, self
->ob_descr
);
1675 if (!result
) return NULL
;
1677 ar
= (arrayobject
*)result
;
1679 for (cur
= start
, i
= 0; i
< slicelength
;
1681 memcpy(ar
->ob_item
+ i
*itemsize
,
1682 self
->ob_item
+ cur
*itemsize
,
1690 PyErr_SetString(PyExc_TypeError
,
1691 "array indices must be integers");
1697 array_ass_subscr(arrayobject
* self
, PyObject
* item
, PyObject
* value
)
1699 Py_ssize_t start
, stop
, step
, slicelength
, needed
;
1703 if (PyIndex_Check(item
)) {
1704 Py_ssize_t i
= PyNumber_AsSsize_t(item
, PyExc_IndexError
);
1706 if (i
== -1 && PyErr_Occurred())
1710 if (i
< 0 || i
>= Py_SIZE(self
)) {
1711 PyErr_SetString(PyExc_IndexError
,
1712 "array assignment index out of range");
1715 if (value
== NULL
) {
1716 /* Fall through to slice assignment */
1723 return (*self
->ob_descr
->setitem
)(self
, i
, value
);
1725 else if (PySlice_Check(item
)) {
1726 if (PySlice_GetIndicesEx((PySliceObject
*)item
,
1727 Py_SIZE(self
), &start
, &stop
,
1728 &step
, &slicelength
) < 0) {
1733 PyErr_SetString(PyExc_TypeError
,
1734 "array indices must be integer");
1737 if (value
== NULL
) {
1741 else if (array_Check(value
)) {
1742 other
= (arrayobject
*)value
;
1743 needed
= Py_SIZE(other
);
1744 if (self
== other
) {
1745 /* Special case "self[i:j] = self" -- copy self first */
1747 value
= array_slice(other
, 0, needed
);
1750 ret
= array_ass_subscr(self
, item
, value
);
1754 if (other
->ob_descr
!= self
->ob_descr
) {
1755 PyErr_BadArgument();
1760 PyErr_Format(PyExc_TypeError
,
1761 "can only assign array (not \"%.200s\") to array slice",
1762 Py_TYPE(value
)->tp_name
);
1765 itemsize
= self
->ob_descr
->itemsize
;
1766 /* for 'a[2:1] = ...', the insertion point is 'start', not 'stop' */
1767 if ((step
> 0 && stop
< start
) ||
1768 (step
< 0 && stop
> start
))
1771 if (slicelength
> needed
) {
1772 memmove(self
->ob_item
+ (start
+ needed
) * itemsize
,
1773 self
->ob_item
+ stop
* itemsize
,
1774 (Py_SIZE(self
) - stop
) * itemsize
);
1775 if (array_resize(self
, Py_SIZE(self
) +
1776 needed
- slicelength
) < 0)
1779 else if (slicelength
< needed
) {
1780 if (array_resize(self
, Py_SIZE(self
) +
1781 needed
- slicelength
) < 0)
1783 memmove(self
->ob_item
+ (start
+ needed
) * itemsize
,
1784 self
->ob_item
+ stop
* itemsize
,
1785 (Py_SIZE(self
) - start
- needed
) * itemsize
);
1788 memcpy(self
->ob_item
+ start
* itemsize
,
1789 other
->ob_item
, needed
* itemsize
);
1792 else if (needed
== 0) {
1798 start
= stop
+ step
* (slicelength
- 1) - 1;
1801 for (cur
= start
, i
= 0; i
< slicelength
;
1803 Py_ssize_t lim
= step
- 1;
1805 if (cur
+ step
>= Py_SIZE(self
))
1806 lim
= Py_SIZE(self
) - cur
- 1;
1807 memmove(self
->ob_item
+ (cur
- i
) * itemsize
,
1808 self
->ob_item
+ (cur
+ 1) * itemsize
,
1811 cur
= start
+ slicelength
* step
;
1812 if (cur
< Py_SIZE(self
)) {
1813 memmove(self
->ob_item
+ (cur
-slicelength
) * itemsize
,
1814 self
->ob_item
+ cur
* itemsize
,
1815 (Py_SIZE(self
) - cur
) * itemsize
);
1817 if (array_resize(self
, Py_SIZE(self
) - slicelength
) < 0)
1824 if (needed
!= slicelength
) {
1825 PyErr_Format(PyExc_ValueError
,
1826 "attempt to assign array of size %zd "
1827 "to extended slice of size %zd",
1828 needed
, slicelength
);
1831 for (cur
= start
, i
= 0; i
< slicelength
;
1833 memcpy(self
->ob_item
+ cur
* itemsize
,
1834 other
->ob_item
+ i
* itemsize
,
1841 static PyMappingMethods array_as_mapping
= {
1842 (lenfunc
)array_length
,
1843 (binaryfunc
)array_subscr
,
1844 (objobjargproc
)array_ass_subscr
1847 static const void *emptybuf
= "";
1850 array_buffer_getreadbuf(arrayobject
*self
, Py_ssize_t index
, const void **ptr
)
1853 PyErr_SetString(PyExc_SystemError
,
1854 "Accessing non-existent array segment");
1857 *ptr
= (void *)self
->ob_item
;
1860 return Py_SIZE(self
)*self
->ob_descr
->itemsize
;
1864 array_buffer_getwritebuf(arrayobject
*self
, Py_ssize_t index
, const void **ptr
)
1867 PyErr_SetString(PyExc_SystemError
,
1868 "Accessing non-existent array segment");
1871 *ptr
= (void *)self
->ob_item
;
1874 return Py_SIZE(self
)*self
->ob_descr
->itemsize
;
1878 array_buffer_getsegcount(arrayobject
*self
, Py_ssize_t
*lenp
)
1881 *lenp
= Py_SIZE(self
)*self
->ob_descr
->itemsize
;
1885 static PySequenceMethods array_as_sequence
= {
1886 (lenfunc
)array_length
, /*sq_length*/
1887 (binaryfunc
)array_concat
, /*sq_concat*/
1888 (ssizeargfunc
)array_repeat
, /*sq_repeat*/
1889 (ssizeargfunc
)array_item
, /*sq_item*/
1890 (ssizessizeargfunc
)array_slice
, /*sq_slice*/
1891 (ssizeobjargproc
)array_ass_item
, /*sq_ass_item*/
1892 (ssizessizeobjargproc
)array_ass_slice
, /*sq_ass_slice*/
1893 (objobjproc
)array_contains
, /*sq_contains*/
1894 (binaryfunc
)array_inplace_concat
, /*sq_inplace_concat*/
1895 (ssizeargfunc
)array_inplace_repeat
/*sq_inplace_repeat*/
1898 static PyBufferProcs array_as_buffer
= {
1899 (readbufferproc
)array_buffer_getreadbuf
,
1900 (writebufferproc
)array_buffer_getwritebuf
,
1901 (segcountproc
)array_buffer_getsegcount
,
1906 array_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwds
)
1909 PyObject
*initial
= NULL
, *it
= NULL
;
1910 struct arraydescr
*descr
;
1912 if (type
== &Arraytype
&& !_PyArg_NoKeywords("array.array()", kwds
))
1915 if (!PyArg_ParseTuple(args
, "c|O:array", &c
, &initial
))
1918 if (!(initial
== NULL
|| PyList_Check(initial
)
1919 || PyString_Check(initial
) || PyTuple_Check(initial
)
1920 || (c
== 'u' && PyUnicode_Check(initial
)))) {
1921 it
= PyObject_GetIter(initial
);
1924 /* We set initial to NULL so that the subsequent code
1925 will create an empty array of the appropriate type
1926 and afterwards we can use array_iter_extend to populate
1931 for (descr
= descriptors
; descr
->typecode
!= '\0'; descr
++) {
1932 if (descr
->typecode
== c
) {
1936 if (initial
== NULL
|| !(PyList_Check(initial
)
1937 || PyTuple_Check(initial
)))
1940 len
= PySequence_Size(initial
);
1942 a
= newarrayobject(type
, len
, descr
);
1948 for (i
= 0; i
< len
; i
++) {
1950 PySequence_GetItem(initial
, i
);
1955 if (setarrayitem(a
, i
, v
) != 0) {
1962 } else if (initial
!= NULL
&& PyString_Check(initial
)) {
1963 PyObject
*t_initial
, *v
;
1964 t_initial
= PyTuple_Pack(1, initial
);
1965 if (t_initial
== NULL
) {
1969 v
= array_fromstring((arrayobject
*)a
,
1971 Py_DECREF(t_initial
);
1977 #ifdef Py_USING_UNICODE
1978 } else if (initial
!= NULL
&& PyUnicode_Check(initial
)) {
1979 Py_ssize_t n
= PyUnicode_GET_DATA_SIZE(initial
);
1981 arrayobject
*self
= (arrayobject
*)a
;
1982 char *item
= self
->ob_item
;
1983 item
= (char *)PyMem_Realloc(item
, n
);
1989 self
->ob_item
= item
;
1990 Py_SIZE(self
) = n
/ sizeof(Py_UNICODE
);
1991 memcpy(item
, PyUnicode_AS_DATA(initial
), n
);
1992 self
->allocated
= Py_SIZE(self
);
1997 if (array_iter_extend((arrayobject
*)a
, it
) == -1) {
2007 PyErr_SetString(PyExc_ValueError
,
2008 "bad typecode (must be c, b, B, u, h, H, i, I, l, L, f or d)");
2013 PyDoc_STRVAR(module_doc
,
2014 "This module defines an object type which can efficiently represent\n\
2015 an array of basic values: characters, integers, floating point\n\
2016 numbers. Arrays are sequence types and behave very much like lists,\n\
2017 except that the type of objects stored in them is constrained. The\n\
2018 type is specified at object creation time by using a type code, which\n\
2019 is a single character. The following type codes are defined:\n\
2021 Type code C Type Minimum size in bytes \n\
2023 'b' signed integer 1 \n\
2024 'B' unsigned integer 1 \n\
2025 'u' Unicode character 2 \n\
2026 'h' signed integer 2 \n\
2027 'H' unsigned integer 2 \n\
2028 'i' signed integer 2 \n\
2029 'I' unsigned integer 2 \n\
2030 'l' signed integer 4 \n\
2031 'L' unsigned integer 4 \n\
2032 'f' floating point 4 \n\
2033 'd' floating point 8 \n\
2035 The constructor is:\n\
2037 array(typecode [, initializer]) -- create a new array\n\
2040 PyDoc_STRVAR(arraytype_doc
,
2041 "array(typecode [, initializer]) -> array\n\
2043 Return a new array whose items are restricted by typecode, and\n\
2044 initialized from the optional initializer value, which must be a list,\n\
2045 string. or iterable over elements of the appropriate type.\n\
2047 Arrays represent basic values and behave very much like lists, except\n\
2048 the type of objects stored in them is constrained.\n\
2052 append() -- append a new item to the end of the array\n\
2053 buffer_info() -- return information giving the current memory info\n\
2054 byteswap() -- byteswap all the items of the array\n\
2055 count() -- return number of occurences of an object\n\
2056 extend() -- extend array by appending multiple elements from an iterable\n\
2057 fromfile() -- read items from a file object\n\
2058 fromlist() -- append items from the list\n\
2059 fromstring() -- append items from the string\n\
2060 index() -- return index of first occurence of an object\n\
2061 insert() -- insert a new item into the array at a provided position\n\
2062 pop() -- remove and return item (default last)\n\
2063 read() -- DEPRECATED, use fromfile()\n\
2064 remove() -- remove first occurence of an object\n\
2065 reverse() -- reverse the order of the items in the array\n\
2066 tofile() -- write all items to a file object\n\
2067 tolist() -- return the array converted to an ordinary list\n\
2068 tostring() -- return the array converted to a string\n\
2069 write() -- DEPRECATED, use tofile()\n\
2073 typecode -- the typecode character used to create the array\n\
2074 itemsize -- the length in bytes of one array item\n\
2077 static PyObject
*array_iter(arrayobject
*ao
);
2079 static PyTypeObject Arraytype
= {
2080 PyVarObject_HEAD_INIT(NULL
, 0)
2082 sizeof(arrayobject
),
2084 (destructor
)array_dealloc
, /* tp_dealloc */
2089 (reprfunc
)array_repr
, /* tp_repr */
2090 0, /* tp_as_number*/
2091 &array_as_sequence
, /* tp_as_sequence*/
2092 &array_as_mapping
, /* tp_as_mapping*/
2096 PyObject_GenericGetAttr
, /* tp_getattro */
2097 0, /* tp_setattro */
2098 &array_as_buffer
, /* tp_as_buffer*/
2099 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
| Py_TPFLAGS_HAVE_WEAKREFS
, /* tp_flags */
2100 arraytype_doc
, /* tp_doc */
2101 0, /* tp_traverse */
2103 array_richcompare
, /* tp_richcompare */
2104 offsetof(arrayobject
, weakreflist
), /* tp_weaklistoffset */
2105 (getiterfunc
)array_iter
, /* tp_iter */
2106 0, /* tp_iternext */
2107 array_methods
, /* tp_methods */
2109 array_getsets
, /* tp_getset */
2112 0, /* tp_descr_get */
2113 0, /* tp_descr_set */
2114 0, /* tp_dictoffset */
2116 PyType_GenericAlloc
, /* tp_alloc */
2117 array_new
, /* tp_new */
2118 PyObject_Del
, /* tp_free */
2122 /*********************** Array Iterator **************************/
2128 PyObject
* (*getitem
)(struct arrayobject
*, Py_ssize_t
);
2131 static PyTypeObject PyArrayIter_Type
;
2133 #define PyArrayIter_Check(op) PyObject_TypeCheck(op, &PyArrayIter_Type)
2136 array_iter(arrayobject
*ao
)
2138 arrayiterobject
*it
;
2140 if (!array_Check(ao
)) {
2141 PyErr_BadInternalCall();
2145 it
= PyObject_GC_New(arrayiterobject
, &PyArrayIter_Type
);
2152 it
->getitem
= ao
->ob_descr
->getitem
;
2153 PyObject_GC_Track(it
);
2154 return (PyObject
*)it
;
2158 arrayiter_next(arrayiterobject
*it
)
2160 assert(PyArrayIter_Check(it
));
2161 if (it
->index
< Py_SIZE(it
->ao
))
2162 return (*it
->getitem
)(it
->ao
, it
->index
++);
2167 arrayiter_dealloc(arrayiterobject
*it
)
2169 PyObject_GC_UnTrack(it
);
2171 PyObject_GC_Del(it
);
2175 arrayiter_traverse(arrayiterobject
*it
, visitproc visit
, void *arg
)
2181 static PyTypeObject PyArrayIter_Type
= {
2182 PyVarObject_HEAD_INIT(NULL
, 0)
2183 "arrayiterator", /* tp_name */
2184 sizeof(arrayiterobject
), /* tp_basicsize */
2185 0, /* tp_itemsize */
2187 (destructor
)arrayiter_dealloc
, /* tp_dealloc */
2193 0, /* tp_as_number */
2194 0, /* tp_as_sequence */
2195 0, /* tp_as_mapping */
2199 PyObject_GenericGetAttr
, /* tp_getattro */
2200 0, /* tp_setattro */
2201 0, /* tp_as_buffer */
2202 Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_HAVE_GC
,/* tp_flags */
2204 (traverseproc
)arrayiter_traverse
, /* tp_traverse */
2206 0, /* tp_richcompare */
2207 0, /* tp_weaklistoffset */
2208 PyObject_SelfIter
, /* tp_iter */
2209 (iternextfunc
)arrayiter_next
, /* tp_iternext */
2214 /*********************** Install Module **************************/
2216 /* No functions in array module. */
2217 static PyMethodDef a_methods
[] = {
2218 {NULL
, NULL
, 0, NULL
} /* Sentinel */
2227 Arraytype
.ob_type
= &PyType_Type
;
2228 PyArrayIter_Type
.ob_type
= &PyType_Type
;
2229 m
= Py_InitModule3("array", a_methods
, module_doc
);
2233 Py_INCREF((PyObject
*)&Arraytype
);
2234 PyModule_AddObject(m
, "ArrayType", (PyObject
*)&Arraytype
);
2235 Py_INCREF((PyObject
*)&Arraytype
);
2236 PyModule_AddObject(m
, "array", (PyObject
*)&Arraytype
);
2237 /* No need to check the error here, the caller will do that */