Python Click command names

Question

I'm using the click package for creating a command line tool. However, I would like to have a 'list' command. For example:

@click.command
@click.option(help='list...')
def list():
    # do stuff here

Is there another way in click to pass in a command name other than having it as the function name? I don't want this function to shadow python's built in list. I've looked through the documentation and can't really find anything about command names -- I've read up on command aliases but that doesn't seem to help this problem. Or do I not need to worry about list being shadowed since it's being wrapped by the click decorator? Thanks in advance.

l0b0 · Accepted Answer · 2021-11-04 01:57:48Z

49

You can provide the name argument when you use the command decorator. Once you've done that, you can name your function whatever you want:

@click.command(name='list')
def list_command():
    pass

See the Click documentation for details.

edited Nov 4, 2021 at 1:57

l0b0

59.6k32 gold badges155 silver badges247 bronze badges

answered Oct 12, 2015 at 19:26

Rob Kennedy

164k23 gold badges288 silver badges481 bronze badges

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

Collectives™ on Stack Overflow

Python Click command names

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related