uproot-custom 2.3.0

uproot extension for reading custom classes

Introduction

Uproot-custom is an extension of Uproot that provides an enhanced way to read custom classes stored in TTree.

[!WARNING] Because of earlier mistakes in version management, the v2.x.x series should still be treated as a development version rather than a stable release.

What uproot-custom can do

Uproot-custom can natively read complicated combinations of nested classes and c-style arrays (e.g. map<int, map<int, map<int, string>>>, vector<TString>[3], etc), and memberwisely stored classes. It also exposes a way for users to implement their own readers for custom classes that are not supported by Uproot or uproot-custom built-in readers.

When to use uproot-custom

Uproot-custom aims to handle cases that classes are too complex for Uproot to read, such as when their Streamer methods are overridden or some specific data members are not supported by Uproot.

How uproot-custom works

Uproot-custom uses a Reader / Factory mechanism to read classes:

flowchart TD
    subgraph py["Python field"]
        direction TB
        AsCustom -- Recursively generate --> fac["Factory (Primitive, STLVector, TString, ...)"]
        fac["Factory (Primitive, STLVector, TString, ...)"] -- Optional --> form(["construct awkward forms"])
        fac --> build_reader(["build corresponding reader"])
        fac --> build_ak(["construct awkward arrays"])
    end

    subgraph reader_field["Reader (Python or C++)"]
        direction TB
        build_reader --> reader["Reader"]
        reader --> read_bin(["read binary data"])
        read_bin --> ret_data(["return data"])
    end

    ret_data --> raw_data[("tuple, list, numpy arrays, ...")]
    raw_data --> build_ak

• Reader is a class that implements the logic to read data from binary buffers. It can be written in Python (for development and debugging) or C++ (for production performance).
• Factory is a Python class that creates, combines Readers, and post-processes the data read by Readers.

This mechanism is implemented as AsCustom interpretation. This makes uproot-custom well compatible with Uproot.

[!TIP] Users can implement their own Factory and Reader, register them to uproot-custom. Start with a Python reader for rapid prototyping, then port the logic to C++ for production speed. The default reader backend is C++; during development, explicitly set the backend to Python. An example of implementing a custom Factory / Reader can be found in the example repository.

[!NOTE] Uproot-custom does not provide a full reimplementation of ROOT's TTree I/O system. Users are expected to implement their own Factory / Reader for their custom classes that built-in factories cannot handle.

System Requirements

• C++17 compatible compiler: Required for building C++ readers and the uproot-custom extension module. The CMake configuration sets CMAKE_CXX_STANDARD 17.
• Python 3.9+: Uproot-custom supports Python 3.9 through 3.13.

Documentation

View the documentation for more details about customizing your own reader/factory, the architecture of uproot-custom, and build-only dependencies (e.g., pybind11 is needed only at build time and should not be present in the runtime environment).