legend-pydataobj 1.11.6__tar.gz → 1.11.8__tar.gz

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: legend_pydataobj
-Version: 1.11.6
+Version: 1.11.8
 Summary: LEGEND Python Data Objects
 Author: The LEGEND Collaboration
 Maintainer: The LEGEND Collaboration
@@ -726,6 +726,7 @@ Requires-Dist: pylegendtestdata; extra == "test"
 Requires-Dist: pytest>=6.0; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: dbetto; extra == "test"
+Dynamic: license-file
 
 # legend-pydataobj
 

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/pyproject.toml

@@ -81,7 +81,7 @@ test = [
 
 [project.scripts]
 lh5ls = "lgdo.cli:lh5ls"
-lh5concat = "lgdo.cli:lh5concat"
+lh5concat = "lgdo.cli:lh5concat_cli"
 
 [tool.setuptools]
 include-package-data = true
@@ -122,7 +122,7 @@ extend-select = [
   "PIE",      # flake8-pie
   "PL",       # pylint
   "PT",       # flake8-pytest-style
-  #"PTH",      # flake8-use-pathlib
+  "PTH",      # flake8-use-pathlib
   "RET",      # flake8-return
   "RUF",      # Ruff-specific
   "SIM",      # flake8-simplify
@@ -167,7 +167,7 @@ minversion = "6.0"
 addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
 xfail_strict = true
 filterwarnings = ["error", 'ignore:\nPyarrow:DeprecationWarning']
-log_cli_level = "info"
+log_cli_level = "INFO"
 testpaths = "tests"
 
 [tool.codespell]

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/legend_pydataobj.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: legend_pydataobj
-Version: 1.11.6
+Version: 1.11.8
 Summary: LEGEND Python Data Objects
 Author: The LEGEND Collaboration
 Maintainer: The LEGEND Collaboration
@@ -726,6 +726,7 @@ Requires-Dist: pylegendtestdata; extra == "test"
 Requires-Dist: pytest>=6.0; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: dbetto; extra == "test"
+Dynamic: license-file
 
 # legend-pydataobj
 

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/legend_pydataobj.egg-info/SOURCES.txt

@@ -12,7 +12,6 @@ src/lgdo/__init__.py
 src/lgdo/_version.py
 src/lgdo/cli.py
 src/lgdo/lgdo_utils.py
-src/lgdo/lh5_store.py
 src/lgdo/logging.py
 src/lgdo/units.py
 src/lgdo/utils.py
@@ -23,6 +22,7 @@ src/lgdo/compression/radware.py
 src/lgdo/compression/utils.py
 src/lgdo/compression/varlen.py
 src/lgdo/lh5/__init__.py
+src/lgdo/lh5/concat.py
 src/lgdo/lh5/core.py
 src/lgdo/lh5/datatype.py
 src/lgdo/lh5/exceptions.py
@@ -68,6 +68,7 @@ tests/compression/test_uleb128_zigzag_diff.py
 tests/compression/sigcompress/LDQTA_r117_20200110T105115Z_cal_geds_raw-0.dat
 tests/compression/sigcompress/special-wf-clipped.dat
 tests/lh5/conftest.py
+tests/lh5/test_concat.py
 tests/lh5/test_core.py
 tests/lh5/test_exceptions.py
 tests/lh5/test_lh5_datatype.py

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/legend_pydataobj.egg-info/entry_points.txt

@@ -1,3 +1,3 @@
 [console_scripts]
-lh5concat = lgdo.cli:lh5concat
+lh5concat = lgdo.cli:lh5concat_cli
 lh5ls = lgdo.cli:lh5ls

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/__init__.py

@@ -45,7 +45,7 @@ browsed easily in python like any `HDF5 <https://www.hdfgroup.org>`_ file using
 from __future__ import annotations
 
 from ._version import version as __version__
-from .lh5_store import LH5Iterator, LH5Store, load_dfs, load_nda, ls, show
+from .lh5 import LH5Iterator, ls, read, read_as, read_n_rows, show, write
 from .types import (
     LGDO,
     Array,
@@ -69,7 +69,6 @@ __all__ = [
     "FixedSizeArray",
     "Histogram",
     "LH5Iterator",
-    "LH5Store",
     "Scalar",
     "Struct",
     "Table",
@@ -77,8 +76,10 @@ __all__ = [
     "VectorOfVectors",
     "WaveformTable",
     "__version__",
-    "load_dfs",
-    "load_nda",
     "ls",
+    "read",
+    "read_as",
+    "read_n_rows",
     "show",
+    "write",
 ]

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# 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, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.11.6'
-__version_tuple__ = version_tuple = (1, 11, 6)
+__version__ = version = '1.11.8'
+__version_tuple__ = version_tuple = (1, 11, 8)

legend_pydataobj-1.11.8/src/lgdo/cli.py

@@ -0,0 +1,183 @@
+"""legend-pydataobj's command line interface utilities."""
+
+from __future__ import annotations
+
+import argparse
+import logging
+import sys
+
+from . import __version__, lh5
+from . import logging as lgdogging  # eheheh
+from .lh5.concat import lh5concat
+
+log = logging.getLogger(__name__)
+
+
+def lh5ls(args=None):
+    """:func:`.lh5.show` command line interface."""
+    parser = argparse.ArgumentParser(
+        prog="lh5ls", description="Inspect LEGEND HDF5 (LH5) file contents"
+    )
+
+    # global options
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="""Print legend-pydataobj version and exit""",
+    )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="store_true",
+        help="""Increase the program verbosity""",
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="""Increase the program verbosity to maximum""",
+    )
+
+    parser.add_argument(
+        "lh5_file",
+        help="""Input LH5 file""",
+    )
+    parser.add_argument("lh5_group", nargs="?", help="""LH5 group.""", default="/")
+    parser.add_argument(
+        "--attributes", "-a", action="store_true", help="""Print HDF5 attributes too"""
+    )
+    parser.add_argument(
+        "--depth",
+        "-d",
+        type=int,
+        default=None,
+        help="""Maximum tree depth of groups to print""",
+    )
+    parser.add_argument(
+        "--detail",
+        action="store_true",
+        help="""Print details about datasets""",
+    )
+
+    args = parser.parse_args(args)
+
+    if args.verbose:
+        lgdogging.setup(logging.DEBUG)
+    elif args.debug:
+        lgdogging.setup(logging.DEBUG, logging.root)
+    else:
+        lgdogging.setup()
+
+    if args.version:
+        print(__version__)  # noqa: T201
+        sys.exit()
+
+    lh5.show(
+        args.lh5_file,
+        args.lh5_group,
+        attrs=args.attributes,
+        depth=args.depth,
+        detail=args.detail,
+    )
+
+
+def lh5concat_cli(args=None):
+    """Command line interface for concatenating array-like LGDOs in LH5 files."""
+    parser = argparse.ArgumentParser(
+        prog="lh5concat",
+        description="""
+Concatenate LGDO Arrays, VectorOfVectors and Tables in LH5 files.
+
+Examples
+--------
+
+Concatenate all eligible objects in file{1,2}.lh5 into concat.lh5:
+
+  $ lh5concat -o concat.lh5 file1.lh5 file2.lh5
+
+Include only the /data/table1 Table:
+
+  $ lh5concat -o concat.lh5 -i /data/table1/* file1.lh5 file2.lh5
+
+Exclude the /data/table1/col1 Table column:
+
+  $ lh5concat -o concat.lh5 -e /data/table1/col1 file1.lh5 file2.lh5
+        """,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    # global options
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="""Print legend-pydataobj version and exit""",
+    )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="store_true",
+        help="""Increase the program verbosity""",
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="""Increase the program verbosity to maximum""",
+    )
+
+    parser.add_argument(
+        "lh5_file",
+        nargs="+",
+        help="""Input LH5 files""",
+    )
+    parser.add_argument(
+        "--output",
+        "-o",
+        help="""Output file""",
+        default="lh5concat-output.lh5",
+    )
+    parser.add_argument(
+        "--overwrite",
+        "-w",
+        action="store_true",
+        help="""Overwrite output file""",
+    )
+    parser.add_argument(
+        "--include",
+        "-i",
+        help="""Regular expression (fnmatch style) for object names that should
+        be concatenated. To include full tables, you need to explicitly include
+        all its columns with e.g. '/path/to/table/*'. The option can be passed
+        multiple times to provide a list of patterns.
+        """,
+        action="append",
+        default=None,
+    )
+    parser.add_argument(
+        "--exclude",
+        "-e",
+        help="""List of object names that should be excluded. Takes priority
+        over --include. See --include help for more details.
+        """,
+        action="append",
+        default=None,
+    )
+
+    args = parser.parse_args(args)
+
+    if args.verbose:
+        lgdogging.setup(logging.INFO, log)
+    elif args.debug:
+        lgdogging.setup(logging.DEBUG, logging.root)
+    else:
+        lgdogging.setup()
+
+    if args.version:
+        print(__version__)  # noqa: T201
+        sys.exit()
+
+    lh5concat(
+        lh5_files=args.lh5_file,
+        overwrite=args.overwrite,
+        output=args.output,
+        include_list=args.include,
+        exclude_list=args.exclude,
+    )

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/lh5/__init__.py

@@ -11,15 +11,14 @@ from ._serializers.write.array import DEFAULT_HDF5_SETTINGS
 from .core import read, read_as, write
 from .iterator import LH5Iterator
 from .store import LH5Store
-from .tools import load_dfs, load_nda, ls, show
+from .tools import ls, show
 from .utils import read_n_rows
 
 __all__ = [
     "DEFAULT_HDF5_SETTINGS",
     "LH5Iterator",
     "LH5Store",
-    "load_dfs",
-    "load_nda",
+    "concat",
     "ls",
     "read",
     "read_as",

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/lh5/_serializers/read/composite.py

@@ -353,15 +353,13 @@ def _h5_read_table(
             table = Table(col_dict=col_dict, attrs=attrs)
 
         # set (write) loc to end of tree
-        table.loc = n_rows_read
+        table.resize(do_warn=True)
         return table, n_rows_read
 
     # We have read all fields into the object buffer. Run
     # checks: All columns should be the same size. So update
     # table's size as necessary, warn if any mismatches are found
     obj_buf.resize(do_warn=True)
-    # set (write) loc to end of tree
-    obj_buf.loc = obj_buf_start + n_rows_read
 
     # check attributes
     utils.check_obj_buf_attrs(obj_buf.attrs, attrs, fname, oname)

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/lh5/_serializers/read/utils.py

@@ -34,7 +34,7 @@ def build_field_mask(field_mask: Mapping[str, bool] | Collection[str]) -> defaul
             default = not field_mask[next(iter(field_mask.keys()))]
         return defaultdict(lambda: default, field_mask)
     if isinstance(field_mask, (list, tuple, set)):
-        return defaultdict(bool, {field: True for field in field_mask})
+        return defaultdict(bool, dict.fromkeys(field_mask, True))
     if isinstance(field_mask, defaultdict):
         return field_mask
     msg = "bad field_mask type"

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/lh5/_serializers/read/vector_of_vectors.py

@@ -123,7 +123,7 @@ def _h5_read_vector_of_vectors(
                 )
                 msg = (
                     f"cumulative_length non-increasing between entries "
-                    f"{start_row} and {start_row+n_rows_read}"
+                    f"{start_row} and {start_row + n_rows_read}"
                 )
                 raise LH5DecodeError(msg, fname, oname)
 

{legend_pydataobj-1.11.6 → legend_pydataobj-1.11.8}/src/lgdo/lh5/_serializers/write/composite.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import logging
-import os
 from inspect import signature
+from pathlib import Path
 
 import h5py
 
@@ -53,7 +53,7 @@ def _h5_write_lgdo(
     # change any object in the file. So we use file:append for
     # write_object:overwrite.
     if not isinstance(lh5_file, h5py.File):
-        mode = "w" if wo_mode == "of" or not os.path.exists(lh5_file) else "a"
+        mode = "w" if wo_mode == "of" or not Path(lh5_file).exists() else "a"
         lh5_file = h5py.File(lh5_file, mode=mode, **file_kwargs)
 
     log.debug(
@@ -186,19 +186,20 @@ def _h5_write_struct(
     write_start=0,
     **h5py_kwargs,
 ):
+    # this works for structs and derived (tables)
     assert isinstance(obj, types.Struct)
 
     # In order to append a column, we need to update the
-    # `table{old_fields}` value in `group.attrs['datatype"]` to include
+    # `struct/table{old_fields}` value in `group.attrs['datatype"]` to include
     # the new fields.  One way to do this is to override
     # `obj.attrs["datatype"]` to include old and new fields. Then we
-    # can write the fields to the table as normal.
+    # can write the fields to the struct/table as normal.
     if wo_mode == "ac":
         old_group = utils.get_h5_group(name, group)
         lgdotype = datatype.datatype(old_group.attrs["datatype"])
         fields = datatype.get_struct_fields(old_group.attrs["datatype"])
-        if not issubclass(lgdotype, types.Struct):
-            msg = f"Trying to append columns to an object of type {lgdotype.__name__}"
+        if lgdotype is not type(obj):
+            msg = f"Trying to append columns to an object of different type {lgdotype.__name__}!={type(obj)}"
             raise LH5EncodeError(msg, lh5_file, group, name)
 
         # If the mode is `append_column`, make sure we aren't appending
@@ -211,8 +212,12 @@ def _h5_write_struct(
                 "column(s) to a table with the same field(s)"
             )
             raise LH5EncodeError(msg, lh5_file, group, name)
+
         # It doesn't matter what key we access, as all fields in the old table have the same size
-        if old_group[next(iter(old_group.keys()))].size != obj.size:
+        if (
+            isinstance(obj, types.Table)
+            and old_group[next(iter(old_group.keys()))].size != obj.size
+        ):
             msg = (
                 f"Table sizes don't match. Trying to append column of size {obj.size} "
                 f"to a table of size {old_group[next(iter(old_group.keys()))].size}."
@@ -222,7 +227,8 @@ def _h5_write_struct(
         # Now we can append the obj.keys() to the old fields, and then update obj.attrs.
         fields.extend(list(obj.keys()))
         obj.attrs.pop("datatype")
-        obj.attrs["datatype"] = "table" + "{" + ",".join(fields) + "}"
+
+        obj.attrs["datatype"] = obj.datatype_name() + "{" + ",".join(fields) + "}"
 
     group = utils.get_h5_group(
         name,

legend_pydataobj-1.11.8/src/lgdo/lh5/concat.py

@@ -0,0 +1,219 @@
+from __future__ import annotations
+
+import fnmatch
+import logging
+
+from lgdo.lh5 import LH5Iterator
+
+from .. import Array, Scalar, Struct, Table, VectorOfVectors, lh5
+
+log = logging.getLogger(__name__)
+
+
+def _get_obj_list(
+    lh5_files: list, include_list: list | None = None, exclude_list: list | None = None
+) -> list[str]:
+    """Extract a list of lh5 objects to concatenate.
+
+    Parameters
+    ----------
+    lh5_files
+        list of input files to concatenate.
+    include_list
+        patterns for tables to include.
+    exclude_list
+        patterns for tables to exclude.
+
+    """
+    file0 = lh5_files[0]
+    obj_list_full = set(lh5.ls(file0, recursive=True))
+
+    # let's remove objects with nested LGDOs inside
+    to_remove = set()
+    for name in obj_list_full:
+        if len(fnmatch.filter(obj_list_full, f"{name}/*")) > 1:
+            to_remove.add(name)
+    obj_list_full -= to_remove
+
+    obj_list = set()
+    # now first remove excluded stuff
+    if exclude_list is not None:
+        for exc in exclude_list:
+            obj_list_full -= set(fnmatch.filter(obj_list_full, exc.strip("/")))
+
+    # then make list of included, based on latest list
+    if include_list is not None:
+        for inc in include_list:
+            obj_list |= set(fnmatch.filter(obj_list_full, inc.strip("/")))
+    else:
+        obj_list = obj_list_full
+
+    # sort
+    return sorted(obj_list)
+
+
+def _get_lgdos(file, obj_list):
+    """Get name of LGDO objects."""
+
+    store = lh5.LH5Store()
+    h5f0 = store.gimme_file(file)
+
+    lgdos = []
+    lgdo_structs = {}
+
+    # loop over object list in the first file
+    for name in obj_list:
+        # now loop over groups starting from root
+        current = ""
+        for item in name.split("/"):
+            current = f"{current}/{item}".strip("/")
+
+            if current in lgdos:
+                break
+
+            # not even an LGDO (i.e. a plain HDF5 group)!
+            if "datatype" not in h5f0[current].attrs:
+                continue
+
+            # read as little as possible
+            obj = store.read(current, h5f0, n_rows=1)
+            if isinstance(obj, (Table, Array, VectorOfVectors)):
+                lgdos.append(current)
+
+            elif isinstance(obj, Struct):
+                # structs might be used in a "group-like" fashion (i.e. they might only
+                # contain array-like objects).
+                # note: handle after handling tables, as tables also satisfy this check.
+                lgdo_structs[current] = obj.attrs["datatype"]
+                continue
+
+            elif isinstance(obj, Scalar):
+                msg = f"cannot concat scalar field {current}"
+                log.warning(msg)
+
+            break
+
+    msg = f"first-level, array-like objects: {lgdos}"
+    log.info(msg)
+
+    msg = f"nested structs: {lgdo_structs}"
+    log.info(msg)
+
+    h5f0.close()
+
+    if lgdos == []:
+        msg = "did not find any field to concatenate, exit"
+        raise RuntimeError(msg)
+
+    return lgdos, lgdo_structs
+
+
+def _inplace_table_filter(name, table, obj_list):
+    """filter objects nested in this LGDO"""
+    skm = fnmatch.filter(obj_list, f"{name}/*")
+    kept = {it.removeprefix(name).strip("/").split("/")[0] for it in skm}
+
+    # now remove fields
+    for k in list(table.keys()):
+        if k not in kept:
+            table.remove_column(k)
+
+    msg = f"fields left in table '{name}': {table.keys()}"
+    log.debug(msg)
+
+    # recurse!
+    for k2, v2 in table.items():
+        if not isinstance(v2, Table):
+            continue
+
+        _inplace_table_filter(f"{name}/{k2}", v2, obj_list)
+
+
+def _remove_nested_fields(lgdos: dict, obj_list: list):
+    """Remove (nested) table fields based on obj_list."""
+
+    for key, val in lgdos.items():
+        if not isinstance(val, Table):
+            continue
+
+        _inplace_table_filter(key, val, obj_list)
+
+
+def lh5concat(
+    lh5_files: list,
+    output: str,
+    overwrite: bool = False,
+    *,
+    include_list: list | None = None,
+    exclude_list: list | None = None,
+) -> None:
+    """Concatenate LGDO Arrays, VectorOfVectors and Tables in LH5 files.
+
+    Parameters
+    ----------
+    lh5_files
+        list of input files to concatenate.
+    output
+        path to the output file
+    include_list
+        patterns for tables to include.
+    exclude_list
+        patterns for tables to exclude.
+    """
+
+    if len(lh5_files) < 2:
+        msg = "you must provide at least two input files"
+        raise RuntimeError(msg)
+
+    # determine list of objects by recursively ls'ing first file
+    obj_list = _get_obj_list(
+        lh5_files, include_list=include_list, exclude_list=exclude_list
+    )
+
+    msg = f"objects matching include patterns {include_list} in {lh5_files[0]}: {obj_list}"
+    log.info(msg)
+
+    lgdos, lgdo_structs = _get_lgdos(lh5_files[0], obj_list)
+    first_done = False
+    store = lh5.LH5Store()
+
+    # loop over lgdo objects
+    for lgdo in lgdos:
+        # iterate over the files
+        for lh5_obj in LH5Iterator(lh5_files, lgdo):
+            data = {lgdo: lh5_obj}
+
+            # remove the nested fields
+            _remove_nested_fields(data, obj_list)
+
+            if first_done is False:
+                msg = f"creating output file {output}"
+                log.info(msg)
+
+                store.write(
+                    data[lgdo],
+                    lgdo,
+                    output,
+                    wo_mode="overwrite_file"
+                    if (overwrite and not first_done)
+                    else "write_safe",
+                )
+                first_done = True
+
+            else:
+                msg = f"appending to {output}"
+                log.info(msg)
+
+                if isinstance(data[lgdo], Table):
+                    _inplace_table_filter(lgdo, data[lgdo], obj_list)
+
+                store.write(data[lgdo], lgdo, output, wo_mode="append")
+
+    if lgdo_structs != {}:
+        output_file = store.gimme_file(output, mode="a")
+        for struct, struct_dtype in lgdo_structs.items():
+            msg = f"reset datatype of struct {struct} to {struct_dtype}"
+            log.debug(msg)
+
+            output_file[struct].attrs["datatype"] = struct_dtype
+        output_file.close()