uproot-custom 1.1.2__tar.gz → 1.1.3.dev1__tar.gz

uproot_custom-1.1.3.dev1/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.1.3
+
+- Support optionally keep `TObject` data by specifying `item_path` in `TObjectReader`.

{uproot_custom-1.1.2 → uproot_custom-1.1.3.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: uproot-custom
-Version: 1.1.2
+Version: 1.1.3.dev1
 Summary: uproot extension for reading custom classes
 Author-Email: Mingrun Li <mrli@ihep.ac.cn>
 Classifier: Development Status :: 3 - Alpha
@@ -106,7 +106,7 @@ Since embedding arrays together into `awkward` array in C++ is not straightforwa
 
 ### Full example
 
-A complete example of how to impolement your own readers is available in the `example` directory of this repository.
+A complete example of how to impolement your own readers is available in the [`example`](https://github.com/mrzimu/uproot-custom/tree/main/example) directory. You can also refer to the [Python part](https://github.com/mrzimu/uproot-custom/tree/main/uproot_custom/readers.py) and [C++ part](https://github.com/mrzimu/uproot-custom/tree/main/cpp/src/uproot-custom.cc) of predefined readers for implementation details.
 
 ### Pre-requisites
 
@@ -149,6 +149,9 @@ Make sure you have `GCC>13.1`/`Clang>=16.0.0`/`MSVC>=19.31`, `cmake` installed o
 
     you can change the `name`, `version`, and other fields as you like.
 
+    > [!WARNING]
+    > If you are releasing the project, specify concrete major and minor versions of `uproot-custom` to ensure the header files are compatible. For example, use `uproot-custom~=1.2` instead of `uproot-custom>=1.2` (may not be compatible with future versions).
+
 ### Reader interface
 
 For a custom `Reader`, a C++ part and a Python part are both required.

{uproot_custom-1.1.2 → uproot_custom-1.1.3.dev1}/README.md

@@ -69,7 +69,7 @@ Since embedding arrays together into `awkward` array in C++ is not straightforwa
 
 ### Full example
 
-A complete example of how to impolement your own readers is available in the `example` directory of this repository.
+A complete example of how to impolement your own readers is available in the [`example`](https://github.com/mrzimu/uproot-custom/tree/main/example) directory. You can also refer to the [Python part](https://github.com/mrzimu/uproot-custom/tree/main/uproot_custom/readers.py) and [C++ part](https://github.com/mrzimu/uproot-custom/tree/main/cpp/src/uproot-custom.cc) of predefined readers for implementation details.
 
 ### Pre-requisites
 
@@ -112,6 +112,9 @@ Make sure you have `GCC>13.1`/`Clang>=16.0.0`/`MSVC>=19.31`, `cmake` installed o
 
     you can change the `name`, `version`, and other fields as you like.
 
+    > [!WARNING]
+    > If you are releasing the project, specify concrete major and minor versions of `uproot-custom` to ensure the header files are compatible. For example, use `uproot-custom~=1.2` instead of `uproot-custom>=1.2` (may not be compatible with future versions).
+
 ### Reader interface
 
 For a custom `Reader`, a C++ part and a Python part are both required.

{uproot_custom-1.1.2 → uproot_custom-1.1.3.dev1}/cpp/src/uproot-custom.cc

@@ -65,8 +65,9 @@ namespace uproot {
     class TObjectReader : public IElementReader {
 
       public:
-        TObjectReader( std::string name )
+        TObjectReader( std::string name, bool keep_data )
             : IElementReader( name )
+            , m_keep_data( keep_data )
             , m_unique_id( std::make_shared<std::vector<int32_t>>() )
             , m_bits( std::make_shared<std::vector<uint32_t>>() )
             , m_pidf( std::make_shared<std::vector<uint16_t>>() )
@@ -75,18 +76,26 @@ namespace uproot {
         void read( BinaryBuffer& buffer ) override {
             buffer.skip_fVersion();
 
-            m_unique_id->push_back( buffer.read<int32_t>() );
-
-            auto fBits = buffer.read<uint32_t>();
-            m_bits->push_back( fBits );
+            auto fUniqueID = buffer.read<int32_t>();
+            auto fBits     = buffer.read<uint32_t>();
 
             if ( fBits & ( BinaryBuffer::kIsReferenced ) )
-            { m_pidf->push_back( buffer.read<uint16_t>() ); }
+            {
+                if ( m_keep_data ) m_pidf->push_back( buffer.read<uint16_t>() );
+                else buffer.skip( 2 );
+            }
 
-            m_pidf_offsets->push_back( m_pidf->size() );
+            if ( m_keep_data )
+            {
+                m_unique_id->push_back( fUniqueID );
+                m_bits->push_back( fBits );
+                m_pidf_offsets->push_back( m_pidf->size() );
+            }
         }
 
         py::object data() const override {
+            if ( !m_keep_data ) return py::none();
+
             auto unique_id_array = make_array( m_unique_id );
             auto bits_array      = make_array( m_bits );
             auto pidf_array      = make_array( m_pidf );
@@ -95,6 +104,7 @@ namespace uproot {
         }
 
       private:
+        const bool m_keep_data;
         SharedVector<int32_t> m_unique_id;
         SharedVector<uint32_t> m_bits;
         SharedVector<uint16_t> m_pidf;
@@ -467,7 +477,7 @@ namespace uproot {
 
         // Other readers
         register_reader<TStringReader>( m, "TStringReader" );
-        register_reader<TObjectReader>( m, "TObjectReader" );
+        register_reader<TObjectReader, bool>( m, "TObjectReader" );
         register_reader<BaseObjectReader, std::vector<SharedReader>>( m, "BaseObjectReader" );
         register_reader<ObjectHeaderReader, std::vector<SharedReader>>( m,
                                                                         "ObjectHeaderReader" );

uproot_custom-1.1.3.dev1/uproot_custom/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.1.3.dev1'
+__version_tuple__ = version_tuple = (1, 1, 3, 'dev1')
+
+__commit_id__ = commit_id = 'gab4d2fe79'

{uproot_custom-1.1.2 → uproot_custom-1.1.3.dev1}/uproot_custom/readers.py

@@ -603,6 +603,9 @@ class TObjectReader(BaseReader):
     It will not record any data.
     """
 
+    # Whether keep TObject data.
+    keep_data_itempaths: set[str] = set()
+
     @classmethod
     def gen_tree_config(
         cls,
@@ -622,6 +625,7 @@ class TObjectReader(BaseReader):
         return {
             "reader": cls,
             "name": cls_streamer_info["fName"],
+            "keep_data": item_path in cls.keep_data_itempaths,
         }
 
     @classmethod
@@ -629,13 +633,19 @@ class TObjectReader(BaseReader):
         if tree_config["reader"] is not cls:
             return None
 
-        return uproot_custom.cpp.TObjectReader(tree_config["name"])
+        return uproot_custom.cpp.TObjectReader(
+            tree_config["name"],
+            tree_config["keep_data"],
+        )
 
     @classmethod
     def reconstruct_array(cls, raw_data, tree_config):
         if tree_config["reader"] is not cls:
             return None
 
+        if not tree_config["keep_data"]:
+            return None
+
         unique_ids, bits, pidf, pidf_offsets = raw_data
 
         return awkward.contents.RecordArray(
@@ -821,6 +831,9 @@ class BaseObjectReader(BaseReader):
 
         arr_dict = {}
         for s_cfg, s_data in zip(sub_tree_configs, raw_data):
+            if s_cfg["reader"] == TObjectReader and not s_cfg["keep_data"]:
+                continue
+
             s_name = s_cfg["name"]
             arr_dict[s_name] = reconstruct_array(s_data, s_cfg)
 
@@ -875,6 +888,9 @@ class ObjectHeaderReader(BaseReader):
 
         arr_dict = {}
         for s_cfg, s_data in zip(sub_tree_configs, raw_data):
+            if s_cfg["reader"] == TObjectReader and not s_cfg["keep_data"]:
+                continue
+
             s_name = s_cfg["name"]
             arr_dict[s_name] = reconstruct_array(s_data, s_cfg)
 

uproot_custom-1.1.2/uproot_custom/_version.py

@@ -1,21 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '1.1.2'
-__version_tuple__ = version_tuple = (1, 1, 2)