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 

22 

23import click 

24 

25from lsst.daf.butler.cli.utils import MWOption 

26from lsst.daf.butler.registry import CollectionType 

27 

28 

29class collection_type_option: # noqa: N801 

30 """Decorator to add a collection type option to a click command. 

31 

32 Converts the type option from string to a CollectionType enum value. 

33 Parameters 

34 ---------- 

35 help : `str`, optional 

36 The help text to use for the option. 

37 required : bool, optional 

38 If true, the option is required to be passed in on the command line. 

39 """ 

40 

41 defaultHelp = "If provided, only list collections of this type." 

42 

43 choices = ["CHAINED", "RUN", "TAGGED"] 

44 

45 def makeCollectionType(self, context, param, value): 

46 if value is None: 

47 return value 

48 value = value.upper() 

49 if value == "CHAINED": 

50 return CollectionType.CHAINED 

51 if value == "RUN": 

52 return CollectionType.RUN 

53 if value == "TAGGED": 

54 return CollectionType.TAGGED 

55 

56 def __init__(self, help=defaultHelp, required=False): 

57 self.required = required 

58 self.help = help 

59 

60 def __call__(self, f): 

61 return click.option("--collection-type", cls=MWOption, 

62 required=self.required, 

63 type=click.Choice(self.choices, case_sensitive=False), 

64 callback=self.makeCollectionType, 

65 help=self.help)(f)