Defined in uproot.containers on line 166.
- class uproot.containers.AsContainer
Abstract class for all descriptions of data as containers, such as
Note that these are not uproot.interpretation.Interpretation objects, since they are recursively nestable and have a
readinstance method like uproot.Model’s
A nested tree of uproot.containers.AsContainer instances and uproot.Model class objects may be the
modelargument of a uproot.AsObjects.
String that uniquely specifies this container, to use as part of an array’s cache key.
String that describes this container as a C++ type.
This type might not exactly correspond to the type in C++, but it would have equivalent meaning.
- AsContainer.awkward_form(file, context)
file (uproot.reading.CommonFileMethods) – The file associated with this interpretation’s
context (dict) – Context for the Form-generation; defaults are the remaining arguments below.
index_format (str) – Format to use for indexes of the
awkward.forms.Form; may be
header (bool) – If True, include header fields of each C++ class.
tobject_header (bool) – If True, include header fields of each
breadcrumbs (tuple of class objects) – Used to check for recursion. Types that contain themselves cannot be Awkward Arrays because the depth of instances is unknown.
awkward.forms.Formto use to put objects of type type in an Awkward Array.
- AsContainer.strided_interpretation(file, header=False, tobject_header=True, breadcrumbs=(), original=None)
file (uproot.ReadOnlyFile) – File to use to generate uproot.Model classes from its streamers and
file_pathfor error messages.
header (bool) – If True, assume the outermost object has a header.
tobject_header (bool) – If True, assume that
breadcrumbs (tuple of class objects) – Used to check for recursion. Types that contain themselves cannot be strided because the depth of instances is unknown.
original (None, uproot.Model, or uproot.containers.Container) – The original, non-strided model or container.
Returns a list of (str,
numpy.dtype) pairs to build a uproot.AsStridedObjects interpretation.
If True, assume this container has a header.
- AsContainer.read(chunk, cursor, context, file, selffile, parent, header=True)
chunk (uproot.source.chunk.Chunk) – Buffer of contiguous data from the file uproot.source.chunk.Source.
cursor (uproot.Cursor) – Current position in that
context (dict) – Auxiliary data used in deserialization.
file (uproot.ReadOnlyFile) – An open file object, capable of generating new uproot.Model classes from its streamers.
selffile (uproot.reading.CommonFileMethods) – A possibly uproot.reading.DetachedFile associated with this object.
parent (None or calling object) – The previous
readin the recursive descent.
header (bool) – If True, enable the container’s header.
Read one object as part of a recursive descent.