{ "__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": "", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "NumPy array." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Read a NumPy array from a text file. This is a helper function for loadtxt." } ] } ], "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": "fname", "annotation": "file, str, or pathlib.Path", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The filename or the file to be read." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "delimiter", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Field delimiter of the fields in line of the file. Default is a comma, ','. If None any sequence of whitespace is considered a delimiter." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "comment", "annotation": "str or sequence of str or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Character that begins a comment. All text from the comment character to the end of the line is ignored. Multiple comments or multiple-character comment strings are supported, but may be slower and " }, { "__type": "ParamRef", "__tag": 4071, "name": "quote" }, { "__type": "Text", "__tag": 4046, "value": " must be empty if used. Use None to disable all use of comments." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "quote", "annotation": "str or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Character that is used to quote string fields. Default is '\"' (a double quote). Use None to disable quote support." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "imaginary_unit", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Character that represent the imaginary unit " }, { "__type": "InlineRole", "__tag": 4003, "value": "sqrt(-1)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". Default is 'j'." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "usecols", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A one-dimensional array of integer column numbers. These are the columns from the file to be included in the array. If this value is not given, all the columns are used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "skiplines", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of lines to skip before interpreting the data in the file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_rows", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Maximum number of rows of data to read. Default is to read the entire file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "converters", "annotation": "dict or callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A function to parse all columns strings into the desired value, or a dictionary mapping column number to a parser function. E.g. if column 0 is a date string: " }, { "__type": "InlineCode", "__tag": 4051, "value": "converters = {0: datestr2num}" }, { "__type": "Text", "__tag": 4046, "value": ". Converters can also be used to provide a default value for missing data, e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "converters = lambda s: float(s.strip() or 0)" }, { "__type": "Text", "__tag": 4046, "value": " will convert empty fields to 0. Default: None" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ndmin", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimum dimension of the array returned. Allowed values are 0, 1 or 2. Default is 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "unpack", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the returned array is transposed, so that arguments may be unpacked using " }, { "__type": "InlineCode", "__tag": 4051, "value": "x, y, z = read(...)" }, { "__type": "Text", "__tag": 4046, "value": ". When used with a structured data-type, arrays are returned for each field. Default is False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "numpy data type", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A NumPy dtype instance, can be a structured dtype to map to the columns of the file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "encoding", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Encoding used to decode the inputfile. The special value 'bytes' (the default) enables backwards-compatible behavior for " }, { "__type": "ParamRef", "__tag": 4071, "name": "converters" }, { "__type": "Text", "__tag": 4046, "value": ", ensuring that inputs to the converter functions are encoded bytes objects. The special value 'bytes' has no additional effect if " }, { "__type": "InlineCode", "__tag": 4051, "value": "converters=None" }, { "__type": "Text", "__tag": 4046, "value": ". If encoding is " }, { "__type": "InlineCode", "__tag": 4051, "value": "'bytes'" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": ", the default system encoding is used." } ] } ] } ] } ], "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": "build-install/usr/lib/python3.14/site-packages/numpy/lib/_npyio_impl.py", "item_line": 861, "item_type": "function", "aliases": [ "numpy.lib._npyio_impl._read" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "fname", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "delimiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "," }, { "__type": "SigParam", "__tag": 4030, "name": "comment", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "#" }, { "__type": "SigParam", "__tag": 4030, "name": "quote", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "\"" }, { "__type": "SigParam", "__tag": 4030, "name": "imaginary_unit", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "j" }, { "__type": "SigParam", "__tag": 4030, "name": "usecols", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "skiplines", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "max_rows", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "converters", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "ndmin", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "unpack", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "encoding", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "_read" }, "references": null, "qa": "numpy.lib._npyio_impl:_read", "arbitrary": [], "local_refs": [ "comment", "converters", "delimiter", "dtype", "encoding", "fname", "imaginary_unit", "max_rows", "ndmin", "quote", "skiplines", "unpack", "usecols" ] }