How to add an argument that takes everything from the command line?

[harryle95]

I tried to achieve this by setting multiple=True, like this script for instance:

#myprogram.py 

from cleo.application import Application
from cleo.commands.command import Command
from cleo.helpers import argument


class RunCommand(Command):
    name = "run"
    description = "Runs a command in the appropriate environment."

    arguments = [
        argument("args", "The command and arguments/options to run.", multiple=True)
    ]

    def handle(self):
        args = self.argument("args")
        print(args)


if __name__ == "__main__":
    application = Application()
    application.add(RunCommand())
    application.run()

When running python myprogram.py run target --var1 1 --var2 10, cleo would throw an error about --var1 option does not exist. Upon futher looking, poetry seems to achieve this by subclassing Application, and redefining io. I am just wondering if there is a painless way of doing this natively in cleo. I am happy to contribute if this feature is not yet available.

Edit:
I know that this can be achieved by using raw sys.argv, but I want to use cleo features like help and list.

[widechaos]

You can keep your command unchanged if an explicit -- separator is acceptable:

python myprogram.py run -- target --var1 1 --var2 10

With your multiple=True argument, self.argument("args") then receives:

["target", "--var1", "1", "--var2", "10"]

multiple=True collects positional arguments; it does not stop option parsing. Cleo's ArgvInput._parse() switches off option parsing when it encounters --, so the following tokens are collected as arguments and the separator itself is omitted.

I checked your application on Cleo 2.1.0: the original invocation fails on --var1, while the invocation above produces that list. python myprogram.py run --help and python myprogram.py list still work. To pass --help through to the target instead, use python myprogram.py run -- target --help.

This requires callers to include the separator; it does not implement Poetry-style forwarding without it.