Make add_cylc_rose_options() a method of CylcOptionParser

cylc/flow/option_parsers.py

@@ -313,6 +313,45 @@ def add_std_options(self):
                 dest="icp",
             )
 
+    def add_cylc_rose_options(self) -> None:
+        """Add extra options for cylc-rose plugin if it is installed."""
+        try:
+            __import__('cylc.rose')
+        except ImportError:
+            return
+        self.add_option(
+            "--opt-conf-key", "-O",
+            help=(
+                "Use optional Rose Config Setting "
+                "(If Cylc-Rose is installed)"
+            ),
+            action="append",
+            default=[],
+            dest="opt_conf_keys"
+        )
+        self.add_option(
+            "--define", '-D',
+            help=(
+                "Each of these overrides the `[SECTION]KEY` setting in a "
+                "`rose-suite.conf` file. "
+                "Can be used to disable a setting using the syntax "
+                "`--define=[SECTION]!KEY` or even `--define=[!SECTION]`."
+            ),
+            action="append",
+            default=[],
+            dest="defines"
+        )
+        self.add_option(
+            "--rose-template-variable", '-S',
+            help=(
+                "As `--define`, but with an implicit `[SECTION]` for "
+                "workflow variables."
+            ),
+            action="append",
+            default=[],
+            dest="rose_template_vars"
+        )
+
     def parse_args(self, api_args, remove_opts=None):
         """Parse options and arguments, overrides OptionParser.parse_args.
 

cylc/flow/scripts/config.py

@@ -55,7 +55,6 @@
 from cylc.flow.config import WorkflowConfig
 from cylc.flow.option_parsers import CylcOptionParser as COP
 from cylc.flow.pathutil import get_workflow_run_dir
-from cylc.flow.scripts.install import add_cylc_rose_options
 from cylc.flow.templatevars import get_template_vars
 from cylc.flow.terminal import cli_function
 from cylc.flow.workflow_files import WorkflowFiles, parse_reg
@@ -101,7 +100,7 @@ def get_option_parser():
             "overrides any settings it shares with those higher up."),
         action="store_true", default=False, dest="print_hierarchy")
 
-    parser = add_cylc_rose_options(parser)
+    parser.add_cylc_rose_options()
 
     return parser
 

cylc/flow/scripts/graph.py

@@ -38,7 +38,6 @@
 from cylc.flow.config import WorkflowConfig
 from cylc.flow.exceptions import UserInputError
 from cylc.flow.option_parsers import CylcOptionParser as COP
-from cylc.flow.scripts.install import add_cylc_rose_options
 from cylc.flow.templatevars import get_template_vars
 from cylc.flow.terminal import cli_function
 from cylc.flow.workflow_files import parse_reg
@@ -218,7 +217,7 @@ def get_option_parser():
         action='store',
     )
 
-    parser = add_cylc_rose_options(parser)
+    parser.add_cylc_rose_options()
 
     return parser
 

cylc/flow/scripts/install.py

@@ -83,51 +83,6 @@
     from optparse import Values
 
 
-def add_cylc_rose_options(parser):
-    """Add extra options for cylc-rose plugin if it is installed.
-
-    Args:
-        parser: An option parser object
-    """
-    try:
-        __import__('cylc.rose')
-        parser.add_option(
-            "--opt-conf-key", "-O",
-            help=(
-                "Use optional Rose Config Setting "
-                "(If Cylc-Rose is installed)"
-            ),
-            action="append",
-            default=[],
-            dest="opt_conf_keys"
-        )
-        parser.add_option(
-            "--define", '-D',
-            help=(
-                "Each of these overrides the `[SECTION]KEY` setting in a "
-                "`rose-suite.conf` file. "
-                "Can be used to disable a setting using the syntax "
-                "`--define=[SECTION]!KEY` or even `--define=[!SECTION]`."
-            ),
-            action="append",
-            default=[],
-            dest="defines"
-        )
-        parser.add_option(
-            "--rose-template-variable", '-S',
-            help=(
-                "As `--define`, but with an implicit `[SECTION]` for "
-                "workflow variables."
-            ),
-            action="append",
-            default=[],
-            dest="rose_template_vars"
-        )
-    except ImportError:
-        pass
-    return parser
-
-
 def get_option_parser():
     parser = COP(
         __doc__, comms=True, prep=True,
@@ -172,7 +127,7 @@ def get_option_parser():
         default=False,
         dest="no_symlinks")
 
-    parser = add_cylc_rose_options(parser)
+    parser.add_cylc_rose_options()
 
     return parser
 

cylc/flow/scripts/list.py

@@ -35,7 +35,6 @@
 
 from cylc.flow.config import WorkflowConfig
 from cylc.flow.option_parsers import CylcOptionParser as COP
-from cylc.flow.scripts.install import add_cylc_rose_options
 from cylc.flow.templatevars import get_template_vars
 from cylc.flow.terminal import cli_function
 from cylc.flow.workflow_files import parse_reg
@@ -86,7 +85,7 @@ def get_option_parser():
         "initial cycle point, by default). Use '-p , ' for the default range.",
         metavar="[START],[STOP]", action="store", default=None, dest="prange")
 
-    parser = add_cylc_rose_options(parser)
+    parser.add_cylc_rose_options()
     return parser
 
 

cylc/flow/scripts/validate.py

@@ -44,7 +44,6 @@
     CylcOptionParser as COP,
     Options
 )
-from cylc.flow.scripts.install import add_cylc_rose_options
 from cylc.flow.workflow_files import parse_reg
 
 
@@ -73,7 +72,7 @@ def get_option_parser():
         default="live", dest="run_mode",
         choices=['live', 'dummy', 'dummy-local', 'simulation'])
 
-    parser = add_cylc_rose_options(parser)
+    parser.add_cylc_rose_options()
 
     parser.set_defaults(is_validate=True)