array — Efficient arrays of numeric values¶

This module defines an object type which can compactly represent an array ofbasic values: characters, integers, floating point numbers. Arrays are sequencetypes and behave very much like lists, except that the type of objects stored inthem is constrained. The type is specified at object creation time by using atype code, which is a single character. The following type codes aredefined:

Notes:

1. The'u' type code corresponds to Python’s obsolete unicode character(Py_UNICODE which iswchar_t). Depending on theplatform, it can be 16 bits or 32 bits.

   'u' will be removed together with the rest of thePy_UNICODEAPI.

   Deprecated since version 3.3, will be removed in version 4.0.

The actual representation of values is determined by the machine architecture(strictly speaking, by the C implementation). The actual size can be accessedthrough theitemsize attribute.

The module defines the following type:

classarray.array(typecode[,initializer])¶

A new array whose items are restricted bytypecode, and initializedfrom the optionalinitializer value, which must be a list, abytes-like object, or iterable over elements of theappropriate type.

If given a list or string, the initializer is passed to the new array’sfromlist(),frombytes(), orfromunicode() method (see below)to add initial items to the array. Otherwise, the iterable initializer ispassed to theextend() method.

Raises anauditing eventarray.__new__ with argumentstypecode,initializer.

array.typecodes¶

A string with all available type codes.

Array objects support the ordinary sequence operations of indexing, slicing,concatenation, and multiplication. When using slice assignment, the assignedvalue must be an array object with the same type code; in all other cases,TypeError is raised. Array objects also implement the buffer interface,and may be used whereverbytes-like objects are supported.

The following data items and methods are also supported:

array.typecode¶

The typecode character used to create the array.

array.itemsize¶

The length in bytes of one array item in the internal representation.

array.append(x)¶

Append a new item with valuex to the end of the array.

array.buffer_info()¶

Return a tuple(address,length) giving the current memory address and thelength in elements of the buffer used to hold array’s contents. The size of thememory buffer in bytes can be computed asarray.buffer_info()[1]*array.itemsize. This is occasionally useful when working with low-level (andinherently unsafe) I/O interfaces that require memory addresses, such as certainioctl() operations. The returned numbers are valid as long as the arrayexists and no length-changing operations are applied to it.

Note

When using array objects from code written in C or C++ (the only way toeffectively make use of this information), it makes more sense to use the bufferinterface supported by array objects. This method is maintained for backwardcompatibility and should be avoided in new code. The buffer interface isdocumented inBuffer Protocol.

array.byteswap()¶

“Byteswap” all items of the array. This is only supported for values which are1, 2, 4, or 8 bytes in size; for other types of values,RuntimeError israised. It is useful when reading data from a file written on a machine with adifferent byte order.

array.count(x)¶

Return the number of occurrences ofx in the array.

array.extend(iterable)¶

Append items fromiterable to the end of the array. Ifiterable is anotherarray, it must haveexactly the same type code; if not,TypeError willbe raised. Ifiterable is not an array, it must be iterable and its elementsmust be the right type to be appended to the array.

array.frombytes(s)¶

Appends items from the string, interpreting the string as an array of machinevalues (as if it had been read from a file using thefromfile() method).

New in version 3.2:fromstring() is renamed tofrombytes() for clarity.

array.fromfile(f,n)¶

Readn items (as machine values) from thefile objectf and appendthem to the end of the array. If less thann items are available,EOFError is raised, but the items that were available are stillinserted into the array.

array.fromlist(list)¶

Append items from the list. This is equivalent toforxinlist:a.append(x) except that if there is a type error, the array is unchanged.

array.fromstring()¶

Deprecated alias forfrombytes().

Deprecated since version 3.2, will be removed in version 3.9.

array.fromunicode(s)¶

Extends this array with data from the given unicode string. The array mustbe a type'u' array; otherwise aValueError is raised. Usearray.frombytes(unicodestring.encode(enc)) to append Unicode data to anarray of some other type.

array.index(x)¶

Return the smallesti such thati is the index of the first occurrence ofx in the array.

array.insert(i,x)¶

Insert a new item with valuex in the array before positioni. Negativevalues are treated as being relative to the end of the array.

array.pop([i])¶

Removes the item with the indexi from the array and returns it. The optionalargument defaults to-1, so that by default the last item is removed andreturned.

array.remove(x)¶

Remove the first occurrence ofx from the array.

array.reverse()¶

Reverse the order of the items in the array.

array.tobytes()¶

Convert the array to an array of machine values and return the bytesrepresentation (the same sequence of bytes that would be written to a file bythetofile() method.)

New in version 3.2:tostring() is renamed totobytes() for clarity.

array.tofile(f)¶

Write all items (as machine values) to thefile objectf.

array.tolist()¶

Convert the array to an ordinary list with the same items.

array.tostring()¶

Deprecated alias fortobytes().

Deprecated since version 3.2, will be removed in version 3.9.

array.tounicode()¶

Convert the array to a unicode string. The array must be a type'u' array;otherwise aValueError is raised. Usearray.tobytes().decode(enc) toobtain a unicode string from an array of some other type.

When an array object is printed or converted to a string, it is represented asarray(typecode,initializer). Theinitializer is omitted if the array isempty, otherwise it is a string if thetypecode is'u', otherwise it is alist of numbers. The string is guaranteed to be able to be converted back to anarray with the same type and value usingeval(), so long as thearray class has been imported usingfromarrayimportarray.Examples:

array('l')array('u','hello\u2641')array('l',[1,2,3,4,5])array('d',[1.0,2.0,3.14])