numpy.lib.npyio.NpzFile

class documentation

class NpzFile(Mapping):

View In Hierarchy

NpzFile(fid)

A dictionary-like object with lazy-loading of files in the zipped archive provided on construction.

NpzFile is used to load files in the NumPy .npz data archive format. It assumes that files in the archive have a .npy extension, other files are ignored.

The arrays and file strings are lazily loaded on either getitem access using obj['key'] or attribute lookup using obj.f.key. A list of all files (without .npy extensions) can be obtained with obj.files and the ZipFile object itself using obj.zip.

Attributes

files : list of str
List of all files in the archive with a .npy extension.
zip : ZipFile instance
The ZipFile object initialized with the zipped archive.
f : BagObj instance
An object on which attribute can be performed as an alternative to getitem access on the NpzFile instance itself.
allow_pickle : bool, optional

Allow loading pickled data. Default: False

Changed in version 1.16.3: Made default False in response to CVE-2019-6446.
pickle_kwargs : dict, optional
Additional keyword arguments to pass on to pickle.load. These are only useful when loading object arrays saved on Python 2 when using Python 3.

Parameters

fid : file or str
The zipped archive to open. This is either a file-like object or a string containing the path to the archive.
own_fid : bool, optional
Whether NpzFile should close the file handle. Requires that fid is a file-like object.

Examples

>>> from tempfile import TemporaryFile
>>> outfile = TemporaryFile()
>>> x = np.arange(10)
>>> y = np.sin(x)
>>> np.savez(outfile, x=x, y=y)
>>> _ = outfile.seek(0)
>>> npz = np.load(outfile)
>>> isinstance(npz, np.lib.io.NpzFile)
True
>>> sorted(npz.files)
['x', 'y']
>>> npz['x']  # getitem access
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> npz.f.x  # attribute lookup
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
Method __del__ Undocumented
Method __enter__ Undocumented
Method __exit__ Undocumented
Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method close Close the file.
Method iteritems Undocumented
Method iterkeys Undocumented
Instance Variable ​_files Undocumented
Instance Variable allow​_pickle Undocumented
Instance Variable f Undocumented
Instance Variable fid Undocumented
Instance Variable files Undocumented
Instance Variable pickle​_kwargs Undocumented
Instance Variable zip Undocumented
def __del__(self):

Undocumented

def __enter__(self):

Undocumented

def __exit__(self, exc_type, exc_value, traceback):

Undocumented

def __getitem__(self, key):

Undocumented

def __init__(self, fid, own_fid=False, allow_pickle=False, pickle_kwargs=None):

Undocumented

def __iter__(self):

Undocumented

def __len__(self):

Undocumented

def close(self):
Close the file.
def iteritems(self):

Undocumented

def iterkeys(self):

Undocumented

_files =

Undocumented

allow_pickle =

Undocumented

f =

Undocumented

fid =

Undocumented

files: list =

Undocumented

pickle_kwargs =

Undocumented

zip =

Undocumented