ak.from_iter — Awkward Array 2.8.2 documentation (original) (raw)
Defined in awkward.operations.ak_from_iter on line 19.
ak.from_iter(iterable, *, allow_record=True, highlevel=True, behavior=None, attrs=None, initial=1024, resize=8)#
Parameters:
- iterable (Python iterable) – Data to convert into an Awkward Array.
- allow_record (bool) – If True, the outermost element may be a record (returning ak.Record or ak.record.Record type, depending on
highlevel); if False, the outermost element must be an array. - highlevel (bool) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.
- behavior (None or dict) – Custom ak.behavior for the output array, if high-level.
- attrs (None or dict) – Custom attributes for the output array, if high-level.
- initial (int) – Initial size (in bytes) of buffers used by the
ak::ArrayBuilder. - resize (float) – Resize multiplier for buffers used by the
ak::ArrayBuilder; should be strictly greater than 1.
Converts Python data into an Awkward Array.
Any heterogeneous and deeply nested Python data can be converted, but the output will never have regular-typed array lengths. Internally, this function usesak::ArrayBuilder (see the high-level ak.ArrayBuilder documentation for a more complete description).
The following Python types are supported.
- bool, including
np.bool_: converted into ak.contents.NumpyArray. - int, including
np.integer: converted into ak.contents.NumpyArray. - float, including
np.floating: converted into ak.contents.NumpyArray. - bytes: converted into ak.contents.ListOffsetArray with parameter
"__array__"equal to"bytestring"(unencoded bytes). - str: converted into ak.contents.ListOffsetArray with parameter
"__array__"equal to"string"(UTF-8 encoded string). - tuple: converted into ak.contents.RecordArray without field names (i.e. homogeneously typed, uniform sized tuples).
- dict: converted into ak.contents.RecordArray with field names (i.e. homogeneously typed records with the same sets of fields).
- iterable, including np.ndarray: converted intoak.contents.ListOffsetArray.
See also ak.to_list.