Release history

Tutorials

Getting started guide
Uproot 3 → 4+ cheat-sheet

Main Interface

uproot.open
uproot.iterate
uproot.concatenate
uproot.dask
uproot.dask_write
uproot.create
uproot.recreate
uproot.update
uproot.ReadOnlyFile
uproot.ReadOnlyDirectory
uproot.TTree
uproot.TBranch
uproot.WritableFile
uproot.WritableDirectory
uproot.WritableTree
uproot.WritableBranch
uproot.ZLIB
uproot.LZMA
uproot.LZ4
uproot.ZSTD
uproot.LRUCache
uproot.LRUArrayCache
uproot.Model
uproot.from_pyroot
uproot.ObjectSource
uproot.MemmapSource
uproot.MultithreadedFileSource
uproot.HTTPSource
uproot.MultithreadedHTTPSource
uproot.XRootDSource
uproot.MultithreadedXRootDSource
uproot.num_entries

Detailed Reference

uproot (module)
uproot.to_writable
uproot.as_TGraph
uproot.ImplementsFormMappingInfo
uproot.ImplementsFormMapping
uproot.behavior_of
uproot.reset_classes
uproot.classname_decode
uproot.classname_encode
uproot.class_named
uproot.has_class_named
uproot.DeserializationError
uproot.to_pyroot
uproot.Cursor
uproot.FSSpecSource
uproot.TrivialExecutor
uproot.ThreadPoolExecutor
uproot.S3Source
uproot.AsGrouped
uproot.AsJagged
uproot.AsDtype
uproot.AsDtypeInPlace
uproot.AsSTLBits
uproot.AsDouble32
uproot.AsFloat16
uproot.AsObjects
uproot.AsStridedObjects
uproot.AsStrings
uproot.AsDynamic
uproot.AsString
uproot.AsPointer
uproot.AsArray
uproot.AsRVec
uproot.AsVector
uproot.AsSet
uproot.AsMap
uproot.STLVector
uproot.STLSet
uproot.STLMap
uproot.KeyInFileError

reading

uproot.reading (module)
uproot.reading.open
uproot.reading.CommonFileMethods
uproot.reading.DetachedFile
uproot.reading.ReadOnlyFile
uproot.reading.ReadOnlyDirectory
uproot.reading.ReadOnlyKey

writing

uproot.writing (module)
uproot.writing._dask_write (module)
uproot.writing._dask_write.dask_write
uproot.writing._dask_write.ak_to_root
uproot.writing.identify (module)
uproot.writing.identify.add_to_directory
uproot.writing.identify.to_writable
uproot.writing.identify.to_TString
uproot.writing.identify.to_TObjString
uproot.writing.identify.to_TList
uproot.writing.identify.to_THashList
uproot.writing.identify.to_TArray
uproot.writing.identify.to_TAxis
uproot.writing.identify.to_TH1x
uproot.writing.identify.to_TH2x
uproot.writing.identify.to_TH3x
uproot.writing.identify.to_TProfile
uproot.writing.identify.to_TProfile2D
uproot.writing.identify.to_TProfile3D
uproot.writing.interpret (module)
uproot.writing.interpret.as_TGraph
uproot.writing.writable (module)
uproot.writing.writable.create
uproot.writing.writable.recreate
uproot.writing.writable.update
uproot.writing.writable.WritableFile
uproot.writing.writable.WritableDirectory
uproot.writing.writable.WritableTree
uproot.writing.writable.WritableBranch
uproot.writing.writable.WritableNTuple

behaviors

uproot.behaviors (module)
uproot.behaviors.RooCurve (module)
uproot.behaviors.RooCurve.RooCurve
uproot.behaviors.RooHist (module)
uproot.behaviors.RooHist.RooHist
uproot.behaviors.TAxis (module)
uproot.behaviors.TAxis.AxisTraits
uproot.behaviors.TAxis.TAxis
uproot.behaviors.TBranch (module)
uproot.behaviors.TBranch.iterate
uproot.behaviors.TBranch.concatenate
uproot.behaviors.TBranch.Report
uproot.behaviors.TBranch.HasBranches
uproot.behaviors.TBranch.TBranch
uproot.behaviors.TBranchElement (module)
uproot.behaviors.TBranchElement.TBranchElement
uproot.behaviors.TDatime (module)
uproot.behaviors.TDatime.TDatime
uproot.behaviors.TGraph (module)
uproot.behaviors.TGraph.TGraph
uproot.behaviors.TGraphAsymmErrors (module)
uproot.behaviors.TGraphAsymmErrors.TGraphAsymmErrors
uproot.behaviors.TGraphErrors (module)
uproot.behaviors.TGraphErrors.TGraphErrors
uproot.behaviors.TH1 (module)
uproot.behaviors.TH1.Histogram
uproot.behaviors.TH1.TH1
uproot.behaviors.TH2 (module)
uproot.behaviors.TH2.TH2
uproot.behaviors.TH2Poly (module)
uproot.behaviors.TH2Poly.TH2Poly
uproot.behaviors.TH3 (module)
uproot.behaviors.TH3.TH3
uproot.behaviors.TParameter (module)
uproot.behaviors.TParameter.TParameter_3c_boolean_3e
uproot.behaviors.TParameter.TParameter_3c_integer_3e
uproot.behaviors.TParameter.TParameter_3c_floating_3e
uproot.behaviors.TParameter.TParameter
uproot.behaviors.TProfile (module)
uproot.behaviors.TProfile.Profile
uproot.behaviors.TProfile.TProfile
uproot.behaviors.TProfile2D (module)
uproot.behaviors.TProfile2D.TProfile2D
uproot.behaviors.TProfile3D (module)
uproot.behaviors.TProfile3D.TProfile3D
uproot.behaviors.TTree (module)
uproot.behaviors.TTree.TTree

behavior

uproot.behavior (module)
uproot.behavior.behavior_of

model

uproot.model (module)
uproot.model.bootstrap_classes
uproot.model.reset_classes
uproot.model.classname_regularize
uproot.model.classname_decode
uproot.model.classname_encode
uproot.model.classname_version
uproot.model.class_named
uproot.model.has_class_named
uproot.model.maybe_custom_classes
uproot.model.Model
uproot.model.VersionedModel
uproot.model.DispatchByVersion
uproot.model.UnknownClass
uproot.model.UnknownClassVersion
uproot.model.DynamicModel

streamers

uproot.streamers (module)
uproot.streamers.Model_TStreamerInfo
uproot.streamers.Model_TStreamerElement
uproot.streamers.Model_TStreamerArtificial
uproot.streamers.Model_TStreamerBase
uproot.streamers.Model_TStreamerBasicPointer
uproot.streamers.Model_TStreamerBasicType
uproot.streamers.Model_TStreamerLoop
uproot.streamers.Model_TStreamerSTL
uproot.streamers.Model_TStreamerSTLstring
uproot.streamers.TStreamerPointerTypes
uproot.streamers.Model_TStreamerObjectAnyPointer
uproot.streamers.Model_TStreamerObjectPointer
uproot.streamers.TStreamerObjectTypes
uproot.streamers.Model_TStreamerObject
uproot.streamers.Model_TStreamerObjectAny
uproot.streamers.Model_TStreamerString

cache

uproot.cache (module)
uproot.cache.LRUCache
uproot.cache.LRUArrayCache

compression

uproot.compression (module)
uproot.compression.Compression
uproot.compression.ZLIB
uproot.compression.LZMA
uproot.compression.LZ4
uproot.compression.ZSTD
uproot.compression.decompress
uproot.compression.hook_before_block
uproot.compression.hook_after_block
uproot.compression.compress

deserialization

uproot.deserialization (module)
uproot.deserialization.compile_class
uproot.deserialization.numbytes_version
uproot.deserialization.numbytes_check
uproot.deserialization.read_object_any
uproot.deserialization.DeserializationError

serialization

uproot.serialization (module)
uproot.serialization.string
uproot.serialization.bytestring
uproot.serialization.numbytes_version
uproot.serialization.serialize_object_any

pyroot

uproot.pyroot (module)
uproot.pyroot.to_pyroot
uproot.pyroot.pyroot_to_buffer
uproot.pyroot.from_pyroot

source

uproot.source (module)
uproot.source.chunk (module)
uproot.source.chunk.Resource
uproot.source.chunk.SourcePerformanceCounters
uproot.source.chunk.Source
uproot.source.chunk.MultithreadedSource
uproot.source.chunk.Chunk
uproot.source.chunk.notifier
uproot.source.coalesce (module)
uproot.source.coalesce.CoalesceConfig
uproot.source.coalesce.SliceFuture
uproot.source.coalesce.RangeRequest
uproot.source.coalesce.Cluster
uproot.source.coalesce.CoalescedRequest
uproot.source.coalesce.coalesce_requests
uproot.source.cursor (module)
uproot.source.cursor.Cursor
uproot.source.file (module)
uproot.source.file.FileResource
uproot.source.file.MemmapSource
uproot.source.file.MultithreadedFileSource
uproot.source.fsspec (module)
uproot.source.fsspec.FSSpecSource
uproot.source.fsspec.FSSpecLoopExecutor
uproot.source.futures (module)
uproot.source.futures.delayed_raise
uproot.source.futures.Executor
uproot.source.futures.TrivialFuture
uproot.source.futures.TrivialExecutor
uproot.source.futures.Future
uproot.source.futures.Worker
uproot.source.futures.ThreadPoolExecutor
uproot.source.futures.ResourceFuture
uproot.source.futures.ResourceWorker
uproot.source.futures.ResourceThreadPoolExecutor
uproot.source.futures.ResourceTrivialExecutor
uproot.source.http (module)
uproot.source.http.make_connection
uproot.source.http.full_path
uproot.source.http.basic_auth_headers
uproot.source.http.get_num_bytes
uproot.source.http.HTTPResource
uproot.source.http.HTTPSource
uproot.source.http.MultithreadedHTTPSource
uproot.source.object (module)
uproot.source.object.ObjectResource
uproot.source.object.ObjectSource
uproot.source.s3 (module)
uproot.source.s3.S3Source
uproot.source.xrootd (module)
uproot.source.xrootd.get_server_config
uproot.source.xrootd.trivial_resource
uproot.source.xrootd.XRootDResource
uproot.source.xrootd.XRootDSource
uproot.source.xrootd.MultithreadedXRootDSource

sink

uproot.sink (module)
uproot.sink.file (module)
uproot.sink.file.FileSink

interpretation

uproot.interpretation (module)
uproot.interpretation.Interpretation
uproot.interpretation.grouped (module)
uproot.interpretation.grouped.AsGrouped
uproot.interpretation.identify (module)
uproot.interpretation.identify.interpretation_of
uproot.interpretation.identify.parse_typename
uproot.interpretation.identify.NotNumerical
uproot.interpretation.identify.UnknownInterpretation
uproot.interpretation.jagged (module)
uproot.interpretation.jagged.fast_divide
uproot.interpretation.jagged.AsJagged
uproot.interpretation.jagged.JaggedArray
uproot.interpretation.library (module)
uproot.interpretation.library.Library
uproot.interpretation.library.NumPy
uproot.interpretation.library.Awkward
uproot.interpretation.library.Pandas
uproot.interpretation.numerical (module)
uproot.interpretation.numerical.Numerical
uproot.interpretation.numerical.AsDtype
uproot.interpretation.numerical.AsDtypeInPlace
uproot.interpretation.numerical.AsSTLBits
uproot.interpretation.numerical.TruncatedNumerical
uproot.interpretation.numerical.AsDouble32
uproot.interpretation.numerical.AsFloat16
uproot.interpretation.objects (module)
uproot.interpretation.objects.AsObjects
uproot.interpretation.objects.AsStridedObjects
uproot.interpretation.objects.CannotBeStrided
uproot.interpretation.objects.CannotBeForth
uproot.interpretation.objects.CannotBeAwkward
uproot.interpretation.objects.ObjectArray
uproot.interpretation.objects.StridedObjectArray
uproot.interpretation.strings (module)
uproot.interpretation.strings.AsStrings
uproot.interpretation.strings.StringArray

containers

uproot.containers (module)
uproot.containers.AsContainer
uproot.containers.AsDynamic
uproot.containers.AsFIXME
uproot.containers.AsString
uproot.containers.AsPointer
uproot.containers.AsArray
uproot.containers.AsVectorLike
uproot.containers.AsRVec
uproot.containers.AsVector
uproot.containers.AsList
uproot.containers.AsBitSet
uproot.containers.AsSet
uproot.containers.AsMap
uproot.containers.Container
uproot.containers.ROOTRVec
uproot.containers.STLList
uproot.containers.STLVector
uproot.containers.STLBitSet
uproot.containers.STLSet
uproot.containers.STLMap

language

uproot.language (module)
uproot.language.Language
uproot.language.python (module)
uproot.language.python.PythonLanguage

models

uproot.models (module)
uproot.models.RNTuple (module)
uproot.models.RNTuple.from_zigzag
uproot.models.RNTuple.Model_ROOT_3a3a_Experimental_3a3a_RNTuple
uproot.models.RNTuple.PageDescription
uproot.models.RNTuple.PageLink
uproot.models.RNTuple.LocatorReader
uproot.models.RNTuple.EnvLinkReader
uproot.models.RNTuple.MetaData
uproot.models.RNTuple.RecordFrameReader
uproot.models.RNTuple.ListFrameReader
uproot.models.RNTuple.FieldRecordReader
uproot.models.RNTuple.ColumnRecordReader
uproot.models.RNTuple.AliasColumnReader
uproot.models.RNTuple.ExtraTypeInfoReader
uproot.models.RNTuple.HeaderReader
uproot.models.RNTuple.ColumnGroupIDReader
uproot.models.RNTuple.ColumnGroupRecordReader
uproot.models.RNTuple.ClusterSummaryReader
uproot.models.RNTuple.ClusterGroupRecordReader
uproot.models.RNTuple.RNTupleSchemaExtension
uproot.models.RNTuple.FooterReader
uproot.models.TArray (module)
uproot.models.TArray.Model_TArray
uproot.models.TArray.Model_TArrayC
uproot.models.TArray.Model_TArrayS
uproot.models.TArray.Model_TArrayI
uproot.models.TArray.Model_TArrayL
uproot.models.TArray.Model_TArrayL64
uproot.models.TArray.Model_TArrayF
uproot.models.TArray.Model_TArrayD
uproot.models.TAtt (module)
uproot.models.TAtt.Model_TAttLine_v1
uproot.models.TAtt.Model_TAttLine_v2
uproot.models.TAtt.Model_TAttLine
uproot.models.TAtt.Model_TAttFill_v1
uproot.models.TAtt.Model_TAttFill_v2
uproot.models.TAtt.Model_TAttFill
uproot.models.TAtt.Model_TAttMarker_v2
uproot.models.TAtt.Model_TAttMarker
uproot.models.TAtt.Model_TAttAxis_v4
uproot.models.TAtt.Model_TAttAxis
uproot.models.TAtt.Model_TAtt3D_v1
uproot.models.TAtt.Model_TAtt3D
uproot.models.TBasket (module)
uproot.models.TBasket.Model_TBasket
uproot.models.TBranch (module)
uproot.models.TBranch.Model_TBranch_v10
uproot.models.TBranch.Model_TBranch_v11
uproot.models.TBranch.Model_TBranch_v12
uproot.models.TBranch.Model_TBranch_v13
uproot.models.TBranch.Model_TBranch
uproot.models.TBranch.Model_TBranchElement_v8
uproot.models.TBranch.Model_TBranchElement_v9
uproot.models.TBranch.Model_TBranchElement_v10
uproot.models.TBranch.Model_TBranchElement
uproot.models.TBranch.Model_TBranchObject_v1
uproot.models.TBranch.Model_TBranchObject
uproot.models.TClonesArray (module)
uproot.models.TClonesArray.Model_TClonesArray
uproot.models.TDatime (module)
uproot.models.TDatime.Model_TDatime
uproot.models.TGraph (module)
uproot.models.TGraph.Model_TGraph_v4
uproot.models.TGraph.Model_TGraph
uproot.models.TGraph.Model_TGraphErrors_v3
uproot.models.TGraph.Model_TGraphErrors
uproot.models.TGraph.Model_TGraphAsymmErrors_v3
uproot.models.TGraph.Model_TGraphAsymmErrors
uproot.models.TH (module)
uproot.models.TH.Model_TAxis_v10
uproot.models.TH.Model_TAxis
uproot.models.TH.Model_TH1_v8
uproot.models.TH.Model_TH1
uproot.models.TH.Model_TH2_v5
uproot.models.TH.Model_TH2
uproot.models.TH.Model_TH3_v6
uproot.models.TH.Model_TH3
uproot.models.TH.Model_TH1C_v3
uproot.models.TH.Model_TH1C
uproot.models.TH.Model_TH1D_v3
uproot.models.TH.Model_TH1D
uproot.models.TH.Model_TH1F_v3
uproot.models.TH.Model_TH1F
uproot.models.TH.Model_TH1I_v3
uproot.models.TH.Model_TH1I
uproot.models.TH.Model_TH1S_v3
uproot.models.TH.Model_TH1S
uproot.models.TH.Model_TH2C_v4
uproot.models.TH.Model_TH2C
uproot.models.TH.Model_TH2D_v4
uproot.models.TH.Model_TH2D
uproot.models.TH.Model_TH2F_v4
uproot.models.TH.Model_TH2F
uproot.models.TH.Model_TH2I_v4
uproot.models.TH.Model_TH2I
uproot.models.TH.Model_TH2S_v4
uproot.models.TH.Model_TH2S
uproot.models.TH.Model_TH3C_v4
uproot.models.TH.Model_TH3C
uproot.models.TH.Model_TH3D_v4
uproot.models.TH.Model_TH3D
uproot.models.TH.Model_TH3F_v4
uproot.models.TH.Model_TH3F
uproot.models.TH.Model_TH3I_v4
uproot.models.TH.Model_TH3I
uproot.models.TH.Model_TH3S_v4
uproot.models.TH.Model_TH3S
uproot.models.TH.Model_TProfile_v7
uproot.models.TH.Model_TProfile
uproot.models.TH.Model_TProfile2D_v8
uproot.models.TH.Model_TProfile2D
uproot.models.TH.Model_TProfile3D_v8
uproot.models.TH.Model_TProfile3D
uproot.models.THashList (module)
uproot.models.THashList.Model_THashList
uproot.models.TLeaf (module)
uproot.models.TLeaf.Model_TLeaf_v2
uproot.models.TLeaf.Model_TLeaf
uproot.models.TLeaf.Model_TLeafO_v1
uproot.models.TLeaf.Model_TLeafO
uproot.models.TLeaf.Model_TLeafB_v1
uproot.models.TLeaf.Model_TLeafB
uproot.models.TLeaf.Model_TLeafS_v1
uproot.models.TLeaf.Model_TLeafS
uproot.models.TLeaf.Model_TLeafI_v1
uproot.models.TLeaf.Model_TLeafI
uproot.models.TLeaf.Model_TLeafG_v1
uproot.models.TLeaf.Model_TLeafG
uproot.models.TLeaf.Model_TLeafL_v1
uproot.models.TLeaf.Model_TLeafL
uproot.models.TLeaf.Model_TLeafF_v1
uproot.models.TLeaf.Model_TLeafF
uproot.models.TLeaf.Model_TLeafD_v1
uproot.models.TLeaf.Model_TLeafD
uproot.models.TLeaf.Model_TLeafC_v1
uproot.models.TLeaf.Model_TLeafC
uproot.models.TLeaf.Model_TLeafF16_v1
uproot.models.TLeaf.Model_TLeafF16
uproot.models.TLeaf.Model_TLeafD32_v1
uproot.models.TLeaf.Model_TLeafD32
uproot.models.TLeaf.Model_TLeafElement_v1
uproot.models.TLeaf.Model_TLeafElement
uproot.models.TList (module)
uproot.models.TList.Model_TList
uproot.models.TMatrixT (module)
uproot.models.TMatrixT.Model_TMatrixTSym_3c_double_3e__v5
uproot.models.TMatrixT.Model_TMatrixTSym_3c_double_3e
uproot.models.TNamed (module)
uproot.models.TNamed.Model_TNamed
uproot.models.TObjArray (module)
uproot.models.TObjArray.Model_TObjArray
uproot.models.TObjArray.Model_TObjArrayOfTBaskets
uproot.models.TObjString (module)
uproot.models.TObjString.Model_TObjString
uproot.models.TObject (module)
uproot.models.TObject.Model_TObject
uproot.models.TRef (module)
uproot.models.TRef.Model_TRef
uproot.models.TRef.Model_TRefArray
uproot.models.TString (module)
uproot.models.TString.Model_TString
uproot.models.TTable (module)
uproot.models.TTable.Model_TDataSet
uproot.models.TTable.EColumnType
uproot.models.TTable.Model_TTableDescriptor_v4
uproot.models.TTable.Model_TTableDescriptor
uproot.models.TTable.Model_TTable_v4
uproot.models.TTable.Model_TTable
uproot.models.TTable.tableDescriptor_st
uproot.models.TTime (module)
uproot.models.TTime.Model_TTime_v2
uproot.models.TTree (module)
uproot.models.TTree.Model_TTree_v16
uproot.models.TTree.Model_TTree_v17
uproot.models.TTree.Model_TTree_v18
uproot.models.TTree.Model_TTree_v19
uproot.models.TTree.Model_TTree_v20
uproot.models.TTree.Model_TTree
uproot.models.TTree.Model_ROOT_3a3a_TIOFeatures
uproot.models.TTree.Model_TTree_NumEntries
uproot.models.TTree.num_entries

exceptions

uproot.exceptions (module)
uproot.exceptions.NameConflictWarning
uproot.exceptions.KeyInFileError

Uproot

uproot.models.THashList

uproot.models.THashList

This module defines a versionless model for THashList.

Previous Next

Built with Sphinx using a theme provided by Read the Docs.