Merge pull request #36 from nlesc-nano/repr

ENH: Improve the `repr` of the various `h5py.File` views

Author: BvB93

.github/workflows/pythonpackage.yml

@@ -1,13 +1,22 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Build
+name: Tests
 
 on:
     push:
         branches:
             - master
     pull_request:
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+defaults:
+    run:
+        shell: bash
 
 jobs:
     build:
@@ -27,20 +36,14 @@ jobs:
                         special: '; no-optional'
                         version: '3.10'
         steps:
-            -   name: Cancel Previous Runs
-                uses: styfle/cancel-workflow-action@0.9.1
-                with:
-                    access_token: ${{ github.token }}
-
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
 
             -   name: Set up Python ${{ matrix.version }} on ${{ matrix.os }}
-                uses: actions/setup-python@v2
+                uses: actions/setup-python@v3
                 with:
                     python-version: ${{ matrix.version }}
 
             -   name: Install dependencies
-                shell: bash
                 run: |
                     case "${{ matrix.special }}" in
                         "; no-optional")
@@ -60,7 +63,6 @@ jobs:
                 run: pip list
 
             -   name: Test with pytest
-                shell: bash
                 run: |
                     case "${{ matrix.special }}" in
                         "; no-optional")
@@ -78,12 +80,12 @@ jobs:
     Linting:
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
 
-            -   name: Set up Python 3.9 on ubuntu-latest
-                uses: actions/setup-python@v2
+            -   name: Set up Python 3.10 on ubuntu-latest
+                uses: actions/setup-python@v3
                 with:
-                    python-version: 3.9
+                    python-version: "3.10"
 
             -   name: Install linters
                 run: |

CHANGELOG.rst

@@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.
 This project adheres to `Semantic Versioning <http://semver.org/>`_.
 
 
+2.3.2
+*****
+* Improve the ``repr`` of the various ``h5py.File`` views.
+
+
 2.3.1
 *****
 * Allow ``VersionInfo.from_str`` to take any pep 440-compatible version string.

README.rst

@@ -22,7 +22,7 @@
 
 
 ################
-Nano-Utils 2.3.1
+Nano-Utils 2.3.2
 ################
 Utility functions used throughout the various nlesc-nano repositories.
 

nanoutils/__version__.py

@@ -1,3 +1,3 @@
 """The **Nano-Utils** version."""
 
-__version__ = '2.3.0'
+__version__ = '2.3.2'

nanoutils/_user_dict.py

@@ -104,7 +104,7 @@ def _reconstruct(cls: type[_ST1], dct: dict[_KT, _VT_co]) -> _ST1:
         """Alternative constructor without argument validation."""
         self = cls.__new__(cls)
         self._dict = dct
-        return self  # type: ignore[no-any-return]
+        return self
 
     def __reduce__(self: _ST1) -> tuple[
         Callable[[dict[_KT, _VT_co]], _ST1],
@@ -302,7 +302,7 @@ def update(self, __iterable: None | _DictLike[_KT, _VT] = None, **kwargs: _VT) -
         if __iterable is None:
             self._dict.update(**kwargs)
         else:
-            self._dict.update(__iterable, **kwargs)  # type: ignore[arg-type]
+            self._dict.update(__iterable, **kwargs)
 
     if sys.version_info >= (3, 9):
         def __ior__(self: _ST2, other: Mapping[_KT, _VT]) -> _ST2:

nanoutils/hdf5_utils.py

@@ -20,6 +20,7 @@
 
 import sys
 import abc
+import io
 from collections import Counter
 from collections.abc import Generator, MappingView, Iterator
 from typing import NoReturn
@@ -84,6 +85,28 @@ def _iter_dfs(
             else:
                 yield v.name, v
 
+    def __repr__(self) -> str:
+        """Implement :func:`repr(self) <repr>`."""
+        cls = type(self)
+        indent = " " * (3 + len(cls.__name__))
+        iterator = iter(self)
+
+        stream = io.StringIO()
+        stream.write(f"<{cls.__name__} [")
+
+        # Print size-1 view on a single line by special casing the first element
+        try:
+            item = next(iterator)
+        except StopIteration:
+            pass
+        else:
+            stream.write(repr(item))
+        for item in iterator:
+            stream.write(f",\n{indent}{item!r}")
+
+        stream.write("]>")
+        return stream.getvalue()
+
     def __len__(self) -> int:
         """Implement :func:`len(self)<len>`."""
         i = 0
@@ -150,14 +173,11 @@ class RecursiveKeysView(_RecursiveMappingView, KeysView[str]):
         ...     dset1 = f.create_dataset('dset1', (10,), dtype=float)
         ...     dset2 = f['a'].create_dataset('dset2', (10,), dtype=float)
         ...     dset3 = f['a']['b'].create_dataset('dset3', (10,), dtype=float)
-
-        >>> with h5py.File(filename, 'r') as f:
-        ...     for key in RecursiveKeysView(f):
-        ...         print(repr(key))
-        '/a/b/dset3'
-        '/a/dset2'
-        '/dset1'
-
+        ...
+        ...     print(RecursiveKeysView(f))
+        <RecursiveKeysView ['/a/b/dset3',
+                            '/a/dset2',
+                            '/dset1']>
 
     .. testcleanup:: python
 
@@ -223,14 +243,11 @@ class RecursiveValuesView(_RecursiveMappingView, ValuesView[H5PyDataset]):
         ...     dset1 = f.create_dataset('dset1', (10,), dtype=float)
         ...     dset2 = f['a'].create_dataset('dset2', (10,), dtype=float)
         ...     dset3 = f['a']['b'].create_dataset('dset3', (10,), dtype=float)
-
-        >>> with h5py.File(filename, 'r') as f:
-        ...     for value in RecursiveValuesView(f):
-        ...         print(value)
-        <HDF5 dataset "dset3": shape (10,), type "<f8">
-        <HDF5 dataset "dset2": shape (10,), type "<f8">
-        <HDF5 dataset "dset1": shape (10,), type "<f8">
-
+        ...
+        ...     print(RecursiveValuesView(f))
+        <RecursiveValuesView [<HDF5 dataset "dset3": shape (10,), type "<f8">,
+                              <HDF5 dataset "dset2": shape (10,), type "<f8">,
+                              <HDF5 dataset "dset1": shape (10,), type "<f8">]>
 
     .. testcleanup:: python
 
@@ -303,14 +320,11 @@ class RecursiveItemsView(_RecursiveMappingView, ItemsView[str, H5PyDataset]):
         ...     dset1 = f.create_dataset('dset1', (10,), dtype=float)
         ...     dset2 = f['a'].create_dataset('dset2', (10,), dtype=float)
         ...     dset3 = f['a']['b'].create_dataset('dset3', (10,), dtype=float)
-
-        >>> with h5py.File(filename, 'r') as f:
-        ...     for items in RecursiveItemsView(f):
-        ...         print(items)
-        ('/a/b/dset3', <HDF5 dataset "dset3": shape (10,), type "<f8">)
-        ('/a/dset2', <HDF5 dataset "dset2": shape (10,), type "<f8">)
-        ('/dset1', <HDF5 dataset "dset1": shape (10,), type "<f8">)
-
+        ...
+        ...     print(RecursiveItemsView(f))
+        <RecursiveItemsView [('/a/b/dset3', <HDF5 dataset "dset3": shape (10,), type "<f8">),
+                             ('/a/dset2', <HDF5 dataset "dset2": shape (10,), type "<f8">),
+                             ('/dset1', <HDF5 dataset "dset1": shape (10,), type "<f8">)]>
 
     .. testcleanup:: python
 

nanoutils/utils.py

@@ -350,7 +350,7 @@ def _keep_keys(
         return [k for k in dct if k not in keep_keys]
     else:
         try:
-            return dct.keys() - keep_keys  # type: ignore
+            return dct.keys() - keep_keys
         except TypeError:
             return set(dct.keys()).difference(keep_keys)
 
@@ -365,7 +365,7 @@ def _disgard_keys(
         return [k for k in dct if k in keep_keys]
     else:
         try:
-            return dct.keys() & keep_keys  # type: ignore
+            return dct.keys() & keep_keys
         except TypeError:
             return set(dct.keys()).intersection(keep_keys)