Add ability to inherit unittest argument parser

[httpsgithubcomatb00ker]

BPO	39283
Nosy	@tirkarthi, @https://github.com/atb00ker

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-01-10.04:32:18.746>
labels = ['type-bug', 'library']
title = 'Add ability to inherit unittest arguement parser'
updated_at = <Date 2020-01-21.10:12:39.221>
user = 'https://github.com/httpsgithubcomatb00ker'

bugs.python.org fields:

activity = <Date 2020-01-21.10:12:39.221>
actor = 'atb00ker'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2020-01-10.04:32:18.746>
creator = 'atb00ker'
dependencies = []
files = []
hgrepos = []
issue_num = 39283
keywords = []
message_count = 5.0
messages = ['359704', '359716', '359949', '360226', '360381']
nosy_count = 3.0
nosy_names = ['paul.j3', 'xtreak', 'atb00ker']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue39283'
versions = []

[httpsgithubcomatb00ker]

I am currently writing a unittest script that requires argparser but since the unittest module already has a ArgumentParser instance, I cannot create and use my own ArgumentParser instance.

Possible solution:

The problem would be solved I could inherit the parent ArgumentParser instance created here:
https://github.com/python/cpython/blob/master/Lib/unittest/main.py#L162

Please let me know if it's feasible / acceptable to change parent_parser as self.parent_parent for inheritance.

I would love to create a pull request for it.

[tirkarthi]

Can you please post the unittest script and the desired behavior? Are you testing your own argument parser created using argparse or want to write something replacing the argument parser of the unittest module like creating a custom unittest runner?

[httpsgithubcomatb00ker]

Hi,

Thanks for your response, here is a code sample of what I am doing right now:

import unittest
import sys

class MyTest(unittest.TestCase):

    def __init__(self, testName, extraArg):
        super(MyTest, self).__init__(testName)
        self.myExtraArg = extraArg

    def test_something(self):
        print(self.myExtraArg)

extraArg = sys.argv.pop()
suite = unittest.TestSuite()
suite.addTest(MyTest('test_something', extraArg))
unittest.TextTestRunner(verbosity=2).run(suite)

It works.
However, this can be cumbersome if there are a lot of "extraArgs" and MyTestClasses.
Especically, if there is an existing argparser function existing that is used in the program, re-writing the code for passing args in another way for unittest doesn't seem ideal.

Ideally, I think something like this may work perfectly:

import unittest


class SomethingLikeInheritedUnitest(unittest.TestProgram):
    # parent_parser is used here: https://github.com/python/cpython/blob/master/Lib/unittest/main.py#L162
    parent = super().createParentArgParserAndReturnIt()
    parser = argparse.ArgumentParser(parents=[parent])
    parser.add_argument('--myarg1', ...)
    parser.add_argument('--myarg2', ...)
    return parser

Now the parser may be exposed to user's MyTest class and they can use
arguements as: paser.myarg1

Note: I am not certain this may be the way to go about it, there may be a better way, infact, I've not even had the time to read the entire code. :-(
I am only trying to point out is that the ability to add myarg1 in the parent_parser may be useful at times.

Hope this makes the point a bit more clear. If I have misunderstood something please correct me.

Thank You,
Ajay Tripathi

[paulj3]

The issue of testing a script that uses argparse has come up on StackOverFlow a number of times.

As noted the unittesting framework(s) often use their own parsers (not necessarily argparse). That means they are looking at the sys.argv commandline. It is difficult then to provide arguments that apply both to the framework, and your own script. If you try to your own options, the unittest parser will complain about unrecognized arguments.

As a first step, your parser should only run when used as a script, not when imported (by the unittester). In other words, only call parse_args in the 'if name' block.

If you do need to do unittesting of your parser, there are several monkey-patching options:

use 'parser.parse_args(argv)' calls, where 'argv' can be None if used as script, and a custom list when being tested.  Some will modify the sys.argv during testing.  The test_argparse.py unittest file tests both ways.

testing parser output may also require patching.  Help and errors are sent to sys.stdout or sys.stderr.  test_argparse.py uses an ArgumentParser subclass that redefines the error() and exit() methods, and redirects stdout/err.

[httpsgithubcomatb00ker]

Hi pual,

The issue of testing a script that uses argparse has come up on StackOverFlow a number of times.

Sorry for the confusing but this is not a support ticket,
I am not stuck with a problem and I am aware of the variaous solutions on Stackoverflow to use arguements with unittest module.

Instead, I am proposing a change in the module so that the user of unittest can get the parent_parser and add their arguements in the unitest argparser instance itself.

I propose this change because it seems like a more intuitive way to use argparser with unittest to me and I hope to hear your thoughts on the change and if it is desired.

Best,
Ajay Tripathi