uproot 5.6.2__tar.gz → 5.6.3__tar.gz

{uproot-5.6.2 → uproot-5.6.3}/.github/workflows/deploy.yml

@@ -38,7 +38,7 @@ jobs:
         run: ls -lha dist/
 
       - name: Generate artifact attestation for sdist and wheel
-        uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd # v2.3.0
+        uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be # v2.4.0
         with:
           subject-path: dist/uproot-*
 

{uproot-5.6.2 → uproot-5.6.3}/.pre-commit-config.yaml

@@ -1,6 +1,7 @@
 ci:
   autoupdate_commit_msg: 'chore: update pre-commit hooks'
   autofix_commit_msg: 'style: pre-commit fixes'
+  autoupdate_schedule: monthly
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -23,20 +24,20 @@ repos:
       - id: black
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.9
+    rev: v0.12.2
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]
 
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.20.0
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
 
   - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    rev: v2.14.0
+    rev: v2.15.0
     hooks:
       - id: pretty-format-toml
         args: [--autofix]

{uproot-5.6.2 → uproot-5.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uproot
-Version: 5.6.2
+Version: 5.6.3
 Summary: ROOT I/O in pure Python and NumPy.
 Project-URL: Download, https://github.com/scikit-hep/uproot5/releases
 Project-URL: Homepage, https://github.com/scikit-hep/uproot5
@@ -37,6 +37,10 @@ Requires-Dist: numpy
 Requires-Dist: packaging
 Requires-Dist: typing-extensions>=4.1.0; python_version < '3.11'
 Requires-Dist: xxhash
+Provides-Extra: gds-cu11
+Requires-Dist: kvikio-cu11>=25.02.01; extra == 'gds-cu11'
+Provides-Extra: gds-cu12
+Requires-Dist: kvikio-cu12>=25.02.01; extra == 'gds-cu12'
 Provides-Extra: http
 Requires-Dist: aiohttp; extra == 'http'
 Provides-Extra: s3

{uproot-5.6.2 → uproot-5.6.3}/docs-sphinx/basic.rst

@@ -919,6 +919,52 @@ Like the caches, the default values for the last two are global ``uproot.decompr
 
 If, however, you're working in an environment that puts limits on parallel processing (e.g. the CMS LPC or informal university computers), you may want to modify the defaults, either locally through a ``decompression_executor`` or ``interpretation_executor`` function parameter, or globally by replacing the global object.
 
+Reading RNTuples
+----------------
+
+TTree has been the default format to store large datasets in ROOT files for decades. However, it has slowly become outdated and is not optimized for modern systems. This is where the RNTuple format comes in. It is a modern serialization format that is designed with modern systems in mind and is planned to replace TTree in the coming years. `Version 1.0.0.0 <https://cds.cern.ch/record/2923186>`__ is out and will be supported "forever".
+
+RNTuples are deliberately simpler than TTrees by design. For the first time, there’s an official specification, making it much easier for third-party I/O tools like Uproot to support it. Uproot already supports reading the full RNTuple specification, meaning that you can read any RNTuple you find in the wild. It also already supports writing a large part of the specification, and intends to support as much as it makes sense for data analysis.
+
+To ease the transition into RNTuples, we are designing the interface to closely match the existing TTree interface. Many of the functionality explained in the previous subsections works in the same way. However, there the terminology is slightly different (e.g. "branch" becomes "field") and arguments may vary slightly, accordingly.
+
+Let's look at a few examples that illustrate how the RNTuple interface works.
+
+When inspecting a file, will have a clear indication that it contains an RNTuple.
+
+.. code-block:: python
+
+    >>> file = uproot.open("https://raw.githubusercontent.com/scikit-hep/scikit-hep-testdata/refs/heads/main/src/skhep_testdata/data/ntpl001_staff_rntuple_v1-0-0-0.root")
+    >>> file.classnames()
+    {'Staff;1': 'ROOT::RNTuple'}
+
+Inspecting the contents of an RNTuple is done in the same way.
+
+.. code-block:: python
+
+    >>> rntuple = uproot.open("https://raw.githubusercontent.com/scikit-hep/scikit-hep-testdata/refs/heads/main/src/skhep_testdata/data/ntpl001_staff_rntuple_v1-0-0-0.root:Staff")
+    >>> rntuple.keys()
+    ['Category', 'Flag', 'Age', 'Service', 'Children', 'Grade', 'Step', 'Hrweek', 'Cost', 'Division', 'Nation']
+    >>> rntuple.typenames()
+    {'Category': 'std::int32_t', 'Flag': 'std::uint32_t', 'Age': 'std::int32_t', 'Service': 'std::int32_t', 'Children': 'std::int32_t', 'Grade': 'std::int32_t', 'Step': 'std::int32_t',
+     'Hrweek': 'std::int32_t', 'Cost': 'std::int32_t', 'Division': 'std::string', 'Nation': 'std::string'}
+
+Reading the content of a single or multiple fields into an array also works very similarly.
+
+.. code-block:: python
+
+    >>> rntuple = uproot.open("https://raw.githubusercontent.com/scikit-hep/scikit-hep-testdata/refs/heads/main/src/skhep_testdata/data/ntpl001_staff_rntuple_v1-0-0-0.root:Staff")
+    >>> rntuple["Age"].array()
+    <Array [58, 63, 56, 61, 52, 60, ..., 51, 25, 35, 28, 43] type='3354 * int32'>
+    >>> rntuple.arrays(["Age", "Cost", "Nation"])
+    <Array [{Age: 58, Cost: 11975, ...}, ...] type='3354 * {Age: int32, Cost: i...'>
+    >>> rntuple.arrays(filter_field=lambda f: f.field_id % 2 == 1)
+    <Array [{Flag: 15, Service: 28, ...}, ...] type='3354 * {Flag: uint32, Serv...'>
+
+Note that for the last input we used the ``filter_field`` argument instead of ``filter_branch`` since the latter terminology doesn't apply to RNTuples.
+
+There are still significant work required to achieve feature-parity with TTrees, but all the basic functionality is already implemented. We will continue to make the transition to RNTuples as seamless as possible.
+
 Opening a file for writing
 --------------------------
 
@@ -1251,3 +1297,17 @@ In addition, each TBranch of the TTree can have a different compression setting:
     {'x': None, 'ny': None, 'y': ZLIB(4)}
 
 Changes to the compression setting only affect TBaskets written after the change (with :ref:`uproot.writing.writable.WritableTree.extend`; see above).
+
+Writing RNTuples
+----------------
+
+Just like with reading, writing RNTuples is similar to writing TTree objects. Since RNTuples are much simpler, we aim to be able to write almost any RNTuple that you might want.
+
+Here is an example of writing an RNTuple. Since TTree is still the default format for the near future, writing an RNTuple is a bit more verbose.
+
+.. code-block:: python
+
+    >>> file = uproot.recreate("example.root")
+    >>> data = {"my_int": [1,2], "my_vector": [[1,2], [3,4,5]]}
+    >>> rntuple = file.mkrntuple("my_rntuple", data)
+    >>> rntuple.extend(data) # Can be extended, just like TTrees

{uproot-5.6.2 → uproot-5.6.3}/pyproject.toml

@@ -36,6 +36,10 @@ test-core = [
   "pytest>=6",
   "scikit-hep-testdata"
 ]
+test-gpu = [
+  "kvikio-cu12>=25.02.01",
+  {include-group = "test-core"}
+]
 test-pyodide = [
   "pytest-pyodide; python_version >='3.11'",
   {include-group = "test-core"}
@@ -91,6 +95,12 @@ readme = "README.md"
 requires-python = ">=3.9"
 
 [project.optional-dependencies]
+GDS_cu11 = [
+  "kvikio-cu11>=25.02.01"
+]
+GDS_cu12 = [
+  "kvikio-cu12>=25.02.01"
+]
 http = ["aiohttp"]
 s3 = ["s3fs"]
 xrootd = ["fsspec-xrootd>=0.5.0"]
@@ -131,6 +141,7 @@ xfail_strict = true
 [tool.ruff]
 exclude = [
   "tests/*.py",
+  "tests-cuda/*.py",
   "src/uproot/__init__.py",
   "docs-sphinx/*.py"
 ]
@@ -148,7 +159,9 @@ ignore = [
   "S307",  # no eval allowed
   "PLC1901",  # empty string is falsey (but I don't want to rely on such weak typing)
   "RUF012",  # enforces type annotations on a codebase that lacks type annotations
-  "SIM103"  # interferes with my if-elif-elif-else blocks
+  "SIM103",  # interferes with my if-elif-elif-else blocks
+  "PLC0415",  # imports outside top level
+  "PLW1641"  # __eq__ without __hash__
 ]
 select = [
   "E",

{uproot-5.6.2 → uproot-5.6.3}/src/uproot/_util.py

@@ -1030,3 +1030,26 @@ class _Unset:
 
 
 unset = _Unset()
+
+
+def get_array_library(arr):
+    """
+    Determine if an array is a NumPy or CuPy ndarray, without importing CuPy.
+
+    Args:
+        arr: The array to check.
+
+    Returns:
+        String: 'numpy' if it's a NumPy array, 'cupy' if it's a CuPy array,
+        'awkward' if it's an Awkward array, and 'unknown' otherwise.
+    """
+    module_name = type(arr).__module__
+
+    if module_name.startswith("numpy"):
+        return "numpy"
+    elif module_name.startswith("cupy"):
+        return "cupy"
+    elif module_name.startswith("awkward"):
+        return "awkward"
+    else:
+        return "unknown"