uproot-custom 2.1.0__tar.gz → 2.2.0__tar.gz

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/.clang-format

@@ -1,13 +1,14 @@
+---
 # This .clang_format file is derectly copied from Gaudi project.
 ---
-Language:        Cpp
-BasedOnStyle:  Google
+Language: Cpp
+BasedOnStyle: Google
 AccessModifierOffset: -2
 AlignAfterOpenBracket: Align
 AlignConsecutiveAssignments: true
 AlignConsecutiveDeclarations: false
 AlignEscapedNewlines: Right
-AlignOperands:   true
+AlignOperands: true
 AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: true
 AllowShortBlocksOnASingleLine: Always
@@ -22,18 +23,18 @@ AlwaysBreakTemplateDeclarations: true
 BinPackArguments: true
 BinPackParameters: true
 BraceWrapping:
-  AfterClass:      false
+  AfterClass: false
   AfterControlStatement: true
-  AfterEnum:       false
-  AfterFunction:   false
-  AfterNamespace:  false
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
   AfterObjCDeclaration: false
-  AfterStruct:     false
-  AfterUnion:      false
+  AfterStruct: false
+  AfterUnion: false
   AfterExternBlock: false
-  BeforeCatch:     false
-  BeforeElse:      true
-  IndentBraces:    false
+  BeforeCatch: false
+  BeforeElse: true
+  IndentBraces: false
   SplitEmptyFunction: false
   SplitEmptyRecord: false
   SplitEmptyNamespace: false
@@ -45,39 +46,39 @@ BreakConstructorInitializersBeforeComma: true
 BreakConstructorInitializers: BeforeComma
 BreakAfterJavaFieldAnnotations: false
 BreakStringLiterals: true
-ColumnLimit:     95
-CommentPragmas:  '^ IWYU pragma:'
+ColumnLimit: 95
+CommentPragmas: '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 ConstructorInitializerIndentWidth: 4
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true
 DerivePointerAlignment: false
-DisableFormat:   false
+DisableFormat: false
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
 ForEachMacros:
   - foreach
   - Q_FOREACH
   - BOOST_FOREACH
-IncludeBlocks:   Preserve
+IncludeBlocks: Preserve
 IncludeCategories:
-  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
-    Priority:        2
-  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
-    Priority:        3
-  - Regex:           '.*'
-    Priority:        1
-IncludeIsMainRegex: '(Test)?$'
+  - Regex: ^"(llvm|llvm-c|clang|clang-c)/
+    Priority: 2
+  - Regex: ^(<|"(gtest|gmock|isl|json)/)
+    Priority: 3
+  - Regex: .*
+    Priority: 1
+IncludeIsMainRegex: (Test)?$
 IndentCaseLabels: false
 IndentPPDirectives: AfterHash
-IndentWidth:     4
+IndentWidth: 4
 IndentWrappedFunctionNames: false
 JavaScriptQuotes: Leave
 JavaScriptWrapImports: true
 KeepEmptyLinesAtTheStartOfBlocks: true
 MacroBlockBegin: ''
-MacroBlockEnd:   ''
+MacroBlockEnd: ''
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: All
 ObjCBinPackProtocolList: Auto
@@ -93,8 +94,8 @@ PenaltyBreakTemplateDeclaration: 10
 PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 60
 PointerAlignment: Left
-ReflowComments:  true
-SortIncludes:    CaseSensitive
+ReflowComments: true
+SortIncludes: CaseSensitive
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterTemplateKeyword: true
@@ -106,22 +107,21 @@ SpaceBeforeParens: ControlStatements
 SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 1
-SpacesInAngles:  false
+SpacesInAngles: false
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
 SpacesInParentheses: true
-Standard:        c++11
-TabWidth:        8
-UseTab:          Never
+Standard: c++11
+TabWidth: 8
+UseTab: Never
 ---
-Language:        Json
-IndentWidth:     4
-ColumnLimit:     95
+Language: Json
+IndentWidth: 4
+ColumnLimit: 95
 ---
-Language:        JavaScript
-ColumnLimit:     95
+Language: JavaScript
+ColumnLimit: 95
 ---
 Language: ObjC
 # Don't format Objective-C, Objective-C++ files.
 DisableFormat: true
-...

uproot_custom-2.2.0/.github/workflows/build-wheels.yml

@@ -0,0 +1,44 @@
+name: Build wheels
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  test-package:
+    uses: ./.github/workflows/test-package.yml
+
+  build-wheels:
+    needs: test-package
+    runs-on: ${{ matrix.os }}
+    name: Build wheels on ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.1.3
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: ci-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build-sdist:
+    needs: test-package
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ci-sdist
+          path: dist/*.tar.gz

uproot_custom-2.2.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,34 @@
+name: Deploy docs
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen
+          uv sync --group=docs
+
+      - name: Build docs
+        run: |
+          sphinx-build -b html docs/ build/html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/html

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/.github/workflows/semantic-pr-titles.yml

@@ -1,4 +1,4 @@
-name: 'Lint PR'
+name: Lint PR
 
 on:
   pull_request_target:

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/.github/workflows/test-package.yml

@@ -1,4 +1,4 @@
-name: Run pytest
+name: Test package
 
 on:
   push:
@@ -16,20 +16,20 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
-        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .[dev]
+          uv lock --upgrade
+          uv sync --all-extras
 
       - name: Run pytest
         run: |
@@ -41,17 +41,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.13"
+          python-version: '3.13'
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .[docs]
           sudo apt-get update
           sudo apt-get install -y doxygen
+          uv lock --upgrade
+          uv sync --all-extras
 
       - name: Build docs
         run: |

uproot_custom-2.2.0/.github/workflows/weekly-build.yml

@@ -0,0 +1,10 @@
+name: Weekly build
+
+on:
+  schedule:
+    - cron: 0 12 * * 5    # Runs every Friday at 20:00 Beijing time
+  workflow_dispatch:
+
+jobs:
+  weekly-build:
+    uses: ./.github/workflows/build-wheels.yml

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/.gitignore

@@ -182,9 +182,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 .vscode/
 
@@ -206,4 +206,4 @@ marimo/_static/
 marimo/_lsp/
 __marimo__/
 
-_version.py
+_version.py

uproot_custom-2.2.0/.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+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
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+        exclude: |
+          (?x)^(
+            \.clang-format
+          )
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 26.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.14
+    hooks:
+      - id: ruff-check
+        args: [--fix, --show-fixes]
+
+  - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+    rev: v2.16.0
+    hooks:
+      - id: pretty-format-toml
+        args: [--autofix]
+      - id: pretty-format-yaml
+        args: [--autofix, --indent, '2', --offset, '2']

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: uproot-custom
-Version: 2.1.0
+Version: 2.2.0
 Summary: uproot extension for reading custom classes
 Author-Email: Mingrun Li <mrli@ihep.ac.cn>
 Classifier: Development Status :: 3 - Alpha
@@ -30,39 +30,23 @@ Requires-Python: <3.14,>=3.9
 Requires-Dist: uproot>=5.6.7
 Requires-Dist: numpy
 Requires-Dist: awkward>=2.8.0
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
-Requires-Dist: dask[complete]; extra == "dev"
-Requires-Dist: dask-awkward; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: sphinx>=8.2; extra == "docs"
-Requires-Dist: sphinx-book-theme; extra == "docs"
-Requires-Dist: myst_parser; extra == "docs"
-Requires-Dist: sphinx-design; extra == "docs"
-Requires-Dist: sphinx-copybutton; extra == "docs"
-Requires-Dist: sphinxext-rediraffe; extra == "docs"
-Requires-Dist: sphinxext-opengraph; extra == "docs"
-Requires-Dist: sphinx-tippy; extra == "docs"
-Requires-Dist: sphinx-togglebutton; extra == "docs"
-Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinx-intl; extra == "docs"
-Requires-Dist: breathe; extra == "docs"
 Description-Content-Type: text/markdown
 
 # Introduction
 
-`uproot-custom` is an extension of [`uproot`](https://uproot.readthedocs.io/en/latest/basic.html) that provides an enhanced way to read custom classes stored in `TTree`.
+Uproot-custom is an extension of [Uproot](https://uproot.readthedocs.io/en/latest/basic.html) that provides an enhanced way to read custom classes stored in `TTree`.
 
-## When to use `uproot-custom`
+## What uproot-custom can do
 
-`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`.
+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, so that users can read their custom classes seamlessly.
 
-## How `uproot-custom` works
+## When to use uproot-custom
 
-`uproot-custom` uses a `reader`/`factory` mechanism to read classes:
+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:
 
 ```mermaid
 flowchart TD
@@ -90,14 +74,14 @@ flowchart TD
 - `reader` is a C++ class that implements the logic to read data from binary buffers.
 - `factory` is a Python class that creates, combines `reader`s, and post-processes the data read by `reader`s.
 
-This machanism is implemented as `uproot_custom.AsCustom` interpretation. `uproot-custom` wraps `uproot.interpretation.identify.interpretation_of` method to intercept the interpretation of specific branches. This makes `uproot-custom` well compatible with `uproot`.
+This machanism is implemented basing on `uproot_custom.AsCustom` interpretation. This makes uproot-custom well compatible with Uproot.
 
 > [!TIP]
-> Users can implement their own `factory` and `reader`, register them to `uproot-custom`. An example of implementing a custom `factory`/`reader` can be found in [the repository](https://github.com/mrzimu/uproot-custom/tree/main/example).
+> Users can implement their own `factory` and `reader`, register them to uproot-custom. An example of implementing a custom `factory`/`reader` can be found in [the example repository](https://github.com/mrzimu/uproot-custom-example).
 
 > [!NOTE]
-> `uproot-custom` does not provide a full reimplementation of `ROOT`'s I/O system. Users are expected to implement their own `factory`/`reader` for their custom classes that built-in factories cannot handle.
+> Uproot-custom does not provide a full reimplementation of `ROOT`'s I/O system. Users are expected to implement their own `factory`/`reader` for their custom classes that built-in factories cannot handle.
 
 ## Documentation
 
-View the [documentation](https://mrzimu.github.io/uproot-custom/) for more details about customizing your own `reader`/`factory`, and the architecture of `uproot-custom`.
+View the [documentation](https://mrzimu.github.io/uproot-custom/) 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).

uproot_custom-2.2.0/README.md

@@ -0,0 +1,53 @@
+# Introduction
+
+Uproot-custom is an extension of [Uproot](https://uproot.readthedocs.io/en/latest/basic.html) that provides an enhanced way to read custom classes stored in `TTree`.
+
+## 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, so that users can read their custom classes seamlessly.
+
+## 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:
+
+```mermaid
+flowchart TD
+    subgraph py["Python field"]
+        direction TB
+        AsCustom --> fac["Factory (Primitive, STLVector, TString, ...)"]
+        fac["Factory (Primitive, STLVector, TString, ...)"] -- Optional --> form(["construct awkward forms"])
+        fac --> build_reader(["build corresponding C++ reader"])
+        fac --> build_ak(["construct awkward arrays"])
+    end
+
+    user_fac["User's Factory"] -. Register .-> fac
+
+    subgraph cpp["C++ field"]
+        direction TB
+        build_reader --> reader["C++ 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 C++ class that implements the logic to read data from binary buffers.
+- `factory` is a Python class that creates, combines `reader`s, and post-processes the data read by `reader`s.
+
+This machanism is implemented basing on `uproot_custom.AsCustom` interpretation. This makes uproot-custom well compatible with Uproot.
+
+> [!TIP]
+> Users can implement their own `factory` and `reader`, register them to uproot-custom. An example of implementing a custom `factory`/`reader` can be found in [the example repository](https://github.com/mrzimu/uproot-custom-example).
+
+> [!NOTE]
+> Uproot-custom does not provide a full reimplementation of `ROOT`'s I/O system. Users are expected to implement their own `factory`/`reader` for their custom classes that built-in factories cannot handle.
+
+## Documentation
+
+View the [documentation](https://mrzimu.github.io/uproot-custom/) 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).

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/cpp/CMakeLists.txt

@@ -49,4 +49,4 @@ if(DEFINED SKBUILD_PROJECT_NAME)
             ${CMAKE_CURRENT_BINARY_DIR}/uproot-customConfigVersion.cmake
         DESTINATION ${SKBUILD_PROJECT_NAME}/share/cmake/
     )
-endif()
+endif()

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/cpp/include/uproot-custom/uproot-custom.hh

@@ -356,22 +356,15 @@ namespace uproot {
         }
 
         /**
-         * @brief Read multiple elements from the buffer in member-wise fashion. This method
-         * checks for negative count and calls @ref read_many() by default. It can be
-         * overridden to handle member-wise reading more efficiently.
+         * @brief Read multiple elements from the buffer in member-wise fashion. Readers
+         * that need to handle member-wise data reading must implement this method.
          *
          * @param buffer The binary buffer to read from.
          * @param count Number of elements to read.
          * @return Number of elements read.
          */
         virtual uint32_t read_many_memberwise( BinaryBuffer& buffer, const int64_t count ) {
-            if ( count < 0 )
-            {
-                std::stringstream msg;
-                msg << name() << "::read_many_memberwise with negative count: " << count;
-                throw std::runtime_error( msg.str() );
-            }
-            return read_many( buffer, count );
+            throw std::runtime_error( name() + "::read_many_memberwise is not implemented." );
         }
     };
 

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/cpp/src/uproot-custom.cc

@@ -116,7 +116,8 @@ namespace uproot {
         /**
          * @brief Read a TObject from the buffer. A TObject contains `fVersion` (int16_t),
          * `fUniqueID` (int32_t), `fBits` (uint32_t). If `fBits & kIsReferenced`, then a `pidf`
-         * (uint16_t) follows. @n If @ref m_keep_data is true, the read data will be stored.
+         * (uint16_t) follows. If @ref m_keep_data is true, the read data
+         * will be stored.
          *
          * @param buffer The binary buffer to read from
          */
@@ -365,11 +366,11 @@ namespace uproot {
                                               "supported when with_header is true!" );
 
                 auto fNBytes       = buffer.read_fNBytes();
+                auto end_pos       = buffer.get_cursor() + fNBytes;
                 auto fVersion      = buffer.read_fVersion();
                 bool is_memberwise = fVersion & kStreamedMemberWise;
                 check_objwise_memberwise( is_memberwise );
                 if ( is_memberwise ) buffer.skip( 2 );
-                auto end_pos = buffer.get_cursor() + fNBytes - 2; //
 
                 uint32_t cur_count = 0;
                 while ( buffer.get_cursor() < end_pos )
@@ -1038,13 +1039,14 @@ namespace uproot {
          * @param buffer The binary buffer to read from.
          */
         void read( BinaryBuffer& buffer ) override {
-            auto nbytes  = buffer.read_fNBytes();
-            auto end_pos = buffer.get_cursor() + nbytes;
+            auto nbytes    = buffer.read_fNBytes();
+            auto start_pos = buffer.get_cursor();
+            auto end_pos   = buffer.get_cursor() + nbytes;
 
             auto fTag = buffer.read<int32_t>();
-            if ( fTag == -1 ) { auto fTypename = buffer.read_null_terminated_string(); }
+            if ( fTag == kNewClassTag )
+            { auto fTypename = buffer.read_null_terminated_string(); }
 
-            auto start_pos = buffer.get_cursor();
             m_element_reader->read( buffer );
 
             if ( buffer.get_cursor() != end_pos )
@@ -1109,7 +1111,7 @@ namespace uproot {
                           m_flat_size );
             debug_printf( buffer );
 
-            if ( m_flat_size > 0 ) { m_element_reader->read_many( buffer, m_flat_size ); }
+            if ( m_flat_size >= 0 ) { m_element_reader->read_many( buffer, m_flat_size ); }
             else
             {
                 // get end-position
@@ -1178,7 +1180,7 @@ namespace uproot {
          * m_element_reader. Otherwise, return a tuple contains: (offsets, elements_data).
          */
         py::object data() const override {
-            if ( m_flat_size > 0 ) return m_element_reader->data();
+            if ( m_flat_size >= 0 ) return m_element_reader->data();
             else
             {
                 auto offsets_array = make_array( m_offsets );

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/docs/conf.py

@@ -2,6 +2,8 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import sys
+from pathlib import Path
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -69,9 +71,6 @@ gettext_compact = False  # Do not compact message files
 language = "en"  # Default language
 
 # -- Options for autodoc ---------------------------------------------------------
-import sys
-from pathlib import Path
-
 sys.path.insert(0, str(Path(__file__).parent.parent.resolve()))
 
 apidoc_modules = [
@@ -121,7 +120,6 @@ sys.path.insert(0, str(Path(__file__).parent.parent.resolve() / "doxygen" / "xml
 def run_doxygen():
     """Run the doxygen make command in the designated folder."""
     import subprocess
-    import os
 
     doxygen_file = Path(__file__).parent / "Doxyfile"
     working_dir = doxygen_file.parent

{uproot_custom-2.1.0 → uproot_custom-2.2.0}/docs/example/override-streamer.md

@@ -1,10 +1,14 @@
 # Example 1: `Streamer` method is overridden
 
+Goal: handle a class whose `Streamer` overrides the default layout by inserting
+an extra mask. We will inspect the bytes, write a C++ reader, wrap it with a
+factory, register it, then read with Uproot.
+
 ```{seealso}
-A full example can be found in the `example` directory of [this repo](https://github.com/mrzimu/uproot-custom/tree/main/example).
+A full example can be found in the [example repository](https://github.com/mrzimu/uproot-custom-example).
 ```
 
-We define a demo class `TOverrideStreamer` whose `Streamer` method is overridden to show how to read such classes using `uproot-custom`.
+We define a demo class `TOverrideStreamer` whose `Streamer` method is overridden to show how to read such classes using uproot-custom.
 
 There are 2 member variables in `TOverrideStreamer`: `m_int` and `m_double`:
 
@@ -35,7 +39,7 @@ We add a mask in the `Streamer` method to demonstrate how to handle special logi
 ```{code-block} cpp
 ---
 caption: `TOverrideStreamer.cc`
-emphasize-lines: 16-23, 31-32 
+emphasize-lines: 16-23, 31-32
 ---
 #include <TBuffer.h>
 #include <TObject.h>
@@ -281,7 +285,7 @@ Refer to [awkward forms](https://awkward-array.org/doc/main/reference/generated/
 
 ## Step 4: Register target branch and the `factory`
 
-Finally, we need to register the branch we want to read with `uproot-custom`, and also register the `OverrideStreamerFactory` so that it can be used by `uproot-custom`. 
+Finally, we need to register the branch we want to read with uproot-custom, and also register the `OverrideStreamerFactory` so that it can be used by uproot-custom.
 
 We can do this by adding the following code in the `__init__.py` of your package:
 
@@ -295,9 +299,9 @@ AsCustom.target_branches |= {
 registered_factories.add(OverrideStreamerFactory)
 ```
 
-## Step 5: Read data with `uproot`
+## Step 5: Read data with Uproot
 
-Now we can read the data using `uproot` as usual:
+Now we can read the data using Uproot as usual:
 
 ```python
 >>> b = uproot.open("demo_data.root")["my_tree:override_streamer"]