How to make an optional value for argument using argparse?

Question

I am creating a python script where I want to have an argument that manipulates how many search results you get as output. I've currently named the argument --head. This is the functionality I'd like it to have:

When --head is not passed at the command line I'd like it to default to one value. In this case, a rather big one, like 80
When --head is passed without any value, I'd like it to default to another value. In this case, something limited, like 10
When --head is passed with a value, I'd like it to store the value it was passed.

Here is some code describing the problem:

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-h',
                        '--head',
                        dest='size',
                        const=80,
                        default=10,
                        action="I don't know",
                        help='Only print the head of the output')
>>> # OFC, that last line will fail because the action is uknown,
... # but here is how I'd like it to work
... parser.parse_args(''.split())
Namespace(size=80)
>>> parser.parse_args('--head'.split())
Namespace(size=10)
>>> parser.parse_args('--head 15'.split())
Namespace(size=15)

I know I probably can write a custom action for this, but I first want to see if there is any default behaviour that does this.

totokaka · Accepted Answer · 2018-05-23 15:40:49Z

96

After a little more reading in the documentation I found what I needed: nargs='?'. This is used with the store action, and does exactly what I want.

Here is an example:

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--head',
                        dest='size',
                        const=10,
                        default=80,
                        action='store',
                        nargs='?',
                        type=int,
                        help='Only print the head of the output')
>>> parser.parse_args(''.split())
... Namespace(size=80)
>>> parser.parse_args('--head'.split())
... Namespace(size=10)
>>> parser.parse_args('--head 15'.split())
... Namespace(size=15)

Source: http://docs.python.org/3/library/argparse.html#nargs

edited May 23, 2018 at 15:40

answered Feb 24, 2014 at 20:25

totokaka

2,3441 gold badge22 silver badges34 bronze badges

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

2 Comments

Thomas Ahle Over a year ago

Excellent. It even supports * and + too, with the results that might be expected from knowledge regular expressions.

jmon12 Over a year ago

@ThomasAhle const argument cannot be used with *. The way to go in that case seems to be [] if the option is provided without argument(s), and None if it hasn't been provided.

Collectives™ on Stack Overflow

How to make an optional value for argument using argparse?

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related