How to specify a parameter of type Array into a Django Command?

Question

It is straight forward creating a string parameter such as --test_email_address below.

   class Command(BaseCommand):
        option_list = BaseCommand.option_list + (
            make_option('--test_email_address',
                        action='store',
                        type="string",
                        dest='test_email_address',
                        help="Specifies test email address."),
            make_option('--vpds',
                        action='store',
                        type='list',           /// ??? Throws exception
                        dest='vpds',
                        help="vpds list [,]"),
        )

But how can I define a list to be passed in? such as [1, 3, 5]

did you try just list - without the quotes ? From the documentation, it looks like type can be any valid simple types. The other (hacky) way is to read the arguments as string, and parse it using ast.literal_eval or something. — karthikr
– karthikr, Commented Nov 3, 2014 at 14:23

Yossi · Accepted Answer · 2014-11-03 14:57:40Z

11

You should add a default value and change the action to 'append':

make_option('--vpds',
            action='append',
            default=[],
            dest='vpds',
            help="vpds list [,]"),

The usage is as follows:

python manage.py my_command --vpds arg1 --vpds arg2

edited Nov 3, 2014 at 14:57

answered Nov 3, 2014 at 14:24

Yossi

12.1k2 gold badges56 silver badges67 bronze badges

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

4 Comments

Houman Over a year ago

sorry, thats an interesting idea, but it throws an exception: optparse.OptionError: option --vpds: invalid option type: 'list'

Yossi Over a year ago

Removing type='list' fixes it. Updated the answer.

domdambrogia Over a year ago

Can anyone point me out to better info on the action values? I'm looking here without finding much info on what the available do or what values I can use

Eugene K Over a year ago

@domdambrogia the docs actually say to check docs.python.org/3/library/argparse.html#action docs

Laurent Lyaudet · Accepted Answer · 2023-05-30 14:53:37Z

3

You can also do it like this:

        parser.add_argument(
            "--vpds",
            nargs="*",
            help="vpds list",
            default=[],
            type=int,
        )

The usage is as follows:

python manage.py my_command --vpds 1 3 5

answered May 30, 2023 at 14:53

Laurent Lyaudet

9981 gold badge12 silver badges20 bronze badges

Collectives™ on Stack Overflow

How to specify a parameter of type Array into a Django Command?

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related