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 

22import click 

23 

24from ..utils import addArgumentHelp, ParameterType, textTypeStr 

25 

26 

27class glob_parameter: # noqa: N801 

28 """Decorator to add an glob option or argument to a click command. 

29 """ 

30 

31 ARGUMENT = ParameterType.ARGUMENT 

32 OPTION = ParameterType.OPTION 

33 

34 defaultHelp = "GLOB is a string to apply to the search." 

35 defaultHelpMultiple = "GLOB is one or more strings to apply to the search." 

36 

37 def __init__(self, parameterType=ParameterType.OPTION, required=False, help=defaultHelp, 

38 multiple=False): 

39 self.parameterType = parameterType 

40 self.required = required 

41 self.help = help 

42 self.multiple = multiple 

43 if self.help == self.defaultHelp and self.multiple: 43 ↛ exitline 43 didn't return from function '__init__', because the condition on line 43 was never false

44 self.help = self.defaultHelpMultiple 

45 

46 def __call__(self, f): 

47 if self.parameterType == ParameterType.OPTION: 47 ↛ 48line 47 didn't jump to line 48, because the condition on line 47 was never true

48 return click.option("--glob", 

49 multiple=self.multiple, 

50 required=self.required, 

51 help=self.help, 

52 metavar=textTypeStr(self.multiple))(f) 

53 else: 

54 f.__doc__ = addArgumentHelp(f.__doc__, self.help) 

55 return click.argument("glob", 

56 required=self.required, 

57 nargs=-1 if self.multiple else 1, 

58 metavar="GLOB ..." if self.multiple else "GLOB")(f)