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 ..utils import addArgumentHelp 

26 

27 

28class directory_argument: # noqa: N801 

29 """Decorator to add a directory argument to a click command. 

30 

31 Parameters 

32 ---------- 

33 help : `str`, optional 

34 The help text to use for the option. 

35 required : bool, optional 

36 If True, the option is required to be passed in on the command line, by 

37 default False. 

38 """ 

39 

40 defaultHelp = "DIRECTORY is the folder containing dataset files." 

41 

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

43 self.required = required 

44 self.helpText = help 

45 

46 def __call__(self, f): 

47 f.__doc__ = addArgumentHelp(f.__doc__, self.helpText) 

48 return click.argument("directory", required=self.required)(f)