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 required : `bool`, optional 

34 Indicates if the caller must pass this argument to the command, by 

35 default True. 

36 help : `str`, optional 

37 The help text for this argument to append to the command's help text. 

38 If None or '' then nothing will be appended to the help text (in which 

39 case the command should document this argument directly in its help 

40 text). By default, the value of directory_argument.default_help 

41 """ 

42 

43 default_help = "DIRECTORY is the folder containing dataset files." 

44 

45 def __init__(self, required=False, help=default_help): 

46 self.required = required 

47 self.helpText = help 

48 

49 def __call__(self, f): 

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

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