Coverage for python/lsst/daf/butler/script/queryDatasetTypes.py: 29%

15 statements  

« prev     ^ index     » next       coverage.py v7.3.2, created at 2023-12-01 11:00 +0000

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27from __future__ import annotations 

28 

29from collections.abc import Iterable 

30 

31from astropy.table import Table 

32from numpy import array 

33 

34from .._butler import Butler 

35 

36 

37def queryDatasetTypes(repo: str, verbose: bool, glob: Iterable[str], components: bool | None) -> Table: 

38 """Get the dataset types in a repository. 

39 

40 Parameters 

41 ---------- 

42 repo : `str` 

43 URI to the location of the repo or URI to a config file describing the 

44 repo and its location. 

45 verbose : `bool` 

46 If false only return the name of the dataset types. If false return 

47 name, dimensions, and storage class of each dataset type. 

48 glob : iterable [`str`] 

49 A list of glob-style search string that fully or partially identify 

50 the dataset type names to search for. 

51 components : `bool` or `None` 

52 If `True`, apply all glob patterns to component dataset type 

53 names as well. If `False`, never apply patterns to components. If 

54 `None` (default), apply patterns to components only if their parent 

55 datasets were not matched by the expression. Fully-specified component 

56 datasets (`str` or `DatasetType` instances) are always included. 

57 

58 Returns 

59 ------- 

60 collections : `astropy.table.Table` 

61 A dict whose key is "datasetTypes" and whose value is a list of 

62 collection names. 

63 """ 

64 butler = Butler.from_config(repo, without_datastore=True) 

65 expression = glob or ... 

66 datasetTypes = butler.registry.queryDatasetTypes(components=components, expression=expression) 

67 if verbose: 

68 table = Table( 

69 array( 

70 [(d.name, str(list(d.dimensions.names)) or "None", d.storageClass_name) for d in datasetTypes] 

71 ), 

72 names=("name", "dimensions", "storage class"), 

73 ) 

74 else: 

75 rows = ([d.name for d in datasetTypes],) 

76 table = Table(rows, names=("name",)) 

77 table.sort("name") 

78 return table