legend-pydataobj 1.2.1__tar.gz → 1.4.0__tar.gz

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: legend_pydataobj
-Version: 1.2.1
+Version: 1.4.0
 Summary: LEGEND Python Data Objects
 Home-page: https://github.com/legend-exp/legend-pydataobj
 Author: The LEGEND Collaboration

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/src/legend_pydataobj.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: legend-pydataobj
-Version: 1.2.1
+Version: 1.4.0
 Summary: LEGEND Python Data Objects
 Home-page: https://github.com/legend-exp/legend-pydataobj
 Author: The LEGEND Collaboration

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/src/legend_pydataobj.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ src/legend_pydataobj.egg-info/requires.txt
 src/legend_pydataobj.egg-info/top_level.txt
 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
@@ -33,6 +34,7 @@ src/lgdo/types/table.py
 src/lgdo/types/vectorofvectors.py
 src/lgdo/types/waveform_table.py
 tests/conftest.py
+tests/test_cli.py
 tests/test_lgdo_utils.py
 tests/test_lh5_iterator.py
 tests/test_lh5_store.py

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/src/lgdo/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2.1'
-__version_tuple__ = version_tuple = (1, 2, 1)
+__version__ = version = '1.4.0'
+__version_tuple__ = version_tuple = (1, 4, 0)

legend_pydataobj-1.4.0/src/lgdo/cli.py

@@ -0,0 +1,56 @@
+"""legend-pydataobj's command line interface utilities."""
+import argparse
+import logging
+import sys
+
+import lgdo
+import lgdo.logging
+from lgdo import show
+
+
+def lh5ls():
+    """:func:`.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 lgdo version and exit"""
+    )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="store_true",
+        help="""Increase the program verbosity""",
+    )
+    parser.add_argument(
+        "--debug",
+        "-d",
+        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"""
+    )
+
+    args = parser.parse_args()
+
+    if args.verbose:
+        lgdo.logging.setup(logging.DEBUG)
+    elif args.debug:
+        lgdo.logging.setup(logging.DEBUG, logging.root)
+    else:
+        lgdo.logging.setup()
+
+    if args.version:
+        print(lgdo.__version__)  # noqa: T201
+        sys.exit()
+
+    show(args.lh5_file, args.lh5_group, attrs=args.attributes)

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/src/lgdo/compression/base.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 import re
 from dataclasses import asdict, dataclass
 
+numba_defaults: dict = {"nopython": True, "cache": True}
+
 
 @dataclass(frozen=True)
 class WaveformCodec:

{legend_pydataobj-1.2.1 → legend_pydataobj-1.4.0}/src/lgdo/compression/generic.py

@@ -40,6 +40,7 @@ def encode(
 
 def decode(
     obj: lgdo.VectorOfEncodedVectors | lgdo.ArrayOfEncodedEqualSizedArrays,
+    out_buf: lgdo.ArrayOfEqualSizedArrays = None,
 ) -> lgdo.VectorOfVectors | lgdo.ArrayOfEqualsizedArrays:
     """Decode encoded LGDOs.
 
@@ -51,6 +52,9 @@ def decode(
     ----------
     obj
         LGDO array type.
+    out_buf
+        pre-allocated LGDO for the decoded signals. See documentation of
+        wrapped encoders for limitations.
     """
     if "codec" not in obj.attrs:
         raise RuntimeError(
@@ -61,9 +65,11 @@ def decode(
     log.debug(f"decoding {repr(obj)} with {codec}")
 
     if _is_codec(codec, radware.RadwareSigcompress):
-        return radware.decode(obj, shift=int(obj.attrs.get("codec_shift", 0)))
+        return radware.decode(
+            obj, sig_out=out_buf, shift=int(obj.attrs.get("codec_shift", 0))
+        )
     elif _is_codec(codec, varlen.ULEB128ZigZagDiff):
-        return varlen.decode(obj)
+        return varlen.decode(obj, sig_out=out_buf)
     else:
         raise ValueError(f"'{codec}' not supported")