Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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 program is free software: you can redistribute it and/or modify 

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

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

12# (at your option) any later version. 

13# 

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

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

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

17# GNU General Public License for more details. 

18# 

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

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

21from __future__ import annotations 

22 

23from typing import Any, List 

24 

25from astropy.table import Table 

26from numpy import array 

27 

28from .. import Butler 

29from ..core.utils import globToRegex 

30 

31 

32def queryDatasetTypes(repo, verbose, glob, components): 

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

34 

35 Parameters 

36 ---------- 

37 repo : `str` 

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

39 repo and its location. 

40 verbose : `bool` 

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

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

43 glob : iterable [`str`] 

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

45 the dataset type names to search for. 

46 components : `bool` or `None` 

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

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

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

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

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

52 

53 Returns 

54 ------- 

55 collections : `dict` [`str`, [`str`]] 

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

57 collection names. 

58 """ 

59 butler = Butler(repo) 

60 datasetTypes = butler.registry.queryDatasetTypes(components=components, expression=globToRegex(glob)) 

61 info: List[Any] 

62 if verbose: 

63 table = Table(array([(d.name, str(list(d.dimensions.names)) or "None", d.storageClass.name) 

64 for d in datasetTypes]), 

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

66 else: 

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

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

69 table.sort("name") 

70 return table