Coverage for src/hdmf/__init__.py: 56%

21 statements  

« prev     ^ index     » next       coverage.py v7.2.5, created at 2023-07-21 22:12 +0000

1from . import query 

2from .backends.hdf5.h5_utils import H5Dataset, H5RegionSlicer 

3from .container import Container, Data, DataRegion, ExternalResourcesManager 

4from .region import ListSlicer 

5from .utils import docval, getargs 

6from .term_set import TermSet 

7 

8 

9@docval( 

10 {"name": "dataset", "type": None, "doc": "the HDF5 dataset to slice"}, 

11 {"name": "region", "type": None, "doc": "the region reference to use to slice"}, 

12 is_method=False, 

13) 

14def get_region_slicer(**kwargs): 

15 import warnings # noqa: E402 

16 

17 warnings.warn( 

18 "get_region_slicer is deprecated and will be removed in HDMF 3.0.", 

19 DeprecationWarning, 

20 ) 

21 

22 dataset, region = getargs("dataset", "region", kwargs) 

23 if isinstance(dataset, (list, tuple, Data)): 

24 return ListSlicer(dataset, region) 

25 elif isinstance(dataset, H5Dataset): 

26 return H5RegionSlicer(dataset, region) 

27 return None 

28 

29 

30try: 

31 # see https://effigies.gitlab.io/posts/python-packaging-2023/ 

32 from ._version import __version__ 

33except ImportError: # pragma: no cover 

34 # this is a relatively slower method for getting the version string 

35 from importlib.metadata import version # noqa: E402 

36 

37 __version__ = version("hdmf") 

38 del version 

39 

40 

41from ._due import BibTeX, due # noqa: E402 

42 

43due.cite( 

44 BibTeX(""" 

45@INPROCEEDINGS{9005648, 

46 author={A. J. {Tritt} and O. {Rübel} and B. {Dichter} and R. {Ly} and D. {Kang} and E. F. {Chang} and L. M. {Frank} and K. {Bouchard}}, 

47 booktitle={2019 IEEE International Conference on Big Data (Big Data)}, 

48 title={HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards}, 

49 year={2019}, 

50 volume={}, 

51 number={}, 

52 pages={165-179}, 

53 doi={10.1109/BigData47090.2019.9005648}} 

54"""), # noqa: E501 

55 description="HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards", 

56 path="hdmf/", 

57 version=__version__, 

58 cite_module=True, 

59) 

60del due, BibTeX