uproot.XRootDSource

Defined in uproot.source.xrootd on line 259.

Inheritance order:
uproot.source.chunk.Source

class uproot.source.xrootd.XRootDSource(file_path: str, **options)

Parameters:

file_path (str) – A URL of the file to open.
options – Must include "timeout", "max_num_elements", "use_threads", and "num_workers"

A uproot.source.chunk.Source that uses XRootD’s vector-read to get many chunks in one request.

resource

XRootDSource.resource: The uproot.source.xrootd.XRootDResource object.

timeout

XRootDSource.timeout: The timeout in seconds or None.

file

XRootDSource.file: The XRootD.client.File object.

chunk

Inherited from uproot.source.chunk.Source.

XRootDSource.chunk(start: int, stop: int) → Chunk

Parameters:

start (int) – Seek position of the first byte to include.
stop (int) – Seek position of the first byte to exclude (one greater than the last byte to include).

Request a byte range of data from the file as a uproot.source.chunk.Chunk.

chunks

Inherited from uproot.source.chunk.Source.

XRootDSource.chunks(ranges: list[int, int], notifications: Queue) → list[Chunk]

Parameters:

ranges (list of (int, int) 2-tuples) – Intervals to fetch as (start, stop) pairs in a single request, if possible.
notifications (queue.Queue) – Indicator of completed chunks. After each gets filled, it is put on the queue; a listener should get from this queue len(ranges) times.

Request a set of byte ranges from the file.

This method has two outputs:

The method returns a list of unfilled uproot.source.chunk.Chunk objects, which get filled in a background thread. If you try to read data from an unfilled chunk, it will wait until it is filled.
The method also puts the same uproot.source.chunk.Chunk objects onto the notifications queue as soon as they are filled.

Reading data from chunks on the queue can be more efficient than reading them from the returned list. The total reading time is the same, but work on the filled chunks can be better parallelized if it is triggered by already-filled chunks, rather than waiting for chunks to be filled.