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 

23 

24 

25def queryCollections(repo, collection_type, flatten_chains, include_chains): 

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

27 

28 Parameters 

29 ---------- 

30 repo : `str` 

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

32 repo and its location. 

33 collection_type : `CollectionType` or `None` 

34 If provided, only return collections of this type. 

35 flatten_chains : `bool` 

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

37 of matching `~CollectionType.CHAINED` collections. 

38 include_chains : `bool` or `None` 

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

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

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

42 

43 Returns 

44 ------- 

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

46 A dict whose key is 'collections' and whose value is a list of 

47 collection names. 

48 """ 

49 butler = Butler(repo) 

50 collections = butler.registry.queryCollections(collectionType=collection_type, 

51 flattenChains=flatten_chains, 

52 includeChains=include_chains) 

53 return {'collections': list(collections)}