ak.contents.Content#

Defined in awkward.contents.content on line 84.

class ak.contents.Content(self)#
ak.contents.Content.is_numpy = False#
ak.contents.Content.is_unknown = False#
ak.contents.Content.is_list = False#
ak.contents.Content.is_regular = False#
ak.contents.Content.is_option = False#
ak.contents.Content.is_indexed = False#
ak.contents.Content.is_record = False#
ak.contents.Content.is_union = False#
ak.contents.Content.is_leaf = False#
ak.contents.Content._init(self, parameters, backend)#
ak.contents.Content.parameters#

Free-form parameters associated with every array node as a dict from parameter name to its JSON-like value. Some parameters are special and are used to assign behaviors to the data.

Note that the dict returned by this property is a view of the array node’s parameters. Changing the dict will change the array!

See ak.behavior.

ak.contents.Content.parameter(self, key)#

Returns a parameter’s value or None.

(No distinction is ever made between unset parameters and parameters set to None.)

ak.contents.Content.backend#
ak.contents.Content.form#
ak.contents.Content.form_with_key(self, form_key='node{id}', id_start=0)#
ak.contents.Content._form_with_key(self, getkey)#
ak.contents.Content.form_cls#
ak.contents.Content.to_typetracer(self, forget_length=False)#
ak.contents.Content._to_typetracer(self, forget_length)#
ak.contents.Content._touch_data(self, recursive)#
ak.contents.Content._touch_shape(self, recursive)#
ak.contents.Content.length#
ak.contents.Content._to_buffers(self, form, getkey, container, backend, byteorder)#
ak.contents.Content.__len__(self)#
ak.contents.Content._repr_extra(self, indent)#
ak.contents.Content.maybe_to_NumpyArray(self)#
ak.contents.Content._maybe_index_error(self, error, slicer)#
ak.contents.Content.__array_ufunc__(self, ufunc, method, *inputs)#
ak.contents.Content.__array_function__(self, func, types, args, kwargs)#
ak.contents.Content.__array__(self)#
ak.contents.Content.__iter__(self)#
ak.contents.Content._getitem_next_field(self, head, tail, advanced)#
ak.contents.Content._getitem_next_fields(self, head, tail, advanced)#
ak.contents.Content._getitem_next_newaxis(self, tail, advanced)#
ak.contents.Content._getitem_next_ellipsis(self, tail, advanced)#
ak.contents.Content._getitem_next_regular_missing(self, head, tail, advanced, raw, length)#
ak.contents.Content._getitem_next_missing_jagged(self, head, tail, advanced, that)#
ak.contents.Content._getitem_next_missing(self, head, tail, advanced)#
ak.contents.Content.__getitem__(self, where)#
ak.contents.Content._getitem(self, where)#
ak.contents.Content._getitem_at(self, where)#
ak.contents.Content._getitem_range(self, start, stop)#
ak.contents.Content._getitem_field(self, where, only_fields=())#
ak.contents.Content._getitem_fields(self, where, only_fields=())#
ak.contents.Content._getitem_next(self, head, tail, advanced)#
ak.contents.Content._getitem_next_jagged(self, slicestarts, slicestops, slicecontent, tail)#
ak.contents.Content._carry(self, carry, allow_lazy)#
ak.contents.Content._local_index_axis0(self)#
ak.contents.Content._mergeable_next(self, other, mergebool)#
ak.contents.Content._mergemany(self, others)#
ak.contents.Content._merging_strategy(self, others)#
ak.contents.Content._local_index(self, axis, depth)#
ak.contents.Content._reduce_next(self, reducer, negaxis, starts, shifts, parents, outlength, mask, keepdims, behavior)#
ak.contents.Content._argsort_next(self, negaxis, starts, shifts, parents, outlength, ascending, stable)#
ak.contents.Content._sort_next(self, negaxis, starts, parents, outlength, ascending, stable)#
ak.contents.Content._combinations_axis0(self, n, replacement, recordlookup, parameters)#
ak.contents.Content._combinations(self, n, replacement, recordlookup, parameters, axis, depth)#
ak.contents.Content._validity_error_parameters(self, path)#
ak.contents.Content._validity_error(self, path)#
ak.contents.Content.nbytes#
ak.contents.Content.purelist_parameter(self, key)#

Return the value of the outermost parameter matching key in a sequence of nested lists, stopping at the first record or tuple layer.

If a layer has ak.types.UnionType, the value is only returned if all

possibilities have the same value.

ak.contents.Content._is_unique(self, negaxis, starts, parents, outlength)#
ak.contents.Content._unique(self, negaxis, starts, parents, outlength)#
ak.contents.Content.is_identity_like#
ak.contents.Content.purelist_isregular#

Returns True if all dimensions down to the first record or tuple layer have ak.types.RegularType; False otherwise.

ak.contents.Content.purelist_depth#

Number of dimensions of nested lists, not counting anything deeper than the first record or tuple layer, if any. The depth of a one-dimensional array is 1.

If the array contains ak.types.UnionType data and its contents have equal depths, the return value is that depth. If they do not have equal depths, the return value is -1.

ak.contents.Content.minmax_depth#
ak.contents.Content.branch_depth#
ak.contents.Content.fields#
ak.contents.Content.is_tuple#
ak.contents.Content.dimension_optiontype#
ak.contents.Content._pad_none_axis0(self, target, clip)#
ak.contents.Content._pad_none(self, target, axis, depth, clip)#
ak.contents.Content.to_arrow(self, list_to32=False, string_to32=False, bytestring_to32=False, emptyarray_to=None, categorical_as_dictionary=False, extensionarray=True, count_nulls=True, record_is_scalar=False)#
ak.contents.Content._to_arrow(self, pyarrow, mask_node, validbytes, length, options)#
ak.contents.Content.to_backend_array(self, allow_missing=True, *, backend=None)#
ak.contents.Content._to_backend_array(self, allow_missing, backend)#
ak.contents.Content.drop_none(self)#
ak.contents.Content._drop_none(self)#
ak.contents.Content._remove_structure(self, backend, options)#
ak.contents.Content._recursively_apply(self, action, behavior, depth, depth_context, lateral_context, options)#
ak.contents.Content.to_json(self, nan_string=None, posinf_string=None, neginf_string=None, complex_record_fields=None, convert_bytes=None, behavior=None)#
ak.contents.Content.to_packed(self)#
ak.contents.Content.to_list(self, behavior=None)#
ak.contents.Content._to_list(self, behavior, json_conversions)#
ak.contents.Content._to_list_custom(self, behavior, json_conversions)#
ak.contents.Content._offsets_and_flattened(self, axis, depth)#
ak.contents.Content.to_backend(self, backend=None)#
ak.contents.Content._to_backend(self, backend)#
ak.contents.Content.with_parameter(self, key, value)#
ak.contents.Content.__copy__(self)#
ak.contents.Content.__deepcopy__(self, memo)#
ak.contents.Content.is_equal_to(self, other, index_dtype=True, numpyarray=True)#
ak.contents.Content._is_equal_to(self, other, index_dtype, numpyarray)#
ak.contents.Content._repr(self, indent, pre, post)#
ak.contents.Content._numbers_to_type(self, name, including_unknown)#
ak.contents.Content._fill_none(self, value)#
ak.contents.Content.copy(self, *, parameters=UNSET)#