| Current File : //proc/self/root/proc/self/root/lib64/python2.7/site-packages/numpy/lib/format.pyc |
�
E�`Qc @ s� d Z d d l Z d d l Z d d l Z d d l m Z d d l m Z m Z e d � Z e
e � d Z d � Z d � Z
d � Z d
� Z d � Z d � Z d d � Z d � Z d d d e d d � Z d S( s`
Define a simple format for saving numpy arrays to disk with the full
information about them.
The ``.npy`` format is the standard binary file format in NumPy for
persisting a *single* arbitrary NumPy array on disk. The format stores all
of the shape and dtype information necessary to reconstruct the array
correctly even on another machine with a different architecture.
The format is designed to be as simple as possible while achieving
its limited goals.
The ``.npz`` format is the standard format for persisting *multiple* NumPy
arrays on disk. A ``.npz`` file is a zip file containing multiple ``.npy``
files, one for each array.
Capabilities
------------
- Can represent all NumPy arrays including nested record arrays and
object arrays.
- Represents the data in its native binary form.
- Supports Fortran-contiguous arrays directly.
- Stores all of the necessary information to reconstruct the array
including shape and dtype on a machine of a different
architecture. Both little-endian and big-endian arrays are
supported, and a file with little-endian numbers will yield
a little-endian array on any machine reading the file. The
types are described in terms of their actual sizes. For example,
if a machine with a 64-bit C "long int" writes out an array with
"long ints", a reading machine with 32-bit C "long ints" will yield
an array with 64-bit integers.
- Is straightforward to reverse engineer. Datasets often live longer than
the programs that created them. A competent developer should be
able create a solution in his preferred programming language to
read most ``.npy`` files that he has been given without much
documentation.
- Allows memory-mapping of the data. See `open_memmep`.
- Can be read from a filelike stream object instead of an actual file.
- Stores object arrays, i.e. arrays containing elements that are arbitrary
Python objects. Files with object arrays are not to be mmapable, but
can be read and written to disk.
Limitations
-----------
- Arbitrary subclasses of numpy.ndarray are not completely preserved.
Subclasses will be accepted for writing, but only the array data will
be written out. A regular numpy.ndarray object will be created
upon reading the file.
.. warning::
Due to limitations in the interpretation of structured dtypes, dtypes
with fields with empty names will have the names replaced by 'f0', 'f1',
etc. Such arrays will not round-trip through the format entirely
accurately. The data is intact; only the field names will differ. We are
working on a fix for this. This fix will not require a change in the
file format. The arrays with such structures can still be saved and
restored, and the correct dtype may be restored by using the
``loadedarray.view(correct_dtype)`` method.
File extensions
---------------
We recommend using the ``.npy`` and ``.npz`` extensions for files saved
in this format. This is by no means a requirement; applications may wish
to use these file formats but use an extension specific to the
application. In the absence of an obvious alternative, however,
we suggest using ``.npy`` and ``.npz``.
Version numbering
-----------------
The version numbering of these formats is independent of NumPy version
numbering. If the format is upgraded, the code in `numpy.io` will still
be able to read and write Version 1.0 files.
Format Version 1.0
------------------
The first 6 bytes are a magic string: exactly ``\x93NUMPY``.
The next 1 byte is an unsigned byte: the major version number of the file
format, e.g. ``\x01``.
The next 1 byte is an unsigned byte: the minor version number of the file
format, e.g. ``\x00``. Note: the version of the file format is not tied
to the version of the numpy package.
The next 2 bytes form a little-endian unsigned short int: the length of
the header data HEADER_LEN.
The next HEADER_LEN bytes form the header data describing the array's
format. It is an ASCII string which contains a Python literal expression
of a dictionary. It is terminated by a newline (``\n``) and padded with
spaces (``\x20``) to make the total length of
``magic string + 4 + HEADER_LEN`` be evenly divisible by 16 for alignment
purposes.
The dictionary contains three keys:
"descr" : dtype.descr
An object that can be passed as an argument to the `numpy.dtype`
constructor to create the array's dtype.
"fortran_order" : bool
Whether the array data is Fortran-contiguous or not. Since
Fortran-contiguous arrays are a common form of non-C-contiguity,
we allow them to be written directly to disk for efficiency.
"shape" : tuple of int
The shape of the array.
For repeatability and readability, the dictionary keys are sorted in
alphabetic order. This is for convenience only. A writer SHOULD implement
this if possible. A reader MUST NOT depend on this.
Following the header comes the array data. If the dtype contains Python
objects (i.e. ``dtype.hasobject is True``), then the data is a Python
pickle of the array. Otherwise the data is the contiguous (either C-
or Fortran-, depending on ``fortran_order``) bytes of the array.
Consumers can figure out the number of bytes by multiplying the number
of elements given by the shape (noting that ``shape=()`` means there is
1 element) by ``dtype.itemsize``.
Notes
-----
The ``.npy`` format, including reasons for creating it and a comparison of
alternatives, is described fully in the "npy-format" NEP.
i����N( t safe_eval( t asbytest isfileobjs �NUMPYi c C s� | d k s | d k r' t d � � n | d k s? | d k rN t d � � n t j d d k ry t t | � t | � St t | | g � Sd S( s
Return the magic string for the given file format version.
Parameters
----------
major : int in [0, 255]
minor : int in [0, 255]
Returns
-------
magic : str
Raises
------
ValueError if the version cannot be formatted.
i i� s& major version must be 0 <= major < 256s& minor version must be 0 <= minor < 256i N( t
ValueErrort syst version_infot MAGIC_PREFIXt chrt bytes( t majort minor( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt magic� s c C s� | j t � } t | � t k r@ d } t | t | f � � n | d t k rs d } t | t | d f � � n t j d d k r� t t | d � \ } } n | d \ } } | | f S( s� Read the magic string to get the version of the file format.
Parameters
----------
fp : filelike object
Returns
-------
major : int
minor : int
s9 could not read %d characters for the magic string; got %ri����s4 the magic string is not correct; expected %r, got %ri i ( t readt MAGIC_LENt lenR R R R t mapt ord( t fpt magic_strt msgR R
( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt
read_magic� s c C s! | j d k r | j S| j Sd S( s�
Get a serializable descriptor from the dtype.
The .descr attribute of a dtype object cannot be round-tripped through
the dtype() constructor. Simple types, like dtype('float32'), have
a descr which looks like a record array with one field with '' as
a name. The dtype() constructor interprets this as a request to give
a default name. Instead, we construct descriptor that can be passed to
dtype().
Parameters
----------
dtype : dtype
The dtype of the array that will be written to disk.
Returns
-------
descr : object
An object that can be passed to `numpy.dtype()` in order to
replicate the input dtype.
N( t namest Nonet descrt str( t dtype( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt dtype_to_descr� s c C sf i } | j | d <| j j r, t | d <n# | j j rE t | d <n
t | d <t | j � | d <| S( s Get the dictionary of header metadata from a numpy.ndarray.
Parameters
----------
array : numpy.ndarray
Returns
-------
d : dict
This has the appropriate entries for writing its string representation
to the header of the file.
t shapet
fortran_orderR ( R t flagst c_contiguoust Falset f_contiguoust TrueR R ( t arrayt d( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt header_data_from_array_1_0� s
c C s
d d l } d g } x= t | j � � D]) \ } } | j d | t | � f � q( W| j d � d j | � } t d t | � d } d | d } t | d
| d � } t | � d k r� t d
d � � n | j
d t | � � } | j | � | j | � d S( s� Write the header for an array using the 1.0 format.
Parameters
----------
fp : filelike object
d : dict
This has the appropriate entries for writing its string representation
to the header of the file.
i����Nt {s
'%s': %s, t }t i i i t s
i s# header does not fit inside %s bytess <Hi i ( t structt sortedt itemst appendt reprt joinR
R R R t packt write( R R# R) t headert keyt valuet current_header_lent topadt header_len_str( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt write_array_header_1_0 s
!
c C sI d d l } | j d � } t | � d k rL d } t | | j � � � n | j d | � d } | j | � } t | � | k r� t d | j � � � n y t | � } Wn/ t k
r� } d } t | | | f � � n Xt | t � sd } t | | � � n | j
� } | j � | d
d d g k rMd
} t | | f � � n t | d t � s�t
j g | d D] } t | t t f � ^ qr� r�d } t | | d f � � n t | d t � s�d } t | | d f � � n y t
j | d
� }
Wn0 t k
r3} d } t | | d
f � � n X| d | d |
f S( s�
Read an array header from a filelike object using the 1.0 file format
version.
This will leave the file object located just after the header.
Parameters
----------
fp : filelike object
A file object or something with a `.read()` method like a file.
Returns
-------
shape : tuple of int
The shape of the array.
fortran_order : bool
The array data will be written out directly if it is either C-contiguous
or Fortran-contiguous. Otherwise, it will be made contiguous before
writing it out.
dtype : dtype
The dtype of the file's data.
Raises
------
ValueError :
If the data is invalid.
i����Ni s, EOF at %s before reading array header lengths <Hi s% EOF at %s before reading array headers% Cannot parse header: %r
Exception: %rs Header is not a dictionary: %rR R R s, Header does not contain the correct keys: %rs shape is not valid: %rs% fortran_order is not a valid bool: %rs) descr is not a valid dtype descriptor: %r( R) R R R t tellt unpackR t SyntaxErrort
isinstancet dictt keyst sortt tuplet numpyt allt intt longt boolR t TypeError( R R) t hlength_strR t
header_lengthR1 R# t eR= t xR ( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt read_array_header_1_0 sF
6i i c C s� | d k r( d } t | | f � � n | j t | � � t | t | � � | j j rs t j | | d d �n� | j j
r� | j j r� t | � r� | j
j | � q� | j | j
j d � � n2 t | � r� | j | � n | j | j d � � d S( s*
Write an array to an NPY file, including a header.
If the array is neither C-contiguous nor Fortran-contiguous AND the
file_like object is not a real file object, this function will have to
copy data in memory.
Parameters
----------
fp : file_like object
An open, writable file object, or similar object with a ``.write()``
method.
array : ndarray
The array to write to disk.
version : (int, int), optional
The version number of the format. Default: (1, 0)
Raises
------
ValueError
If the array cannot be persisted.
Various other errors
If the array contains Python objects as part of its dtype, the
process of pickling them may raise various errors if the objects
are not picklable.
i i s, we only support format version (1,0), not %st protocoli t CN( i i ( R R0 R R7 R$ R t hasobjectt cPicklet dumpR R R R t Tt tofilet tostring( R R" t versionR ( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt write_arraym s c C s* t | � } | d k r4 d } t | | f � � n t | � \ } } } t | � d k rd d } n t j j | � } | j r� t j | � } n� t
| � r� t j | d | d | �} n7 | j t
| | j � � } t j | d | d | �} | r | d d d � | _ | j � } n | | _ | S( s\
Read an array from an NPY file.
Parameters
----------
fp : file_like object
If this is not a real file object, then this may take extra memory
and time.
Returns
-------
array : ndarray
The array from the data on disk.
Raises
------
ValueError
If the data is invalid.
i i s1 only support version (1,0) of file format, not %rR t countNi����( i i ( R R RJ R R@ t multiplyt reduceRM RN t loadR t fromfileR RB t itemsizet
fromstringR t transpose( R RS R R R R RU R" t data( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt
read_array� s& s r+c C s� t | t � s t d � � n d | k r� | d k rR d } t | | f � � n t j | � } | j r d } t | � � n t d t | � d | d | � } t | | d
� } z0 | j t
| � � t | | � | j � } Wd | j
� Xn� t | d � } zw t | � } | d k r:d } t | | f � � n t | � \ } } } | j rmd } t | � � n | j � } Wd | j
� X| r�d
}
n d }
| d k r�d } n t j | d | d | d |
d | d | �} | S( s6
Open a .npy file as a memory-mapped array.
This may be used to read an existing file or create a new one.
Parameters
----------
filename : str
The name of the file on disk. This may *not* be a file-like
object.
mode : str, optional
The mode in which to open the file; the default is 'r+'. In
addition to the standard file modes, 'c' is also accepted to
mean "copy on write." See `memmap` for the available mode strings.
dtype : data-type, optional
The data type of the array if we are creating a new file in "write"
mode, if not, `dtype` is ignored. The default value is None,
which results in a data-type of `float64`.
shape : tuple of int
The shape of the array if we are creating a new file in "write"
mode, in which case this parameter is required. Otherwise, this
parameter is ignored and is thus optional.
fortran_order : bool, optional
Whether the array should be Fortran-contiguous (True) or
C-contiguous (False, the default) if we are creating a new file
in "write" mode.
version : tuple of int (major, minor)
If the mode is a "write" mode, then this is the version of the file
format used to create the file. Default: (1,0)
Returns
-------
marray : memmap
The memory-mapped array.
Raises
------
ValueError
If the data or the mode is invalid.
IOError
If the file is not found or cannot be opened correctly.
See Also
--------
memmap
sD Filename must be a string. Memmap cannot use existing file handles.t wi i s1 only support version (1,0) of file format, not %rs6 Array can't be memory-mapped: Python objects in dtype.R R R t bNt rbt FRL s w+s r+R t ordert modet offset( i i ( i i ( R; t
basestringR R@ R RM R< R t openR0 R R7 R8 t closeR RJ t memmap( t filenameRd R R R RS R R# R Re Rc t marray( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt open_memmap� sP 1
( i i ( i i ( t __doc__RN R@ R t numpy.lib.utilsR t numpy.compatR R R R R
R R R R$ R7 RJ RT R^ R R Rl ( ( ( s6 /usr/lib64/python2.7/site-packages/numpy/lib/format.pyt <module>� s" M 2 7