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 

25 

26class repo_argument: # noqa: N801 

27 """Decorator to add a repo argument to a click command. 

28 

29 Parameters 

30 ---------- 

31 required : bool, optional 

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

33 default True. 

34 help : str, optional 

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

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

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

38 text). By default the value of repo_argument.existing_repo. 

39 """ 

40 

41 will_create_repo = "REPO is the URI or path to the new repository. " \ 

42 "Will be created if it does not exist." 

43 existing_repo = "REPO is the URI or path to an existing data repository root " \ 

44 "or configuration file." 

45 

46 def __init__(self, required=False, help=existing_repo): 

47 self.required = required 

48 self.helpText = help 

49 

50 def __call__(self, f): 

51 if self.helpText: 51 ↛ 56line 51 didn't jump to line 56, because the condition on line 51 was never false

52 # Modify the passed-in fucntions's doc string, which is used to 

53 # generate the Click Command help, to include the argument help 

54 # text: 

55 f.__doc__ = f"{'' if f.__doc__ is None else f.__doc__}\n\n {self.helpText}" 

56 return click.argument("repo", required=self.required)(f)