How to set argparse arguments from python script

Question

I have a main function specified as entry point in my package's setup.py which uses the argparse package in order to pass command line arguments (see discussion here):

# file with main routine specified as entry point in setup.py
import argparse
def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('a', type=str, help='mandatory argument a')
    args = parser.parse_args()

Ideally, I would like to use the same main function in the package's tests as suggested here. In the latter context, I would like to call the main function from within the test class and set (some of) the command line arguments prior to the function call (which otherwise will fail, due to missing arguments).

# file in the tests folder calling the above main function
class TestConsole(TestCase):
    def test_basic(self):
        set_value_of_a()
        main()

Is that possible?

Why don't you add kwargs to main and only if they're None, you set them to the parse_args? — William Fernandes
– William Fernandes, Commented Oct 4, 2016 at 13:19

Community · Accepted Answer · 2017-05-23 11:52:53Z

28

The argparse module actually reads input variables from special variable, which is called ARGV (short from ARGument Vector). This variable is usually accessed by reading sys.argv from sys module.

This variable is a ordinary list, so you can append your command-line parameters to it like this:

import sys
sys.argv.extend(['-a', SOME_VALUE])
main()

However, messing with sys.argv at runtime is not a good way of testing. A much more cleaner way to replace the sys.argv for some limited scope is using unittest.mock.patch context manager, like this:

with unittest.mock.patch('sys.argv'. ['-a', SOME_VALUE]):
    main()

Read more about unittest.mock.patch in documentation

Also, check this SO question:

How do I set sys.argv so I can unit test it?

edited May 23, 2017 at 11:52

CommunityBot

11 silver badge

answered Oct 4, 2016 at 13:31

Evgeny Sharypin

6797 silver badges7 bronze badges

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

1 Comment

khaverim Over a year ago

For whatever reason, from unittest.mock import patch with patch(...) worked, while import unittest with unittest.mock.patch(...) did not. In any case, this helped a lot.

XabiFermal · Accepted Answer · 2016-10-04 14:06:52Z

1

@William Fernandes: Just for the sake of completeness, I'll post the full solution in the way that was suggested by (checking for an empty dict not kwargs is None):

def main(**kwargs):
    a = None
    if not kwargs:
        parser = argparse.ArgumentParser()
        parser.add_argument('a', type=str, help='mandatory argument a')
        args = parser.parse_args()
        a = args.a
    else:
        a = kwargs.get('a')

    print(a)

From within the test class the main function can then be called with arguments:

# file in the tests folder calling the above main function
class TestConsole(TestCase):
    def test_basic(self):
        main(a=42)

The call from the command line without kwargs then requires the specification of the command line argument a=....

edited Oct 4, 2016 at 14:06

answered Oct 4, 2016 at 13:58

XabiFermal

1631 gold badge1 silver badge7 bronze badges

Comments

William Fernandes · Accepted Answer · 2016-10-04 13:50:02Z

0

Add kwargs to main and if they're None, you set them to the parse_args.

answered Oct 4, 2016 at 13:50

William Fernandes

2391 gold badge2 silver badges15 bronze badges

Collectives™ on Stack Overflow

How to set argparse arguments from python script

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related