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 queryCollections(repo, glob, collection_type, flatten_chains, include_chains): 

27 """Get the collections whose names match an expression. 

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 glob : iterable [`str`] 

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

36 the dataset type names to search for. 

37 collection_type : `Iterable` [ `CollectionType` ], optional 

38 If provided, only return collections of these types. 

39 flatten_chains : `bool` 

40 If `True` (`False` is default), recursively yield the child collections 

41 of matching `~CollectionType.CHAINED` collections. 

42 include_chains : `bool` or `None` 

43 If `True`, yield records for matching `~CollectionType.CHAINED` 

44 collections. Default is the opposite of ``flattenChains``: include 

45 either CHAINED collections or their children, but not both. 

46 

47 Returns 

48 ------- 

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

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

51 collection names. 

52 """ 

53 butler = Butler(repo) 

54 expression = globToRegex(glob) 

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

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

57 kwargs = {} 

58 if expression: 

59 kwargs["expression"] = expression 

60 collections = butler.registry.queryCollections(collectionTypes=frozenset(collection_type), 

61 flattenChains=flatten_chains, 

62 includeChains=include_chains, 

63 **kwargs) 

64 return {"collections": list(collections)}