{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the file contains pickle data, then whatever object is stored in the pickle is returned." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the file is a " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npy" }, { "__type": "Text", "__tag": 4046, "value": " file, then a single array is returned." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the file is a " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " file, then a dictionary-like object is returned, containing " }, { "__type": "InlineCode", "__tag": 4051, "value": "{filename: array}" }, { "__type": "Text", "__tag": 4046, "value": " key-value pairs, one for each file in the archive." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the file is a " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " file, the returned value supports the context manager protocol in a similar fashion to the open function " } ] }, { "__type": "Code", "__tag": 4050, "value": "with load('foo.npz') as data:\n a = data['a']", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The underlying file descriptor is closed when exiting the 'with' block." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "OSError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the input file does not exist or cannot be read." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "UnpicklingError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "allow_pickle=True" }, { "__type": "Text", "__tag": 4046, "value": ", but the file cannot be loaded as a pickle." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The file contains an object array, but " }, { "__type": "InlineCode", "__tag": 4051, "value": "allow_pickle=False" }, { "__type": "Text", "__tag": 4046, "value": " given." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "EOFError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When calling " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.load" }, { "__type": "Text", "__tag": 4046, "value": " multiple times on the same file handle, if all data has already been read" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "result", "annotation": "array, tuple, dict, etc.", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Data stored in the file. For " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " files, the returned instance of NpzFile class must be closed to avoid leaking file descriptors." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Load arrays or pickled objects from " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npy" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " or pickled files." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "file", "annotation": "file-like object, string, or pathlib.Path", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The file to read. File-like objects must support the " }, { "__type": "InlineCode", "__tag": 4051, "value": "seek()" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "read()" }, { "__type": "Text", "__tag": 4046, "value": " methods and must always be opened in binary mode. Pickled files require that the file-like object support the " }, { "__type": "InlineCode", "__tag": 4051, "value": "readline()" }, { "__type": "Text", "__tag": 4046, "value": " method as well." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mmap_mode", "annotation": "{None, 'r+', 'r', 'w+', 'c'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If not None, then memory-map the file, using the given mode (see " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.memmap", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:memmap" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for a detailed description of the modes). A memory-mapped array is kept on disk. However, it can be accessed and sliced like any ndarray. Memory mapping is especially useful for accessing small fragments of large files without reading the entire file into memory." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "allow_pickle", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Allow loading pickled object arrays stored in npy files. Reasons for disallowing pickles include security, as loading pickled data can execute arbitrary code. If pickles are disallowed, loading object arrays will fail. Default: False" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fix_imports", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Only useful when loading Python 2 generated pickled files, which includes npy/npz files containing object arrays. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "fix_imports" }, { "__type": "Text", "__tag": 4046, "value": " is True, pickle will try to map the old Python 2 names to the new names used in Python 3." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "encoding", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "What encoding to use when reading Python 2 strings. Only useful when loading Python 2 generated pickled files, which includes npy/npz files containing object arrays. Values other than 'latin1', 'ASCII', and 'bytes' are not allowed, as they can corrupt numerical data. Default: 'ASCII'" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_header_size", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum allowed size of the header. Large headers may not be safe to load securely and thus require explicitly passing a larger value. See " }, { "__type": "InlineRole", "__tag": 4003, "value": "ast.literal_eval()", "domain": "py", "role": "func", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details. This option is ignored when " }, { "__type": "ParamRef", "__tag": 4071, "name": "allow_pickle" }, { "__type": "Text", "__tag": 4046, "value": " is passed. In that case the file is by definition trusted and the limit is unnecessary." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "warning", "base_type": "warning", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "warning " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Loading files that contain object arrays uses the " }, { "__type": "InlineCode", "__tag": 4051, "value": "pickle" }, { "__type": "Text", "__tag": 4046, "value": " module, which is not secure against erroneous or maliciously constructed data. Consider passing " }, { "__type": "InlineCode", "__tag": 4051, "value": "allow_pickle=False" }, { "__type": "Text", "__tag": 4046, "value": " to load data that is known not to contain object arrays for the safer handling of untrusted sources." } ] } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/numpy/lib/_npyio_impl.py", "item_line": 311, "item_type": "function", "aliases": [ "numpy.load" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nStore data to disk, and load it again:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.save('/tmp/123', np.array([[1, 2, 3], [4, 5, 6]]))\nnp.load('/tmp/123.npy')\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nStore compressed data to disk, and load it again:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a=np.array([[1, 2, 3], [4, 5, 6]])\nb=np.array([1, 2])\nnp.savez('/tmp/123.npz', a=a, b=b)\ndata = np.load('/tmp/123.npz')\ndata['a']\ndata['b']\ndata.close()\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nMem-map the stored array, and then access the second row\ndirectly from disk:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X = np.load('/tmp/123.npy', mmap_mode='r')\nX[1, :]\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "lib.format.open_memmap", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "lib.format.open_memmap" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Create or load a memory-mapped " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npy" }, { "__type": "Text", "__tag": 4046, "value": " file." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "loadtxt", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:loadtxt" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "memmap", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "memmap" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Create a memory-map to an array stored in a file on disk." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "save", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "save" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "savez", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "savez" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "savez_compressed", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "savez_compressed" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "file", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "mmap_mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "allow_pickle", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "fix_imports", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "encoding", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "ASCII" }, { "__type": "SigParam", "__tag": 4030, "name": "max_header_size", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "10000" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "load" }, "references": null, "qa": "numpy:load", "arbitrary": [], "local_refs": [ "allow_pickle", "encoding", "file", "fix_imports", "max_header_size", "mmap_mode", "result" ] }