Add unspecified options to cli command using python-click

Question

I would like to add unspecified options to the cli command using python-click library. So my cli function could look like the following

$ my-cmd --option1 value1 --options2 value2 --unknown_var value3

My current code:

import click

@click.option('--option1')
@click.option('--option2')
@click.command(name='my-cmd')
def cli(option1, option2):
  click.echo("my test")

I would like to see something like the following:

import click

@click.option('--option1')
@click.option('--option2')
@click.command(name='my-cmd')
def cli(option1, option2, **kwargs):
  click.echo("my test")
  # Manually manage **kwargs

If you are willing to accept my-cmd --option1 value1 -- --unknown_var value3 --another-unknown-var value 4 then you can use Option Like Arguments and Variadic Arguments together. — RubenLaguna
– RubenLaguna, Commented Oct 5, 2015 at 9:10

SkunkSpinner · Accepted Answer · 2021-04-19 15:46:08Z

55

You can pass context with ignore_unknown_options and allow_extra_args settings, the extra arguments will be collected in context.args list (['--unknown_var', 'value3', '--unknown_var2', 'value4']). Then you can transform it to dict.

import click

@click.command(name='my-cmd', context_settings=dict(
    ignore_unknown_options=True,
    allow_extra_args=True,
))
@click.option('--option1')
@click.option('--option2')
@click.pass_context
def cli(ctx, option1, option2):
    click.echo({ctx.args[i][2:]: ctx.args[i+1] for i in range(0, len(ctx.args), 2)})

example

python cli.py --option1 value1 --option2 value2 --unknown_var value3 --unknown_var2 value4
>> {'unknown_var2': 'value4', 'unknown_var': 'value3'}

See Forwarding Unknown Options.

edited Apr 19, 2021 at 15:46

SkunkSpinner

11.7k7 gold badges43 silver badges54 bronze badges

answered Oct 5, 2015 at 10:31

r-m-n

15.3k6 gold badges74 silver badges71 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

omni Over a year ago

In addition, if you want to support args (starting with -) and options (starting with --) you might want to use something like

{(ctx.args[i][2:] if str(ctx.args[i]).startswith("--") else ctx.args[i][1:]): ctx.args[i+1] for i in range(0, len(ctx.args), 2)}

tupui Over a year ago

I would use a stripping and splitting with a list comprehension. This looks way cleaner: data = dict([item.strip('--').split('=') for item in ctx.args])

Fraser Langton Over a year ago

Make sure you account for boolean flags 😁

params = {k.lstrip('--'): ctx.args[i + 1] if not (i + 1 >= len(ctx.args) or ctx.args[i + 1].startswith('--')) else True for i, k in enumerate(ctx.args) if k.startswith('--')}

(ugly one line so it fits in a comment)

Collectives™ on Stack Overflow

Add unspecified options to cli command using python-click

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related