cli: Fix allow_interspersed_args not inherited anymore

And make commands.options a protected module.

Author: cassava

cli/cloe_launch/commands/options.py renamed to cli/cloe_launch/commands/_options.py

@@ -27,6 +27,11 @@
 import click
 
 
+def cli_command(name):
+    """Click command with correct settings applied."""
+    return click.command(name, context_settings={"allow_interspersed_args": False})
+
+
 def conanfile():
     """Click argument CONANFILE."""
     return click.argument(
@@ -36,7 +41,7 @@ def conanfile():
 
 def args():
     """Click argument ARGS."""
-    return click.argument("args", nargs=-1)
+    return click.argument("args", nargs=-1, type=click.UNPROCESSED)
 
 
 def split_args(xargs) -> Tuple[List[str], List[str]]:

cli/cloe_launch/commands/activate.py

@@ -26,13 +26,13 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
-
-@click.command("activate")
-@options.cache()
-@options.conanfile()
-@options.args()
+@cli_command("activate")
+@_options.cache()
+@_options.conanfile()
+@_options.args()
 @click.pass_obj
 def cli_activate(
     conf: Configuration,
@@ -71,5 +71,5 @@ def cli_activate(
     command instead of `activate`.
     """
     engine = Engine(conf, conanfile=conanfile)
-    engine.conan_args = options.extract_conan_args(args)
+    engine.conan_args = _options.extract_conan_args(args)
     engine.activate(use_cache=cache)

cli/cloe_launch/commands/clean.py

@@ -29,12 +29,13 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
 
-@click.command("clean")
+@cli_command("clean")
 @click.option("--all", is_flag=True, help="Clean all runtime environments.")
-@options.conanfile()
+@_options.conanfile()
 @click.pass_obj
 def cli_clean(
     conf: Configuration,

cli/cloe_launch/commands/deploy.py

@@ -30,10 +30,11 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
 
-@click.command("deploy")
+@cli_command("deploy")
 @click.option(
     "-D",
     "--dest",
@@ -53,8 +54,8 @@
     default=True,
     help="Set the RPATH of all binaries and libraries.",
 )
-@options.conanfile()
-@options.args()
+@_options.conanfile()
+@_options.args()
 @click.pass_obj
 def cli_deploy(
     conf: Configuration,
@@ -76,7 +77,7 @@ def cli_deploy(
         cloe-launch deploy -D deploy tests/conanfile.py
     """
     engine = Engine(conf, conanfile=conanfile)
-    engine.conan_args = options.extract_conan_args(args)
+    engine.conan_args = _options.extract_conan_args(args)
 
     try:
         engine.deploy(

cli/cloe_launch/commands/exec.py

@@ -29,21 +29,21 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
-
-@click.command("exec")
-@options.preserve_env()
-@options.override_env()
-@options.cache()
+@cli_command("exec")
+@_options.preserve_env()
+@_options.override_env()
+@_options.cache()
 @click.option(
     "-d",
     "--debug",
     is_flag=True,
     help="Launch cloe-engine with GDB.",
 )
-@options.conanfile()
-@options.args()
+@_options.conanfile()
+@_options.args()
 @click.pass_obj
 def cli_exec(
     conf: Configuration,
@@ -69,13 +69,13 @@ def cli_exec(
         cloe-launch exec -c tests/conanfile.py -- -l debug run tests/smoketest.json
     """
     engine = Engine(conf, conanfile=conanfile)
-    engine.conan_args = options.extract_conan_args(args)
+    engine.conan_args = _options.extract_conan_args(args)
     engine.preserve_env = preserve_env
 
     # Run cloe-engine and pass on returncode:
     # If cloe-engine is killed/aborted, subprocess will return 250.
-    engine_args = options.extract_target_args(args)
-    overrides = options.process_overrides(override_env)
+    engine_args = _options.extract_target_args(args)
+    overrides = _options.process_overrides(override_env)
     result = engine.exec(
         engine_args, use_cache=cache, debug=debug, override_env=overrides
     )

cli/cloe_launch/commands/prepare.py

@@ -29,12 +29,13 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
 
-@click.command("prepare")
-@options.conanfile()
-@options.args()
+@cli_command("prepare")
+@_options.conanfile()
+@_options.args()
 @click.pass_obj
 def cli_prepare(
     conf: Configuration,
@@ -60,7 +61,7 @@ def cli_prepare(
         cloe-launch prepare tests/conanfile.py --require-override boost/1.81
     """
     engine = Engine(conf, conanfile=conanfile)
-    engine.conan_args = options.extract_conan_args(args)
+    engine.conan_args = _options.extract_conan_args(args)
 
     try:
         engine.prepare()

cli/cloe_launch/commands/shell.py

@@ -28,15 +28,16 @@
 
 from cloe_launch import Configuration
 from cloe_launch.exec import Engine
-from . import options
+from . import _options
+from ._options import cli_command
 
 
-@click.command("shell")
-@options.preserve_env()
-@options.override_env()
-@options.cache()
-@options.conanfile()
-@options.args()
+@cli_command("shell")
+@_options.preserve_env()
+@_options.override_env()
+@_options.cache()
+@_options.conanfile()
+@_options.args()
 @click.pass_obj
 def cli_shell(
     conf: Configuration,
@@ -66,7 +67,7 @@ def cli_shell(
     """
     engine = Engine(conf, conanfile=conanfile)
     engine.preserve_env = preserve_env
-    engine.conan_args = options.extract_conan_args(args)
+    engine.conan_args = _options.extract_conan_args(args)
 
     # Replace process with shell.
-    engine.shell(options.extract_target_args(args), use_cache=cache)
+    engine.shell(_options.extract_target_args(args), use_cache=cache)