Make docopt parse arguments containing spaces in unit tests

Question

I am having issues getting docopt to parse arguments that contain spaces into a proper dictionary object for use with my unit tests.

Here is the code I'm currently using to construct the argument list for docopt to parse:

testargs = []

def clear_args():
    testargs[:] = []
    return

def add_testfiles(file1='defaultfile1.txt', file2='defaultfile2.txt'):
    clear_args()
    testargs.append('--debug')
    testargs.append(file1)
    testargs.append(file2)
    return

def parse_args(optlist):
    argstr = ' '.join(optlist)
    return docopt(downpost.__doc__, argv=argstr)

The code I am writing unit tests for has 2 tests that are separately given the following arguments:

-t <title>  # <title> can be any string (with spaces) inside quotation marks
"A Filename with Spaces.txt"  # any filename as long as it's in quotation marks

To add, for example, the -t argument, I would do:

def test_exampleunittest(self):
    add_testfiles()
    testargs.append('-t "This is the title I want"')
    self.args = parse_args(testargs)
    self.post = myPythonScript.process(self.args)
    self.assertEqual(self.post['Subject'], 'This is the title I want')

If I run the script I'm testing by itself with the said arguments, they are accepted without any problems and the output is as expected.

However, if I run the unit tests which use arguments containing spaces, I get the following:

DocoptExit: Usage: myPythonScript [options] <file_1> <file_2>

Other unit tests that require the same dict object (containing the same arguments) work fine.

What should I change in my code to make docopt parse the arguments as it normally does?

This has been re-posted & answered on docopt's issue tracker on Github. Just waiting for @Halst to copy his answer over here so it can be marked as accepted. — Isxek
– Isxek, Commented Jul 24, 2013 at 12:41

Vladimir Keleshev · Accepted Answer · 2013-07-24 21:17:15Z

3

docopt takes argv parameter as either a string or a list.

If it is a list, it will interpret each item in the list as a separate argument.
If it is a string, it will split the string into a list using .split(). This way you loose all whitespace.

So in order for your test to work, you should pass a list instead of joining it into a string argstr = ' '.join(testargs).

This confusion is probably due to the fact that passing string to argv is undocumented. In fact it is not part of API, just an implementation detail. You should not rely on the fact that docopt argv takes a string—this might go away. However docopt will always accept a list for argv.

answered Jul 24, 2013 at 21:17

Vladimir Keleshev

14.4k17 gold badges71 silver badges96 bronze badges

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

Collectives™ on Stack Overflow

Make docopt parse arguments containing spaces in unit tests

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