{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "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": "idl_dict", "annotation": "AttrDict or dict", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "python_dict" }, { "__type": "Text", "__tag": 4046, "value": " is set to False (default), this function returns a case-insensitive dictionary with item, attribute, and call access to variables. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "python_dict" }, { "__type": "Text", "__tag": 4046, "value": " is set to True, this function returns a Python dictionary with all variable names in lowercase. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "idict" }, { "__type": "Text", "__tag": 4046, "value": " was specified, then variables are written to the dictionary specified, and the updated dictionary is returned." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Read an IDL .sav file." } ] } ], "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_name", "annotation": "str", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Name of the IDL save file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "idict", "annotation": "dict, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Dictionary in which to insert .sav file variables." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "python_dict", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, the object return is not a Python dictionary, but a case-insensitive dictionary with item, attribute, and call access to variables. To get a standard Python dictionary, set this option to True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "uncompressed_file_name", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This option only has an effect for .sav files written with the /compress option. If a file name is specified, compressed .sav files are uncompressed to this file. Otherwise, readsav will use the " }, { "__type": "CrossRef", "__tag": 4002, "value": "tempfile", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "tempfile", "version": "*", "kind": "api", "path": "tempfile" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " module to determine a temporary filename automatically, and will remove the temporary file upon successfully reading it in." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "verbose", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to print out information about the save file, including the records read, and available variables." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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": "/scipy/io/_idl.py", "item_line": 677, "item_type": "function", "aliases": [ "scipy.io.readsav" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from os.path import dirname, join as pjoin\nimport scipy.io as sio\nfrom scipy.io import readsav\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nGet the filename for an example .sav file from the tests/data directory.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "data_dir = pjoin(dirname(sio.__file__), 'tests', 'data')\nsav_fname = pjoin(data_dir, 'array_float32_1d.sav')\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nLoad the .sav file contents.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "sav_data = readsav(sav_fname)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nGet keys of the .sav file contents.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "print(sav_data.keys())\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nAccess a content with a key.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "print(sav_data['array1d'])\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "file_name", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "idict", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "python_dict", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "uncompressed_file_name", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "verbose", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "readsav" }, "references": null, "qa": "scipy.io._idl:readsav", "arbitrary": [], "local_refs": [ "file_name", "idict", "idl_dict", "python_dict", "uncompressed_file_name", "verbose" ] }