legend-pydataobj 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

{legend_pydataobj-1.0.0.dist-info → legend_pydataobj-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: legend-pydataobj
-Version: 1.0.0
+Version: 1.1.1
 Summary: LEGEND Python Data Objects
 Home-page: https://github.com/legend-exp/legend-pydataobj
 Author: The LEGEND Collaboration
@@ -25,7 +25,8 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: h5py (>=3.2.0)
+Requires-Dist: colorlog
+Requires-Dist: h5py (>=3.2)
 Requires-Dist: hdf5plugin
 Requires-Dist: numba (!=0.53.*,!=0.54.*)
 Requires-Dist: numexpr

{legend_pydataobj-1.0.0.dist-info → legend_pydataobj-1.1.1.dist-info}/RECORD

@@ -1,7 +1,9 @@
-lgdo/__init__.py,sha256=mw2Xnk3eLo9W-jpOIkh8Xi9x_r4piK_ZC7r-H0OzDyE,2826
-lgdo/_version.py,sha256=FrtOfsGtY3HPkXwopVTLnBRPrKexJ-VIfXoRzWX47O4,160
+lgdo/__init__.py,sha256=mY6pUNy2yJ2MYzq_ZdhVZZ7xItBW1KJ8h9qA29bOECU,2878
+lgdo/_version.py,sha256=YLzlJBLuVqQyUSlkA30f-5TxKHA1-kSXwKvyg5nAOSc,160
+lgdo/cli.py,sha256=nYU1_igMTHoXw2H_jgyAW_2FzX1gdB_gnzf1LbsUYFE,1570
 lgdo/lgdo_utils.py,sha256=i6zG4r5wnv2WHXfWv232C_ZxaET556Rft8315QnTTiQ,5596
-lgdo/lh5_store.py,sha256=ozql8fFtfL5qpOte3B_i9LscDOKLz75b9JHasPYU6qQ,68252
+lgdo/lh5_store.py,sha256=xGnCQ1NCSWiamfndf0w8Sxn-5AB1Y_RytFcGz0PEOyM,68396
+lgdo/logging.py,sha256=Nu3wgIoWN7cyUxuzPom5rMwFvTlBu8p8d9uONHDquRg,965
 lgdo/compression/__init__.py,sha256=oT9OXiDDxC7BZciWrQVfHZNkOxXfj4p8EpF2tF04w84,1091
 lgdo/compression/base.py,sha256=82cQJujfvoAOKBFx761dEcx_xM02TBCBBuBo6i78tuI,838
 lgdo/compression/generic.py,sha256=zWoZqR5H4x-xpbvBYKDZ0rnNqUh9pC9aZeoc8Z98OjI,2252
@@ -19,8 +21,9 @@ lgdo/types/struct.py,sha256=UxV0wnCHoQM5rSmzEC9EIKWYV6drHVyK5Ab7UQztuj4,2984
 lgdo/types/table.py,sha256=h5E4Keu-a3l25WXf7m_hm2Yr4RRzGjS_WCQ_Pla7SAI,12531
 lgdo/types/vectorofvectors.py,sha256=1oxKJDX8VVWpmvUUDHHEzEYw0RRWJrMjOB-jHRY12N4,21859
 lgdo/types/waveform_table.py,sha256=52vqjGudX5_ZR1-b087jx3vuTxJ_yEPO-dO8Dpi0ceg,9407
-legend_pydataobj-1.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-legend_pydataobj-1.0.0.dist-info/METADATA,sha256=75XcT2_CMrBJoZCYOu3gohPrpvPl6wwmhtLmcA2uYI4,3219
-legend_pydataobj-1.0.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-legend_pydataobj-1.0.0.dist-info/top_level.txt,sha256=KyR-EUloqiXcQ62IWnzBmtInDtvsHl4q2ZJAZgTcLXE,5
-legend_pydataobj-1.0.0.dist-info/RECORD,,
+legend_pydataobj-1.1.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+legend_pydataobj-1.1.1.dist-info/METADATA,sha256=6E2XP7A3l3_mo-QqnOYyyHkPIH7lq8ctADfSkkzoMo0,3241
+legend_pydataobj-1.1.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+legend_pydataobj-1.1.1.dist-info/entry_points.txt,sha256=j22HoS-1cVhTtKJkDnKB49uNH0nEVER2Tpw-lVh1aws,41
+legend_pydataobj-1.1.1.dist-info/top_level.txt,sha256=KyR-EUloqiXcQ62IWnzBmtInDtvsHl4q2ZJAZgTcLXE,5
+legend_pydataobj-1.1.1.dist-info/RECORD,,

legend_pydataobj-1.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+lh5ls = lgdo.cli:lh5ls

lgdo/__init__.py

@@ -38,6 +38,7 @@ browsed easily in python like any `HDF5 <https://www.hdfgroup.org>`_ file using
 `h5py <https://www.h5py.org>`_.
 """
 
+from ._version import version as __version__
 from .lh5_store import LH5Iterator, LH5Store, load_dfs, load_nda, ls, show
 from .types import (
     LGDO,
@@ -71,5 +72,5 @@ __all__ = [
     "load_nda",
     "ls",
     "show",
-    "copy",
+    "__version__",
 ]

lgdo/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '1.0.0'
-__version_tuple__ = version_tuple = (1, 0, 0)
+__version__ = version = '1.1.1'
+__version_tuple__ = version_tuple = (1, 1, 1)

lgdo/cli.py

@@ -0,0 +1,68 @@
+"""Command line interface utilities."""
+from __future__ import annotations
+
+import argparse
+import sys
+
+from . import __version__, logging, show
+
+
+def lh5ls():
+    """``lh5ls`` console command.
+
+    To learn more, have a look at the help section:
+
+    .. code-block:: console
+
+      $ lh5ls --help
+    """
+
+    parser = argparse.ArgumentParser(
+        prog="lh5ls", description="Inspect LEGEND HDF5 (LH5) file contents"
+    )
+
+    # global options
+    parser.add_argument(
+        "--version", action="store_true", help="""Print the program 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""",
+    )
+
+    # show options
+    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",
+        default=False,
+        help="""Print HDF5 attributes too""",
+    )
+
+    args = parser.parse_args()
+
+    if args.verbose:
+        logging.setup(logging.DEBUG)
+    elif args.debug:
+        logging.setup(logging.DEBUG, logging.root)
+    else:
+        logging.setup()
+
+    if args.version:
+        print(__version__)  # noqa: T201
+        sys.exit()
+
+    show(args.lh5_file, args.lh5_group, attrs=args.attributes)

lgdo/lh5_store.py

@@ -1287,9 +1287,11 @@ def show(
         if dtype == "no datatype" and isinstance(val, h5py.Group):
             dtype = "HDF5 group"
 
-        attrs_d = dict(val.attrs)
-        attrs_d.pop("datatype", "")
-        attrs = "── " + str(attrs_d) if attrs_d else ""
+        _attrs = ""
+        if attrs:
+            attrs_d = dict(val.attrs)
+            attrs_d.pop("datatype", "")
+            _attrs = "── " + str(attrs_d) if attrs_d else ""
 
         # is this the last key?
         killme = False
@@ -1301,11 +1303,16 @@ def show(
         else:
             char = "├──"
 
-        print(f"{indent}{char} \033[1m{key}\033[0m · {dtype} {attrs}")  # noqa: T201
+        print(f"{indent}{char} \033[1m{key}\033[0m · {dtype} {_attrs}")  # noqa: T201
 
         # if it's a group, call this function recursively
         if isinstance(val, h5py.Group):
-            show(val, indent=indent + ("    " if killme else "│   "), header=False)
+            show(
+                val,
+                indent=indent + ("    " if killme else "│   "),
+                header=False,
+                attrs=attrs,
+            )
 
         # break or move to next key
         if killme:

lgdo/logging.py

@@ -0,0 +1,40 @@
+"""This module implements some helpers for setting up logging."""
+import logging
+
+import colorlog
+
+DEBUG = logging.DEBUG
+INFO = logging.INFO
+WARNING = logging.WARNING
+ERROR = logging.ERROR
+FATAL = logging.FATAL
+CRITICAL = logging.CRITICAL
+
+
+def setup(level: int = logging.INFO, logger: logging.Logger = None) -> None:
+    """Setup a colorful logging output.
+
+    If `logger` is None, sets up only the ``pygama`` logger.
+
+    Parameters
+    ----------
+    level
+        logging level (see :mod:`logging` module).
+    logger
+        if not `None`, setup this logger.
+
+    Examples
+    --------
+    >>> from pygama import logging
+    >>> logging.setup(level=logging.DEBUG)
+    """
+    handler = colorlog.StreamHandler()
+    handler.setFormatter(
+        colorlog.ColoredFormatter("%(log_color)s%(name)s [%(levelname)s] %(message)s")
+    )
+
+    if logger is None:
+        logger = colorlog.getLogger("pygama")
+
+    logger.setLevel(level)
+    logger.addHandler(handler)