Coverage for python / lsst / ctrl / bps / cli / bps.py: 88%

1# This file is part of ctrl_bps. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <https://www.gnu.org/licenses/>. 

27"""Definition of Batch Production Service command-line interface.""" 

28 

29import click 

30 

31from lsst.daf.butler.cli.butler import LoaderCLI 

32from lsst.daf.butler.cli.opt import ( 

33 log_file_option, 

34 log_label_option, 

35 log_level_option, 

36 log_tty_option, 

37 long_log_option, 

38) 

39from lsst.daf.butler.cli.utils import unwrap 

40 

41epilog = unwrap( 

42 """Note: 

43 

44Commands 'acquire', 'cluster', 'transform', and 'prepare' halt the submission 

45process at different points prior to submitting the workflow for execution. See 

46the help for individual command for more details. 

47 

48However, the current version does not support starting the submission process 

49from any of these intermediate points. 

50""" 

51) 

52 

53 

54class BpsCli(LoaderCLI): 

55 """Specialized command loader implementing the ``bps`` command.""" 

56 

57 localCmdPkg = "lsst.ctrl.bps.cli.cmd" 

58 

59 

60@click.command(cls=BpsCli, context_settings={"help_option_names": ["-h", "--help"]}, epilog=epilog) 

61@log_level_option(default=["INFO"]) 

62@long_log_option() 

63@log_file_option() 

64@log_tty_option() 

65@log_label_option() 

66def cli(log_level, long_log, log_file, log_tty, log_label): # numpydoc ignore=PR01 

67 """Command line interface for BPS.""" 

68 pass 

69 

70 

71def main(): 

72 """Return main entry point for command-line.""" 

73 return cli()