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/>. 

21 

22from .. import Butler 

23from ..core.utils import globToRegex 

24 

25 

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

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

28 

29 Parameters 

30 ---------- 

31 repo : `str` 

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

33 repo and its location. 

34 verbose : `bool` 

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

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

37 glob : iterable [`str`] 

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

39 the dataset type names to search for. 

40 components : `bool` or `None` 

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

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

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

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

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

46 

47 Returns 

48 ------- 

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

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

51 collection names. 

52 """ 

53 butler = Butler(repo) 

54 expression = globToRegex(glob) 

55 # Only pass expression to queryDatasetTypes if there is an expression to 

56 # apply; otherwise let queryDatasetTypes use its default value. 

57 kwargs = {} 

58 if expression: 

59 kwargs["expression"] = expression 

60 datasetTypes = butler.registry.queryDatasetTypes(components=components, **kwargs) 

61 if verbose: 

62 info = [dict(name=datasetType.name, 

63 dimensions=list(datasetType.dimensions.names), 

64 storageClass=datasetType.storageClass.name) 

65 for datasetType in datasetTypes] 

66 else: 

67 info = [datasetType.name for datasetType in datasetTypes] 

68 return {"datasetTypes": info}