Skip to content

docs: clarify max_num_elements behavior #1682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sapunyangkut wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: clarify max_num_elements behavior #1682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d12b41b
docs: clarify max_num_elements behavior
sapunyangkut Jul 13, 2026
3b8153f
docs: clarify max_num_elements across entry points
sapunyangkut Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/uproot/_dask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,10 @@ def dask(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down
10 changes: 8 additions & 2 deletions src/uproot/behaviors/RNTuple.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,10 @@ def iterate(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down Expand Up @@ -318,7 +321,10 @@ def concatenate(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down
10 changes: 8 additions & 2 deletions src/uproot/behaviors/TBranch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,10 @@ def iterate(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down Expand Up @@ -370,7 +373,10 @@ def concatenate(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down
10 changes: 8 additions & 2 deletions src/uproot/reading.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@ def open(
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down Expand Up @@ -528,7 +531,10 @@ class ReadOnlyFile(CommonFileMethods):
* handler (:doc:`uproot.source.chunk.Source` class; None)
* timeout (float for HTTP, int for XRootD; 30)
* max_num_elements (None or int; None)
The maximum number of elements to be requested in a single vector read, when using XRootD.
The maximum number of byte ranges requested in a single XRootD vector
read. This does not limit the number of TTree or RNTuple entries read;
pass ``entry_stop`` to ``arrays``, ``uproot.iterate``, or
``uproot.concatenate`` instead.
* num_workers (int; 1)
* use_threads (bool; False on the emscripten platform (i.e. in a web browser), else True)
* num_fallback_workers (int; 10)
Expand Down