OwlCyberSecurity - MANAGER
Edit File: format.cpython-38.pyc
U �p�]�y � @ s& d Z ddlmZmZmZ ddlZddlZddlZddlZddl m Z ddl m Z m Z mZmZ dZee�d ZdZd Zd d d d �Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Z d d � Z d8d d �Z d d!� Z d"d#� Z d$d%� Z!d&d'� Z"d(d)� Z#d*d+� Z$d9d-d.�Z%d:d0d1�Z&d;d3d4�Z'd<d6d7�Z(dS )=a Binary serialization NPY format ========== 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 to create a solution in their 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 of ``len(magic string) + 2 + len(length) + HEADER_LEN`` be evenly divisible by 64 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``. Format Version 2.0 ------------------ The version 1.0 format only allowed the array header to have a total size of 65535 bytes. This can be exceeded by structured arrays with a large number of columns. The version 2.0 format extends the header size to 4 GiB. `numpy.save` will automatically save in 2.0 format if the data requires it, else it will always use the more compatible 1.0 format. The description of the fourth element of the header therefore has become: "The next 4 bytes form a little-endian unsigned int: the length of the header data HEADER_LEN." Format Version 3.0 ------------------ This version replaces the ASCII string (which in practice was latin1) with a utf8-encoded string, so supports structured types with any unicode field names. Notes ----- The ``.npy`` format, including motivation for creating it and a comparison of alternatives, is described in the `"npy-format" NEP <https://www.numpy.org/neps/nep-0001-npy-format.html>`_, however details have evolved with time and this document is more current. � )�division�absolute_import�print_functionN)� safe_eval)� isfileobj�long� os_fspath�pickles �NUMPY� �@ i )z<H�latin1)�<Ir )r �utf8)�� r �r r �� r c C s | dkrd}t || f ��d S )N)r r r Nz>we only support format version (1,0), (2,0), and (3,0), not %s)� ValueError)�version�msg� r �2/usr/lib/python3/dist-packages/numpy/lib/format.py�_check_version� s r c C sf | dk s| dkrt d��|dk s(|dkr0t d��tjd dk rRtt| � t|� S tt| |g� S dS )a 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. r � z&major version must be 0 <= major < 256z&minor version must be 0 <= minor < 256r N)r �sys� version_info� MAGIC_PREFIX�chr�bytes)�major�minorr r r �magic� s r" c C sv t | td�}|dd� tkr8d}t|t|dd� f ��tjd dk r^tt|dd� �\}}n|dd� \}}||fS )z� Read the magic string to get the version of the file format. Parameters ---------- fp : filelike object Returns ------- major : int minor : int z magic stringN���z4the magic string is not correct; expected %r, got %rr r )� _read_bytes� MAGIC_LENr r r r �map�ord)�fpZ magic_strr r r! r r r � read_magic� s r) c C s | j dk r| jS | jS dS )a� 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)�names�descr�str��dtyper r r �dtype_to_descr� s r/ c C s t | t�rt�| �S t | t�r<t| d �}t�|| d f�S g }d}| D ]z}t|�dkrj|\}}t|�}n |\}}}t�t|�|f�}|dko�|jtjko�|j dk}|s�|� |||f� ||j 7 }qHt |� \} } } dd� | D �} t | � \} } t�| | | | |d��S ) aK descr may be stored as dtype.descr, which is a list of (name, format, [shape]) tuples where format may be a str or a tuple. Offsets are not explicitly saved, rather empty fields with name, format == '', '|Vn' are added as padding. This function reverses the process, eliminating the empty padding fields. r r r � Nc s s$ | ] }t |t�r|nd |fV qd S )N)� isinstance�tuple)�.0�nr r r � <genexpr>6 s z!descr_to_dtype.<locals>.<genexpr>)r* �formats�titles�offsets�itemsize) r1 r, �numpyr. r2 �descr_to_dtype�len�typeZvoidr* �appendr9 �zip)r+ ZdtZfields�offsetZfield�nameZ descr_str�shapeZis_padr* r6 r8 Znametupsr7 r r r r; s0 �r; c C sH d| j i}| jjr d|d< n| jjr.d|d< nd|d< t| j�|d< |S )a 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. rB F� fortran_orderTr+ )rB �flags� c_contiguous� f_contiguousr/ r. )�array�dr r r �header_data_from_array_1_0; s rI c C s� ddl }|dk st�t| \}}t| t�s4| �|�} t| �d }tt|� |� | t }z t |� |� ||| � }W n* |j k r� d� ||�}t|��Y nX || d| d S )zO Takes a stringified header, and attaches the prefix and padding to it r Nr z'Header length {} too big for version={}� � )�struct�AssertionError�_header_size_infor1 r �encoder< � ARRAY_ALIGNr% �calcsizer" Zpack�error�formatr ) �headerr rL Zfmt�encodingZhlenZpadlenZ header_prefixr r r r � _wrap_headerW s rV c C sx z t | d�W S tk r Y nX zt | d�}W n tk rD Y nX tjdtdd� |S t | d�} tjdtdd� | S )zT Like `_wrap_header`, but chooses an appropriate version given the contents r r z>Stored array in format 2.0. It can only beread by NumPy >= 1.9r )� stacklevelr z?Stored array in format 3.0. It can only beread by NumPy >= 1.17)rV r �UnicodeEncodeError�warnings�warn� UserWarning)rT Zretr r r �_wrap_header_guess_versionp s& � �r\ c C sx dg}t |�� �D ] \}}|�d|t|�f � q|�d� d�|�}t|�}|dkr`t|�}n t||�}| �|� dS )a� Write the header for an array and returns the version used Parameters ---------- fp : filelike object d : dict This has the appropriate entries for writing its string representation to the header of the file. version: tuple or None None means use oldest that works explicit version will raise a ValueError if the format does not allow saving this data. Default: None �{z '%s': %s, �}r0 N) �sorted�itemsr> �repr�join�_filter_headerr\ rV �write)r( rH r rT �key�valuer r r �_write_array_header� s rg c C s t | |d� dS )z� 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. r N�rg �r( rH r r r �write_array_header_1_0� s rj c C s t | |d� dS )aQ Write the header for an array using the 2.0 format. The 2.0 format allows storing very large structured arrays. .. versionadded:: 1.9.0 Parameters ---------- fp : filelike object d : dict This has the appropriate entries for writing its string representation to the header of the file. r Nrh ri r r r �write_array_header_2_0� s rk c C s t | dd�S )a� 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. r �r ��_read_array_header�r( r r r �read_array_header_1_0� s rp c C s t | dd�S )a� Read an array header from a filelike object using the 2.0 file format version. This will leave the file object located just after the header. .. versionadded:: 1.9.0 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. r rl rm ro r r r �read_array_header_2_0� s rq c C s� ddl }tjd dkr$ddlm} n ddlm} g }d}| d }|�||�j�D ]B}|d }|d }|r~||jkr~|dkr~qPn |�|� ||j k}qP|� |�dd � S ) a6 Clean up 'L' in npz header ints. Cleans up the 'L' in strings representing integers. Needed to allow npz headers produced in Python2 to be read in Python3. Parameters ---------- s : string Npy file header. Returns ------- header : str Cleaned up header. r Nr )�StringIOF� r �L���) �tokenizer r �iorr �generate_tokens�readline�NAMEr> �NUMBER� untokenize) �srv rr �tokensZlast_token_was_number�string�token� token_typeZ token_stringr r r rc s& �� rc c C s� ddl }t�|�}|dkr(td�|���|\}}t| |�|�d�}|�||�d }t| |d�}|�|�}t |�}z t |�} W n6 t k r� } zd} t| �|| ���W 5 d} ~ X Y nX t | t �s�d} t| �| ���t| �� �} | dd d gkr�d } t| �| ���t | d t��r&t�d d � | d D ���s<d} t| �| d ���t | d t��sbd} t| �| d ���zt| d �} W n: tk �r� } zd} t| �| d ���W 5 d} ~ X Y nX | d | d | fS )z# see read_array_header_1_0 r NzInvalid version {!r}zarray header lengthz array headerz)Cannot parse header: {!r} Exception: {!r}z Header is not a dictionary: {!r}r+ rC rB z.Header does not contain the correct keys: {!r}c S s g | ]}t |ttf��qS r )r1 �intr )r3 �xr r r � <listcomp>P s z&_read_array_header.<locals>.<listcomp>zshape is not valid: {!r}z'fortran_order is not a valid bool: {!r}z+descr is not a valid dtype descriptor: {!r})rL rN �getr rS r$ rQ Zunpack�decoderc r � SyntaxErrorr1 �dictr_ �keysr2 r: �all�boolr; � TypeError)r( r rL ZhinfoZ hlength_typerU Z hlength_strZ header_lengthrT rH �er r� r. r r r rn ) sH " �$rn Tc C s t |� t| t|�|� |jdkr(d}ntd|j d�}|jjrr|sLtd��|dkrXi }tj || fddi|�� n�|j j r�|j j s�t | �r�|j�| � n.tj|dd d g|d d �D ]}| �|�d �� q�nBt | �r�|�| � n.tj|dd d g|d d �D ]}| �|�d �� q�dS )a' 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) or None, optional The version number of the format. None means use the oldest supported version that is able to store the data. Default: None allow_pickle : bool, optional Whether to allow writing pickled data. Default: True pickle_kwargs : dict, optional Additional keyword arguments to pass to pickle.dump, excluding 'protocol'. These are only useful when pickling objects in object arrays on Python 3 to Python 2 compatible format. Raises ------ ValueError If the array cannot be persisted. This includes the case of allow_pickle=False and array being an object array. 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. r i r z5Object arrays cannot be saved when allow_pickle=FalseNZprotocolr Z external_loopZbufferedZ zerosize_ok�F)rD � buffersize�order�C)r rg rI r9 �maxr. � hasobjectr r �dumprD rF rE r �TZtofiler: Znditerrd �tobytes)r( rG r � allow_pickle� pickle_kwargsr� �chunkr r r � write_array^ s< $ � � r� Fc C s~ t | �}t|� t| |�\}}}t|�dkr2d}ntjj|tjd�}|jr�|sVt d��|dkrbi }zt j | f|�}W n@ t k r� } z"t jd dkr�t d| f ��� W 5 d} ~ X Y nX n�t| �r�tj| ||d�}n�tj||d�}|jdk�rTttt|j� } td|| �D ]J} t| || �} t| |j �} t| | d �}tj||| d�|| | | �< �q|�rt|ddd � |_|�� }n||_|S ) a! 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. allow_pickle : bool, optional Whether to allow writing pickled data. Default: False .. versionchanged:: 1.16.3 Made default False in response to CVE-2019-6446. pickle_kwargs : dict Additional keyword arguments to pass to pickle.load. These are only useful when loading object arrays saved on Python 2 when using Python 3. Returns ------- array : ndarray The array from the data on disk. Raises ------ ValueError If the data is invalid, or allow_pickle=False and the file contains an object array. r r r- z6Object arrays cannot be loaded when allow_pickle=FalseNr z]Unpickling a python object failed: %r You may need to pass the encoding= option to numpy.load)r. �countz array dataru )r) r rn r< r: Zmultiply�reduceZint64r� r r �load� UnicodeErrorr r r ZfromfileZndarrayr9 � BUFFER_SIZE�min�ranger� r$ Z frombufferrB Z transpose)r( r� r� r rB rC r. r� rG �errZmax_read_count�iZ read_countZ read_size�datar r r � read_array� sH � � r� �r+c C s t | �rtd��d|kr�t|� t�|�}|jr<d}t|��tt|�||d�}tt | �|d ��}t |||� |� � } W 5 Q R X nTtt | �d��@}t |�}t|� t ||�\}}}|jr�d}t|��|� � } W 5 Q R X |r�d} nd} |d kr�d }tj| ||| || d �} | S ) a� 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 or path-like 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) or None If the mode is a "write" mode, then this is the version of the file format used to create the file. None means use the oldest supported version that is able to store the data. Default: None 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 zZFilename must be a string or a path-like object. Memmap cannot use existing file handles.�wz6Array can't be memory-mapped: Python objects in dtype.)r+ rC rB �b�rbr� r� zw+r� )r. rB r� �moder@ )r r r r: r. r� r� r/ �openr rg �tellr) rn Zmemmap) �filenamer� r. rB rC r r rH r( r@ r� Zmarrayr r r � open_memmap sD 2 � �r� �ran out of datac C s� t � }z:| �|t|� �}||7 }t|�dks:t|�|kr>W qZW q tjk rV Y qX qt|�|kr�d}t|||t|�f ��n|S dS )a+ Read from file-like object until size bytes are read. Raises ValueError if not EOF is encountered before size bytes are read. Non-blocking objects only supported if they derive from io objects. Required as e.g. ZipExtFile in python 2.6 can return less data than requested. r z)EOF: reading %s, expected %d bytes got %dN)r �readr< rw �BlockingIOErrorr )r( �sizeZerror_templater� �rr r r r r$ j s r$ )N)NTN)FN)r� NNFN)r� ))�__doc__Z __future__r r r r: r rw rY Znumpy.lib.utilsr Z numpy.compatr r r r r r< r% rP r� rN r r" r) r/ r; rI rV r\ rg rj rk rp rq rc rn r� r� r� r$ r r r r �<module> sL $ � ) ")5 H _ � e