Physical layer interface

Jump to bottom Edit New page

Jim Pivarski edited this page Nov 3, 2020 · 8 revisions

In this wiki, I'll document the interface that Uproot expects from Source classes, such as HTTPSource and XRootDSource. This document only describes reading because only reading has been implemented (Nov 2020).

When a user opens a file with uproot4.open, the URL scheme determines which Source to use:

non-URL or "file://" defaults to MemmapSource, but MultithreadedFileSource is also a good option
"http://" and "https://" default to HTTPSource
"root://" defaults to XRootDSource
a non-string, non-Path object with read and seek methods is handled by ObjectSource.