Coverage for python/lsst/ctrl/bps/cli/opt/option_groups.py: 100%

8 statements  

« prev     ^ index     » next       coverage.py v7.5.0, created at 2024-05-03 02:57 -0700

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 <http://www.gnu.org/licenses/>. 

27"""Option groups for bps. 

28""" 

29 

30__all__ = ["submission_options"] 

31 

32from lsst.ctrl.mpexec.cli.opt import ( 

33 butler_config_option, 

34 data_query_option, 

35 input_option, 

36 output_option, 

37 output_run_option, 

38 pipeline_option, 

39 qgraph_option, 

40) 

41from lsst.daf.butler.cli.utils import OptionGroup, option_section 

42 

43from .options import ( 

44 extra_init_option, 

45 extra_qgraph_option, 

46 extra_run_quantum_option, 

47 extra_update_qgraph_option, 

48) 

49 

50 

51# Using snake_case for a submission option group (a class) to keep the naming 

52# convention consistent with other options or option groups in other Middleware 

53# packages (e.g daf_butler, ctrl_mpexec). 

54class submission_options(OptionGroup): # noqa: N801 

55 """Decorator to add options to a command function for any stage during 

56 submission. 

57 """ 

58 

59 def __init__(self): 

60 self.decorators = [ 

61 option_section(sectionText="Submission options:"), 

62 butler_config_option(), 

63 input_option(), 

64 output_option(), 

65 output_run_option(), 

66 data_query_option(), 

67 pipeline_option(), 

68 qgraph_option(), 

69 extra_qgraph_option(), 

70 extra_update_qgraph_option(), 

71 extra_init_option(), 

72 extra_run_quantum_option(), 

73 ]