libarray.tex 5.53 KB
Newer Older
1
\section{Built-in Module \sectcode{array}}
Guido van Rossum's avatar
Guido van Rossum committed
2
\label{module-array}
3 4 5 6 7 8 9 10 11 12
\bimodindex{array}
\index{arrays}

This module defines a new object type which can efficiently represent
an array of basic values: characters, integers, floating point
numbers.  Arrays are sequence types and behave very much like lists,
except that the type of objects stored in them is constrained.  The
type is specified at object creation time by using a \dfn{type code},
which is a single character.  The following type codes are defined:

Fred Drake's avatar
Fred Drake committed
13
\begin{tableiii}{|c|c|c|}{code}{Type code}{Type}{Minimum size in bytes}
14 15
\lineiii{'c'}{character}{1}
\lineiii{'b'}{signed integer}{1}
16
\lineiii{'B'}{unsigned integer}{1}
17
\lineiii{'h'}{signed integer}{2}
18
\lineiii{'H'}{unsigned integer}{2}
19
\lineiii{'i'}{signed integer}{2}
20
\lineiii{'I'}{unsigned integer}{2}
21
\lineiii{'l'}{signed integer}{4}
22
\lineiii{'L'}{unsigned integer}{4}
23 24 25 26 27
\lineiii{'f'}{floating point}{4}
\lineiii{'d'}{floating point}{8}
\end{tableiii}

The actual representation of values is determined by the machine
Fred Drake's avatar
Fred Drake committed
28
architecture (strictly speaking, by the \C{} implementation).  The actual
29 30 31
size can be accessed through the \var{itemsize} attribute.  The values
stored  for \code{'L'} and \code{'I'} items will be represented as
Python long integers when retrieved, because Python's plain integer
Fred Drake's avatar
Fred Drake committed
32
type can't represent the full range of \C{}'s unsigned (long) integers.
33

Fred Drake's avatar
Fred Drake committed
34
See also built-in module \module{struct}\refbimodindex{struct}.
35

36 37
The module defines the following function:

38
\begin{funcdesc}{array}{typecode\optional{\, initializer}}
39 40 41
Return a new array whose items are restricted by \var{typecode}, and
initialized from the optional \var{initializer} value, which must be a
list or a string.  The list or string is passed to the new array's
Fred Drake's avatar
Fred Drake committed
42
\method{fromlist()} or \method{fromstring()} method (see below) to add
43 44 45 46 47
initial items to the array.
\end{funcdesc}

Array objects support the following data items and methods:

Fred Drake's avatar
Fred Drake committed
48 49
\setindexsubitem{(array attribute)}

50 51 52 53 54 55 56 57
\begin{datadesc}{typecode}
The typecode character used to create the array.
\end{datadesc}

\begin{datadesc}{itemsize}
The length in bytes of one array item in the internal representation.
\end{datadesc}

Fred Drake's avatar
Fred Drake committed
58 59
\setindexsubitem{(array method)}

60 61 62 63
\begin{funcdesc}{append}{x}
Append a new item with value \var{x} to the end of the array.
\end{funcdesc}

64
\begin{funcdesc}{buffer_info}{}
65
Return a tuple \code{(\var{address}, \var{length})} giving the current
66 67 68
memory address and the length in bytes of the buffer used to hold
array's contents.  This is occasionally useful when working with
low-level (and inherently unsafe) I/O interfaces that require memory
Fred Drake's avatar
Fred Drake committed
69
addresses, such as certain \cfunction{ioctl()} operations.  The returned
70 71 72 73
numbers are valid as long as the array exists and no length-changing
operations are applied to it.
\end{funcdesc}

74 75
\begin{funcdesc}{byteswap}{x}
``Byteswap'' all items of the array.  This is only supported for
76
integer values.  It is useful when reading data from a file written
77 78 79 80 81 82
on a machine with a different byte order.
\end{funcdesc}

\begin{funcdesc}{fromfile}{f\, n}
Read \var{n} items (as machine values) from the file object \var{f}
and append them to the end of the array.  If less than \var{n} items
Fred Drake's avatar
Fred Drake committed
83
are available, \exception{EOFError} is raised, but the items that were
84 85 86
available are still inserted into the array.  \var{f} must be a real
built-in file object; something else with a \code{read()} method won't
do.
87 88 89
\end{funcdesc}

\begin{funcdesc}{fromlist}{list}
90
Append items from the list.  This is equivalent to
Fred Drake's avatar
Fred Drake committed
91
\samp{for x in \var{list}:\ a.append(x)}
92 93 94 95 96 97
except that if there is a type error, the array is unchanged.
\end{funcdesc}

\begin{funcdesc}{fromstring}{s}
Appends items from the string, interpreting the string as an
array of machine values (i.e. as if it had been read from a
Fred Drake's avatar
Fred Drake committed
98
file using the \method{fromfile()} method).
99 100 101 102 103 104 105
\end{funcdesc}

\begin{funcdesc}{insert}{i\, x}
Insert a new item with value \var{x} in the array before position
\var{i}.
\end{funcdesc}

Fred Drake's avatar
Fred Drake committed
106
\begin{funcdesc}{read}{f\, n}
107 108
\deprecated {1.5.1}
  {Use the \method{fromfile()} method.}
Fred Drake's avatar
Fred Drake committed
109 110 111 112 113 114 115 116 117 118 119 120
Read \var{n} items (as machine values) from the file object \var{f}
and append them to the end of the array.  If less than \var{n} items
are available, \exception{EOFError} is raised, but the items that were
available are still inserted into the array.  \var{f} must be a real
built-in file object; something else with a \method{read()} method won't
do.
\end{funcdesc}

\begin{funcdesc}{reverse}{}
Reverse the order of the items in the array.
\end{funcdesc}

121 122 123 124 125 126 127 128 129 130 131
\begin{funcdesc}{tofile}{f}
Write all items (as machine values) to the file object \var{f}.
\end{funcdesc}

\begin{funcdesc}{tolist}{}
Convert the array to an ordinary list with the same items.
\end{funcdesc}

\begin{funcdesc}{tostring}{}
Convert the array to an array of machine values and return the
string representation (the same sequence of bytes that would
Fred Drake's avatar
Fred Drake committed
132 133 134 135
be written to a file by the \method{tofile()} method.)
\end{funcdesc}

\begin{funcdesc}{write}{f}
136 137
\deprecated {1.5.1}
  {Use the \method{tofile()} method.}
Fred Drake's avatar
Fred Drake committed
138
Write all items (as machine values) to the file object \var{f}.
139 140 141 142 143 144 145 146 147 148
\end{funcdesc}

When an array object is printed or converted to a string, it is
represented as \code{array(\var{typecode}, \var{initializer})}.  The
\var{initializer} is omitted if the array is empty, otherwise it is a
string if the \var{typecode} is \code{'c'}, otherwise it is a list of
numbers.  The string is guaranteed to be able to be converted back to
an array with the same type and value using reverse quotes
(\code{``}).  Examples:

149
\begin{verbatim}
150 151 152 153
array('l')
array('c', 'hello world')
array('l', [1, 2, 3, 4, 5])
array('d', [1.0, 2.0, 3.14])
154
\end{verbatim}