The :pyuproot3.rootio
module contains everything needed to navigate through a ROOT file and extract inert, data-only objects. Methods for those objects are defined in other modules. The :pyuproot3.open <uproot3.rootio.open>
function returns a :pyROOTDirectory <uproot3.rootio.ROOTDirectory>
object, which is a handle into the file, from which all other data can be accessed.
This module has many more classes than those documented here, but all but a few are considered internal details. The classes documented below represent the public API. In fact, only :pyROOTDirectory <uproot3.rootio.ROOTDirectory>
has useful attributes and methods for a typical user. The other two, :pyROOTObject <uproot3.rootio.ROOTObject>
and :pyROOTStreamedObject <uproot3.rootio.ROOTStreamedObject>
, are documented because they are superclasses of all objects that could be extracted from a ROOT file, and may be useful in isinstance
checks.
uproot3.rootio.ROOTDirectory ---------------------------
Although :pyROOTDirectory <uproot3.rootio.ROOTDirectory>
resembles ROOT's TFile, TDirectory, and TFileDirectory to some degree, it does not have a direct relationship to any of them. (This is because we adopted a different model for representing the contents of a ROOT file: purely acyclic with continuation passing.) As a result, :pyROOTDirectory <uproot3.rootio.ROOTDirectory>
is not a :pyROOTObject <uproot3.rootio.ROOTObject>
and isn't named "TFile."
A :pyROOTDirectory <uproot3.rootio.ROOTDirectory>
may represent a whole ROOT file or a single TDirectory within that file--- after reading, there is no difference.
uproot3.rootio.ROOTDirectory
uproot3.rootio.ROOTDirectory.get
uproot3.rootio.ROOTDirectory.iterkeys
uproot3.rootio.ROOTDirectory.itervalues
uproot3.rootio.ROOTDirectory.iteritems
uproot3.rootio.ROOTDirectory.iterclasses
uproot3.rootio.ROOTDirectory.keys
uproot3.rootio.ROOTDirectory.values
uproot3.rootio.ROOTDirectory.items
uproot3.rootio.ROOTDirectory.classes
uproot3.rootio.ROOTDirectory.allkeys
uproot3.rootio.ROOTDirectory.allvalues
uproot3.rootio.ROOTDirectory.allitems
uproot3.rootio.ROOTDirectory.allclasses
uproot3.rootio.ROOTObject ------------------------
uproot3.rootio.ROOTObject
uproot3.rootio.ROOTStreamedObject --------------------------------
uproot3.rootio.ROOTStreamedObject