mirror of https://github.com/python/cpython
7071 lines
245 KiB
Python
7071 lines
245 KiB
Python
# Author: Steven J. Bethard <steven.bethard@gmail.com>.
|
|
|
|
import contextlib
|
|
import functools
|
|
import inspect
|
|
import io
|
|
import operator
|
|
import os
|
|
import py_compile
|
|
import shutil
|
|
import stat
|
|
import sys
|
|
import textwrap
|
|
import tempfile
|
|
import unittest
|
|
import argparse
|
|
import warnings
|
|
|
|
from enum import StrEnum
|
|
from test.support import captured_stderr
|
|
from test.support import import_helper
|
|
from test.support import os_helper
|
|
from test.support import script_helper
|
|
from test.support.i18n_helper import TestTranslationsBase, update_translation_snapshots
|
|
from unittest import mock
|
|
|
|
|
|
py = os.path.basename(sys.executable)
|
|
|
|
|
|
class StdIOBuffer(io.TextIOWrapper):
|
|
'''Replacement for writable io.StringIO that behaves more like real file
|
|
|
|
Unlike StringIO, provides a buffer attribute that holds the underlying
|
|
binary data, allowing it to replace sys.stdout/sys.stderr in more
|
|
contexts.
|
|
'''
|
|
|
|
def __init__(self, initial_value='', newline='\n'):
|
|
initial_value = initial_value.encode('utf-8')
|
|
super().__init__(io.BufferedWriter(io.BytesIO(initial_value)),
|
|
'utf-8', newline=newline)
|
|
|
|
def getvalue(self):
|
|
self.flush()
|
|
return self.buffer.raw.getvalue().decode('utf-8')
|
|
|
|
|
|
class StdStreamTest(unittest.TestCase):
|
|
|
|
def test_skip_invalid_stderr(self):
|
|
parser = argparse.ArgumentParser()
|
|
with (
|
|
contextlib.redirect_stderr(None),
|
|
mock.patch('argparse._sys.exit')
|
|
):
|
|
parser.exit(status=0, message='foo')
|
|
|
|
def test_skip_invalid_stdout(self):
|
|
parser = argparse.ArgumentParser()
|
|
for func in (
|
|
parser.print_usage,
|
|
parser.print_help,
|
|
functools.partial(parser.parse_args, ['-h'])
|
|
):
|
|
with (
|
|
self.subTest(func=func),
|
|
contextlib.redirect_stdout(None),
|
|
# argparse uses stderr as a fallback
|
|
StdIOBuffer() as mocked_stderr,
|
|
contextlib.redirect_stderr(mocked_stderr),
|
|
mock.patch('argparse._sys.exit'),
|
|
):
|
|
func()
|
|
self.assertRegex(mocked_stderr.getvalue(), r'usage:')
|
|
|
|
|
|
class TestCase(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
# The tests assume that line wrapping occurs at 80 columns, but this
|
|
# behaviour can be overridden by setting the COLUMNS environment
|
|
# variable. To ensure that this width is used, set COLUMNS to 80.
|
|
env = self.enterContext(os_helper.EnvironmentVarGuard())
|
|
env['COLUMNS'] = '80'
|
|
|
|
|
|
@os_helper.skip_unless_working_chmod
|
|
class TempDirMixin(object):
|
|
|
|
def setUp(self):
|
|
self.temp_dir = tempfile.mkdtemp()
|
|
self.old_dir = os.getcwd()
|
|
os.chdir(self.temp_dir)
|
|
|
|
def tearDown(self):
|
|
os.chdir(self.old_dir)
|
|
for root, dirs, files in os.walk(self.temp_dir, topdown=False):
|
|
for name in files:
|
|
os.chmod(os.path.join(self.temp_dir, name), stat.S_IWRITE)
|
|
shutil.rmtree(self.temp_dir, True)
|
|
|
|
def create_writable_file(self, filename):
|
|
file_path = os.path.join(self.temp_dir, filename)
|
|
with open(file_path, 'w', encoding="utf-8") as file:
|
|
file.write(filename)
|
|
return file_path
|
|
|
|
def create_readonly_file(self, filename):
|
|
os.chmod(self.create_writable_file(filename), stat.S_IREAD)
|
|
|
|
class Sig(object):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.args = args
|
|
self.kwargs = kwargs
|
|
|
|
|
|
class NS(object):
|
|
|
|
def __init__(self, **kwargs):
|
|
self.__dict__.update(kwargs)
|
|
|
|
def __repr__(self):
|
|
sorted_items = sorted(self.__dict__.items())
|
|
kwarg_str = ', '.join(['%s=%r' % tup for tup in sorted_items])
|
|
return '%s(%s)' % (type(self).__name__, kwarg_str)
|
|
|
|
def __eq__(self, other):
|
|
return vars(self) == vars(other)
|
|
|
|
|
|
class ArgumentParserError(Exception):
|
|
|
|
def __init__(self, message, stdout=None, stderr=None, error_code=None):
|
|
Exception.__init__(self, message, stdout, stderr)
|
|
self.message = message
|
|
self.stdout = stdout
|
|
self.stderr = stderr
|
|
self.error_code = error_code
|
|
|
|
|
|
def stderr_to_parser_error(parse_args, *args, **kwargs):
|
|
# if this is being called recursively and stderr or stdout is already being
|
|
# redirected, simply call the function and let the enclosing function
|
|
# catch the exception
|
|
if isinstance(sys.stderr, StdIOBuffer) or isinstance(sys.stdout, StdIOBuffer):
|
|
return parse_args(*args, **kwargs)
|
|
|
|
# if this is not being called recursively, redirect stderr and
|
|
# use it as the ArgumentParserError message
|
|
old_stdout = sys.stdout
|
|
old_stderr = sys.stderr
|
|
sys.stdout = StdIOBuffer()
|
|
sys.stderr = StdIOBuffer()
|
|
try:
|
|
try:
|
|
result = parse_args(*args, **kwargs)
|
|
for key in list(vars(result)):
|
|
attr = getattr(result, key)
|
|
if attr is sys.stdout:
|
|
setattr(result, key, old_stdout)
|
|
elif attr is sys.stdout.buffer:
|
|
setattr(result, key, getattr(old_stdout, 'buffer', BIN_STDOUT_SENTINEL))
|
|
elif attr is sys.stderr:
|
|
setattr(result, key, old_stderr)
|
|
elif attr is sys.stderr.buffer:
|
|
setattr(result, key, getattr(old_stderr, 'buffer', BIN_STDERR_SENTINEL))
|
|
return result
|
|
except SystemExit as e:
|
|
code = e.code
|
|
stdout = sys.stdout.getvalue()
|
|
stderr = sys.stderr.getvalue()
|
|
raise ArgumentParserError(
|
|
"SystemExit", stdout, stderr, code) from None
|
|
finally:
|
|
sys.stdout = old_stdout
|
|
sys.stderr = old_stderr
|
|
|
|
|
|
class ErrorRaisingArgumentParser(argparse.ArgumentParser):
|
|
|
|
def parse_args(self, *args, **kwargs):
|
|
parse_args = super(ErrorRaisingArgumentParser, self).parse_args
|
|
return stderr_to_parser_error(parse_args, *args, **kwargs)
|
|
|
|
def exit(self, *args, **kwargs):
|
|
exit = super(ErrorRaisingArgumentParser, self).exit
|
|
return stderr_to_parser_error(exit, *args, **kwargs)
|
|
|
|
def error(self, *args, **kwargs):
|
|
error = super(ErrorRaisingArgumentParser, self).error
|
|
return stderr_to_parser_error(error, *args, **kwargs)
|
|
|
|
|
|
class ParserTesterMetaclass(type):
|
|
"""Adds parser tests using the class attributes.
|
|
|
|
Classes of this type should specify the following attributes:
|
|
|
|
argument_signatures -- a list of Sig objects which specify
|
|
the signatures of Argument objects to be created
|
|
failures -- a list of args lists that should cause the parser
|
|
to fail
|
|
successes -- a list of (initial_args, options, remaining_args) tuples
|
|
where initial_args specifies the string args to be parsed,
|
|
options is a dict that should match the vars() of the options
|
|
parsed out of initial_args, and remaining_args should be any
|
|
remaining unparsed arguments
|
|
"""
|
|
|
|
def __init__(cls, name, bases, bodydict):
|
|
if name == 'ParserTestCase':
|
|
return
|
|
|
|
# default parser signature is empty
|
|
if not hasattr(cls, 'parser_signature'):
|
|
cls.parser_signature = Sig()
|
|
if not hasattr(cls, 'parser_class'):
|
|
cls.parser_class = ErrorRaisingArgumentParser
|
|
|
|
# ---------------------------------------
|
|
# functions for adding optional arguments
|
|
# ---------------------------------------
|
|
def no_groups(parser, argument_signatures):
|
|
"""Add all arguments directly to the parser"""
|
|
for sig in argument_signatures:
|
|
parser.add_argument(*sig.args, **sig.kwargs)
|
|
|
|
def one_group(parser, argument_signatures):
|
|
"""Add all arguments under a single group in the parser"""
|
|
group = parser.add_argument_group('foo')
|
|
for sig in argument_signatures:
|
|
group.add_argument(*sig.args, **sig.kwargs)
|
|
|
|
def many_groups(parser, argument_signatures):
|
|
"""Add each argument in its own group to the parser"""
|
|
for i, sig in enumerate(argument_signatures):
|
|
group = parser.add_argument_group('foo:%i' % i)
|
|
group.add_argument(*sig.args, **sig.kwargs)
|
|
|
|
# --------------------------
|
|
# functions for parsing args
|
|
# --------------------------
|
|
def listargs(parser, args):
|
|
"""Parse the args by passing in a list"""
|
|
return parser.parse_args(args)
|
|
|
|
def sysargs(parser, args):
|
|
"""Parse the args by defaulting to sys.argv"""
|
|
old_sys_argv = sys.argv
|
|
sys.argv = [old_sys_argv[0]] + args
|
|
try:
|
|
return parser.parse_args()
|
|
finally:
|
|
sys.argv = old_sys_argv
|
|
|
|
# class that holds the combination of one optional argument
|
|
# addition method and one arg parsing method
|
|
class AddTests(object):
|
|
|
|
def __init__(self, tester_cls, add_arguments, parse_args):
|
|
self._add_arguments = add_arguments
|
|
self._parse_args = parse_args
|
|
|
|
add_arguments_name = self._add_arguments.__name__
|
|
parse_args_name = self._parse_args.__name__
|
|
for test_func in [self.test_failures, self.test_successes]:
|
|
func_name = test_func.__name__
|
|
names = func_name, add_arguments_name, parse_args_name
|
|
test_name = '_'.join(names)
|
|
|
|
def wrapper(self, test_func=test_func):
|
|
test_func(self)
|
|
try:
|
|
wrapper.__name__ = test_name
|
|
except TypeError:
|
|
pass
|
|
setattr(tester_cls, test_name, wrapper)
|
|
|
|
def _get_parser(self, tester):
|
|
args = tester.parser_signature.args
|
|
kwargs = tester.parser_signature.kwargs
|
|
parser = tester.parser_class(*args, **kwargs)
|
|
self._add_arguments(parser, tester.argument_signatures)
|
|
return parser
|
|
|
|
def test_failures(self, tester):
|
|
parser = self._get_parser(tester)
|
|
for args_str in tester.failures:
|
|
args = args_str.split()
|
|
with tester.subTest(args=args):
|
|
with tester.assertRaises(ArgumentParserError, msg=args):
|
|
parser.parse_args(args)
|
|
|
|
def test_successes(self, tester):
|
|
parser = self._get_parser(tester)
|
|
for args, expected_ns in tester.successes:
|
|
if isinstance(args, str):
|
|
args = args.split()
|
|
with tester.subTest(args=args):
|
|
result_ns = self._parse_args(parser, args)
|
|
tester.assertEqual(expected_ns, result_ns)
|
|
|
|
# add tests for each combination of an optionals adding method
|
|
# and an arg parsing method
|
|
for add_arguments in [no_groups, one_group, many_groups]:
|
|
for parse_args in [listargs, sysargs]:
|
|
AddTests(cls, add_arguments, parse_args)
|
|
|
|
bases = TestCase,
|
|
ParserTestCase = ParserTesterMetaclass('ParserTestCase', bases, {})
|
|
|
|
# ===============
|
|
# Optionals tests
|
|
# ===============
|
|
|
|
class TestOptionalsSingleDash(ParserTestCase):
|
|
"""Test an Optional with a single-dash option string"""
|
|
|
|
argument_signatures = [Sig('-x')]
|
|
failures = ['-x', 'a', '--foo', '-x --foo', '-x -y']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-x a', NS(x='a')),
|
|
('-xa', NS(x='a')),
|
|
('-x -1', NS(x='-1')),
|
|
('-x-1', NS(x='-1')),
|
|
]
|
|
|
|
|
|
class TestOptionalsSingleDashCombined(ParserTestCase):
|
|
"""Test an Optional with a single-dash option string"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', action='store_true'),
|
|
Sig('-yyy', action='store_const', const=42),
|
|
Sig('-z'),
|
|
]
|
|
failures = ['a', '--foo', '-xa', '-x --foo', '-x -z', '-z -x',
|
|
'-yx', '-yz a', '-yyyx', '-yyyza', '-xyza', '-x=']
|
|
successes = [
|
|
('', NS(x=False, yyy=None, z=None)),
|
|
('-x', NS(x=True, yyy=None, z=None)),
|
|
('-za', NS(x=False, yyy=None, z='a')),
|
|
('-z a', NS(x=False, yyy=None, z='a')),
|
|
('-xza', NS(x=True, yyy=None, z='a')),
|
|
('-xz a', NS(x=True, yyy=None, z='a')),
|
|
('-x -za', NS(x=True, yyy=None, z='a')),
|
|
('-x -z a', NS(x=True, yyy=None, z='a')),
|
|
('-y', NS(x=False, yyy=42, z=None)),
|
|
('-yyy', NS(x=False, yyy=42, z=None)),
|
|
('-x -yyy -za', NS(x=True, yyy=42, z='a')),
|
|
('-x -yyy -z a', NS(x=True, yyy=42, z='a')),
|
|
]
|
|
|
|
|
|
class TestOptionalsSingleDashLong(ParserTestCase):
|
|
"""Test an Optional with a multi-character single-dash option string"""
|
|
|
|
argument_signatures = [Sig('-foo')]
|
|
failures = ['-foo', 'a', '--foo', '-foo --foo', '-foo -y', '-fooa']
|
|
successes = [
|
|
('', NS(foo=None)),
|
|
('-foo a', NS(foo='a')),
|
|
('-foo -1', NS(foo='-1')),
|
|
('-fo a', NS(foo='a')),
|
|
('-f a', NS(foo='a')),
|
|
]
|
|
|
|
|
|
class TestOptionalsSingleDashSubsetAmbiguous(ParserTestCase):
|
|
"""Test Optionals where option strings are subsets of each other"""
|
|
|
|
argument_signatures = [Sig('-f'), Sig('-foobar'), Sig('-foorab')]
|
|
failures = ['-f', '-foo', '-fo', '-foo b', '-foob', '-fooba', '-foora']
|
|
successes = [
|
|
('', NS(f=None, foobar=None, foorab=None)),
|
|
('-f a', NS(f='a', foobar=None, foorab=None)),
|
|
('-fa', NS(f='a', foobar=None, foorab=None)),
|
|
('-foa', NS(f='oa', foobar=None, foorab=None)),
|
|
('-fooa', NS(f='ooa', foobar=None, foorab=None)),
|
|
('-foobar a', NS(f=None, foobar='a', foorab=None)),
|
|
('-foorab a', NS(f=None, foobar=None, foorab='a')),
|
|
]
|
|
|
|
|
|
class TestOptionalsSingleDashAmbiguous(ParserTestCase):
|
|
"""Test Optionals that partially match but are not subsets"""
|
|
|
|
argument_signatures = [Sig('-foobar'), Sig('-foorab')]
|
|
failures = ['-f', '-f a', '-fa', '-foa', '-foo', '-fo', '-foo b',
|
|
'-f=a', '-foo=b']
|
|
successes = [
|
|
('', NS(foobar=None, foorab=None)),
|
|
('-foob a', NS(foobar='a', foorab=None)),
|
|
('-foob=a', NS(foobar='a', foorab=None)),
|
|
('-foor a', NS(foobar=None, foorab='a')),
|
|
('-foor=a', NS(foobar=None, foorab='a')),
|
|
('-fooba a', NS(foobar='a', foorab=None)),
|
|
('-fooba=a', NS(foobar='a', foorab=None)),
|
|
('-foora a', NS(foobar=None, foorab='a')),
|
|
('-foora=a', NS(foobar=None, foorab='a')),
|
|
('-foobar a', NS(foobar='a', foorab=None)),
|
|
('-foobar=a', NS(foobar='a', foorab=None)),
|
|
('-foorab a', NS(foobar=None, foorab='a')),
|
|
('-foorab=a', NS(foobar=None, foorab='a')),
|
|
]
|
|
|
|
|
|
class TestOptionalsNumeric(ParserTestCase):
|
|
"""Test an Optional with a short opt string"""
|
|
|
|
argument_signatures = [Sig('-1', dest='one')]
|
|
failures = ['-1', 'a', '-1 --foo', '-1 -y', '-1 -1', '-1 -2']
|
|
successes = [
|
|
('', NS(one=None)),
|
|
('-1 a', NS(one='a')),
|
|
('-1a', NS(one='a')),
|
|
('-1-2', NS(one='-2')),
|
|
]
|
|
|
|
|
|
class TestOptionalsDoubleDash(ParserTestCase):
|
|
"""Test an Optional with a double-dash option string"""
|
|
|
|
argument_signatures = [Sig('--foo')]
|
|
failures = ['--foo', '-f', '-f a', 'a', '--foo -x', '--foo --bar']
|
|
successes = [
|
|
('', NS(foo=None)),
|
|
('--foo a', NS(foo='a')),
|
|
('--foo=a', NS(foo='a')),
|
|
('--foo -2.5', NS(foo='-2.5')),
|
|
('--foo=-2.5', NS(foo='-2.5')),
|
|
]
|
|
|
|
|
|
class TestOptionalsDoubleDashPartialMatch(ParserTestCase):
|
|
"""Tests partial matching with a double-dash option string"""
|
|
|
|
argument_signatures = [
|
|
Sig('--badger', action='store_true'),
|
|
Sig('--bat'),
|
|
]
|
|
failures = ['--bar', '--b', '--ba', '--b=2', '--ba=4', '--badge 5']
|
|
successes = [
|
|
('', NS(badger=False, bat=None)),
|
|
('--bat X', NS(badger=False, bat='X')),
|
|
('--bad', NS(badger=True, bat=None)),
|
|
('--badg', NS(badger=True, bat=None)),
|
|
('--badge', NS(badger=True, bat=None)),
|
|
('--badger', NS(badger=True, bat=None)),
|
|
]
|
|
|
|
|
|
class TestOptionalsDoubleDashPrefixMatch(ParserTestCase):
|
|
"""Tests when one double-dash option string is a prefix of another"""
|
|
|
|
argument_signatures = [
|
|
Sig('--badger', action='store_true'),
|
|
Sig('--ba'),
|
|
]
|
|
failures = ['--bar', '--b', '--ba', '--b=2', '--badge 5']
|
|
successes = [
|
|
('', NS(badger=False, ba=None)),
|
|
('--ba X', NS(badger=False, ba='X')),
|
|
('--ba=X', NS(badger=False, ba='X')),
|
|
('--bad', NS(badger=True, ba=None)),
|
|
('--badg', NS(badger=True, ba=None)),
|
|
('--badge', NS(badger=True, ba=None)),
|
|
('--badger', NS(badger=True, ba=None)),
|
|
]
|
|
|
|
|
|
class TestOptionalsSingleDoubleDash(ParserTestCase):
|
|
"""Test an Optional with single- and double-dash option strings"""
|
|
|
|
argument_signatures = [
|
|
Sig('-f', action='store_true'),
|
|
Sig('--bar'),
|
|
Sig('-baz', action='store_const', const=42),
|
|
]
|
|
failures = ['--bar', '-fbar', '-fbaz', '-bazf', '-b B', 'B']
|
|
successes = [
|
|
('', NS(f=False, bar=None, baz=None)),
|
|
('-f', NS(f=True, bar=None, baz=None)),
|
|
('--ba B', NS(f=False, bar='B', baz=None)),
|
|
('-f --bar B', NS(f=True, bar='B', baz=None)),
|
|
('-f -b', NS(f=True, bar=None, baz=42)),
|
|
('-ba -f', NS(f=True, bar=None, baz=42)),
|
|
]
|
|
|
|
|
|
class TestOptionalsAlternatePrefixChars(ParserTestCase):
|
|
"""Test an Optional with option strings with custom prefixes"""
|
|
|
|
parser_signature = Sig(prefix_chars='+:/', add_help=False)
|
|
argument_signatures = [
|
|
Sig('+f', action='store_true'),
|
|
Sig('::bar'),
|
|
Sig('/baz', action='store_const', const=42),
|
|
]
|
|
failures = ['--bar', '-fbar', '-b B', 'B', '-f', '--bar B', '-baz', '-h', '--help', '+h', '::help', '/help']
|
|
successes = [
|
|
('', NS(f=False, bar=None, baz=None)),
|
|
('+f', NS(f=True, bar=None, baz=None)),
|
|
('::ba B', NS(f=False, bar='B', baz=None)),
|
|
('+f ::bar B', NS(f=True, bar='B', baz=None)),
|
|
('+f /b', NS(f=True, bar=None, baz=42)),
|
|
('/ba +f', NS(f=True, bar=None, baz=42)),
|
|
]
|
|
|
|
|
|
class TestOptionalsAlternatePrefixCharsAddedHelp(ParserTestCase):
|
|
"""When ``-`` not in prefix_chars, default operators created for help
|
|
should use the prefix_chars in use rather than - or --
|
|
http://bugs.python.org/issue9444"""
|
|
|
|
parser_signature = Sig(prefix_chars='+:/', add_help=True)
|
|
argument_signatures = [
|
|
Sig('+f', action='store_true'),
|
|
Sig('::bar'),
|
|
Sig('/baz', action='store_const', const=42),
|
|
]
|
|
failures = ['--bar', '-fbar', '-b B', 'B', '-f', '--bar B', '-baz']
|
|
successes = [
|
|
('', NS(f=False, bar=None, baz=None)),
|
|
('+f', NS(f=True, bar=None, baz=None)),
|
|
('::ba B', NS(f=False, bar='B', baz=None)),
|
|
('+f ::bar B', NS(f=True, bar='B', baz=None)),
|
|
('+f /b', NS(f=True, bar=None, baz=42)),
|
|
('/ba +f', NS(f=True, bar=None, baz=42))
|
|
]
|
|
|
|
|
|
class TestOptionalsAlternatePrefixCharsMultipleShortArgs(ParserTestCase):
|
|
"""Verify that Optionals must be called with their defined prefixes"""
|
|
|
|
parser_signature = Sig(prefix_chars='+-', add_help=False)
|
|
argument_signatures = [
|
|
Sig('-x', action='store_true'),
|
|
Sig('+y', action='store_true'),
|
|
Sig('+z', action='store_true'),
|
|
]
|
|
failures = ['-w',
|
|
'-xyz',
|
|
'+x',
|
|
'-y',
|
|
'+xyz',
|
|
]
|
|
successes = [
|
|
('', NS(x=False, y=False, z=False)),
|
|
('-x', NS(x=True, y=False, z=False)),
|
|
('+y -x', NS(x=True, y=True, z=False)),
|
|
('+yz -x', NS(x=True, y=True, z=True)),
|
|
]
|
|
|
|
|
|
class TestOptionalsShortLong(ParserTestCase):
|
|
"""Test a combination of single- and double-dash option strings"""
|
|
|
|
argument_signatures = [
|
|
Sig('-v', '--verbose', '-n', '--noisy', action='store_true'),
|
|
]
|
|
failures = ['--x --verbose', '-N', 'a', '-v x']
|
|
successes = [
|
|
('', NS(verbose=False)),
|
|
('-v', NS(verbose=True)),
|
|
('--verbose', NS(verbose=True)),
|
|
('-n', NS(verbose=True)),
|
|
('--noisy', NS(verbose=True)),
|
|
]
|
|
|
|
|
|
class TestOptionalsDest(ParserTestCase):
|
|
"""Tests various means of setting destination"""
|
|
|
|
argument_signatures = [Sig('--foo-bar'), Sig('--baz', dest='zabbaz')]
|
|
failures = ['a']
|
|
successes = [
|
|
('--foo-bar f', NS(foo_bar='f', zabbaz=None)),
|
|
('--baz g', NS(foo_bar=None, zabbaz='g')),
|
|
('--foo-bar h --baz i', NS(foo_bar='h', zabbaz='i')),
|
|
('--baz j --foo-bar k', NS(foo_bar='k', zabbaz='j')),
|
|
]
|
|
|
|
|
|
class TestOptionalsDefault(ParserTestCase):
|
|
"""Tests specifying a default for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('-y', default=42)]
|
|
failures = ['a']
|
|
successes = [
|
|
('', NS(x=None, y=42)),
|
|
('-xx', NS(x='x', y=42)),
|
|
('-yy', NS(x=None, y='y')),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargsDefault(ParserTestCase):
|
|
"""Tests not specifying the number of args for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x')]
|
|
failures = ['a', '-x']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-x a', NS(x='a')),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargs1(ParserTestCase):
|
|
"""Tests specifying 1 arg for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x', nargs=1)]
|
|
failures = ['a', '-x']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-x a', NS(x=['a'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargs3(ParserTestCase):
|
|
"""Tests specifying 3 args for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x', nargs=3)]
|
|
failures = ['a', '-x', '-x a', '-x a b', 'a -x', 'a -x b']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-x a b c', NS(x=['a', 'b', 'c'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargsOptional(ParserTestCase):
|
|
"""Tests specifying an Optional arg for an Optional"""
|
|
|
|
argument_signatures = [
|
|
Sig('-w', nargs='?'),
|
|
Sig('-x', nargs='?', const=42),
|
|
Sig('-y', nargs='?', default='spam'),
|
|
Sig('-z', nargs='?', type=int, const='42', default='84', choices=[1, 2]),
|
|
]
|
|
failures = ['2', '-z a', '-z 42', '-z 84']
|
|
successes = [
|
|
('', NS(w=None, x=None, y='spam', z=84)),
|
|
('-w', NS(w=None, x=None, y='spam', z=84)),
|
|
('-w 2', NS(w='2', x=None, y='spam', z=84)),
|
|
('-x', NS(w=None, x=42, y='spam', z=84)),
|
|
('-x 2', NS(w=None, x='2', y='spam', z=84)),
|
|
('-y', NS(w=None, x=None, y=None, z=84)),
|
|
('-y 2', NS(w=None, x=None, y='2', z=84)),
|
|
('-z', NS(w=None, x=None, y='spam', z=42)),
|
|
('-z 2', NS(w=None, x=None, y='spam', z=2)),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargsZeroOrMore(ParserTestCase):
|
|
"""Tests specifying args for an Optional that accepts zero or more"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', nargs='*'),
|
|
Sig('-y', nargs='*', default='spam'),
|
|
]
|
|
failures = ['a']
|
|
successes = [
|
|
('', NS(x=None, y='spam')),
|
|
('-x', NS(x=[], y='spam')),
|
|
('-x a', NS(x=['a'], y='spam')),
|
|
('-x a b', NS(x=['a', 'b'], y='spam')),
|
|
('-y', NS(x=None, y=[])),
|
|
('-y a', NS(x=None, y=['a'])),
|
|
('-y a b', NS(x=None, y=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsNargsOneOrMore(ParserTestCase):
|
|
"""Tests specifying args for an Optional that accepts one or more"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', nargs='+'),
|
|
Sig('-y', nargs='+', default='spam'),
|
|
]
|
|
failures = ['a', '-x', '-y', 'a -x', 'a -y b']
|
|
successes = [
|
|
('', NS(x=None, y='spam')),
|
|
('-x a', NS(x=['a'], y='spam')),
|
|
('-x a b', NS(x=['a', 'b'], y='spam')),
|
|
('-y a', NS(x=None, y=['a'])),
|
|
('-y a b', NS(x=None, y=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsChoices(ParserTestCase):
|
|
"""Tests specifying the choices for an Optional"""
|
|
|
|
argument_signatures = [
|
|
Sig('-f', choices='abc'),
|
|
Sig('-g', type=int, choices=range(5))]
|
|
failures = ['a', '-f d', '-f ab', '-fad', '-ga', '-g 6']
|
|
successes = [
|
|
('', NS(f=None, g=None)),
|
|
('-f a', NS(f='a', g=None)),
|
|
('-f c', NS(f='c', g=None)),
|
|
('-g 0', NS(f=None, g=0)),
|
|
('-g 03', NS(f=None, g=3)),
|
|
('-fb -g4', NS(f='b', g=4)),
|
|
]
|
|
|
|
|
|
class TestOptionalsRequired(ParserTestCase):
|
|
"""Tests an optional action that is required"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=int, required=True),
|
|
]
|
|
failures = ['a', '']
|
|
successes = [
|
|
('-x 1', NS(x=1)),
|
|
('-x42', NS(x=42)),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionStore(ParserTestCase):
|
|
"""Tests the store action for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x', action='store')]
|
|
failures = ['a', 'a -x']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-xfoo', NS(x='foo')),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionStoreConst(ParserTestCase):
|
|
"""Tests the store_const action for an Optional"""
|
|
|
|
argument_signatures = [Sig('-y', action='store_const', const=object)]
|
|
failures = ['a']
|
|
successes = [
|
|
('', NS(y=None)),
|
|
('-y', NS(y=object)),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionStoreFalse(ParserTestCase):
|
|
"""Tests the store_false action for an Optional"""
|
|
|
|
argument_signatures = [Sig('-z', action='store_false')]
|
|
failures = ['a', '-za', '-z a']
|
|
successes = [
|
|
('', NS(z=True)),
|
|
('-z', NS(z=False)),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionStoreTrue(ParserTestCase):
|
|
"""Tests the store_true action for an Optional"""
|
|
|
|
argument_signatures = [Sig('--apple', action='store_true')]
|
|
failures = ['a', '--apple=b', '--apple b']
|
|
successes = [
|
|
('', NS(apple=False)),
|
|
('--apple', NS(apple=True)),
|
|
]
|
|
|
|
class TestBooleanOptionalAction(ParserTestCase):
|
|
"""Tests BooleanOptionalAction"""
|
|
|
|
argument_signatures = [Sig('--foo', action=argparse.BooleanOptionalAction)]
|
|
failures = ['--foo bar', '--foo=bar']
|
|
successes = [
|
|
('', NS(foo=None)),
|
|
('--foo', NS(foo=True)),
|
|
('--no-foo', NS(foo=False)),
|
|
('--foo --no-foo', NS(foo=False)), # useful for aliases
|
|
('--no-foo --foo', NS(foo=True)),
|
|
]
|
|
|
|
def test_const(self):
|
|
# See bpo-40862
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(TypeError) as cm:
|
|
parser.add_argument('--foo', const=True, action=argparse.BooleanOptionalAction)
|
|
|
|
self.assertIn("got an unexpected keyword argument 'const'", str(cm.exception))
|
|
|
|
def test_invalid_name(self):
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(ValueError) as cm:
|
|
parser.add_argument('--no-foo', action=argparse.BooleanOptionalAction)
|
|
self.assertEqual(str(cm.exception),
|
|
"invalid option name '--no-foo' for BooleanOptionalAction")
|
|
|
|
class TestBooleanOptionalActionRequired(ParserTestCase):
|
|
"""Tests BooleanOptionalAction required"""
|
|
|
|
argument_signatures = [
|
|
Sig('--foo', required=True, action=argparse.BooleanOptionalAction)
|
|
]
|
|
failures = ['']
|
|
successes = [
|
|
('--foo', NS(foo=True)),
|
|
('--no-foo', NS(foo=False)),
|
|
]
|
|
|
|
class TestOptionalsActionAppend(ParserTestCase):
|
|
"""Tests the append action for an Optional"""
|
|
|
|
argument_signatures = [Sig('--baz', action='append')]
|
|
failures = ['a', '--baz', 'a --baz', '--baz a b']
|
|
successes = [
|
|
('', NS(baz=None)),
|
|
('--baz a', NS(baz=['a'])),
|
|
('--baz a --baz b', NS(baz=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionAppendWithDefault(ParserTestCase):
|
|
"""Tests the append action for an Optional"""
|
|
|
|
argument_signatures = [Sig('--baz', action='append', default=['X'])]
|
|
failures = ['a', '--baz', 'a --baz', '--baz a b']
|
|
successes = [
|
|
('', NS(baz=['X'])),
|
|
('--baz a', NS(baz=['X', 'a'])),
|
|
('--baz a --baz b', NS(baz=['X', 'a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestConstActionsMissingConstKwarg(ParserTestCase):
|
|
"""Tests that const gets default value of None when not provided"""
|
|
|
|
argument_signatures = [
|
|
Sig('-f', action='append_const'),
|
|
Sig('--foo', action='append_const'),
|
|
Sig('-b', action='store_const'),
|
|
Sig('--bar', action='store_const')
|
|
]
|
|
failures = ['-f v', '--foo=bar', '--foo bar']
|
|
successes = [
|
|
('', NS(f=None, foo=None, b=None, bar=None)),
|
|
('-f', NS(f=[None], foo=None, b=None, bar=None)),
|
|
('--foo', NS(f=None, foo=[None], b=None, bar=None)),
|
|
('-b', NS(f=None, foo=None, b=None, bar=None)),
|
|
('--bar', NS(f=None, foo=None, b=None, bar=None)),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionAppendConst(ParserTestCase):
|
|
"""Tests the append_const action for an Optional"""
|
|
|
|
argument_signatures = [
|
|
Sig('-b', action='append_const', const=Exception),
|
|
Sig('-c', action='append', dest='b'),
|
|
]
|
|
failures = ['a', '-c', 'a -c', '-bx', '-b x']
|
|
successes = [
|
|
('', NS(b=None)),
|
|
('-b', NS(b=[Exception])),
|
|
('-b -cx -b -cyz', NS(b=[Exception, 'x', Exception, 'yz'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionAppendConstWithDefault(ParserTestCase):
|
|
"""Tests the append_const action for an Optional"""
|
|
|
|
argument_signatures = [
|
|
Sig('-b', action='append_const', const=Exception, default=['X']),
|
|
Sig('-c', action='append', dest='b'),
|
|
]
|
|
failures = ['a', '-c', 'a -c', '-bx', '-b x']
|
|
successes = [
|
|
('', NS(b=['X'])),
|
|
('-b', NS(b=['X', Exception])),
|
|
('-b -cx -b -cyz', NS(b=['X', Exception, 'x', Exception, 'yz'])),
|
|
]
|
|
|
|
|
|
class TestOptionalsActionCount(ParserTestCase):
|
|
"""Tests the count action for an Optional"""
|
|
|
|
argument_signatures = [Sig('-x', action='count')]
|
|
failures = ['a', '-x a', '-x b', '-x a -x b']
|
|
successes = [
|
|
('', NS(x=None)),
|
|
('-x', NS(x=1)),
|
|
]
|
|
|
|
|
|
class TestOptionalsAllowLongAbbreviation(ParserTestCase):
|
|
"""Allow long options to be abbreviated unambiguously"""
|
|
|
|
argument_signatures = [
|
|
Sig('--foo'),
|
|
Sig('--foobaz'),
|
|
Sig('--fooble', action='store_true'),
|
|
]
|
|
failures = ['--foob 5', '--foob']
|
|
successes = [
|
|
('', NS(foo=None, foobaz=None, fooble=False)),
|
|
('--foo 7', NS(foo='7', foobaz=None, fooble=False)),
|
|
('--foo=7', NS(foo='7', foobaz=None, fooble=False)),
|
|
('--fooba a', NS(foo=None, foobaz='a', fooble=False)),
|
|
('--fooba=a', NS(foo=None, foobaz='a', fooble=False)),
|
|
('--foobl --foo g', NS(foo='g', foobaz=None, fooble=True)),
|
|
]
|
|
|
|
|
|
class TestOptionalsDisallowLongAbbreviation(ParserTestCase):
|
|
"""Do not allow abbreviations of long options at all"""
|
|
|
|
parser_signature = Sig(allow_abbrev=False)
|
|
argument_signatures = [
|
|
Sig('--foo'),
|
|
Sig('--foodle', action='store_true'),
|
|
Sig('--foonly'),
|
|
]
|
|
failures = ['-foon 3', '--foon 3', '--food', '--food --foo 2']
|
|
successes = [
|
|
('', NS(foo=None, foodle=False, foonly=None)),
|
|
('--foo 3', NS(foo='3', foodle=False, foonly=None)),
|
|
('--foonly 7 --foodle --foo 2', NS(foo='2', foodle=True, foonly='7')),
|
|
]
|
|
|
|
|
|
class TestOptionalsDisallowLongAbbreviationPrefixChars(ParserTestCase):
|
|
"""Disallowing abbreviations works with alternative prefix characters"""
|
|
|
|
parser_signature = Sig(prefix_chars='+', allow_abbrev=False)
|
|
argument_signatures = [
|
|
Sig('++foo'),
|
|
Sig('++foodle', action='store_true'),
|
|
Sig('++foonly'),
|
|
]
|
|
failures = ['+foon 3', '++foon 3', '++food', '++food ++foo 2']
|
|
successes = [
|
|
('', NS(foo=None, foodle=False, foonly=None)),
|
|
('++foo 3', NS(foo='3', foodle=False, foonly=None)),
|
|
('++foonly 7 ++foodle ++foo 2', NS(foo='2', foodle=True, foonly='7')),
|
|
]
|
|
|
|
|
|
class TestOptionalsDisallowSingleDashLongAbbreviation(ParserTestCase):
|
|
"""Do not allow abbreviations of long options at all"""
|
|
|
|
parser_signature = Sig(allow_abbrev=False)
|
|
argument_signatures = [
|
|
Sig('-foo'),
|
|
Sig('-foodle', action='store_true'),
|
|
Sig('-foonly'),
|
|
]
|
|
failures = ['-foon 3', '-food', '-food -foo 2']
|
|
successes = [
|
|
('', NS(foo=None, foodle=False, foonly=None)),
|
|
('-foo 3', NS(foo='3', foodle=False, foonly=None)),
|
|
('-foonly 7 -foodle -foo 2', NS(foo='2', foodle=True, foonly='7')),
|
|
]
|
|
|
|
|
|
class TestDisallowLongAbbreviationAllowsShortGrouping(ParserTestCase):
|
|
"""Do not allow abbreviations of long options at all"""
|
|
|
|
parser_signature = Sig(allow_abbrev=False)
|
|
argument_signatures = [
|
|
Sig('-r'),
|
|
Sig('-c', action='count'),
|
|
]
|
|
failures = ['-r', '-c -r']
|
|
successes = [
|
|
('', NS(r=None, c=None)),
|
|
('-ra', NS(r='a', c=None)),
|
|
('-rcc', NS(r='cc', c=None)),
|
|
('-cc', NS(r=None, c=2)),
|
|
('-cc -ra', NS(r='a', c=2)),
|
|
('-ccrcc', NS(r='cc', c=2)),
|
|
]
|
|
|
|
|
|
class TestDisallowLongAbbreviationAllowsShortGroupingPrefix(ParserTestCase):
|
|
"""Short option grouping works with custom prefix and allow_abbrev=False"""
|
|
|
|
parser_signature = Sig(prefix_chars='+', allow_abbrev=False)
|
|
argument_signatures = [
|
|
Sig('+r'),
|
|
Sig('+c', action='count'),
|
|
]
|
|
failures = ['+r', '+c +r']
|
|
successes = [
|
|
('', NS(r=None, c=None)),
|
|
('+ra', NS(r='a', c=None)),
|
|
('+rcc', NS(r='cc', c=None)),
|
|
('+cc', NS(r=None, c=2)),
|
|
('+cc +ra', NS(r='a', c=2)),
|
|
('+ccrcc', NS(r='cc', c=2)),
|
|
]
|
|
|
|
|
|
class TestStrEnumChoices(TestCase):
|
|
class Color(StrEnum):
|
|
RED = "red"
|
|
GREEN = "green"
|
|
BLUE = "blue"
|
|
|
|
def test_parse_enum_value(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--color', choices=self.Color)
|
|
args = parser.parse_args(['--color', 'red'])
|
|
self.assertEqual(args.color, self.Color.RED)
|
|
|
|
def test_help_message_contains_enum_choices(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--color', choices=self.Color, help='Choose a color')
|
|
self.assertIn('[--color {red,green,blue}]', parser.format_usage())
|
|
self.assertIn(' --color {red,green,blue}', parser.format_help())
|
|
|
|
def test_invalid_enum_value_raises_error(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('--color', choices=self.Color)
|
|
self.assertRaisesRegex(
|
|
argparse.ArgumentError,
|
|
r"invalid choice: 'yellow' \(choose from red, green, blue\)",
|
|
parser.parse_args,
|
|
['--color', 'yellow'],
|
|
)
|
|
|
|
# ================
|
|
# Positional tests
|
|
# ================
|
|
|
|
class TestPositionalsNargsNone(ParserTestCase):
|
|
"""Test a Positional that doesn't specify nargs"""
|
|
|
|
argument_signatures = [Sig('foo')]
|
|
failures = ['', '-x', 'a b']
|
|
successes = [
|
|
('a', NS(foo='a')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs1(ParserTestCase):
|
|
"""Test a Positional that specifies an nargs of 1"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=1)]
|
|
failures = ['', '-x', 'a b']
|
|
successes = [
|
|
('a', NS(foo=['a'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs2(ParserTestCase):
|
|
"""Test a Positional that specifies an nargs of 2"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=2)]
|
|
failures = ['', 'a', '-x', 'a b c']
|
|
successes = [
|
|
('a b', NS(foo=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsZeroOrMore(ParserTestCase):
|
|
"""Test a Positional that specifies unlimited nargs"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='*')]
|
|
failures = ['-x']
|
|
successes = [
|
|
('', NS(foo=[])),
|
|
('a', NS(foo=['a'])),
|
|
('a b', NS(foo=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsZeroOrMoreDefault(ParserTestCase):
|
|
"""Test a Positional that specifies unlimited nargs and a default"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='*', default='bar', choices=['a', 'b'])]
|
|
failures = ['-x', 'bar', 'a c']
|
|
successes = [
|
|
('', NS(foo='bar')),
|
|
('a', NS(foo=['a'])),
|
|
('a b', NS(foo=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOneOrMore(ParserTestCase):
|
|
"""Test a Positional that specifies one or more nargs"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='+')]
|
|
failures = ['', '-x']
|
|
successes = [
|
|
('a', NS(foo=['a'])),
|
|
('a b', NS(foo=['a', 'b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptional(ParserTestCase):
|
|
"""Tests an Optional Positional"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?')]
|
|
failures = ['-x', 'a b']
|
|
successes = [
|
|
('', NS(foo=None)),
|
|
('a', NS(foo='a')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalDefault(ParserTestCase):
|
|
"""Tests an Optional Positional with a default value"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?', default=42, choices=['a', 'b'])]
|
|
failures = ['-x', 'a b', '42']
|
|
successes = [
|
|
('', NS(foo=42)),
|
|
('a', NS(foo='a')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalConvertedDefault(ParserTestCase):
|
|
"""Tests an Optional Positional with a default value
|
|
that needs to be converted to the appropriate type.
|
|
"""
|
|
|
|
argument_signatures = [
|
|
Sig('foo', nargs='?', type=int, default='42', choices=[1, 2]),
|
|
]
|
|
failures = ['-x', 'a b', '1 2', '42']
|
|
successes = [
|
|
('', NS(foo=42)),
|
|
('1', NS(foo=1)),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneNone(ParserTestCase):
|
|
"""Test two Positionals that don't specify nargs"""
|
|
|
|
argument_signatures = [Sig('foo'), Sig('bar')]
|
|
failures = ['', '-x', 'a', 'a b c']
|
|
successes = [
|
|
('a b', NS(foo='a', bar='b')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNone1(ParserTestCase):
|
|
"""Test a Positional with no nargs followed by one with 1"""
|
|
|
|
argument_signatures = [Sig('foo'), Sig('bar', nargs=1)]
|
|
failures = ['', '--foo', 'a', 'a b c']
|
|
successes = [
|
|
('a b', NS(foo='a', bar=['b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs2None(ParserTestCase):
|
|
"""Test a Positional with 2 nargs followed by one with none"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=2), Sig('bar')]
|
|
failures = ['', '--foo', 'a', 'a b', 'a b c d']
|
|
successes = [
|
|
('a b c', NS(foo=['a', 'b'], bar='c')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneZeroOrMore(ParserTestCase):
|
|
"""Test a Positional with no nargs followed by one with unlimited"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='*')]
|
|
failures = ['', '--foo', 'a b -x X c']
|
|
successes = [
|
|
('a', NS(x=None, foo='a', bar=[])),
|
|
('a b', NS(x=None, foo='a', bar=['b'])),
|
|
('a b c', NS(x=None, foo='a', bar=['b', 'c'])),
|
|
('-x X a', NS(x='X', foo='a', bar=[])),
|
|
('a -x X', NS(x='X', foo='a', bar=[])),
|
|
('-x X a b', NS(x='X', foo='a', bar=['b'])),
|
|
('a -x X b', NS(x='X', foo='a', bar=['b'])),
|
|
('a b -x X', NS(x='X', foo='a', bar=['b'])),
|
|
('-x X a b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
('a -x X b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
('a b c -x X', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneOneOrMore(ParserTestCase):
|
|
"""Test a Positional with no nargs followed by one with one or more"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='+')]
|
|
failures = ['', '--foo', 'a', 'a b -x X c']
|
|
successes = [
|
|
('a b', NS(x=None, foo='a', bar=['b'])),
|
|
('a b c', NS(x=None, foo='a', bar=['b', 'c'])),
|
|
('-x X a b', NS(x='X', foo='a', bar=['b'])),
|
|
('a -x X b', NS(x='X', foo='a', bar=['b'])),
|
|
('a b -x X', NS(x='X', foo='a', bar=['b'])),
|
|
('-x X a b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
('a -x X b c', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
('a b c -x X', NS(x='X', foo='a', bar=['b', 'c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneOptional(ParserTestCase):
|
|
"""Test a Positional with no nargs followed by one with an Optional"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('foo'), Sig('bar', nargs='?')]
|
|
failures = ['', '--foo', 'a b c']
|
|
successes = [
|
|
('a', NS(x=None, foo='a', bar=None)),
|
|
('a b', NS(x=None, foo='a', bar='b')),
|
|
('-x X a', NS(x='X', foo='a', bar=None)),
|
|
('a -x X', NS(x='X', foo='a', bar=None)),
|
|
('-x X a b', NS(x='X', foo='a', bar='b')),
|
|
('a -x X b', NS(x='X', foo='a', bar='b')),
|
|
('a b -x X', NS(x='X', foo='a', bar='b')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsZeroOrMoreNone(ParserTestCase):
|
|
"""Test a Positional with unlimited nargs followed by one with none"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('foo', nargs='*'), Sig('bar')]
|
|
failures = ['', '--foo', 'a -x X b', 'a -x X b c', 'a b -x X c']
|
|
successes = [
|
|
('a', NS(x=None, foo=[], bar='a')),
|
|
('a b', NS(x=None, foo=['a'], bar='b')),
|
|
('a b c', NS(x=None, foo=['a', 'b'], bar='c')),
|
|
('-x X a', NS(x='X', foo=[], bar='a')),
|
|
('a -x X', NS(x='X', foo=[], bar='a')),
|
|
('-x X a b', NS(x='X', foo=['a'], bar='b')),
|
|
('a b -x X', NS(x='X', foo=['a'], bar='b')),
|
|
('-x X a b c', NS(x='X', foo=['a', 'b'], bar='c')),
|
|
('a b c -x X', NS(x='X', foo=['a', 'b'], bar='c')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOneOrMoreNone(ParserTestCase):
|
|
"""Test a Positional with one or more nargs followed by one with none"""
|
|
|
|
argument_signatures = [Sig('-x'), Sig('foo', nargs='+'), Sig('bar')]
|
|
failures = ['', '--foo', 'a', 'a -x X b c', 'a b -x X c']
|
|
successes = [
|
|
('a b', NS(x=None, foo=['a'], bar='b')),
|
|
('a b c', NS(x=None, foo=['a', 'b'], bar='c')),
|
|
('-x X a b', NS(x='X', foo=['a'], bar='b')),
|
|
('a -x X b', NS(x='X', foo=['a'], bar='b')),
|
|
('a b -x X', NS(x='X', foo=['a'], bar='b')),
|
|
('-x X a b c', NS(x='X', foo=['a', 'b'], bar='c')),
|
|
('a b c -x X', NS(x='X', foo=['a', 'b'], bar='c')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalNone(ParserTestCase):
|
|
"""Test a Positional with an Optional nargs followed by one with none"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?', default=42), Sig('bar')]
|
|
failures = ['', '--foo', 'a b c']
|
|
successes = [
|
|
('a', NS(foo=42, bar='a')),
|
|
('a b', NS(foo='a', bar='b')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs2ZeroOrMore(ParserTestCase):
|
|
"""Test a Positional with 2 nargs followed by one with unlimited"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=2), Sig('bar', nargs='*')]
|
|
failures = ['', '--foo', 'a']
|
|
successes = [
|
|
('a b', NS(foo=['a', 'b'], bar=[])),
|
|
('a b c', NS(foo=['a', 'b'], bar=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs2OneOrMore(ParserTestCase):
|
|
"""Test a Positional with 2 nargs followed by one with one or more"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=2), Sig('bar', nargs='+')]
|
|
failures = ['', '--foo', 'a', 'a b']
|
|
successes = [
|
|
('a b c', NS(foo=['a', 'b'], bar=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargs2Optional(ParserTestCase):
|
|
"""Test a Positional with 2 nargs followed by one optional"""
|
|
|
|
argument_signatures = [Sig('foo', nargs=2), Sig('bar', nargs='?')]
|
|
failures = ['', '--foo', 'a', 'a b c d']
|
|
successes = [
|
|
('a b', NS(foo=['a', 'b'], bar=None)),
|
|
('a b c', NS(foo=['a', 'b'], bar='c')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsZeroOrMore1(ParserTestCase):
|
|
"""Test a Positional with unlimited nargs followed by one with 1"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='*'), Sig('bar', nargs=1)]
|
|
failures = ['', '--foo', ]
|
|
successes = [
|
|
('a', NS(foo=[], bar=['a'])),
|
|
('a b', NS(foo=['a'], bar=['b'])),
|
|
('a b c', NS(foo=['a', 'b'], bar=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOneOrMore1(ParserTestCase):
|
|
"""Test a Positional with one or more nargs followed by one with 1"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='+'), Sig('bar', nargs=1)]
|
|
failures = ['', '--foo', 'a']
|
|
successes = [
|
|
('a b', NS(foo=['a'], bar=['b'])),
|
|
('a b c', NS(foo=['a', 'b'], bar=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptional1(ParserTestCase):
|
|
"""Test a Positional with an Optional nargs followed by one with 1"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?'), Sig('bar', nargs=1)]
|
|
failures = ['', '--foo', 'a b c']
|
|
successes = [
|
|
('a', NS(foo=None, bar=['a'])),
|
|
('a b', NS(foo='a', bar=['b'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneZeroOrMore1(ParserTestCase):
|
|
"""Test three Positionals: no nargs, unlimited nargs and 1 nargs"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x'),
|
|
Sig('foo'),
|
|
Sig('bar', nargs='*'),
|
|
Sig('baz', nargs=1),
|
|
]
|
|
failures = ['', '--foo', 'a', 'a b -x X c']
|
|
successes = [
|
|
('a b', NS(x=None, foo='a', bar=[], baz=['b'])),
|
|
('a b c', NS(x=None, foo='a', bar=['b'], baz=['c'])),
|
|
('-x X a b', NS(x='X', foo='a', bar=[], baz=['b'])),
|
|
('a -x X b', NS(x='X', foo='a', bar=[], baz=['b'])),
|
|
('a b -x X', NS(x='X', foo='a', bar=[], baz=['b'])),
|
|
('-x X a b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('a -x X b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('a b c -x X', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneOneOrMore1(ParserTestCase):
|
|
"""Test three Positionals: no nargs, one or more nargs and 1 nargs"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x'),
|
|
Sig('foo'),
|
|
Sig('bar', nargs='+'),
|
|
Sig('baz', nargs=1),
|
|
]
|
|
failures = ['', '--foo', 'a', 'b', 'a b -x X c d', 'a b c -x X d']
|
|
successes = [
|
|
('a b c', NS(x=None, foo='a', bar=['b'], baz=['c'])),
|
|
('a b c d', NS(x=None, foo='a', bar=['b', 'c'], baz=['d'])),
|
|
('-x X a b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('a -x X b c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('a b -x X c', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('a b c -x X', NS(x='X', foo='a', bar=['b'], baz=['c'])),
|
|
('-x X a b c d', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
|
('a -x X b c d', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
|
('a b c d -x X', NS(x='X', foo='a', bar=['b', 'c'], baz=['d'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsNoneOptional1(ParserTestCase):
|
|
"""Test three Positionals: no nargs, optional narg and 1 nargs"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x'),
|
|
Sig('foo'),
|
|
Sig('bar', nargs='?', default=0.625),
|
|
Sig('baz', nargs=1),
|
|
]
|
|
failures = ['', '--foo', 'a', 'a b -x X c']
|
|
successes = [
|
|
('a b', NS(x=None, foo='a', bar=0.625, baz=['b'])),
|
|
('a b c', NS(x=None, foo='a', bar='b', baz=['c'])),
|
|
('-x X a b', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
|
('a -x X b', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
|
('a b -x X', NS(x='X', foo='a', bar=0.625, baz=['b'])),
|
|
('-x X a b c', NS(x='X', foo='a', bar='b', baz=['c'])),
|
|
('a -x X b c', NS(x='X', foo='a', bar='b', baz=['c'])),
|
|
('a b c -x X', NS(x='X', foo='a', bar='b', baz=['c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalOptional(ParserTestCase):
|
|
"""Test two optional nargs"""
|
|
|
|
argument_signatures = [
|
|
Sig('foo', nargs='?'),
|
|
Sig('bar', nargs='?', default=42),
|
|
]
|
|
failures = ['--foo', 'a b c']
|
|
successes = [
|
|
('', NS(foo=None, bar=42)),
|
|
('a', NS(foo='a', bar=42)),
|
|
('a b', NS(foo='a', bar='b')),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalZeroOrMore(ParserTestCase):
|
|
"""Test an Optional narg followed by unlimited nargs"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?'), Sig('bar', nargs='*')]
|
|
failures = ['--foo']
|
|
successes = [
|
|
('', NS(foo=None, bar=[])),
|
|
('a', NS(foo='a', bar=[])),
|
|
('a b', NS(foo='a', bar=['b'])),
|
|
('a b c', NS(foo='a', bar=['b', 'c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsNargsOptionalOneOrMore(ParserTestCase):
|
|
"""Test an Optional narg followed by one or more nargs"""
|
|
|
|
argument_signatures = [Sig('foo', nargs='?'), Sig('bar', nargs='+')]
|
|
failures = ['', '--foo']
|
|
successes = [
|
|
('a', NS(foo=None, bar=['a'])),
|
|
('a b', NS(foo='a', bar=['b'])),
|
|
('a b c', NS(foo='a', bar=['b', 'c'])),
|
|
]
|
|
|
|
|
|
class TestPositionalsChoicesString(ParserTestCase):
|
|
"""Test a set of single-character choices"""
|
|
|
|
argument_signatures = [Sig('spam', choices=set('abcdefg'))]
|
|
failures = ['', '--foo', 'h', '42', 'ef']
|
|
successes = [
|
|
('a', NS(spam='a')),
|
|
('g', NS(spam='g')),
|
|
]
|
|
|
|
|
|
class TestPositionalsChoicesInt(ParserTestCase):
|
|
"""Test a set of integer choices"""
|
|
|
|
argument_signatures = [Sig('spam', type=int, choices=range(20))]
|
|
failures = ['', '--foo', 'h', '42', 'ef']
|
|
successes = [
|
|
('4', NS(spam=4)),
|
|
('15', NS(spam=15)),
|
|
]
|
|
|
|
|
|
class TestPositionalsActionAppend(ParserTestCase):
|
|
"""Test the 'append' action"""
|
|
|
|
argument_signatures = [
|
|
Sig('spam', action='append'),
|
|
Sig('spam', action='append', nargs=2),
|
|
]
|
|
failures = ['', '--foo', 'a', 'a b', 'a b c d']
|
|
successes = [
|
|
('a b c', NS(spam=['a', ['b', 'c']])),
|
|
]
|
|
|
|
|
|
class TestPositionalsActionExtend(ParserTestCase):
|
|
"""Test the 'extend' action"""
|
|
|
|
argument_signatures = [
|
|
Sig('spam', action='extend'),
|
|
Sig('spam', action='extend', nargs=2),
|
|
]
|
|
failures = ['', '--foo', 'a', 'a b', 'a b c d']
|
|
successes = [
|
|
('a b c', NS(spam=['a', 'b', 'c'])),
|
|
]
|
|
|
|
# ========================================
|
|
# Combined optionals and positionals tests
|
|
# ========================================
|
|
|
|
class TestOptionalsNumericAndPositionals(ParserTestCase):
|
|
"""Tests negative number args when numeric options are present"""
|
|
|
|
argument_signatures = [
|
|
Sig('x', nargs='?'),
|
|
Sig('-4', dest='y', action='store_true'),
|
|
]
|
|
failures = ['-2', '-315']
|
|
successes = [
|
|
('', NS(x=None, y=False)),
|
|
('a', NS(x='a', y=False)),
|
|
('-4', NS(x=None, y=True)),
|
|
('-4 a', NS(x='a', y=True)),
|
|
]
|
|
|
|
|
|
class TestOptionalsAlmostNumericAndPositionals(ParserTestCase):
|
|
"""Tests negative number args when almost numeric options are present"""
|
|
|
|
argument_signatures = [
|
|
Sig('x', nargs='?'),
|
|
Sig('-k4', dest='y', action='store_true'),
|
|
]
|
|
failures = ['-k3']
|
|
successes = [
|
|
('', NS(x=None, y=False)),
|
|
('-2', NS(x='-2', y=False)),
|
|
('a', NS(x='a', y=False)),
|
|
('-k4', NS(x=None, y=True)),
|
|
('-k4 a', NS(x='a', y=True)),
|
|
]
|
|
|
|
|
|
class TestOptionalsAndPositionalsAppend(ParserTestCase):
|
|
argument_signatures = [
|
|
Sig('foo', nargs='*', action='append'),
|
|
Sig('--bar'),
|
|
]
|
|
failures = ['-foo']
|
|
successes = [
|
|
('a b', NS(foo=[['a', 'b']], bar=None)),
|
|
('--bar a b', NS(foo=[['b']], bar='a')),
|
|
('a b --bar c', NS(foo=[['a', 'b']], bar='c')),
|
|
]
|
|
|
|
|
|
class TestOptionalsAndPositionalsExtend(ParserTestCase):
|
|
argument_signatures = [
|
|
Sig('foo', nargs='*', action='extend'),
|
|
Sig('--bar'),
|
|
]
|
|
failures = ['-foo']
|
|
successes = [
|
|
('a b', NS(foo=['a', 'b'], bar=None)),
|
|
('--bar a b', NS(foo=['b'], bar='a')),
|
|
('a b --bar c', NS(foo=['a', 'b'], bar='c')),
|
|
]
|
|
|
|
|
|
class TestEmptyAndSpaceContainingArguments(ParserTestCase):
|
|
|
|
argument_signatures = [
|
|
Sig('x', nargs='?'),
|
|
Sig('-y', '--yyy', dest='y'),
|
|
]
|
|
failures = ['-y']
|
|
successes = [
|
|
([''], NS(x='', y=None)),
|
|
(['a badger'], NS(x='a badger', y=None)),
|
|
(['-a badger'], NS(x='-a badger', y=None)),
|
|
(['-y', ''], NS(x=None, y='')),
|
|
(['-y', 'a badger'], NS(x=None, y='a badger')),
|
|
(['-y', '-a badger'], NS(x=None, y='-a badger')),
|
|
(['--yyy=a badger'], NS(x=None, y='a badger')),
|
|
(['--yyy=-a badger'], NS(x=None, y='-a badger')),
|
|
]
|
|
|
|
|
|
class TestPrefixCharacterOnlyArguments(ParserTestCase):
|
|
|
|
parser_signature = Sig(prefix_chars='-+')
|
|
argument_signatures = [
|
|
Sig('-', dest='x', nargs='?', const='badger'),
|
|
Sig('+', dest='y', type=int, default=42),
|
|
Sig('-+-', dest='z', action='store_true'),
|
|
]
|
|
failures = ['-y', '+ -']
|
|
successes = [
|
|
('', NS(x=None, y=42, z=False)),
|
|
('-', NS(x='badger', y=42, z=False)),
|
|
('- X', NS(x='X', y=42, z=False)),
|
|
('+ -3', NS(x=None, y=-3, z=False)),
|
|
('-+-', NS(x=None, y=42, z=True)),
|
|
('- ===', NS(x='===', y=42, z=False)),
|
|
]
|
|
|
|
|
|
class TestNargsZeroOrMore(ParserTestCase):
|
|
"""Tests specifying args for an Optional that accepts zero or more"""
|
|
|
|
argument_signatures = [Sig('-x', nargs='*'), Sig('y', nargs='*')]
|
|
failures = []
|
|
successes = [
|
|
('', NS(x=None, y=[])),
|
|
('-x', NS(x=[], y=[])),
|
|
('-x a', NS(x=['a'], y=[])),
|
|
('-x a -- b', NS(x=['a'], y=['b'])),
|
|
('a', NS(x=None, y=['a'])),
|
|
('a -x', NS(x=[], y=['a'])),
|
|
('a -x b', NS(x=['b'], y=['a'])),
|
|
]
|
|
|
|
|
|
class TestNargsRemainder(ParserTestCase):
|
|
"""Tests specifying a positional with nargs=REMAINDER"""
|
|
|
|
argument_signatures = [Sig('x'), Sig('y', nargs='...'), Sig('-z')]
|
|
failures = ['', '-z', '-z Z']
|
|
successes = [
|
|
('X', NS(x='X', y=[], z=None)),
|
|
('-z Z X', NS(x='X', y=[], z='Z')),
|
|
('-z Z X A B', NS(x='X', y=['A', 'B'], z='Z')),
|
|
('X -z Z A B', NS(x='X', y=['-z', 'Z', 'A', 'B'], z=None)),
|
|
('X A -z Z B', NS(x='X', y=['A', '-z', 'Z', 'B'], z=None)),
|
|
('X A B -z Z', NS(x='X', y=['A', 'B', '-z', 'Z'], z=None)),
|
|
('X Y --foo', NS(x='X', y=['Y', '--foo'], z=None)),
|
|
]
|
|
|
|
|
|
class TestOptionLike(ParserTestCase):
|
|
"""Tests options that may or may not be arguments"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=float),
|
|
Sig('-3', type=float, dest='y'),
|
|
Sig('z', nargs='*'),
|
|
]
|
|
failures = ['-x', '-y2.5', '-xa', '-x -a',
|
|
'-x -3', '-x -3.5', '-3 -3.5',
|
|
'-x -2.5', '-x -2.5 a', '-3 -.5',
|
|
'a x -1', '-x -1 a', '-3 -1 a']
|
|
successes = [
|
|
('', NS(x=None, y=None, z=[])),
|
|
('-x 2.5', NS(x=2.5, y=None, z=[])),
|
|
('-x 2.5 a', NS(x=2.5, y=None, z=['a'])),
|
|
('-3.5', NS(x=None, y=0.5, z=[])),
|
|
('-3-.5', NS(x=None, y=-0.5, z=[])),
|
|
('-3 .5', NS(x=None, y=0.5, z=[])),
|
|
('a -3.5', NS(x=None, y=0.5, z=['a'])),
|
|
('a', NS(x=None, y=None, z=['a'])),
|
|
('a -x 1', NS(x=1.0, y=None, z=['a'])),
|
|
('-x 1 a', NS(x=1.0, y=None, z=['a'])),
|
|
('-3 1 a', NS(x=None, y=1.0, z=['a'])),
|
|
]
|
|
|
|
|
|
class TestDefaultSuppress(ParserTestCase):
|
|
"""Test actions with suppressed defaults"""
|
|
|
|
argument_signatures = [
|
|
Sig('foo', nargs='?', type=int, default=argparse.SUPPRESS),
|
|
Sig('bar', nargs='*', type=int, default=argparse.SUPPRESS),
|
|
Sig('--baz', action='store_true', default=argparse.SUPPRESS),
|
|
Sig('--qux', nargs='?', type=int, default=argparse.SUPPRESS),
|
|
Sig('--quux', nargs='*', type=int, default=argparse.SUPPRESS),
|
|
]
|
|
failures = ['-x', 'a', '1 a']
|
|
successes = [
|
|
('', NS()),
|
|
('1', NS(foo=1)),
|
|
('1 2', NS(foo=1, bar=[2])),
|
|
('--baz', NS(baz=True)),
|
|
('1 --baz', NS(foo=1, baz=True)),
|
|
('--baz 1 2', NS(foo=1, bar=[2], baz=True)),
|
|
('--qux', NS(qux=None)),
|
|
('--qux 1', NS(qux=1)),
|
|
('--quux', NS(quux=[])),
|
|
('--quux 1 2', NS(quux=[1, 2])),
|
|
]
|
|
|
|
|
|
class TestParserDefaultSuppress(ParserTestCase):
|
|
"""Test actions with a parser-level default of SUPPRESS"""
|
|
|
|
parser_signature = Sig(argument_default=argparse.SUPPRESS)
|
|
argument_signatures = [
|
|
Sig('foo', nargs='?'),
|
|
Sig('bar', nargs='*'),
|
|
Sig('--baz', action='store_true'),
|
|
]
|
|
failures = ['-x']
|
|
successes = [
|
|
('', NS()),
|
|
('a', NS(foo='a')),
|
|
('a b', NS(foo='a', bar=['b'])),
|
|
('--baz', NS(baz=True)),
|
|
('a --baz', NS(foo='a', baz=True)),
|
|
('--baz a b', NS(foo='a', bar=['b'], baz=True)),
|
|
]
|
|
|
|
|
|
class TestParserDefault42(ParserTestCase):
|
|
"""Test actions with a parser-level default of 42"""
|
|
|
|
parser_signature = Sig(argument_default=42)
|
|
argument_signatures = [
|
|
Sig('--version', action='version', version='1.0'),
|
|
Sig('foo', nargs='?'),
|
|
Sig('bar', nargs='*'),
|
|
Sig('--baz', action='store_true'),
|
|
]
|
|
failures = ['-x']
|
|
successes = [
|
|
('', NS(foo=42, bar=42, baz=42, version=42)),
|
|
('a', NS(foo='a', bar=42, baz=42, version=42)),
|
|
('a b', NS(foo='a', bar=['b'], baz=42, version=42)),
|
|
('--baz', NS(foo=42, bar=42, baz=True, version=42)),
|
|
('a --baz', NS(foo='a', bar=42, baz=True, version=42)),
|
|
('--baz a b', NS(foo='a', bar=['b'], baz=True, version=42)),
|
|
]
|
|
|
|
|
|
class TestArgumentsFromFile(TempDirMixin, ParserTestCase):
|
|
"""Test reading arguments from a file"""
|
|
|
|
def setUp(self):
|
|
super(TestArgumentsFromFile, self).setUp()
|
|
file_texts = [
|
|
('hello', os.fsencode(self.hello) + b'\n'),
|
|
('recursive', b'-a\n'
|
|
b'A\n'
|
|
b'@hello'),
|
|
('invalid', b'@no-such-path\n'),
|
|
('undecodable', self.undecodable + b'\n'),
|
|
]
|
|
for path, text in file_texts:
|
|
with open(path, 'wb') as file:
|
|
file.write(text)
|
|
|
|
parser_signature = Sig(fromfile_prefix_chars='@')
|
|
argument_signatures = [
|
|
Sig('-a'),
|
|
Sig('x'),
|
|
Sig('y', nargs='+'),
|
|
]
|
|
failures = ['', '-b', 'X', '@invalid', '@missing']
|
|
hello = 'hello world!' + os_helper.FS_NONASCII
|
|
successes = [
|
|
('X Y', NS(a=None, x='X', y=['Y'])),
|
|
('X -a A Y Z', NS(a='A', x='X', y=['Y', 'Z'])),
|
|
('@hello X', NS(a=None, x=hello, y=['X'])),
|
|
('X @hello', NS(a=None, x='X', y=[hello])),
|
|
('-a B @recursive Y Z', NS(a='A', x=hello, y=['Y', 'Z'])),
|
|
('X @recursive Z -a B', NS(a='B', x='X', y=[hello, 'Z'])),
|
|
(["-a", "", "X", "Y"], NS(a='', x='X', y=['Y'])),
|
|
]
|
|
if os_helper.TESTFN_UNDECODABLE:
|
|
undecodable = os_helper.TESTFN_UNDECODABLE.lstrip(b'@')
|
|
decoded_undecodable = os.fsdecode(undecodable)
|
|
successes += [
|
|
('@undecodable X', NS(a=None, x=decoded_undecodable, y=['X'])),
|
|
('X @undecodable', NS(a=None, x='X', y=[decoded_undecodable])),
|
|
]
|
|
else:
|
|
undecodable = b''
|
|
|
|
|
|
class TestArgumentsFromFileConverter(TempDirMixin, ParserTestCase):
|
|
"""Test reading arguments from a file"""
|
|
|
|
def setUp(self):
|
|
super(TestArgumentsFromFileConverter, self).setUp()
|
|
file_texts = [
|
|
('hello', b'hello world!\n'),
|
|
]
|
|
for path, text in file_texts:
|
|
with open(path, 'wb') as file:
|
|
file.write(text)
|
|
|
|
class FromFileConverterArgumentParser(ErrorRaisingArgumentParser):
|
|
|
|
def convert_arg_line_to_args(self, arg_line):
|
|
for arg in arg_line.split():
|
|
if not arg.strip():
|
|
continue
|
|
yield arg
|
|
parser_class = FromFileConverterArgumentParser
|
|
parser_signature = Sig(fromfile_prefix_chars='@')
|
|
argument_signatures = [
|
|
Sig('y', nargs='+'),
|
|
]
|
|
failures = []
|
|
successes = [
|
|
('@hello X', NS(y=['hello', 'world!', 'X'])),
|
|
]
|
|
|
|
|
|
# =====================
|
|
# Type conversion tests
|
|
# =====================
|
|
|
|
def FileType(*args, **kwargs):
|
|
with warnings.catch_warnings():
|
|
warnings.filterwarnings('ignore', 'FileType is deprecated',
|
|
PendingDeprecationWarning, __name__)
|
|
return argparse.FileType(*args, **kwargs)
|
|
|
|
|
|
class TestFileTypeDeprecation(TestCase):
|
|
|
|
def test(self):
|
|
with self.assertWarns(PendingDeprecationWarning) as cm:
|
|
argparse.FileType()
|
|
self.assertIn('FileType is deprecated', str(cm.warning))
|
|
self.assertEqual(cm.filename, __file__)
|
|
|
|
|
|
class TestFileTypeRepr(TestCase):
|
|
|
|
def test_r(self):
|
|
type = FileType('r')
|
|
self.assertEqual("FileType('r')", repr(type))
|
|
|
|
def test_wb_1(self):
|
|
type = FileType('wb', 1)
|
|
self.assertEqual("FileType('wb', 1)", repr(type))
|
|
|
|
def test_r_latin(self):
|
|
type = FileType('r', encoding='latin_1')
|
|
self.assertEqual("FileType('r', encoding='latin_1')", repr(type))
|
|
|
|
def test_w_big5_ignore(self):
|
|
type = FileType('w', encoding='big5', errors='ignore')
|
|
self.assertEqual("FileType('w', encoding='big5', errors='ignore')",
|
|
repr(type))
|
|
|
|
def test_r_1_replace(self):
|
|
type = FileType('r', 1, errors='replace')
|
|
self.assertEqual("FileType('r', 1, errors='replace')", repr(type))
|
|
|
|
|
|
BIN_STDOUT_SENTINEL = object()
|
|
BIN_STDERR_SENTINEL = object()
|
|
|
|
|
|
class StdStreamComparer:
|
|
def __init__(self, attr):
|
|
# We try to use the actual stdXXX.buffer attribute as our
|
|
# marker, but but under some test environments,
|
|
# sys.stdout/err are replaced by io.StringIO which won't have .buffer,
|
|
# so we use a sentinel simply to show that the tests do the right thing
|
|
# for any buffer supporting object
|
|
self.getattr = operator.attrgetter(attr)
|
|
if attr == 'stdout.buffer':
|
|
self.backupattr = BIN_STDOUT_SENTINEL
|
|
elif attr == 'stderr.buffer':
|
|
self.backupattr = BIN_STDERR_SENTINEL
|
|
else:
|
|
self.backupattr = object() # Not equal to anything
|
|
|
|
def __eq__(self, other):
|
|
try:
|
|
return other == self.getattr(sys)
|
|
except AttributeError:
|
|
return other == self.backupattr
|
|
|
|
|
|
eq_stdin = StdStreamComparer('stdin')
|
|
eq_stdout = StdStreamComparer('stdout')
|
|
eq_stderr = StdStreamComparer('stderr')
|
|
eq_bstdin = StdStreamComparer('stdin.buffer')
|
|
eq_bstdout = StdStreamComparer('stdout.buffer')
|
|
eq_bstderr = StdStreamComparer('stderr.buffer')
|
|
|
|
|
|
class RFile(object):
|
|
seen = {}
|
|
|
|
def __init__(self, name):
|
|
self.name = name
|
|
|
|
def __eq__(self, other):
|
|
if other in self.seen:
|
|
text = self.seen[other]
|
|
else:
|
|
text = self.seen[other] = other.read()
|
|
other.close()
|
|
if not isinstance(text, str):
|
|
text = text.decode('ascii')
|
|
return self.name == other.name == text
|
|
|
|
class TestFileTypeR(TempDirMixin, ParserTestCase):
|
|
"""Test the FileType option/argument type for reading files"""
|
|
|
|
def setUp(self):
|
|
super(TestFileTypeR, self).setUp()
|
|
for file_name in ['foo', 'bar']:
|
|
with open(os.path.join(self.temp_dir, file_name),
|
|
'w', encoding="utf-8") as file:
|
|
file.write(file_name)
|
|
self.create_readonly_file('readonly')
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType()),
|
|
Sig('spam', type=FileType('r')),
|
|
]
|
|
failures = ['-x', '', 'non-existent-file.txt']
|
|
successes = [
|
|
('foo', NS(x=None, spam=RFile('foo'))),
|
|
('-x foo bar', NS(x=RFile('foo'), spam=RFile('bar'))),
|
|
('bar -x foo', NS(x=RFile('foo'), spam=RFile('bar'))),
|
|
('-x - -', NS(x=eq_stdin, spam=eq_stdin)),
|
|
('readonly', NS(x=None, spam=RFile('readonly'))),
|
|
]
|
|
|
|
class TestFileTypeDefaults(TempDirMixin, ParserTestCase):
|
|
"""Test that a file is not created unless the default is needed"""
|
|
def setUp(self):
|
|
super(TestFileTypeDefaults, self).setUp()
|
|
file = open(os.path.join(self.temp_dir, 'good'), 'w', encoding="utf-8")
|
|
file.write('good')
|
|
file.close()
|
|
|
|
argument_signatures = [
|
|
Sig('-c', type=FileType('r'), default='no-file.txt'),
|
|
]
|
|
# should provoke no such file error
|
|
failures = ['']
|
|
# should not provoke error because default file is created
|
|
successes = [('-c good', NS(c=RFile('good')))]
|
|
|
|
|
|
class TestFileTypeRB(TempDirMixin, ParserTestCase):
|
|
"""Test the FileType option/argument type for reading files"""
|
|
|
|
def setUp(self):
|
|
super(TestFileTypeRB, self).setUp()
|
|
for file_name in ['foo', 'bar']:
|
|
with open(os.path.join(self.temp_dir, file_name),
|
|
'w', encoding="utf-8") as file:
|
|
file.write(file_name)
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType('rb')),
|
|
Sig('spam', type=FileType('rb')),
|
|
]
|
|
failures = ['-x', '']
|
|
successes = [
|
|
('foo', NS(x=None, spam=RFile('foo'))),
|
|
('-x foo bar', NS(x=RFile('foo'), spam=RFile('bar'))),
|
|
('bar -x foo', NS(x=RFile('foo'), spam=RFile('bar'))),
|
|
('-x - -', NS(x=eq_bstdin, spam=eq_bstdin)),
|
|
]
|
|
|
|
|
|
class WFile(object):
|
|
seen = set()
|
|
|
|
def __init__(self, name):
|
|
self.name = name
|
|
|
|
def __eq__(self, other):
|
|
if other not in self.seen:
|
|
text = 'Check that file is writable.'
|
|
if 'b' in other.mode:
|
|
text = text.encode('ascii')
|
|
other.write(text)
|
|
other.close()
|
|
self.seen.add(other)
|
|
return self.name == other.name
|
|
|
|
|
|
@os_helper.skip_if_dac_override
|
|
class TestFileTypeW(TempDirMixin, ParserTestCase):
|
|
"""Test the FileType option/argument type for writing files"""
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.create_readonly_file('readonly')
|
|
self.create_writable_file('writable')
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType('w')),
|
|
Sig('spam', type=FileType('w')),
|
|
]
|
|
failures = ['-x', '', 'readonly']
|
|
successes = [
|
|
('foo', NS(x=None, spam=WFile('foo'))),
|
|
('writable', NS(x=None, spam=WFile('writable'))),
|
|
('-x foo bar', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('bar -x foo', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('-x - -', NS(x=eq_stdout, spam=eq_stdout)),
|
|
]
|
|
|
|
|
|
@os_helper.skip_if_dac_override
|
|
class TestFileTypeX(TempDirMixin, ParserTestCase):
|
|
"""Test the FileType option/argument type for writing new files only"""
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.create_readonly_file('readonly')
|
|
self.create_writable_file('writable')
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType('x')),
|
|
Sig('spam', type=FileType('x')),
|
|
]
|
|
failures = ['-x', '', 'readonly', 'writable']
|
|
successes = [
|
|
('-x foo bar', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('-x - -', NS(x=eq_stdout, spam=eq_stdout)),
|
|
]
|
|
|
|
|
|
@os_helper.skip_if_dac_override
|
|
class TestFileTypeWB(TempDirMixin, ParserTestCase):
|
|
"""Test the FileType option/argument type for writing binary files"""
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType('wb')),
|
|
Sig('spam', type=FileType('wb')),
|
|
]
|
|
failures = ['-x', '']
|
|
successes = [
|
|
('foo', NS(x=None, spam=WFile('foo'))),
|
|
('-x foo bar', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('bar -x foo', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('-x - -', NS(x=eq_bstdout, spam=eq_bstdout)),
|
|
]
|
|
|
|
|
|
@os_helper.skip_if_dac_override
|
|
class TestFileTypeXB(TestFileTypeX):
|
|
"Test the FileType option/argument type for writing new binary files only"
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=FileType('xb')),
|
|
Sig('spam', type=FileType('xb')),
|
|
]
|
|
successes = [
|
|
('-x foo bar', NS(x=WFile('foo'), spam=WFile('bar'))),
|
|
('-x - -', NS(x=eq_bstdout, spam=eq_bstdout)),
|
|
]
|
|
|
|
|
|
class TestFileTypeOpenArgs(TestCase):
|
|
"""Test that open (the builtin) is correctly called"""
|
|
|
|
def test_open_args(self):
|
|
FT = FileType
|
|
cases = [
|
|
(FT('rb'), ('rb', -1, None, None)),
|
|
(FT('w', 1), ('w', 1, None, None)),
|
|
(FT('w', errors='replace'), ('w', -1, None, 'replace')),
|
|
(FT('wb', encoding='big5'), ('wb', -1, 'big5', None)),
|
|
(FT('w', 0, 'l1', 'strict'), ('w', 0, 'l1', 'strict')),
|
|
]
|
|
with mock.patch('builtins.open') as m:
|
|
for type, args in cases:
|
|
type('foo')
|
|
m.assert_called_with('foo', *args)
|
|
|
|
def test_invalid_file_type(self):
|
|
with self.assertRaises(ValueError):
|
|
FileType('b')('-test')
|
|
|
|
|
|
class TestFileTypeMissingInitialization(TestCase):
|
|
"""
|
|
Test that add_argument throws an error if FileType class
|
|
object was passed instead of instance of FileType
|
|
"""
|
|
|
|
def test(self):
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(TypeError) as cm:
|
|
parser.add_argument('-x', type=argparse.FileType)
|
|
|
|
self.assertEqual(
|
|
'%r is a FileType class object, instance of it must be passed'
|
|
% (argparse.FileType,),
|
|
str(cm.exception)
|
|
)
|
|
|
|
|
|
class TestTypeCallable(ParserTestCase):
|
|
"""Test some callables as option/argument types"""
|
|
|
|
argument_signatures = [
|
|
Sig('--eggs', type=complex),
|
|
Sig('spam', type=float),
|
|
]
|
|
failures = ['a', '42j', '--eggs a', '--eggs 2i']
|
|
successes = [
|
|
('--eggs=42 42', NS(eggs=42, spam=42.0)),
|
|
('--eggs 2j -- -1.5', NS(eggs=2j, spam=-1.5)),
|
|
('1024.675', NS(eggs=None, spam=1024.675)),
|
|
]
|
|
|
|
|
|
class TestTypeUserDefined(ParserTestCase):
|
|
"""Test a user-defined option/argument type"""
|
|
|
|
class MyType(TestCase):
|
|
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
def __eq__(self, other):
|
|
return (type(self), self.value) == (type(other), other.value)
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=MyType),
|
|
Sig('spam', type=MyType),
|
|
]
|
|
failures = []
|
|
successes = [
|
|
('a -x b', NS(x=MyType('b'), spam=MyType('a'))),
|
|
('-xf g', NS(x=MyType('f'), spam=MyType('g'))),
|
|
]
|
|
|
|
|
|
class TestTypeClassicClass(ParserTestCase):
|
|
"""Test a classic class type"""
|
|
|
|
class C:
|
|
|
|
def __init__(self, value):
|
|
self.value = value
|
|
|
|
def __eq__(self, other):
|
|
return (type(self), self.value) == (type(other), other.value)
|
|
|
|
argument_signatures = [
|
|
Sig('-x', type=C),
|
|
Sig('spam', type=C),
|
|
]
|
|
failures = []
|
|
successes = [
|
|
('a -x b', NS(x=C('b'), spam=C('a'))),
|
|
('-xf g', NS(x=C('f'), spam=C('g'))),
|
|
]
|
|
|
|
|
|
class TestTypeRegistration(TestCase):
|
|
"""Test a user-defined type by registering it"""
|
|
|
|
def test(self):
|
|
|
|
def get_my_type(string):
|
|
return 'my_type{%s}' % string
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.register('type', 'my_type', get_my_type)
|
|
parser.add_argument('-x', type='my_type')
|
|
parser.add_argument('y', type='my_type')
|
|
|
|
self.assertEqual(parser.parse_args('1'.split()),
|
|
NS(x=None, y='my_type{1}'))
|
|
self.assertEqual(parser.parse_args('-x 1 42'.split()),
|
|
NS(x='my_type{1}', y='my_type{42}'))
|
|
|
|
|
|
# ============
|
|
# Action tests
|
|
# ============
|
|
|
|
class TestActionUserDefined(ParserTestCase):
|
|
"""Test a user-defined option/argument action"""
|
|
|
|
class OptionalAction(argparse.Action):
|
|
|
|
def __call__(self, parser, namespace, value, option_string=None):
|
|
try:
|
|
# check destination and option string
|
|
assert self.dest == 'spam', 'dest: %s' % self.dest
|
|
assert option_string == '-s', 'flag: %s' % option_string
|
|
# when option is before argument, badger=2, and when
|
|
# option is after argument, badger=<whatever was set>
|
|
expected_ns = NS(spam=0.25)
|
|
if value in [0.125, 0.625]:
|
|
expected_ns.badger = 2
|
|
elif value in [2.0]:
|
|
expected_ns.badger = 84
|
|
else:
|
|
raise AssertionError('value: %s' % value)
|
|
assert expected_ns == namespace, ('expected %s, got %s' %
|
|
(expected_ns, namespace))
|
|
except AssertionError as e:
|
|
raise ArgumentParserError('opt_action failed: %s' % e)
|
|
setattr(namespace, 'spam', value)
|
|
|
|
class PositionalAction(argparse.Action):
|
|
|
|
def __call__(self, parser, namespace, value, option_string=None):
|
|
try:
|
|
assert option_string is None, ('option_string: %s' %
|
|
option_string)
|
|
# check destination
|
|
assert self.dest == 'badger', 'dest: %s' % self.dest
|
|
# when argument is before option, spam=0.25, and when
|
|
# option is after argument, spam=<whatever was set>
|
|
expected_ns = NS(badger=2)
|
|
if value in [42, 84]:
|
|
expected_ns.spam = 0.25
|
|
elif value in [1]:
|
|
expected_ns.spam = 0.625
|
|
elif value in [2]:
|
|
expected_ns.spam = 0.125
|
|
else:
|
|
raise AssertionError('value: %s' % value)
|
|
assert expected_ns == namespace, ('expected %s, got %s' %
|
|
(expected_ns, namespace))
|
|
except AssertionError as e:
|
|
raise ArgumentParserError('arg_action failed: %s' % e)
|
|
setattr(namespace, 'badger', value)
|
|
|
|
argument_signatures = [
|
|
Sig('-s', dest='spam', action=OptionalAction,
|
|
type=float, default=0.25),
|
|
Sig('badger', action=PositionalAction,
|
|
type=int, nargs='?', default=2),
|
|
]
|
|
failures = []
|
|
successes = [
|
|
('-s0.125', NS(spam=0.125, badger=2)),
|
|
('42', NS(spam=0.25, badger=42)),
|
|
('-s 0.625 1', NS(spam=0.625, badger=1)),
|
|
('84 -s2', NS(spam=2.0, badger=84)),
|
|
]
|
|
|
|
|
|
class TestActionRegistration(TestCase):
|
|
"""Test a user-defined action supplied by registering it"""
|
|
|
|
class MyAction(argparse.Action):
|
|
|
|
def __call__(self, parser, namespace, values, option_string=None):
|
|
setattr(namespace, self.dest, 'foo[%s]' % values)
|
|
|
|
def test(self):
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.register('action', 'my_action', self.MyAction)
|
|
parser.add_argument('badger', action='my_action')
|
|
|
|
self.assertEqual(parser.parse_args(['1']), NS(badger='foo[1]'))
|
|
self.assertEqual(parser.parse_args(['42']), NS(badger='foo[42]'))
|
|
|
|
|
|
class TestActionExtend(ParserTestCase):
|
|
argument_signatures = [
|
|
Sig('--foo', action="extend", nargs="+", type=str),
|
|
]
|
|
failures = ()
|
|
successes = [
|
|
('--foo f1 --foo f2 f3 f4', NS(foo=['f1', 'f2', 'f3', 'f4'])),
|
|
]
|
|
|
|
|
|
class TestNegativeNumber(ParserTestCase):
|
|
"""Test parsing negative numbers"""
|
|
|
|
argument_signatures = [
|
|
Sig('--int', type=int),
|
|
Sig('--float', type=float),
|
|
Sig('--complex', type=complex),
|
|
]
|
|
failures = [
|
|
'--float -_.45',
|
|
'--float -1__000.0',
|
|
'--float -1.0.0',
|
|
'--int -1__000',
|
|
'--int -1.0',
|
|
'--complex -1__000.0j',
|
|
'--complex -1.0jj',
|
|
'--complex -_.45j',
|
|
]
|
|
successes = [
|
|
('--int -1000 --float -1000.0', NS(int=-1000, float=-1000.0, complex=None)),
|
|
('--int -1_000 --float -1_000.0', NS(int=-1000, float=-1000.0, complex=None)),
|
|
('--int -1_000_000 --float -1_000_000.0', NS(int=-1000000, float=-1000000.0, complex=None)),
|
|
('--float -1_000.0', NS(int=None, float=-1000.0, complex=None)),
|
|
('--float -1_000_000.0_0', NS(int=None, float=-1000000.0, complex=None)),
|
|
('--float -.5', NS(int=None, float=-0.5, complex=None)),
|
|
('--float -.5_000', NS(int=None, float=-0.5, complex=None)),
|
|
('--float -1e3', NS(int=None, float=-1000, complex=None)),
|
|
('--float -1e-3', NS(int=None, float=-0.001, complex=None)),
|
|
('--complex -1j', NS(int=None, float=None, complex=-1j)),
|
|
('--complex -1_000j', NS(int=None, float=None, complex=-1000j)),
|
|
('--complex -1_000.0j', NS(int=None, float=None, complex=-1000.0j)),
|
|
('--complex -1e3j', NS(int=None, float=None, complex=-1000j)),
|
|
('--complex -1e-3j', NS(int=None, float=None, complex=-0.001j)),
|
|
]
|
|
|
|
class TestArgumentAndSubparserSuggestions(TestCase):
|
|
"""Test error handling and suggestion when a user makes a typo"""
|
|
|
|
def test_wrong_argument_error_with_suggestions(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=True)
|
|
parser.add_argument('foo', choices=['bar', 'baz'])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('bazz',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: 'bazz', maybe you meant 'baz'? (choose from bar, baz)",
|
|
excinfo.exception.stderr
|
|
)
|
|
|
|
def test_wrong_argument_error_no_suggestions(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=False)
|
|
parser.add_argument('foo', choices=['bar', 'baz'])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('bazz',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: 'bazz' (choose from bar, baz)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_wrong_argument_subparsers_with_suggestions(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=True)
|
|
subparsers = parser.add_subparsers(required=True)
|
|
subparsers.add_parser('foo')
|
|
subparsers.add_parser('bar')
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('baz',))
|
|
self.assertIn(
|
|
"error: argument {foo,bar}: invalid choice: 'baz', maybe you meant"
|
|
" 'bar'? (choose from foo, bar)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_wrong_argument_subparsers_no_suggestions(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=False)
|
|
subparsers = parser.add_subparsers(required=True)
|
|
subparsers.add_parser('foo')
|
|
subparsers.add_parser('bar')
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('baz',))
|
|
self.assertIn(
|
|
"error: argument {foo,bar}: invalid choice: 'baz' (choose from foo, bar)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_wrong_argument_no_suggestion_implicit(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('foo', choices=['bar', 'baz'])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('bazz',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: 'bazz' (choose from bar, baz)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_suggestions_choices_empty(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=True)
|
|
parser.add_argument('foo', choices=[])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('bazz',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: 'bazz' (choose from )",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_suggestions_choices_int(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=True)
|
|
parser.add_argument('foo', choices=[1, 2])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('3',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: '3' (choose from 1, 2)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
def test_suggestions_choices_mixed_types(self):
|
|
parser = ErrorRaisingArgumentParser(suggest_on_error=True)
|
|
parser.add_argument('foo', choices=[1, '2'])
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(('3',))
|
|
self.assertIn(
|
|
"error: argument foo: invalid choice: '3' (choose from 1, 2)",
|
|
excinfo.exception.stderr,
|
|
)
|
|
|
|
|
|
class TestInvalidAction(TestCase):
|
|
"""Test invalid user defined Action"""
|
|
|
|
class ActionWithoutCall(argparse.Action):
|
|
pass
|
|
|
|
def test_invalid_type(self):
|
|
parser = argparse.ArgumentParser()
|
|
|
|
parser.add_argument('--foo', action=self.ActionWithoutCall)
|
|
self.assertRaises(NotImplementedError, parser.parse_args, ['--foo', 'bar'])
|
|
|
|
def test_modified_invalid_action(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
action = parser.add_argument('--foo')
|
|
# Someone got crazy and did this
|
|
action.type = 1
|
|
self.assertRaisesRegex(TypeError, '1 is not callable',
|
|
parser.parse_args, ['--foo', 'bar'])
|
|
action.type = ()
|
|
self.assertRaisesRegex(TypeError, r'\(\) is not callable',
|
|
parser.parse_args, ['--foo', 'bar'])
|
|
# It is impossible to distinguish a TypeError raised due to a mismatch
|
|
# of the required function arguments from a TypeError raised for an incorrect
|
|
# argument value, and using the heavy inspection machinery is not worthwhile
|
|
# as it does not reliably work in all cases.
|
|
# Therefore, a generic ArgumentError is raised to handle this logical error.
|
|
action.type = pow
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"argument --foo: invalid pow value: 'bar'",
|
|
parser.parse_args, ['--foo', 'bar'])
|
|
|
|
|
|
# ================
|
|
# Subparsers tests
|
|
# ================
|
|
|
|
class TestAddSubparsers(TestCase):
|
|
"""Test the add_subparsers method"""
|
|
|
|
def assertArgumentParserError(self, *args, **kwargs):
|
|
self.assertRaises(ArgumentParserError, *args, **kwargs)
|
|
|
|
def _get_parser(self, subparser_help=False, prefix_chars=None,
|
|
aliases=False):
|
|
# create a parser with a subparsers argument
|
|
if prefix_chars:
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog='PROG', description='main description', prefix_chars=prefix_chars)
|
|
parser.add_argument(
|
|
prefix_chars[0] * 2 + 'foo', action='store_true', help='foo help')
|
|
else:
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog='PROG', description='main description')
|
|
parser.add_argument(
|
|
'--foo', action='store_true', help='foo help')
|
|
parser.add_argument(
|
|
'bar', type=float, help='bar help')
|
|
|
|
# check that only one subparsers argument can be added
|
|
subparsers_kwargs = {'required': False}
|
|
if aliases:
|
|
subparsers_kwargs['metavar'] = 'COMMAND'
|
|
subparsers_kwargs['title'] = 'commands'
|
|
else:
|
|
subparsers_kwargs['help'] = 'command help'
|
|
subparsers = parser.add_subparsers(**subparsers_kwargs)
|
|
self.assertRaisesRegex(ValueError,
|
|
'cannot have multiple subparser arguments',
|
|
parser.add_subparsers)
|
|
|
|
# add first sub-parser
|
|
parser1_kwargs = dict(description='1 description')
|
|
if subparser_help:
|
|
parser1_kwargs['help'] = '1 help'
|
|
if aliases:
|
|
parser1_kwargs['aliases'] = ['1alias1', '1alias2']
|
|
parser1 = subparsers.add_parser('1', **parser1_kwargs)
|
|
parser1.add_argument('-w', type=int, help='w help')
|
|
parser1.add_argument('x', choices=['a', 'b', 'c'], help='x help')
|
|
|
|
# add second sub-parser
|
|
parser2_kwargs = dict(description='2 description')
|
|
if subparser_help:
|
|
parser2_kwargs['help'] = '2 help'
|
|
parser2 = subparsers.add_parser('2', **parser2_kwargs)
|
|
parser2.add_argument('-y', choices=['1', '2', '3'], help='y help')
|
|
parser2.add_argument('z', type=complex, nargs='*', help='z help')
|
|
|
|
# add third sub-parser
|
|
parser3_kwargs = dict(description='3 description')
|
|
if subparser_help:
|
|
parser3_kwargs['help'] = '3 help'
|
|
parser3 = subparsers.add_parser('3', **parser3_kwargs)
|
|
parser3.add_argument('t', type=int, help='t help')
|
|
parser3.add_argument('u', nargs='...', help='u help')
|
|
|
|
# return the main parser
|
|
return parser
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.parser = self._get_parser()
|
|
self.command_help_parser = self._get_parser(subparser_help=True)
|
|
|
|
def test_parse_args_failures(self):
|
|
# check some failure cases:
|
|
for args_str in ['', 'a', 'a a', '0.5 a', '0.5 1',
|
|
'0.5 1 -y', '0.5 2 -w']:
|
|
args = args_str.split()
|
|
self.assertArgumentParserError(self.parser.parse_args, args)
|
|
|
|
def test_parse_args(self):
|
|
# check some non-failure cases:
|
|
self.assertEqual(
|
|
self.parser.parse_args('0.5 1 b -w 7'.split()),
|
|
NS(foo=False, bar=0.5, w=7, x='b'),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_args('0.25 --foo 2 -y 2 3j -- -1j'.split()),
|
|
NS(foo=True, bar=0.25, y='2', z=[3j, -1j]),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_args('--foo 0.125 1 c'.split()),
|
|
NS(foo=True, bar=0.125, w=None, x='c'),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_args('-1.5 3 11 -- a --foo 7 -- b'.split()),
|
|
NS(foo=False, bar=-1.5, t=11, u=['a', '--foo', '7', '--', 'b']),
|
|
)
|
|
|
|
def test_parse_known_args(self):
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 1 b -w 7'.split()),
|
|
(NS(foo=False, bar=0.5, w=7, x='b'), []),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 -p 1 b -w 7'.split()),
|
|
(NS(foo=False, bar=0.5, w=7, x='b'), ['-p']),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 1 b -w 7 -p'.split()),
|
|
(NS(foo=False, bar=0.5, w=7, x='b'), ['-p']),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 1 b -q -rs -w 7'.split()),
|
|
(NS(foo=False, bar=0.5, w=7, x='b'), ['-q', '-rs']),
|
|
)
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 -W 1 b -X Y -w 7 Z'.split()),
|
|
(NS(foo=False, bar=0.5, w=7, x='b'), ['-W', '-X', 'Y', 'Z']),
|
|
)
|
|
|
|
def test_parse_known_args_to_class_namespace(self):
|
|
class C:
|
|
pass
|
|
self.assertEqual(
|
|
self.parser.parse_known_args('0.5 1 b -w 7 -p'.split(), namespace=C),
|
|
(C, ['-p']),
|
|
)
|
|
self.assertIs(C.foo, False)
|
|
self.assertEqual(C.bar, 0.5)
|
|
self.assertEqual(C.w, 7)
|
|
self.assertEqual(C.x, 'b')
|
|
|
|
def test_abbreviation(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('--foodle')
|
|
parser.add_argument('--foonly')
|
|
subparsers = parser.add_subparsers()
|
|
parser1 = subparsers.add_parser('bar')
|
|
parser1.add_argument('--fo')
|
|
parser1.add_argument('--foonew')
|
|
|
|
self.assertEqual(parser.parse_args(['--food', 'baz', 'bar']),
|
|
NS(foodle='baz', foonly=None, fo=None, foonew=None))
|
|
self.assertEqual(parser.parse_args(['--foon', 'baz', 'bar']),
|
|
NS(foodle=None, foonly='baz', fo=None, foonew=None))
|
|
self.assertArgumentParserError(parser.parse_args, ['--fo', 'baz', 'bar'])
|
|
self.assertEqual(parser.parse_args(['bar', '--fo', 'baz']),
|
|
NS(foodle=None, foonly=None, fo='baz', foonew=None))
|
|
self.assertEqual(parser.parse_args(['bar', '--foo', 'baz']),
|
|
NS(foodle=None, foonly=None, fo=None, foonew='baz'))
|
|
self.assertEqual(parser.parse_args(['bar', '--foon', 'baz']),
|
|
NS(foodle=None, foonly=None, fo=None, foonew='baz'))
|
|
self.assertArgumentParserError(parser.parse_args, ['bar', '--food', 'baz'])
|
|
|
|
def test_parse_known_args_with_single_dash_option(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('-k', '--known', action='count', default=0)
|
|
parser.add_argument('-n', '--new', action='count', default=0)
|
|
self.assertEqual(parser.parse_known_args(['-k', '-u']),
|
|
(NS(known=1, new=0), ['-u']))
|
|
self.assertEqual(parser.parse_known_args(['-u', '-k']),
|
|
(NS(known=1, new=0), ['-u']))
|
|
self.assertEqual(parser.parse_known_args(['-ku']),
|
|
(NS(known=1, new=0), ['-u']))
|
|
self.assertArgumentParserError(parser.parse_known_args, ['-k=u'])
|
|
self.assertEqual(parser.parse_known_args(['-uk']),
|
|
(NS(known=0, new=0), ['-uk']))
|
|
self.assertEqual(parser.parse_known_args(['-u=k']),
|
|
(NS(known=0, new=0), ['-u=k']))
|
|
self.assertEqual(parser.parse_known_args(['-kunknown']),
|
|
(NS(known=1, new=0), ['-unknown']))
|
|
self.assertArgumentParserError(parser.parse_known_args, ['-k=unknown'])
|
|
self.assertEqual(parser.parse_known_args(['-ku=nknown']),
|
|
(NS(known=1, new=0), ['-u=nknown']))
|
|
self.assertEqual(parser.parse_known_args(['-knew']),
|
|
(NS(known=1, new=1), ['-ew']))
|
|
self.assertArgumentParserError(parser.parse_known_args, ['-kn=ew'])
|
|
self.assertArgumentParserError(parser.parse_known_args, ['-k-new'])
|
|
self.assertArgumentParserError(parser.parse_known_args, ['-kn-ew'])
|
|
self.assertEqual(parser.parse_known_args(['-kne-w']),
|
|
(NS(known=1, new=1), ['-e-w']))
|
|
|
|
def test_dest(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('--foo', action='store_true')
|
|
subparsers = parser.add_subparsers(dest='bar')
|
|
parser1 = subparsers.add_parser('1')
|
|
parser1.add_argument('baz')
|
|
self.assertEqual(NS(foo=False, bar='1', baz='2'),
|
|
parser.parse_args('1 2'.split()))
|
|
|
|
def _test_required_subparsers(self, parser):
|
|
# Should parse the sub command
|
|
ret = parser.parse_args(['run'])
|
|
self.assertEqual(ret.command, 'run')
|
|
|
|
# Error when the command is missing
|
|
self.assertArgumentParserError(parser.parse_args, ())
|
|
|
|
def test_required_subparsers_via_attribute(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers(dest='command')
|
|
subparsers.required = True
|
|
subparsers.add_parser('run')
|
|
self._test_required_subparsers(parser)
|
|
|
|
def test_required_subparsers_via_kwarg(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers(dest='command', required=True)
|
|
subparsers.add_parser('run')
|
|
self._test_required_subparsers(parser)
|
|
|
|
def test_required_subparsers_default(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers(dest='command')
|
|
subparsers.add_parser('run')
|
|
# No error here
|
|
ret = parser.parse_args(())
|
|
self.assertIsNone(ret.command)
|
|
|
|
def test_required_subparsers_no_destination_error(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers(required=True)
|
|
subparsers.add_parser('foo')
|
|
subparsers.add_parser('bar')
|
|
with self.assertRaises(ArgumentParserError) as excinfo:
|
|
parser.parse_args(())
|
|
self.assertRegex(
|
|
excinfo.exception.stderr,
|
|
'error: the following arguments are required: {foo,bar}\n$'
|
|
)
|
|
|
|
def test_optional_subparsers(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers(dest='command', required=False)
|
|
subparsers.add_parser('run')
|
|
# No error here
|
|
ret = parser.parse_args(())
|
|
self.assertIsNone(ret.command)
|
|
|
|
def test_help(self):
|
|
self.assertEqual(self.parser.format_usage(),
|
|
'usage: PROG [-h] [--foo] bar {1,2,3} ...\n')
|
|
self.assertEqual(self.parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [--foo] bar {1,2,3} ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
{1,2,3} command help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo foo help
|
|
'''))
|
|
|
|
def test_help_extra_prefix_chars(self):
|
|
# Make sure - is still used for help if it is a non-first prefix char
|
|
parser = self._get_parser(prefix_chars='+:-')
|
|
self.assertEqual(parser.format_usage(),
|
|
'usage: PROG [-h] [++foo] bar {1,2,3} ...\n')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [++foo] bar {1,2,3} ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
{1,2,3} command help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
++foo foo help
|
|
'''))
|
|
|
|
def test_help_non_breaking_spaces(self):
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog='PROG', description='main description')
|
|
parser.add_argument(
|
|
"--non-breaking", action='store_false',
|
|
help='help message containing non-breaking spaces shall not '
|
|
'wrap\N{NO-BREAK SPACE}at non-breaking spaces')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [--non-breaking]
|
|
|
|
main description
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--non-breaking help message containing non-breaking spaces shall not
|
|
wrap\N{NO-BREAK SPACE}at non-breaking spaces
|
|
'''))
|
|
|
|
def test_help_blank(self):
|
|
# Issue 24444
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog='PROG', description='main description')
|
|
parser.add_argument(
|
|
'foo',
|
|
help=' ')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] foo
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
foo \n
|
|
options:
|
|
-h, --help show this help message and exit
|
|
'''))
|
|
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog='PROG', description='main description')
|
|
parser.add_argument(
|
|
'foo', choices=[],
|
|
help='%(choices)s')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] {}
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
{} \n
|
|
options:
|
|
-h, --help show this help message and exit
|
|
'''))
|
|
|
|
def test_help_alternate_prefix_chars(self):
|
|
parser = self._get_parser(prefix_chars='+:/')
|
|
self.assertEqual(parser.format_usage(),
|
|
'usage: PROG [+h] [++foo] bar {1,2,3} ...\n')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [+h] [++foo] bar {1,2,3} ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
{1,2,3} command help
|
|
|
|
options:
|
|
+h, ++help show this help message and exit
|
|
++foo foo help
|
|
'''))
|
|
|
|
def test_parser_command_help(self):
|
|
self.assertEqual(self.command_help_parser.format_usage(),
|
|
'usage: PROG [-h] [--foo] bar {1,2,3} ...\n')
|
|
self.assertEqual(self.command_help_parser.format_help(),
|
|
textwrap.dedent('''\
|
|
usage: PROG [-h] [--foo] bar {1,2,3} ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
{1,2,3} command help
|
|
1 1 help
|
|
2 2 help
|
|
3 3 help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo foo help
|
|
'''))
|
|
|
|
def assert_bad_help(self, context_type, func, *args, **kwargs):
|
|
with self.assertRaisesRegex(ValueError, 'badly formed help string') as cm:
|
|
func(*args, **kwargs)
|
|
self.assertIsInstance(cm.exception.__context__, context_type)
|
|
|
|
def test_invalid_subparsers_help(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
self.assert_bad_help(ValueError, parser.add_subparsers, help='%Y-%m-%d')
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
self.assert_bad_help(KeyError, parser.add_subparsers, help='%(spam)s')
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
self.assert_bad_help(TypeError, parser.add_subparsers, help='%(prog)d')
|
|
|
|
def test_invalid_subparser_help(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
subparsers = parser.add_subparsers()
|
|
self.assert_bad_help(ValueError, subparsers.add_parser, '1',
|
|
help='%Y-%m-%d')
|
|
self.assert_bad_help(KeyError, subparsers.add_parser, '1',
|
|
help='%(spam)s')
|
|
self.assert_bad_help(TypeError, subparsers.add_parser, '1',
|
|
help='%(prog)d')
|
|
|
|
def test_subparser_title_help(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG',
|
|
description='main description')
|
|
parser.add_argument('--foo', action='store_true', help='foo help')
|
|
parser.add_argument('bar', help='bar help')
|
|
subparsers = parser.add_subparsers(title='subcommands',
|
|
description='command help',
|
|
help='additional text')
|
|
parser1 = subparsers.add_parser('1')
|
|
parser2 = subparsers.add_parser('2')
|
|
self.assertEqual(parser.format_usage(),
|
|
'usage: PROG [-h] [--foo] bar {1,2} ...\n')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [--foo] bar {1,2} ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo foo help
|
|
|
|
subcommands:
|
|
command help
|
|
|
|
{1,2} additional text
|
|
'''))
|
|
|
|
def _test_subparser_help(self, args_str, expected_help):
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
self.parser.parse_args(args_str.split())
|
|
self.assertEqual(expected_help, cm.exception.stdout)
|
|
|
|
def test_subparser1_help(self):
|
|
self._test_subparser_help('5.0 1 -h', textwrap.dedent('''\
|
|
usage: PROG bar 1 [-h] [-w W] {a,b,c}
|
|
|
|
1 description
|
|
|
|
positional arguments:
|
|
{a,b,c} x help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w W w help
|
|
'''))
|
|
|
|
def test_subparser2_help(self):
|
|
self._test_subparser_help('5.0 2 -h', textwrap.dedent('''\
|
|
usage: PROG bar 2 [-h] [-y {1,2,3}] [z ...]
|
|
|
|
2 description
|
|
|
|
positional arguments:
|
|
z z help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-y {1,2,3} y help
|
|
'''))
|
|
|
|
def test_alias_invocation(self):
|
|
parser = self._get_parser(aliases=True)
|
|
self.assertEqual(
|
|
parser.parse_known_args('0.5 1alias1 b'.split()),
|
|
(NS(foo=False, bar=0.5, w=None, x='b'), []),
|
|
)
|
|
self.assertEqual(
|
|
parser.parse_known_args('0.5 1alias2 b'.split()),
|
|
(NS(foo=False, bar=0.5, w=None, x='b'), []),
|
|
)
|
|
|
|
def test_error_alias_invocation(self):
|
|
parser = self._get_parser(aliases=True)
|
|
self.assertArgumentParserError(parser.parse_args,
|
|
'0.5 1alias3 b'.split())
|
|
|
|
def test_alias_help(self):
|
|
parser = self._get_parser(aliases=True, subparser_help=True)
|
|
self.maxDiff = None
|
|
self.assertEqual(parser.format_help(), textwrap.dedent("""\
|
|
usage: PROG [-h] [--foo] bar COMMAND ...
|
|
|
|
main description
|
|
|
|
positional arguments:
|
|
bar bar help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo foo help
|
|
|
|
commands:
|
|
COMMAND
|
|
1 (1alias1, 1alias2)
|
|
1 help
|
|
2 2 help
|
|
3 3 help
|
|
"""))
|
|
|
|
# ============
|
|
# Groups tests
|
|
# ============
|
|
|
|
class TestPositionalsGroups(TestCase):
|
|
"""Tests that order of group positionals matches construction order"""
|
|
|
|
def test_nongroup_first(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('foo')
|
|
group = parser.add_argument_group('g')
|
|
group.add_argument('bar')
|
|
parser.add_argument('baz')
|
|
expected = NS(foo='1', bar='2', baz='3')
|
|
result = parser.parse_args('1 2 3'.split())
|
|
self.assertEqual(expected, result)
|
|
|
|
def test_group_first(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
group = parser.add_argument_group('xxx')
|
|
group.add_argument('foo')
|
|
parser.add_argument('bar')
|
|
parser.add_argument('baz')
|
|
expected = NS(foo='1', bar='2', baz='3')
|
|
result = parser.parse_args('1 2 3'.split())
|
|
self.assertEqual(expected, result)
|
|
|
|
def test_interleaved_groups(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
group = parser.add_argument_group('xxx')
|
|
parser.add_argument('foo')
|
|
group.add_argument('bar')
|
|
parser.add_argument('baz')
|
|
group = parser.add_argument_group('yyy')
|
|
group.add_argument('frell')
|
|
expected = NS(foo='1', bar='2', baz='3', frell='4')
|
|
result = parser.parse_args('1 2 3 4'.split())
|
|
self.assertEqual(expected, result)
|
|
|
|
class TestGroupConstructor(TestCase):
|
|
def test_group_prefix_chars(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
msg = (
|
|
"The use of the undocumented 'prefix_chars' parameter in "
|
|
"ArgumentParser.add_argument_group() is deprecated."
|
|
)
|
|
with self.assertWarns(DeprecationWarning) as cm:
|
|
parser.add_argument_group(prefix_chars='-+')
|
|
self.assertEqual(msg, str(cm.warning))
|
|
self.assertEqual(cm.filename, __file__)
|
|
|
|
def test_group_prefix_chars_default(self):
|
|
# "default" isn't quite the right word here, but it's the same as
|
|
# the parser's default prefix so it's a good test
|
|
parser = ErrorRaisingArgumentParser()
|
|
msg = (
|
|
"The use of the undocumented 'prefix_chars' parameter in "
|
|
"ArgumentParser.add_argument_group() is deprecated."
|
|
)
|
|
with self.assertWarns(DeprecationWarning) as cm:
|
|
parser.add_argument_group(prefix_chars='-')
|
|
self.assertEqual(msg, str(cm.warning))
|
|
self.assertEqual(cm.filename, __file__)
|
|
|
|
# ===================
|
|
# Parent parser tests
|
|
# ===================
|
|
|
|
class TestParentParsers(TestCase):
|
|
"""Tests that parsers can be created with parent parsers"""
|
|
|
|
def assertArgumentParserError(self, *args, **kwargs):
|
|
self.assertRaises(ArgumentParserError, *args, **kwargs)
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.wxyz_parent = ErrorRaisingArgumentParser(add_help=False)
|
|
self.wxyz_parent.add_argument('--w')
|
|
x_group = self.wxyz_parent.add_argument_group('x')
|
|
x_group.add_argument('-y')
|
|
self.wxyz_parent.add_argument('z')
|
|
|
|
self.abcd_parent = ErrorRaisingArgumentParser(add_help=False)
|
|
self.abcd_parent.add_argument('a')
|
|
self.abcd_parent.add_argument('-b')
|
|
c_group = self.abcd_parent.add_argument_group('c')
|
|
c_group.add_argument('--d')
|
|
|
|
self.w_parent = ErrorRaisingArgumentParser(add_help=False)
|
|
self.w_parent.add_argument('--w')
|
|
|
|
self.z_parent = ErrorRaisingArgumentParser(add_help=False)
|
|
self.z_parent.add_argument('z')
|
|
|
|
# parents with mutually exclusive groups
|
|
self.ab_mutex_parent = ErrorRaisingArgumentParser(add_help=False)
|
|
group = self.ab_mutex_parent.add_mutually_exclusive_group()
|
|
group.add_argument('-a', action='store_true')
|
|
group.add_argument('-b', action='store_true')
|
|
|
|
def test_single_parent(self):
|
|
parser = ErrorRaisingArgumentParser(parents=[self.wxyz_parent])
|
|
self.assertEqual(parser.parse_args('-y 1 2 --w 3'.split()),
|
|
NS(w='3', y='1', z='2'))
|
|
|
|
def test_single_parent_mutex(self):
|
|
self._test_mutex_ab(self.ab_mutex_parent.parse_args)
|
|
parser = ErrorRaisingArgumentParser(parents=[self.ab_mutex_parent])
|
|
self._test_mutex_ab(parser.parse_args)
|
|
|
|
def test_single_grandparent_mutex(self):
|
|
parents = [self.ab_mutex_parent]
|
|
parser = ErrorRaisingArgumentParser(add_help=False, parents=parents)
|
|
parser = ErrorRaisingArgumentParser(parents=[parser])
|
|
self._test_mutex_ab(parser.parse_args)
|
|
|
|
def _test_mutex_ab(self, parse_args):
|
|
self.assertEqual(parse_args([]), NS(a=False, b=False))
|
|
self.assertEqual(parse_args(['-a']), NS(a=True, b=False))
|
|
self.assertEqual(parse_args(['-b']), NS(a=False, b=True))
|
|
self.assertArgumentParserError(parse_args, ['-a', '-b'])
|
|
self.assertArgumentParserError(parse_args, ['-b', '-a'])
|
|
self.assertArgumentParserError(parse_args, ['-c'])
|
|
self.assertArgumentParserError(parse_args, ['-a', '-c'])
|
|
self.assertArgumentParserError(parse_args, ['-b', '-c'])
|
|
|
|
def test_multiple_parents(self):
|
|
parents = [self.abcd_parent, self.wxyz_parent]
|
|
parser = ErrorRaisingArgumentParser(parents=parents)
|
|
self.assertEqual(parser.parse_args('--d 1 --w 2 3 4'.split()),
|
|
NS(a='3', b=None, d='1', w='2', y=None, z='4'))
|
|
|
|
def test_multiple_parents_mutex(self):
|
|
parents = [self.ab_mutex_parent, self.wxyz_parent]
|
|
parser = ErrorRaisingArgumentParser(parents=parents)
|
|
self.assertEqual(parser.parse_args('-a --w 2 3'.split()),
|
|
NS(a=True, b=False, w='2', y=None, z='3'))
|
|
self.assertArgumentParserError(
|
|
parser.parse_args, '-a --w 2 3 -b'.split())
|
|
self.assertArgumentParserError(
|
|
parser.parse_args, '-a -b --w 2 3'.split())
|
|
|
|
def test_conflicting_parents(self):
|
|
self.assertRaises(
|
|
argparse.ArgumentError,
|
|
argparse.ArgumentParser,
|
|
parents=[self.w_parent, self.wxyz_parent])
|
|
|
|
def test_conflicting_parents_mutex(self):
|
|
self.assertRaises(
|
|
argparse.ArgumentError,
|
|
argparse.ArgumentParser,
|
|
parents=[self.abcd_parent, self.ab_mutex_parent])
|
|
|
|
def test_same_argument_name_parents(self):
|
|
parents = [self.wxyz_parent, self.z_parent]
|
|
parser = ErrorRaisingArgumentParser(parents=parents)
|
|
self.assertEqual(parser.parse_args('1 2'.split()),
|
|
NS(w=None, y=None, z='2'))
|
|
|
|
def test_subparser_parents(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers()
|
|
abcde_parser = subparsers.add_parser('bar', parents=[self.abcd_parent])
|
|
abcde_parser.add_argument('e')
|
|
self.assertEqual(parser.parse_args('bar -b 1 --d 2 3 4'.split()),
|
|
NS(a='3', b='1', d='2', e='4'))
|
|
|
|
def test_subparser_parents_mutex(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
subparsers = parser.add_subparsers()
|
|
parents = [self.ab_mutex_parent]
|
|
abc_parser = subparsers.add_parser('foo', parents=parents)
|
|
c_group = abc_parser.add_argument_group('c_group')
|
|
c_group.add_argument('c')
|
|
parents = [self.wxyz_parent, self.ab_mutex_parent]
|
|
wxyzabe_parser = subparsers.add_parser('bar', parents=parents)
|
|
wxyzabe_parser.add_argument('e')
|
|
self.assertEqual(parser.parse_args('foo -a 4'.split()),
|
|
NS(a=True, b=False, c='4'))
|
|
self.assertEqual(parser.parse_args('bar -b --w 2 3 4'.split()),
|
|
NS(a=False, b=True, w='2', y=None, z='3', e='4'))
|
|
self.assertArgumentParserError(
|
|
parser.parse_args, 'foo -a -b 4'.split())
|
|
self.assertArgumentParserError(
|
|
parser.parse_args, 'bar -b -a 4'.split())
|
|
|
|
def test_parent_help(self):
|
|
parents = [self.abcd_parent, self.wxyz_parent]
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', parents=parents)
|
|
parser_help = parser.format_help()
|
|
self.assertEqual(parser_help, textwrap.dedent('''\
|
|
usage: PROG [-h] [-b B] [--d D] [--w W] [-y Y] a z
|
|
|
|
positional arguments:
|
|
a
|
|
z
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-b B
|
|
--w W
|
|
|
|
c:
|
|
--d D
|
|
|
|
x:
|
|
-y Y
|
|
'''))
|
|
|
|
def test_groups_parents(self):
|
|
parent = ErrorRaisingArgumentParser(add_help=False)
|
|
g = parent.add_argument_group(title='g', description='gd')
|
|
g.add_argument('-w')
|
|
g.add_argument('-x')
|
|
m = parent.add_mutually_exclusive_group()
|
|
m.add_argument('-y')
|
|
m.add_argument('-z')
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', parents=[parent])
|
|
|
|
self.assertRaises(ArgumentParserError, parser.parse_args,
|
|
['-y', 'Y', '-z', 'Z'])
|
|
|
|
parser_help = parser.format_help()
|
|
self.assertEqual(parser_help, textwrap.dedent('''\
|
|
usage: PROG [-h] [-w W] [-x X] [-y Y | -z Z]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-y Y
|
|
-z Z
|
|
|
|
g:
|
|
gd
|
|
|
|
-w W
|
|
-x X
|
|
'''))
|
|
|
|
def test_wrong_type_parents(self):
|
|
self.assertRaises(TypeError, ErrorRaisingArgumentParser, parents=[1])
|
|
|
|
def test_mutex_groups_parents(self):
|
|
parent = ErrorRaisingArgumentParser(add_help=False)
|
|
g = parent.add_argument_group(title='g', description='gd')
|
|
g.add_argument('-w')
|
|
g.add_argument('-x')
|
|
m = g.add_mutually_exclusive_group()
|
|
m.add_argument('-y')
|
|
m.add_argument('-z')
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', parents=[parent])
|
|
|
|
self.assertRaises(ArgumentParserError, parser.parse_args,
|
|
['-y', 'Y', '-z', 'Z'])
|
|
|
|
parser_help = parser.format_help()
|
|
self.assertEqual(parser_help, textwrap.dedent('''\
|
|
usage: PROG [-h] [-w W] [-x X] [-y Y | -z Z]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
|
|
g:
|
|
gd
|
|
|
|
-w W
|
|
-x X
|
|
-y Y
|
|
-z Z
|
|
'''))
|
|
|
|
# ==============================
|
|
# Mutually exclusive group tests
|
|
# ==============================
|
|
|
|
class TestMutuallyExclusiveGroupErrors(TestCase):
|
|
|
|
def test_invalid_add_argument_group(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
raises = self.assertRaises
|
|
raises(TypeError, parser.add_mutually_exclusive_group, title='foo')
|
|
|
|
def test_invalid_add_argument(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
group = parser.add_mutually_exclusive_group()
|
|
add_argument = group.add_argument
|
|
raises = self.assertRaises
|
|
raises(ValueError, add_argument, '--foo', required=True)
|
|
raises(ValueError, add_argument, 'bar')
|
|
raises(ValueError, add_argument, 'bar', nargs='+')
|
|
raises(ValueError, add_argument, 'bar', nargs=1)
|
|
raises(ValueError, add_argument, 'bar', nargs=argparse.PARSER)
|
|
|
|
def test_help(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group1 = parser.add_mutually_exclusive_group()
|
|
group1.add_argument('--foo', action='store_true')
|
|
group1.add_argument('--bar', action='store_false')
|
|
group2 = parser.add_mutually_exclusive_group()
|
|
group2.add_argument('--soup', action='store_true')
|
|
group2.add_argument('--nuts', action='store_false')
|
|
expected = '''\
|
|
usage: PROG [-h] [--foo | --bar] [--soup | --nuts]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo
|
|
--bar
|
|
--soup
|
|
--nuts
|
|
'''
|
|
self.assertEqual(parser.format_help(), textwrap.dedent(expected))
|
|
|
|
def test_optional_order(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=True)
|
|
group.add_argument('--foo')
|
|
group.add_argument('bar', nargs='?')
|
|
expected = '''\
|
|
usage: PROG [-h] (--foo FOO | bar)
|
|
|
|
positional arguments:
|
|
bar
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
'''
|
|
self.assertEqual(parser.format_help(), textwrap.dedent(expected))
|
|
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=True)
|
|
group.add_argument('bar', nargs='?')
|
|
group.add_argument('--foo')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent(expected))
|
|
|
|
def test_help_subparser_all_mutually_exclusive_group_members_suppressed(self):
|
|
self.maxDiff = None
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
commands = parser.add_subparsers(title="commands", dest="command")
|
|
cmd_foo = commands.add_parser("foo")
|
|
group = cmd_foo.add_mutually_exclusive_group()
|
|
group.add_argument('--verbose', action='store_true', help=argparse.SUPPRESS)
|
|
group.add_argument('--quiet', action='store_true', help=argparse.SUPPRESS)
|
|
longopt = '--' + 'long'*32
|
|
longmeta = 'LONG'*32
|
|
cmd_foo.add_argument(longopt)
|
|
expected = f'''\
|
|
usage: PROG foo [-h]
|
|
[{longopt} {longmeta}]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
{longopt} {longmeta}
|
|
'''
|
|
self.assertEqual(cmd_foo.format_help(), textwrap.dedent(expected))
|
|
|
|
def test_empty_group(self):
|
|
# See issue 26952
|
|
parser = argparse.ArgumentParser()
|
|
group = parser.add_mutually_exclusive_group()
|
|
with self.assertRaises(ValueError):
|
|
parser.parse_args(['-h'])
|
|
|
|
class MEMixin(object):
|
|
|
|
def test_failures_when_not_required(self):
|
|
parse_args = self.get_parser(required=False).parse_args
|
|
error = ArgumentParserError
|
|
for args_string in self.failures:
|
|
with self.subTest(args=args_string):
|
|
self.assertRaises(error, parse_args, args_string.split())
|
|
|
|
def test_failures_when_required(self):
|
|
parse_args = self.get_parser(required=True).parse_args
|
|
error = ArgumentParserError
|
|
for args_string in self.failures + ['']:
|
|
with self.subTest(args=args_string):
|
|
self.assertRaises(error, parse_args, args_string.split())
|
|
|
|
def test_successes_when_not_required(self):
|
|
parse_args = self.get_parser(required=False).parse_args
|
|
successes = self.successes + self.successes_when_not_required
|
|
for args_string, expected_ns in successes:
|
|
with self.subTest(args=args_string):
|
|
actual_ns = parse_args(args_string.split())
|
|
self.assertEqual(actual_ns, expected_ns)
|
|
|
|
def test_successes_when_required(self):
|
|
parse_args = self.get_parser(required=True).parse_args
|
|
for args_string, expected_ns in self.successes:
|
|
with self.subTest(args=args_string):
|
|
actual_ns = parse_args(args_string.split())
|
|
self.assertEqual(actual_ns, expected_ns)
|
|
|
|
def test_usage_when_not_required(self):
|
|
format_usage = self.get_parser(required=False).format_usage
|
|
expected_usage = self.usage_when_not_required
|
|
self.assertEqual(format_usage(), textwrap.dedent(expected_usage))
|
|
|
|
def test_usage_when_required(self):
|
|
format_usage = self.get_parser(required=True).format_usage
|
|
expected_usage = self.usage_when_required
|
|
self.assertEqual(format_usage(), textwrap.dedent(expected_usage))
|
|
|
|
def test_help_when_not_required(self):
|
|
format_help = self.get_parser(required=False).format_help
|
|
help = self.usage_when_not_required + self.help
|
|
self.assertEqual(format_help(), textwrap.dedent(help))
|
|
|
|
def test_help_when_required(self):
|
|
format_help = self.get_parser(required=True).format_help
|
|
help = self.usage_when_required + self.help
|
|
self.assertEqual(format_help(), textwrap.dedent(help))
|
|
|
|
|
|
class TestMutuallyExclusiveSimple(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--bar', help='bar help')
|
|
group.add_argument('--baz', nargs='?', const='Z', help='baz help')
|
|
return parser
|
|
|
|
failures = ['--bar X --baz Y', '--bar X --baz']
|
|
successes = [
|
|
('--bar X', NS(bar='X', baz=None)),
|
|
('--bar X --bar Z', NS(bar='Z', baz=None)),
|
|
('--baz Y', NS(bar=None, baz='Y')),
|
|
('--baz', NS(bar=None, baz='Z')),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(bar=None, baz=None)),
|
|
]
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--bar BAR | --baz [BAZ]]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--bar BAR | --baz [BAZ])
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--bar BAR bar help
|
|
--baz [BAZ] baz help
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveLong(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
parser.add_argument('--abcde', help='abcde help')
|
|
parser.add_argument('--fghij', help='fghij help')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--klmno', help='klmno help')
|
|
group.add_argument('--pqrst', help='pqrst help')
|
|
return parser
|
|
|
|
failures = ['--klmno X --pqrst Y']
|
|
successes = [
|
|
('--klmno X', NS(abcde=None, fghij=None, klmno='X', pqrst=None)),
|
|
('--abcde Y --klmno X',
|
|
NS(abcde='Y', fghij=None, klmno='X', pqrst=None)),
|
|
('--pqrst X', NS(abcde=None, fghij=None, klmno=None, pqrst='X')),
|
|
('--pqrst X --fghij Y',
|
|
NS(abcde=None, fghij='Y', klmno=None, pqrst='X')),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(abcde=None, fghij=None, klmno=None, pqrst=None)),
|
|
]
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--abcde ABCDE] [--fghij FGHIJ] [--klmno KLMNO |
|
|
--pqrst PQRST]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] [--abcde ABCDE] [--fghij FGHIJ] (--klmno KLMNO |
|
|
--pqrst PQRST)
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--abcde ABCDE abcde help
|
|
--fghij FGHIJ fghij help
|
|
--klmno KLMNO klmno help
|
|
--pqrst PQRST pqrst help
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveFirstSuppressed(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('-x', help=argparse.SUPPRESS)
|
|
group.add_argument('-y', action='store_false', help='y help')
|
|
return parser
|
|
|
|
failures = ['-x X -y']
|
|
successes = [
|
|
('-x X', NS(x='X', y=True)),
|
|
('-x X -x Y', NS(x='Y', y=True)),
|
|
('-y', NS(x=None, y=False)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(x=None, y=True)),
|
|
]
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [-y]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] -y
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-y y help
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveManySuppressed(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
add = group.add_argument
|
|
add('--spam', action='store_true', help=argparse.SUPPRESS)
|
|
add('--badger', action='store_false', help=argparse.SUPPRESS)
|
|
add('--bladder', help=argparse.SUPPRESS)
|
|
return parser
|
|
|
|
failures = [
|
|
'--spam --badger',
|
|
'--badger --bladder B',
|
|
'--bladder B --spam',
|
|
]
|
|
successes = [
|
|
('--spam', NS(spam=True, badger=True, bladder=None)),
|
|
('--badger', NS(spam=False, badger=False, bladder=None)),
|
|
('--bladder B', NS(spam=False, badger=True, bladder='B')),
|
|
('--spam --spam', NS(spam=True, badger=True, bladder=None)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(spam=False, badger=True, bladder=None)),
|
|
]
|
|
|
|
usage_when_required = usage_when_not_required = '''\
|
|
usage: PROG [-h]
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalAndPositional(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--foo', action='store_true', help='FOO')
|
|
group.add_argument('--spam', help='SPAM')
|
|
group.add_argument('badger', nargs='*', help='BADGER')
|
|
return parser
|
|
|
|
failures = [
|
|
'--foo --spam S',
|
|
'--spam S X',
|
|
'X --foo',
|
|
'X Y Z --spam S',
|
|
'--foo X Y',
|
|
]
|
|
successes = [
|
|
('--foo', NS(foo=True, spam=None, badger=[])),
|
|
('--spam S', NS(foo=False, spam='S', badger=[])),
|
|
('X', NS(foo=False, spam=None, badger=['X'])),
|
|
('X Y Z', NS(foo=False, spam=None, badger=['X', 'Y', 'Z'])),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(foo=False, spam=None, badger=[])),
|
|
]
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--foo | --spam SPAM | badger ...]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--foo | --spam SPAM | badger ...)
|
|
'''
|
|
help = '''\
|
|
|
|
positional arguments:
|
|
badger BADGER
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
--spam SPAM SPAM
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalsMixed(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
parser.add_argument('-x', action='store_true', help='x help')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('-a', action='store_true', help='a help')
|
|
group.add_argument('-b', action='store_true', help='b help')
|
|
parser.add_argument('-y', action='store_true', help='y help')
|
|
group.add_argument('-c', action='store_true', help='c help')
|
|
return parser
|
|
|
|
failures = ['-a -b', '-b -c', '-a -c', '-a -b -c']
|
|
successes = [
|
|
('-a', NS(a=True, b=False, c=False, x=False, y=False)),
|
|
('-b', NS(a=False, b=True, c=False, x=False, y=False)),
|
|
('-c', NS(a=False, b=False, c=True, x=False, y=False)),
|
|
('-a -x', NS(a=True, b=False, c=False, x=True, y=False)),
|
|
('-y -b', NS(a=False, b=True, c=False, x=False, y=True)),
|
|
('-x -y -c', NS(a=False, b=False, c=True, x=True, y=True)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(a=False, b=False, c=False, x=False, y=False)),
|
|
('-x', NS(a=False, b=False, c=False, x=True, y=False)),
|
|
('-y', NS(a=False, b=False, c=False, x=False, y=True)),
|
|
]
|
|
|
|
usage_when_required = usage_when_not_required = '''\
|
|
usage: PROG [-h] [-x] [-a] [-b] [-y] [-c]
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x x help
|
|
-a a help
|
|
-b b help
|
|
-y y help
|
|
-c c help
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveInGroup(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
titled_group = parser.add_argument_group(
|
|
title='Titled group', description='Group description')
|
|
mutex_group = \
|
|
titled_group.add_mutually_exclusive_group(required=required)
|
|
mutex_group.add_argument('--bar', help='bar help')
|
|
mutex_group.add_argument('--baz', help='baz help')
|
|
return parser
|
|
|
|
failures = ['--bar X --baz Y', '--baz X --bar Y']
|
|
successes = [
|
|
('--bar X', NS(bar='X', baz=None)),
|
|
('--baz Y', NS(bar=None, baz='Y')),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(bar=None, baz=None)),
|
|
]
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--bar BAR | --baz BAZ]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--bar BAR | --baz BAZ)
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
|
|
Titled group:
|
|
Group description
|
|
|
|
--bar BAR bar help
|
|
--baz BAZ baz help
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalsAndPositionalsMixed(MEMixin, TestCase):
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
parser.add_argument('x', help='x help')
|
|
parser.add_argument('-y', action='store_true', help='y help')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('a', nargs='?', help='a help')
|
|
group.add_argument('-b', action='store_true', help='b help')
|
|
group.add_argument('-c', action='store_true', help='c help')
|
|
return parser
|
|
|
|
failures = ['X A -b', '-b -c', '-c X A']
|
|
successes = [
|
|
('X A', NS(a='A', b=False, c=False, x='X', y=False)),
|
|
('X -b', NS(a=None, b=True, c=False, x='X', y=False)),
|
|
('X -c', NS(a=None, b=False, c=True, x='X', y=False)),
|
|
('X A -y', NS(a='A', b=False, c=False, x='X', y=True)),
|
|
('X -y -b', NS(a=None, b=True, c=False, x='X', y=True)),
|
|
]
|
|
successes_when_not_required = [
|
|
('X', NS(a=None, b=False, c=False, x='X', y=False)),
|
|
('X -y', NS(a=None, b=False, c=False, x='X', y=True)),
|
|
]
|
|
|
|
usage_when_required = usage_when_not_required = '''\
|
|
usage: PROG [-h] [-y] [-b] [-c] x [a]
|
|
'''
|
|
help = '''\
|
|
|
|
positional arguments:
|
|
x x help
|
|
a a help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-y y help
|
|
-b b help
|
|
-c c help
|
|
'''
|
|
|
|
class TestMutuallyExclusiveNested(MEMixin, TestCase):
|
|
|
|
# Nesting mutually exclusive groups is an undocumented feature
|
|
# that came about by accident through inheritance and has been
|
|
# the source of many bugs. It is deprecated and this test should
|
|
# eventually be removed along with it.
|
|
|
|
def get_parser(self, required):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('-a')
|
|
group.add_argument('-b')
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('ignore', DeprecationWarning)
|
|
group2 = group.add_mutually_exclusive_group(required=required)
|
|
group2.add_argument('-c')
|
|
group2.add_argument('-d')
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('ignore', DeprecationWarning)
|
|
group3 = group2.add_mutually_exclusive_group(required=required)
|
|
group3.add_argument('-e')
|
|
group3.add_argument('-f')
|
|
return parser
|
|
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [-a A | -b B | [-c C | -d D | [-e E | -f F]]]
|
|
'''
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (-a A | -b B | (-c C | -d D | (-e E | -f F)))
|
|
'''
|
|
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-a A
|
|
-b B
|
|
-c C
|
|
-d D
|
|
-e E
|
|
-f F
|
|
'''
|
|
|
|
# We are only interested in testing the behavior of format_usage().
|
|
test_failures_when_not_required = None
|
|
test_failures_when_required = None
|
|
test_successes_when_not_required = None
|
|
test_successes_when_required = None
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalOptional(MEMixin, TestCase):
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--foo')
|
|
group.add_argument('--bar', nargs='?')
|
|
return parser
|
|
|
|
failures = [
|
|
'--foo X --bar Y',
|
|
'--foo X --bar',
|
|
]
|
|
successes = [
|
|
('--foo X', NS(foo='X', bar=None)),
|
|
('--bar X', NS(foo=None, bar='X')),
|
|
('--bar', NS(foo=None, bar=None)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(foo=None, bar=None)),
|
|
]
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--foo FOO | --bar [BAR])
|
|
'''
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--foo FOO | --bar [BAR]]
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
--bar [BAR]
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalWithDefault(MEMixin, TestCase):
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--foo')
|
|
group.add_argument('--bar', type=bool, default=True)
|
|
return parser
|
|
|
|
failures = [
|
|
'--foo X --bar Y',
|
|
'--foo X --bar=',
|
|
]
|
|
successes = [
|
|
('--foo X', NS(foo='X', bar=True)),
|
|
('--bar X', NS(foo=None, bar=True)),
|
|
('--bar=', NS(foo=None, bar=False)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(foo=None, bar=True)),
|
|
]
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--foo FOO | --bar BAR)
|
|
'''
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--foo FOO | --bar BAR]
|
|
'''
|
|
help = '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
--bar BAR
|
|
'''
|
|
|
|
|
|
class TestMutuallyExclusivePositionalWithDefault(MEMixin, TestCase):
|
|
def get_parser(self, required=None):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
group = parser.add_mutually_exclusive_group(required=required)
|
|
group.add_argument('--foo')
|
|
group.add_argument('bar', nargs='?', type=bool, default=True)
|
|
return parser
|
|
|
|
failures = [
|
|
'--foo X Y',
|
|
]
|
|
successes = [
|
|
('--foo X', NS(foo='X', bar=True)),
|
|
('X', NS(foo=None, bar=True)),
|
|
]
|
|
successes_when_not_required = [
|
|
('', NS(foo=None, bar=True)),
|
|
]
|
|
usage_when_required = '''\
|
|
usage: PROG [-h] (--foo FOO | bar)
|
|
'''
|
|
usage_when_not_required = '''\
|
|
usage: PROG [-h] [--foo FOO | bar]
|
|
'''
|
|
help = '''\
|
|
|
|
positional arguments:
|
|
bar
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
'''
|
|
|
|
# =================================================
|
|
# Mutually exclusive group in parent parser tests
|
|
# =================================================
|
|
|
|
class MEPBase(object):
|
|
|
|
def get_parser(self, required=None):
|
|
parent = super(MEPBase, self).get_parser(required=required)
|
|
parser = ErrorRaisingArgumentParser(
|
|
prog=parent.prog, add_help=False, parents=[parent])
|
|
return parser
|
|
|
|
|
|
class TestMutuallyExclusiveGroupErrorsParent(
|
|
MEPBase, TestMutuallyExclusiveGroupErrors):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveSimpleParent(
|
|
MEPBase, TestMutuallyExclusiveSimple):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveLongParent(
|
|
MEPBase, TestMutuallyExclusiveLong):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveFirstSuppressedParent(
|
|
MEPBase, TestMutuallyExclusiveFirstSuppressed):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveManySuppressedParent(
|
|
MEPBase, TestMutuallyExclusiveManySuppressed):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalAndPositionalParent(
|
|
MEPBase, TestMutuallyExclusiveOptionalAndPositional):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalsMixedParent(
|
|
MEPBase, TestMutuallyExclusiveOptionalsMixed):
|
|
pass
|
|
|
|
|
|
class TestMutuallyExclusiveOptionalsAndPositionalsMixedParent(
|
|
MEPBase, TestMutuallyExclusiveOptionalsAndPositionalsMixed):
|
|
pass
|
|
|
|
# =================
|
|
# Set default tests
|
|
# =================
|
|
|
|
class TestSetDefaults(TestCase):
|
|
|
|
def test_set_defaults_no_args(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.set_defaults(x='foo')
|
|
parser.set_defaults(y='bar', z=1)
|
|
self.assertEqual(NS(x='foo', y='bar', z=1),
|
|
parser.parse_args([]))
|
|
self.assertEqual(NS(x='foo', y='bar', z=1),
|
|
parser.parse_args([], NS()))
|
|
self.assertEqual(NS(x='baz', y='bar', z=1),
|
|
parser.parse_args([], NS(x='baz')))
|
|
self.assertEqual(NS(x='baz', y='bar', z=2),
|
|
parser.parse_args([], NS(x='baz', z=2)))
|
|
|
|
def test_set_defaults_with_args(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.set_defaults(x='foo', y='bar')
|
|
parser.add_argument('-x', default='xfoox')
|
|
self.assertEqual(NS(x='xfoox', y='bar'),
|
|
parser.parse_args([]))
|
|
self.assertEqual(NS(x='xfoox', y='bar'),
|
|
parser.parse_args([], NS()))
|
|
self.assertEqual(NS(x='baz', y='bar'),
|
|
parser.parse_args([], NS(x='baz')))
|
|
self.assertEqual(NS(x='1', y='bar'),
|
|
parser.parse_args('-x 1'.split()))
|
|
self.assertEqual(NS(x='1', y='bar'),
|
|
parser.parse_args('-x 1'.split(), NS()))
|
|
self.assertEqual(NS(x='1', y='bar'),
|
|
parser.parse_args('-x 1'.split(), NS(x='baz')))
|
|
|
|
def test_set_defaults_subparsers(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.set_defaults(x='foo')
|
|
subparsers = parser.add_subparsers()
|
|
parser_a = subparsers.add_parser('a')
|
|
parser_a.set_defaults(y='bar')
|
|
self.assertEqual(NS(x='foo', y='bar'),
|
|
parser.parse_args('a'.split()))
|
|
|
|
def test_set_defaults_parents(self):
|
|
parent = ErrorRaisingArgumentParser(add_help=False)
|
|
parent.set_defaults(x='foo')
|
|
parser = ErrorRaisingArgumentParser(parents=[parent])
|
|
self.assertEqual(NS(x='foo'), parser.parse_args([]))
|
|
|
|
def test_set_defaults_on_parent_and_subparser(self):
|
|
parser = argparse.ArgumentParser()
|
|
xparser = parser.add_subparsers().add_parser('X')
|
|
parser.set_defaults(foo=1)
|
|
xparser.set_defaults(foo=2)
|
|
self.assertEqual(NS(foo=2), parser.parse_args(['X']))
|
|
|
|
def test_set_defaults_same_as_add_argument(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.set_defaults(w='W', x='X', y='Y', z='Z')
|
|
parser.add_argument('-w')
|
|
parser.add_argument('-x', default='XX')
|
|
parser.add_argument('y', nargs='?')
|
|
parser.add_argument('z', nargs='?', default='ZZ')
|
|
|
|
# defaults set previously
|
|
self.assertEqual(NS(w='W', x='XX', y='Y', z='ZZ'),
|
|
parser.parse_args([]))
|
|
|
|
# reset defaults
|
|
parser.set_defaults(w='WW', x='X', y='YY', z='Z')
|
|
self.assertEqual(NS(w='WW', x='X', y='YY', z='Z'),
|
|
parser.parse_args([]))
|
|
|
|
def test_set_defaults_same_as_add_argument_group(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.set_defaults(w='W', x='X', y='Y', z='Z')
|
|
group = parser.add_argument_group('foo')
|
|
group.add_argument('-w')
|
|
group.add_argument('-x', default='XX')
|
|
group.add_argument('y', nargs='?')
|
|
group.add_argument('z', nargs='?', default='ZZ')
|
|
|
|
|
|
# defaults set previously
|
|
self.assertEqual(NS(w='W', x='XX', y='Y', z='ZZ'),
|
|
parser.parse_args([]))
|
|
|
|
# reset defaults
|
|
parser.set_defaults(w='WW', x='X', y='YY', z='Z')
|
|
self.assertEqual(NS(w='WW', x='X', y='YY', z='Z'),
|
|
parser.parse_args([]))
|
|
|
|
# =================
|
|
# Get default tests
|
|
# =================
|
|
|
|
class TestGetDefault(TestCase):
|
|
|
|
def test_get_default(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
self.assertIsNone(parser.get_default("foo"))
|
|
self.assertIsNone(parser.get_default("bar"))
|
|
|
|
parser.add_argument("--foo")
|
|
self.assertIsNone(parser.get_default("foo"))
|
|
self.assertIsNone(parser.get_default("bar"))
|
|
|
|
parser.add_argument("--bar", type=int, default=42)
|
|
self.assertIsNone(parser.get_default("foo"))
|
|
self.assertEqual(42, parser.get_default("bar"))
|
|
|
|
parser.set_defaults(foo="badger")
|
|
self.assertEqual("badger", parser.get_default("foo"))
|
|
self.assertEqual(42, parser.get_default("bar"))
|
|
|
|
# ==========================
|
|
# Namespace 'contains' tests
|
|
# ==========================
|
|
|
|
class TestNamespaceContainsSimple(TestCase):
|
|
|
|
def test_empty(self):
|
|
ns = argparse.Namespace()
|
|
self.assertNotIn('', ns)
|
|
self.assertNotIn('x', ns)
|
|
|
|
def test_non_empty(self):
|
|
ns = argparse.Namespace(x=1, y=2)
|
|
self.assertNotIn('', ns)
|
|
self.assertIn('x', ns)
|
|
self.assertIn('y', ns)
|
|
self.assertNotIn('xx', ns)
|
|
self.assertNotIn('z', ns)
|
|
|
|
# =====================
|
|
# Help formatting tests
|
|
# =====================
|
|
|
|
class TestHelpFormattingMetaclass(type):
|
|
|
|
def __init__(cls, name, bases, bodydict):
|
|
if name == 'HelpTestCase':
|
|
return
|
|
|
|
class AddTests(object):
|
|
|
|
def __init__(self, test_class, func_suffix, std_name):
|
|
self.func_suffix = func_suffix
|
|
self.std_name = std_name
|
|
|
|
for test_func in [self.test_format,
|
|
self.test_print,
|
|
self.test_print_file]:
|
|
test_name = '%s_%s' % (test_func.__name__, func_suffix)
|
|
|
|
def test_wrapper(self, test_func=test_func):
|
|
test_func(self)
|
|
try:
|
|
test_wrapper.__name__ = test_name
|
|
except TypeError:
|
|
pass
|
|
setattr(test_class, test_name, test_wrapper)
|
|
|
|
def _get_parser(self, tester):
|
|
parser = argparse.ArgumentParser(
|
|
*tester.parser_signature.args,
|
|
**tester.parser_signature.kwargs)
|
|
for argument_sig in getattr(tester, 'argument_signatures', []):
|
|
parser.add_argument(*argument_sig.args,
|
|
**argument_sig.kwargs)
|
|
group_sigs = getattr(tester, 'argument_group_signatures', [])
|
|
for group_sig, argument_sigs in group_sigs:
|
|
group = parser.add_argument_group(*group_sig.args,
|
|
**group_sig.kwargs)
|
|
for argument_sig in argument_sigs:
|
|
group.add_argument(*argument_sig.args,
|
|
**argument_sig.kwargs)
|
|
subparsers_sigs = getattr(tester, 'subparsers_signatures', [])
|
|
if subparsers_sigs:
|
|
subparsers = parser.add_subparsers()
|
|
for subparser_sig in subparsers_sigs:
|
|
subparsers.add_parser(*subparser_sig.args,
|
|
**subparser_sig.kwargs)
|
|
return parser
|
|
|
|
def _test(self, tester, parser_text):
|
|
expected_text = getattr(tester, self.func_suffix)
|
|
expected_text = textwrap.dedent(expected_text)
|
|
tester.maxDiff = None
|
|
tester.assertEqual(expected_text, parser_text)
|
|
|
|
def test_format(self, tester):
|
|
parser = self._get_parser(tester)
|
|
format = getattr(parser, 'format_%s' % self.func_suffix)
|
|
self._test(tester, format())
|
|
|
|
def test_print(self, tester):
|
|
parser = self._get_parser(tester)
|
|
print_ = getattr(parser, 'print_%s' % self.func_suffix)
|
|
old_stream = getattr(sys, self.std_name)
|
|
setattr(sys, self.std_name, StdIOBuffer())
|
|
try:
|
|
print_()
|
|
parser_text = getattr(sys, self.std_name).getvalue()
|
|
finally:
|
|
setattr(sys, self.std_name, old_stream)
|
|
self._test(tester, parser_text)
|
|
|
|
def test_print_file(self, tester):
|
|
parser = self._get_parser(tester)
|
|
print_ = getattr(parser, 'print_%s' % self.func_suffix)
|
|
sfile = StdIOBuffer()
|
|
print_(sfile)
|
|
parser_text = sfile.getvalue()
|
|
self._test(tester, parser_text)
|
|
|
|
# add tests for {format,print}_{usage,help}
|
|
for func_suffix, std_name in [('usage', 'stdout'),
|
|
('help', 'stdout')]:
|
|
AddTests(cls, func_suffix, std_name)
|
|
|
|
bases = TestCase,
|
|
HelpTestCase = TestHelpFormattingMetaclass('HelpTestCase', bases, {})
|
|
|
|
|
|
class TestHelpBiggerOptionals(HelpTestCase):
|
|
"""Make sure that argument help aligns when options are longer"""
|
|
|
|
parser_signature = Sig(prog='PROG', description='DESCRIPTION',
|
|
epilog='EPILOG')
|
|
argument_signatures = [
|
|
Sig('-v', '--version', action='version', version='0.1'),
|
|
Sig('-x', action='store_true', help='X HELP'),
|
|
Sig('--y', help='Y HELP'),
|
|
Sig('foo', help='FOO HELP'),
|
|
Sig('bar', help='BAR HELP'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-v] [-x] [--y Y] foo bar
|
|
'''
|
|
help = usage + '''\
|
|
|
|
DESCRIPTION
|
|
|
|
positional arguments:
|
|
foo FOO HELP
|
|
bar BAR HELP
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-v, --version show program's version number and exit
|
|
-x X HELP
|
|
--y Y Y HELP
|
|
|
|
EPILOG
|
|
'''
|
|
version = '''\
|
|
0.1
|
|
'''
|
|
|
|
class TestShortColumns(HelpTestCase):
|
|
'''Test extremely small number of columns.
|
|
|
|
TestCase prevents "COLUMNS" from being too small in the tests themselves,
|
|
but we don't want any exceptions thrown in such cases. Only ugly representation.
|
|
'''
|
|
def setUp(self):
|
|
env = self.enterContext(os_helper.EnvironmentVarGuard())
|
|
env.set("COLUMNS", '15')
|
|
|
|
parser_signature = TestHelpBiggerOptionals.parser_signature
|
|
argument_signatures = TestHelpBiggerOptionals.argument_signatures
|
|
argument_group_signatures = TestHelpBiggerOptionals.argument_group_signatures
|
|
usage = '''\
|
|
usage: PROG
|
|
[-h]
|
|
[-v]
|
|
[-x]
|
|
[--y Y]
|
|
foo
|
|
bar
|
|
'''
|
|
help = usage + '''\
|
|
|
|
DESCRIPTION
|
|
|
|
positional arguments:
|
|
foo
|
|
FOO HELP
|
|
bar
|
|
BAR HELP
|
|
|
|
options:
|
|
-h, --help
|
|
show this
|
|
help
|
|
message and
|
|
exit
|
|
-v, --version
|
|
show
|
|
program's
|
|
version
|
|
number and
|
|
exit
|
|
-x
|
|
X HELP
|
|
--y Y
|
|
Y HELP
|
|
|
|
EPILOG
|
|
'''
|
|
version = TestHelpBiggerOptionals.version
|
|
|
|
|
|
class TestHelpBiggerOptionalGroups(HelpTestCase):
|
|
"""Make sure that argument help aligns when options are longer"""
|
|
|
|
parser_signature = Sig(prog='PROG', description='DESCRIPTION',
|
|
epilog='EPILOG')
|
|
argument_signatures = [
|
|
Sig('-v', '--version', action='version', version='0.1'),
|
|
Sig('-x', action='store_true', help='X HELP'),
|
|
Sig('--y', help='Y HELP'),
|
|
Sig('foo', help='FOO HELP'),
|
|
Sig('bar', help='BAR HELP'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('GROUP TITLE', description='GROUP DESCRIPTION'), [
|
|
Sig('baz', help='BAZ HELP'),
|
|
Sig('-z', nargs='+', help='Z HELP')]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [-v] [-x] [--y Y] [-z Z [Z ...]] foo bar baz
|
|
'''
|
|
help = usage + '''\
|
|
|
|
DESCRIPTION
|
|
|
|
positional arguments:
|
|
foo FOO HELP
|
|
bar BAR HELP
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-v, --version show program's version number and exit
|
|
-x X HELP
|
|
--y Y Y HELP
|
|
|
|
GROUP TITLE:
|
|
GROUP DESCRIPTION
|
|
|
|
baz BAZ HELP
|
|
-z Z [Z ...] Z HELP
|
|
|
|
EPILOG
|
|
'''
|
|
version = '''\
|
|
0.1
|
|
'''
|
|
|
|
|
|
class TestHelpBiggerPositionals(HelpTestCase):
|
|
"""Make sure that help aligns when arguments are longer"""
|
|
|
|
parser_signature = Sig(usage='USAGE', description='DESCRIPTION')
|
|
argument_signatures = [
|
|
Sig('-x', action='store_true', help='X HELP'),
|
|
Sig('--y', help='Y HELP'),
|
|
Sig('ekiekiekifekang', help='EKI HELP'),
|
|
Sig('bar', help='BAR HELP'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: USAGE
|
|
'''
|
|
help = usage + '''\
|
|
|
|
DESCRIPTION
|
|
|
|
positional arguments:
|
|
ekiekiekifekang EKI HELP
|
|
bar BAR HELP
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x X HELP
|
|
--y Y Y HELP
|
|
'''
|
|
|
|
version = ''
|
|
|
|
|
|
class TestHelpReformatting(HelpTestCase):
|
|
"""Make sure that text after short names starts on the first line"""
|
|
|
|
parser_signature = Sig(
|
|
prog='PROG',
|
|
description=' oddly formatted\n'
|
|
'description\n'
|
|
'\n'
|
|
'that is so long that it should go onto multiple '
|
|
'lines when wrapped')
|
|
argument_signatures = [
|
|
Sig('-x', metavar='XX', help='oddly\n'
|
|
' formatted -x help'),
|
|
Sig('y', metavar='yyy', help='normal y help'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('title', description='\n'
|
|
' oddly formatted group\n'
|
|
'\n'
|
|
'description'),
|
|
[Sig('-a', action='store_true',
|
|
help=' oddly \n'
|
|
'formatted -a help \n'
|
|
' again, so long that it should be wrapped over '
|
|
'multiple lines')]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [-x XX] [-a] yyy
|
|
'''
|
|
help = usage + '''\
|
|
|
|
oddly formatted description that is so long that it should go onto \
|
|
multiple
|
|
lines when wrapped
|
|
|
|
positional arguments:
|
|
yyy normal y help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x XX oddly formatted -x help
|
|
|
|
title:
|
|
oddly formatted group description
|
|
|
|
-a oddly formatted -a help again, so long that it should \
|
|
be wrapped
|
|
over multiple lines
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpWrappingShortNames(HelpTestCase):
|
|
"""Make sure that text after short names starts on the first line"""
|
|
|
|
parser_signature = Sig(prog='PROG', description= 'D\nD' * 30)
|
|
argument_signatures = [
|
|
Sig('-x', metavar='XX', help='XHH HX' * 20),
|
|
Sig('y', metavar='yyy', help='YH YH' * 20),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('ALPHAS'), [
|
|
Sig('-a', action='store_true', help='AHHH HHA' * 10)]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [-x XX] [-a] yyy
|
|
'''
|
|
help = usage + '''\
|
|
|
|
D DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD \
|
|
DD DD DD
|
|
DD DD DD DD D
|
|
|
|
positional arguments:
|
|
yyy YH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH \
|
|
YHYH YHYH
|
|
YHYH YHYH YHYH YHYH YHYH YHYH YHYH YH
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x XX XHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH \
|
|
HXXHH HXXHH
|
|
HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HXXHH HX
|
|
|
|
ALPHAS:
|
|
-a AHHH HHAAHHH HHAAHHH HHAAHHH HHAAHHH HHAAHHH HHAAHHH \
|
|
HHAAHHH
|
|
HHAAHHH HHAAHHH HHA
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpWrappingLongNames(HelpTestCase):
|
|
"""Make sure that text after long names starts on the next line"""
|
|
|
|
parser_signature = Sig(usage='USAGE', description= 'D D' * 30)
|
|
argument_signatures = [
|
|
Sig('-v', '--version', action='version', version='V V' * 30),
|
|
Sig('-x', metavar='X' * 25, help='XH XH' * 20),
|
|
Sig('y', metavar='y' * 25, help='YH YH' * 20),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('ALPHAS'), [
|
|
Sig('-a', metavar='A' * 25, help='AH AH' * 20),
|
|
Sig('z', metavar='z' * 25, help='ZH ZH' * 20)]),
|
|
]
|
|
usage = '''\
|
|
usage: USAGE
|
|
'''
|
|
help = usage + '''\
|
|
|
|
D DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD DD \
|
|
DD DD DD
|
|
DD DD DD DD D
|
|
|
|
positional arguments:
|
|
yyyyyyyyyyyyyyyyyyyyyyyyy
|
|
YH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH \
|
|
YHYH YHYH
|
|
YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YHYH YH
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-v, --version show program's version number and exit
|
|
-x XXXXXXXXXXXXXXXXXXXXXXXXX
|
|
XH XHXH XHXH XHXH XHXH XHXH XHXH XHXH XHXH \
|
|
XHXH XHXH
|
|
XHXH XHXH XHXH XHXH XHXH XHXH XHXH XHXH XHXH XH
|
|
|
|
ALPHAS:
|
|
-a AAAAAAAAAAAAAAAAAAAAAAAAA
|
|
AH AHAH AHAH AHAH AHAH AHAH AHAH AHAH AHAH \
|
|
AHAH AHAH
|
|
AHAH AHAH AHAH AHAH AHAH AHAH AHAH AHAH AHAH AH
|
|
zzzzzzzzzzzzzzzzzzzzzzzzz
|
|
ZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH \
|
|
ZHZH ZHZH
|
|
ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZHZH ZH
|
|
'''
|
|
version = '''\
|
|
V VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV VV \
|
|
VV VV VV
|
|
VV VV VV VV V
|
|
'''
|
|
|
|
|
|
class TestHelpUsage(HelpTestCase):
|
|
"""Test basic usage messages"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-w', nargs='+', help='w'),
|
|
Sig('-x', nargs='*', help='x'),
|
|
Sig('a', help='a'),
|
|
Sig('b', help='b', nargs=2),
|
|
Sig('c', help='c', nargs='?'),
|
|
Sig('--foo', help='Whether to foo', action=argparse.BooleanOptionalAction),
|
|
Sig('--bar', help='Whether to bar', default=True,
|
|
action=argparse.BooleanOptionalAction),
|
|
Sig('-f', '--foobar', '--barfoo', action=argparse.BooleanOptionalAction),
|
|
Sig('--bazz', action=argparse.BooleanOptionalAction,
|
|
default=argparse.SUPPRESS, help='Bazz!'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('group'), [
|
|
Sig('-y', nargs='?', help='y'),
|
|
Sig('-z', nargs=3, help='z'),
|
|
Sig('d', help='d', nargs='*'),
|
|
Sig('e', help='e', nargs='+'),
|
|
])
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [-w W [W ...]] [-x [X ...]] [--foo | --no-foo]
|
|
[--bar | --no-bar]
|
|
[-f | --foobar | --no-foobar | --barfoo | --no-barfoo]
|
|
[--bazz | --no-bazz] [-y [Y]] [-z Z Z Z]
|
|
a b b [c] [d ...] e [e ...]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
a a
|
|
b b
|
|
c c
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w W [W ...] w
|
|
-x [X ...] x
|
|
--foo, --no-foo Whether to foo
|
|
--bar, --no-bar Whether to bar
|
|
-f, --foobar, --no-foobar, --barfoo, --no-barfoo
|
|
--bazz, --no-bazz Bazz!
|
|
|
|
group:
|
|
-y [Y] y
|
|
-z Z Z Z z
|
|
d d
|
|
e e
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageWithParentheses(HelpTestCase):
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('positional', metavar='(example) positional'),
|
|
Sig('-p', '--optional', metavar='{1 (option A), 2 (option B)}'),
|
|
]
|
|
|
|
usage = '''\
|
|
usage: PROG [-h] [-p {1 (option A), 2 (option B)}] (example) positional
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
(example) positional
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-p, --optional {1 (option A), 2 (option B)}
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpOnlyUserGroups(HelpTestCase):
|
|
"""Test basic usage messages"""
|
|
|
|
parser_signature = Sig(prog='PROG', add_help=False)
|
|
argument_signatures = []
|
|
argument_group_signatures = [
|
|
(Sig('xxxx'), [
|
|
Sig('-x', help='x'),
|
|
Sig('a', help='a'),
|
|
]),
|
|
(Sig('yyyy'), [
|
|
Sig('b', help='b'),
|
|
Sig('-y', help='y'),
|
|
]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-x X] [-y Y] a b
|
|
'''
|
|
help = usage + '''\
|
|
|
|
xxxx:
|
|
-x X x
|
|
a a
|
|
|
|
yyyy:
|
|
b b
|
|
-y Y y
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageLongProg(HelpTestCase):
|
|
"""Test usage messages where the prog is long"""
|
|
|
|
parser_signature = Sig(prog='P' * 60)
|
|
argument_signatures = [
|
|
Sig('-w', metavar='W'),
|
|
Sig('-x', metavar='X'),
|
|
Sig('a'),
|
|
Sig('b'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP
|
|
[-h] [-w W] [-x X] a b
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
a
|
|
b
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w W
|
|
-x X
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageLongProgOptionsWrap(HelpTestCase):
|
|
"""Test usage messages where the prog is long and the optionals wrap"""
|
|
|
|
parser_signature = Sig(prog='P' * 60)
|
|
argument_signatures = [
|
|
Sig('-w', metavar='W' * 25),
|
|
Sig('-x', metavar='X' * 25),
|
|
Sig('-y', metavar='Y' * 25),
|
|
Sig('-z', metavar='Z' * 25),
|
|
Sig('a'),
|
|
Sig('b'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP
|
|
[-h] [-w WWWWWWWWWWWWWWWWWWWWWWWWW] \
|
|
[-x XXXXXXXXXXXXXXXXXXXXXXXXX]
|
|
[-y YYYYYYYYYYYYYYYYYYYYYYYYY] [-z ZZZZZZZZZZZZZZZZZZZZZZZZZ]
|
|
a b
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
a
|
|
b
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w WWWWWWWWWWWWWWWWWWWWWWWWW
|
|
-x XXXXXXXXXXXXXXXXXXXXXXXXX
|
|
-y YYYYYYYYYYYYYYYYYYYYYYYYY
|
|
-z ZZZZZZZZZZZZZZZZZZZZZZZZZ
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageLongProgPositionalsWrap(HelpTestCase):
|
|
"""Test usage messages where the prog is long and the positionals wrap"""
|
|
|
|
parser_signature = Sig(prog='P' * 60, add_help=False)
|
|
argument_signatures = [
|
|
Sig('a' * 25),
|
|
Sig('b' * 25),
|
|
Sig('c' * 25),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPPP
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa
|
|
bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageOptionalsWrap(HelpTestCase):
|
|
"""Test usage messages where the optionals wrap"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-w', metavar='W' * 25),
|
|
Sig('-x', metavar='X' * 25),
|
|
Sig('-y', metavar='Y' * 25),
|
|
Sig('-z', metavar='Z' * 25),
|
|
Sig('a'),
|
|
Sig('b'),
|
|
Sig('c'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-w WWWWWWWWWWWWWWWWWWWWWWWWW] \
|
|
[-x XXXXXXXXXXXXXXXXXXXXXXXXX]
|
|
[-y YYYYYYYYYYYYYYYYYYYYYYYYY] \
|
|
[-z ZZZZZZZZZZZZZZZZZZZZZZZZZ]
|
|
a b c
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
a
|
|
b
|
|
c
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w WWWWWWWWWWWWWWWWWWWWWWWWW
|
|
-x XXXXXXXXXXXXXXXXXXXXXXXXX
|
|
-y YYYYYYYYYYYYYYYYYYYYYYYYY
|
|
-z ZZZZZZZZZZZZZZZZZZZZZZZZZ
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsagePositionalsWrap(HelpTestCase):
|
|
"""Test usage messages where the positionals wrap"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-x'),
|
|
Sig('-y'),
|
|
Sig('-z'),
|
|
Sig('a' * 25),
|
|
Sig('b' * 25),
|
|
Sig('c' * 25),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-x X] [-y Y] [-z Z]
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa
|
|
bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x X
|
|
-y Y
|
|
-z Z
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageOptionalsPositionalsWrap(HelpTestCase):
|
|
"""Test usage messages where the optionals and positionals wrap"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-x', metavar='X' * 25),
|
|
Sig('-y', metavar='Y' * 25),
|
|
Sig('-z', metavar='Z' * 25),
|
|
Sig('a' * 25),
|
|
Sig('b' * 25),
|
|
Sig('c' * 25),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-x XXXXXXXXXXXXXXXXXXXXXXXXX] \
|
|
[-y YYYYYYYYYYYYYYYYYYYYYYYYY]
|
|
[-z ZZZZZZZZZZZZZZZZZZZZZZZZZ]
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa
|
|
bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x XXXXXXXXXXXXXXXXXXXXXXXXX
|
|
-y YYYYYYYYYYYYYYYYYYYYYYYYY
|
|
-z ZZZZZZZZZZZZZZZZZZZZZZZZZ
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageOptionalsOnlyWrap(HelpTestCase):
|
|
"""Test usage messages where there are only optionals and they wrap"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-x', metavar='X' * 25),
|
|
Sig('-y', metavar='Y' * 25),
|
|
Sig('-z', metavar='Z' * 25),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-x XXXXXXXXXXXXXXXXXXXXXXXXX] \
|
|
[-y YYYYYYYYYYYYYYYYYYYYYYYYY]
|
|
[-z ZZZZZZZZZZZZZZZZZZZZZZZZZ]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x XXXXXXXXXXXXXXXXXXXXXXXXX
|
|
-y YYYYYYYYYYYYYYYYYYYYYYYYY
|
|
-z ZZZZZZZZZZZZZZZZZZZZZZZZZ
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsagePositionalsOnlyWrap(HelpTestCase):
|
|
"""Test usage messages where there are only positionals and they wrap"""
|
|
|
|
parser_signature = Sig(prog='PROG', add_help=False)
|
|
argument_signatures = [
|
|
Sig('a' * 25),
|
|
Sig('b' * 25),
|
|
Sig('c' * 25),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG aaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
aaaaaaaaaaaaaaaaaaaaaaaaa
|
|
bbbbbbbbbbbbbbbbbbbbbbbbb
|
|
ccccccccccccccccccccccccc
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageMetavarsSpacesParentheses(HelpTestCase):
|
|
# https://github.com/python/cpython/issues/62549
|
|
# https://github.com/python/cpython/issues/89743
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-n1', metavar='()', help='n1'),
|
|
Sig('-o1', metavar='(1, 2)', help='o1'),
|
|
Sig('-u1', metavar=' (uu) ', help='u1'),
|
|
Sig('-v1', metavar='( vv )', help='v1'),
|
|
Sig('-w1', metavar='(w)w', help='w1'),
|
|
Sig('-x1', metavar='x(x)', help='x1'),
|
|
Sig('-y1', metavar='yy)', help='y1'),
|
|
Sig('-z1', metavar='(zz', help='z1'),
|
|
Sig('-n2', metavar='[]', help='n2'),
|
|
Sig('-o2', metavar='[1, 2]', help='o2'),
|
|
Sig('-u2', metavar=' [uu] ', help='u2'),
|
|
Sig('-v2', metavar='[ vv ]', help='v2'),
|
|
Sig('-w2', metavar='[w]w', help='w2'),
|
|
Sig('-x2', metavar='x[x]', help='x2'),
|
|
Sig('-y2', metavar='yy]', help='y2'),
|
|
Sig('-z2', metavar='[zz', help='z2'),
|
|
]
|
|
|
|
usage = '''\
|
|
usage: PROG [-h] [-n1 ()] [-o1 (1, 2)] [-u1 (uu) ] [-v1 ( vv )] [-w1 (w)w]
|
|
[-x1 x(x)] [-y1 yy)] [-z1 (zz] [-n2 []] [-o2 [1, 2]] [-u2 [uu] ]
|
|
[-v2 [ vv ]] [-w2 [w]w] [-x2 x[x]] [-y2 yy]] [-z2 [zz]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-n1 () n1
|
|
-o1 (1, 2) o1
|
|
-u1 (uu) u1
|
|
-v1 ( vv ) v1
|
|
-w1 (w)w w1
|
|
-x1 x(x) x1
|
|
-y1 yy) y1
|
|
-z1 (zz z1
|
|
-n2 [] n2
|
|
-o2 [1, 2] o2
|
|
-u2 [uu] u2
|
|
-v2 [ vv ] v2
|
|
-w2 [w]w w2
|
|
-x2 x[x] x2
|
|
-y2 yy] y2
|
|
-z2 [zz z2
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageNoWhitespaceCrash(TestCase):
|
|
|
|
def test_all_suppressed_mutex_followed_by_long_arg(self):
|
|
# https://github.com/python/cpython/issues/62090
|
|
# https://github.com/python/cpython/issues/96310
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
mutex = parser.add_mutually_exclusive_group()
|
|
mutex.add_argument('--spam', help=argparse.SUPPRESS)
|
|
parser.add_argument('--eggs-eggs-eggs-eggs-eggs-eggs')
|
|
usage = textwrap.dedent('''\
|
|
usage: PROG [-h]
|
|
[--eggs-eggs-eggs-eggs-eggs-eggs EGGS_EGGS_EGGS_EGGS_EGGS_EGGS]
|
|
''')
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
def test_newline_in_metavar(self):
|
|
# https://github.com/python/cpython/issues/77048
|
|
mapping = ['123456', '12345', '12345', '123']
|
|
parser = argparse.ArgumentParser('11111111111111')
|
|
parser.add_argument('-v', '--verbose',
|
|
help='verbose mode', action='store_true')
|
|
parser.add_argument('targets',
|
|
help='installation targets',
|
|
nargs='+',
|
|
metavar='\n'.join(mapping))
|
|
usage = textwrap.dedent('''\
|
|
usage: 11111111111111 [-h] [-v]
|
|
123456
|
|
12345
|
|
12345
|
|
123 [123456
|
|
12345
|
|
12345
|
|
123 ...]
|
|
''')
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
def test_empty_metavar_required_arg(self):
|
|
# https://github.com/python/cpython/issues/82091
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
parser.add_argument('--nil', metavar='', required=True)
|
|
parser.add_argument('--a', metavar='A' * 70)
|
|
usage = (
|
|
'usage: PROG [-h] --nil \n'
|
|
' [--a AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
|
|
'AAAAAAAAAAAAAAAAAAAAAAA]\n'
|
|
)
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
def test_all_suppressed_mutex_with_optional_nargs(self):
|
|
# https://github.com/python/cpython/issues/98666
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
mutex = parser.add_mutually_exclusive_group()
|
|
mutex.add_argument(
|
|
'--param1',
|
|
nargs='?', const='default', metavar='NAME', help=argparse.SUPPRESS)
|
|
mutex.add_argument(
|
|
'--param2',
|
|
nargs='?', const='default', metavar='NAME', help=argparse.SUPPRESS)
|
|
usage = 'usage: PROG [-h]\n'
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
def test_nested_mutex_groups(self):
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
g = parser.add_mutually_exclusive_group()
|
|
g.add_argument("--spam")
|
|
with warnings.catch_warnings():
|
|
warnings.simplefilter('ignore', DeprecationWarning)
|
|
gg = g.add_mutually_exclusive_group()
|
|
gg.add_argument("--hax")
|
|
gg.add_argument("--hox", help=argparse.SUPPRESS)
|
|
gg.add_argument("--hex")
|
|
g.add_argument("--eggs")
|
|
parser.add_argument("--num")
|
|
|
|
usage = textwrap.dedent('''\
|
|
usage: PROG [-h] [--spam SPAM | [--hax HAX | --hex HEX] | --eggs EGGS]
|
|
[--num NUM]
|
|
''')
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
def test_long_mutex_groups_wrap(self):
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
g = parser.add_mutually_exclusive_group()
|
|
g.add_argument('--op1', metavar='MET', nargs='?')
|
|
g.add_argument('--op2', metavar=('MET1', 'MET2'), nargs='*')
|
|
g.add_argument('--op3', nargs='*')
|
|
g.add_argument('--op4', metavar=('MET1', 'MET2'), nargs='+')
|
|
g.add_argument('--op5', nargs='+')
|
|
g.add_argument('--op6', nargs=3)
|
|
g.add_argument('--op7', metavar=('MET1', 'MET2', 'MET3'), nargs=3)
|
|
|
|
usage = textwrap.dedent('''\
|
|
usage: PROG [-h] [--op1 [MET] | --op2 [MET1 [MET2 ...]] | --op3 [OP3 ...] |
|
|
--op4 MET1 [MET2 ...] | --op5 OP5 [OP5 ...] | --op6 OP6 OP6 OP6 |
|
|
--op7 MET1 MET2 MET3]
|
|
''')
|
|
self.assertEqual(parser.format_usage(), usage)
|
|
|
|
|
|
class TestHelpVariableExpansion(HelpTestCase):
|
|
"""Test that variables are expanded properly in help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-x', type=int,
|
|
help='x %(prog)s %(default)s %(type)s %%'),
|
|
Sig('-y', action='store_const', default=42, const='XXX',
|
|
help='y %(prog)s %(default)s %(const)s'),
|
|
Sig('--foo', choices=['a', 'b', 'c'],
|
|
help='foo %(prog)s %(default)s %(choices)s'),
|
|
Sig('--bar', default='baz', choices=[1, 2], metavar='BBB',
|
|
help='bar %(prog)s %(default)s %(dest)s'),
|
|
Sig('spam', help='spam %(prog)s %(default)s'),
|
|
Sig('badger', default=0.5, help='badger %(prog)s %(default)s'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('group'), [
|
|
Sig('-a', help='a %(prog)s %(default)s'),
|
|
Sig('-b', default=-1, help='b %(prog)s %(default)s'),
|
|
])
|
|
]
|
|
usage = ('''\
|
|
usage: PROG [-h] [-x X] [-y] [--foo {a,b,c}] [--bar BBB] [-a A] [-b B]
|
|
spam badger
|
|
''')
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam spam PROG None
|
|
badger badger PROG 0.5
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x X x PROG None int %
|
|
-y y PROG 42 XXX
|
|
--foo {a,b,c} foo PROG None a, b, c
|
|
--bar BBB bar PROG baz bar
|
|
|
|
group:
|
|
-a A a PROG None
|
|
-b B b PROG -1
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpVariableExpansionUsageSupplied(HelpTestCase):
|
|
"""Test that variables are expanded properly when usage= is present"""
|
|
|
|
parser_signature = Sig(prog='PROG', usage='%(prog)s FOO')
|
|
argument_signatures = []
|
|
argument_group_signatures = []
|
|
usage = ('''\
|
|
usage: PROG FOO
|
|
''')
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpVariableExpansionNoArguments(HelpTestCase):
|
|
"""Test that variables are expanded properly with no arguments"""
|
|
|
|
parser_signature = Sig(prog='PROG', add_help=False)
|
|
argument_signatures = []
|
|
argument_group_signatures = []
|
|
usage = ('''\
|
|
usage: PROG
|
|
''')
|
|
help = usage
|
|
version = ''
|
|
|
|
|
|
class TestHelpSuppressUsage(HelpTestCase):
|
|
"""Test that items can be suppressed in usage messages"""
|
|
|
|
parser_signature = Sig(prog='PROG', usage=argparse.SUPPRESS)
|
|
argument_signatures = [
|
|
Sig('--foo', help='foo help'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = []
|
|
help = '''\
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help
|
|
'''
|
|
usage = ''
|
|
version = ''
|
|
|
|
|
|
class TestHelpSuppressOptional(HelpTestCase):
|
|
"""Test that optional arguments can be suppressed in help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG', add_help=False)
|
|
argument_signatures = [
|
|
Sig('--foo', help=argparse.SUPPRESS),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpSuppressOptionalGroup(HelpTestCase):
|
|
"""Test that optional groups can be suppressed in help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('--foo', help='foo help'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('group'), [Sig('--bar', help=argparse.SUPPRESS)]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpSuppressPositional(HelpTestCase):
|
|
"""Test that positional arguments can be suppressed in help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('--foo', help='foo help'),
|
|
Sig('spam', help=argparse.SUPPRESS),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpRequiredOptional(HelpTestCase):
|
|
"""Test that required options don't look optional"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('--foo', required=True, help='foo help'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] --foo FOO
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpAlternatePrefixChars(HelpTestCase):
|
|
"""Test that options display with different prefix characters"""
|
|
|
|
parser_signature = Sig(prog='PROG', prefix_chars='^;', add_help=False)
|
|
argument_signatures = [
|
|
Sig('^^foo', action='store_true', help='foo help'),
|
|
Sig(';b', ';;bar', help='bar help'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [^^foo] [;b BAR]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
^^foo foo help
|
|
;b, ;;bar BAR bar help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpNoHelpOptional(HelpTestCase):
|
|
"""Test that the --help argument can be suppressed help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG', add_help=False)
|
|
argument_signatures = [
|
|
Sig('--foo', help='foo help'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [--foo FOO] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
--foo FOO foo help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpNone(HelpTestCase):
|
|
"""Test that no errors occur if no help is specified"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('--foo'),
|
|
Sig('spam'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpTupleMetavarOptional(HelpTestCase):
|
|
"""Test specifying metavar as a tuple"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-w', help='w', nargs='+', metavar=('W1', 'W2')),
|
|
Sig('-x', help='x', nargs='*', metavar=('X1', 'X2')),
|
|
Sig('-y', help='y', nargs=3, metavar=('Y1', 'Y2', 'Y3')),
|
|
Sig('-z', help='z', nargs='?', metavar=('Z1', )),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-w W1 [W2 ...]] [-x [X1 [X2 ...]]] [-y Y1 Y2 Y3] \
|
|
[-z [Z1]]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-w W1 [W2 ...] w
|
|
-x [X1 [X2 ...]] x
|
|
-y Y1 Y2 Y3 y
|
|
-z [Z1] z
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpTupleMetavarPositional(HelpTestCase):
|
|
"""Test specifying metavar on a Positional as a tuple"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('w', help='w help', nargs='+', metavar=('W1', 'W2')),
|
|
Sig('x', help='x help', nargs='*', metavar=('X1', 'X2')),
|
|
Sig('y', help='y help', nargs=3, metavar=('Y1', 'Y2', 'Y3')),
|
|
Sig('z', help='z help', nargs='?', metavar=('Z1',)),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] W1 [W2 ...] [X1 [X2 ...]] Y1 Y2 Y3 [Z1]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
W1 W2 w help
|
|
X1 X2 x help
|
|
Y1 Y2 Y3 y help
|
|
Z1 z help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpRawText(HelpTestCase):
|
|
"""Test the RawTextHelpFormatter"""
|
|
|
|
parser_signature = Sig(
|
|
prog='PROG', formatter_class=argparse.RawTextHelpFormatter,
|
|
description='Keep the formatting\n'
|
|
' exactly as it is written\n'
|
|
'\n'
|
|
'here\n')
|
|
|
|
argument_signatures = [
|
|
Sig('--foo', help=' foo help should also\n'
|
|
'appear as given here'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('title', description=' This text\n'
|
|
' should be indented\n'
|
|
' exactly like it is here\n'),
|
|
[Sig('--bar', help='bar help')]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] [--bar BAR] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
Keep the formatting
|
|
exactly as it is written
|
|
|
|
here
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help should also
|
|
appear as given here
|
|
|
|
title:
|
|
This text
|
|
should be indented
|
|
exactly like it is here
|
|
|
|
--bar BAR bar help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpRawDescription(HelpTestCase):
|
|
"""Test the RawTextHelpFormatter"""
|
|
|
|
parser_signature = Sig(
|
|
prog='PROG', formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
description='Keep the formatting\n'
|
|
' exactly as it is written\n'
|
|
'\n'
|
|
'here\n')
|
|
|
|
argument_signatures = [
|
|
Sig('--foo', help=' foo help should not\n'
|
|
' retain this odd formatting'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('title', description=' This text\n'
|
|
' should be indented\n'
|
|
' exactly like it is here\n'),
|
|
[Sig('--bar', help='bar help')]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] [--bar BAR] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
Keep the formatting
|
|
exactly as it is written
|
|
|
|
here
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help should not retain this odd formatting
|
|
|
|
title:
|
|
This text
|
|
should be indented
|
|
exactly like it is here
|
|
|
|
--bar BAR bar help
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpArgumentDefaults(HelpTestCase):
|
|
"""Test the ArgumentDefaultsHelpFormatter"""
|
|
|
|
parser_signature = Sig(
|
|
prog='PROG', formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
|
description='description')
|
|
|
|
argument_signatures = [
|
|
Sig('--foo', help='foo help - oh and by the way, %(default)s'),
|
|
Sig('--bar', action='store_true', help='bar help'),
|
|
Sig('--taz', action=argparse.BooleanOptionalAction,
|
|
help='Whether to taz it', default=True),
|
|
Sig('--corge', action=argparse.BooleanOptionalAction,
|
|
help='Whether to corge it', default=argparse.SUPPRESS),
|
|
Sig('--quux', help="Set the quux", default=42),
|
|
Sig('spam', help='spam help'),
|
|
Sig('badger', nargs='?', default='wooden', help='badger help'),
|
|
]
|
|
argument_group_signatures = [
|
|
(Sig('title', description='description'),
|
|
[Sig('--baz', type=int, default=42, help='baz help')]),
|
|
]
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] [--bar] [--taz | --no-taz] [--corge | --no-corge]
|
|
[--quux QUUX] [--baz BAZ]
|
|
spam [badger]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
description
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
badger badger help (default: wooden)
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help - oh and by the way, None
|
|
--bar bar help (default: False)
|
|
--taz, --no-taz Whether to taz it (default: True)
|
|
--corge, --no-corge Whether to corge it
|
|
--quux QUUX Set the quux (default: 42)
|
|
|
|
title:
|
|
description
|
|
|
|
--baz BAZ baz help (default: 42)
|
|
'''
|
|
version = ''
|
|
|
|
class TestHelpVersionAction(HelpTestCase):
|
|
"""Test the default help for the version action"""
|
|
|
|
parser_signature = Sig(prog='PROG', description='description')
|
|
argument_signatures = [Sig('-V', '--version', action='version', version='3.6')]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-V]
|
|
'''
|
|
help = usage + '''\
|
|
|
|
description
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-V, --version show program's version number and exit
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpVersionActionSuppress(HelpTestCase):
|
|
"""Test that the --version argument can be suppressed in help messages"""
|
|
|
|
parser_signature = Sig(prog='PROG')
|
|
argument_signatures = [
|
|
Sig('-v', '--version', action='version', version='1.0',
|
|
help=argparse.SUPPRESS),
|
|
Sig('--foo', help='foo help'),
|
|
Sig('spam', help='spam help'),
|
|
]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [--foo FOO] spam
|
|
'''
|
|
help = usage + '''\
|
|
|
|
positional arguments:
|
|
spam spam help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--foo FOO foo help
|
|
'''
|
|
|
|
|
|
class TestHelpSubparsersOrdering(HelpTestCase):
|
|
"""Test ordering of subcommands in help matches the code"""
|
|
parser_signature = Sig(prog='PROG',
|
|
description='display some subcommands')
|
|
argument_signatures = [Sig('-v', '--version', action='version', version='0.1')]
|
|
|
|
subparsers_signatures = [Sig(name=name)
|
|
for name in ('a', 'b', 'c', 'd', 'e')]
|
|
|
|
usage = '''\
|
|
usage: PROG [-h] [-v] {a,b,c,d,e} ...
|
|
'''
|
|
|
|
help = usage + '''\
|
|
|
|
display some subcommands
|
|
|
|
positional arguments:
|
|
{a,b,c,d,e}
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-v, --version show program's version number and exit
|
|
'''
|
|
|
|
version = '''\
|
|
0.1
|
|
'''
|
|
|
|
class TestHelpSubparsersWithHelpOrdering(HelpTestCase):
|
|
"""Test ordering of subcommands in help matches the code"""
|
|
parser_signature = Sig(prog='PROG',
|
|
description='display some subcommands')
|
|
argument_signatures = [Sig('-v', '--version', action='version', version='0.1')]
|
|
|
|
subcommand_data = (('a', 'a subcommand help'),
|
|
('b', 'b subcommand help'),
|
|
('c', 'c subcommand help'),
|
|
('d', 'd subcommand help'),
|
|
('e', 'e subcommand help'),
|
|
)
|
|
|
|
subparsers_signatures = [Sig(name=name, help=help)
|
|
for name, help in subcommand_data]
|
|
|
|
usage = '''\
|
|
usage: PROG [-h] [-v] {a,b,c,d,e} ...
|
|
'''
|
|
|
|
help = usage + '''\
|
|
|
|
display some subcommands
|
|
|
|
positional arguments:
|
|
{a,b,c,d,e}
|
|
a a subcommand help
|
|
b b subcommand help
|
|
c c subcommand help
|
|
d d subcommand help
|
|
e e subcommand help
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-v, --version show program's version number and exit
|
|
'''
|
|
|
|
version = '''\
|
|
0.1
|
|
'''
|
|
|
|
|
|
|
|
class TestHelpMetavarTypeFormatter(HelpTestCase):
|
|
|
|
def custom_type(string):
|
|
return string
|
|
|
|
parser_signature = Sig(prog='PROG', description='description',
|
|
formatter_class=argparse.MetavarTypeHelpFormatter)
|
|
argument_signatures = [Sig('a', type=int),
|
|
Sig('-b', type=custom_type),
|
|
Sig('-c', type=float, metavar='SOME FLOAT')]
|
|
argument_group_signatures = []
|
|
usage = '''\
|
|
usage: PROG [-h] [-b custom_type] [-c SOME FLOAT] int
|
|
'''
|
|
help = usage + '''\
|
|
|
|
description
|
|
|
|
positional arguments:
|
|
int
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-b custom_type
|
|
-c SOME FLOAT
|
|
'''
|
|
version = ''
|
|
|
|
|
|
class TestHelpUsageLongSubparserCommand(TestCase):
|
|
"""Test that subparser commands are formatted correctly in help"""
|
|
maxDiff = None
|
|
|
|
def test_parent_help(self):
|
|
def custom_formatter(prog):
|
|
return argparse.RawTextHelpFormatter(prog, max_help_position=50)
|
|
|
|
parent_parser = argparse.ArgumentParser(
|
|
prog='PROG',
|
|
formatter_class=custom_formatter
|
|
)
|
|
|
|
cmd_subparsers = parent_parser.add_subparsers(title="commands",
|
|
metavar='CMD',
|
|
help='command to use')
|
|
cmd_subparsers.add_parser("add",
|
|
help="add something")
|
|
|
|
cmd_subparsers.add_parser("remove",
|
|
help="remove something")
|
|
|
|
cmd_subparsers.add_parser("a-very-long-command",
|
|
help="command that does something")
|
|
|
|
parser_help = parent_parser.format_help()
|
|
self.assertEqual(parser_help, textwrap.dedent('''\
|
|
usage: PROG [-h] CMD ...
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
|
|
commands:
|
|
CMD command to use
|
|
add add something
|
|
remove remove something
|
|
a-very-long-command command that does something
|
|
'''))
|
|
|
|
|
|
# =====================================
|
|
# Optional/Positional constructor tests
|
|
# =====================================
|
|
|
|
class TestInvalidArgumentConstructors(TestCase):
|
|
"""Test a bunch of invalid Argument constructors"""
|
|
|
|
def assertTypeError(self, *args, errmsg=None, **kwargs):
|
|
parser = argparse.ArgumentParser()
|
|
self.assertRaisesRegex(TypeError, errmsg, parser.add_argument,
|
|
*args, **kwargs)
|
|
|
|
def assertValueError(self, *args, errmsg=None, **kwargs):
|
|
parser = argparse.ArgumentParser()
|
|
self.assertRaisesRegex(ValueError, errmsg, parser.add_argument,
|
|
*args, **kwargs)
|
|
|
|
def test_invalid_keyword_arguments(self):
|
|
self.assertTypeError('-x', bar=None)
|
|
self.assertTypeError('-y', callback='foo')
|
|
self.assertTypeError('-y', callback_args=())
|
|
self.assertTypeError('-y', callback_kwargs={})
|
|
|
|
def test_missing_destination(self):
|
|
self.assertTypeError()
|
|
for action in ['store', 'append', 'extend']:
|
|
with self.subTest(action=action):
|
|
self.assertTypeError(action=action)
|
|
|
|
def test_invalid_option_strings(self):
|
|
self.assertTypeError('-', errmsg='dest= is required')
|
|
self.assertTypeError('--', errmsg='dest= is required')
|
|
self.assertTypeError('---', errmsg='dest= is required')
|
|
|
|
def test_invalid_prefix(self):
|
|
self.assertValueError('--foo', '+foo',
|
|
errmsg='must start with a character')
|
|
|
|
def test_invalid_type(self):
|
|
self.assertTypeError('--foo', type='int',
|
|
errmsg="'int' is not callable")
|
|
self.assertTypeError('--foo', type=(int, float),
|
|
errmsg='is not callable')
|
|
|
|
def test_invalid_action(self):
|
|
self.assertValueError('-x', action='foo',
|
|
errmsg='unknown action')
|
|
self.assertValueError('foo', action='baz',
|
|
errmsg='unknown action')
|
|
self.assertValueError('--foo', action=('store', 'append'),
|
|
errmsg='unknown action')
|
|
self.assertValueError('--foo', action="store-true",
|
|
errmsg='unknown action')
|
|
|
|
def test_invalid_help(self):
|
|
self.assertValueError('--foo', help='%Y-%m-%d',
|
|
errmsg='badly formed help string')
|
|
self.assertValueError('--foo', help='%(spam)s',
|
|
errmsg='badly formed help string')
|
|
self.assertValueError('--foo', help='%(prog)d',
|
|
errmsg='badly formed help string')
|
|
|
|
def test_multiple_dest(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument(dest='foo')
|
|
with self.assertRaises(TypeError) as cm:
|
|
parser.add_argument('bar', dest='baz')
|
|
self.assertIn('dest supplied twice for positional argument,'
|
|
' did you mean metavar?',
|
|
str(cm.exception))
|
|
|
|
def test_no_argument_actions(self):
|
|
for action in ['store_const', 'store_true', 'store_false',
|
|
'append_const', 'count']:
|
|
with self.subTest(action=action):
|
|
for attrs in [dict(type=int), dict(nargs='+'),
|
|
dict(choices=['a', 'b'])]:
|
|
with self.subTest(attrs=attrs):
|
|
self.assertTypeError('-x', action=action, **attrs)
|
|
self.assertTypeError('x', action=action, **attrs)
|
|
self.assertValueError('x', action=action,
|
|
errmsg=f"action '{action}' is not valid for positional arguments")
|
|
self.assertTypeError('-x', action=action, nargs=0)
|
|
self.assertValueError('x', action=action, nargs=0,
|
|
errmsg='nargs for positionals must be != 0')
|
|
|
|
def test_no_argument_no_const_actions(self):
|
|
# options with zero arguments
|
|
for action in ['store_true', 'store_false', 'count']:
|
|
with self.subTest(action=action):
|
|
# const is always disallowed
|
|
self.assertTypeError('-x', const='foo', action=action)
|
|
|
|
# nargs is always disallowed
|
|
self.assertTypeError('-x', nargs='*', action=action)
|
|
|
|
def test_more_than_one_argument_actions(self):
|
|
for action in ['store', 'append', 'extend']:
|
|
with self.subTest(action=action):
|
|
# nargs=0 is disallowed
|
|
action_name = 'append' if action == 'extend' else action
|
|
self.assertValueError('-x', nargs=0, action=action,
|
|
errmsg=f'nargs for {action_name} actions must be != 0')
|
|
self.assertValueError('spam', nargs=0, action=action,
|
|
errmsg='nargs for positionals must be != 0')
|
|
|
|
# const is disallowed with non-optional arguments
|
|
for nargs in [1, '*', '+']:
|
|
self.assertValueError('-x', const='foo',
|
|
nargs=nargs, action=action)
|
|
self.assertValueError('spam', const='foo',
|
|
nargs=nargs, action=action)
|
|
|
|
def test_required_const_actions(self):
|
|
for action in ['store_const', 'append_const']:
|
|
with self.subTest(action=action):
|
|
# nargs is always disallowed
|
|
self.assertTypeError('-x', nargs='+', action=action)
|
|
|
|
def test_parsers_action_missing_params(self):
|
|
self.assertTypeError('command', action='parsers')
|
|
self.assertTypeError('command', action='parsers', prog='PROG')
|
|
self.assertTypeError('command', action='parsers',
|
|
parser_class=argparse.ArgumentParser)
|
|
|
|
def test_version_missing_params(self):
|
|
self.assertTypeError('command', action='version')
|
|
|
|
def test_required_positional(self):
|
|
self.assertTypeError('foo', required=True)
|
|
|
|
def test_user_defined_action(self):
|
|
|
|
class Success(Exception):
|
|
pass
|
|
|
|
class Action(object):
|
|
|
|
def __init__(self,
|
|
option_strings,
|
|
dest,
|
|
const,
|
|
default,
|
|
required=False):
|
|
if dest == 'spam':
|
|
if const is Success:
|
|
if default is Success:
|
|
raise Success()
|
|
|
|
def __call__(self, *args, **kwargs):
|
|
pass
|
|
|
|
parser = argparse.ArgumentParser()
|
|
self.assertRaises(Success, parser.add_argument, '--spam',
|
|
action=Action, default=Success, const=Success)
|
|
self.assertRaises(Success, parser.add_argument, 'spam',
|
|
action=Action, default=Success, const=Success)
|
|
|
|
# ================================
|
|
# Actions returned by add_argument
|
|
# ================================
|
|
|
|
class TestActionsReturned(TestCase):
|
|
|
|
def test_dest(self):
|
|
parser = argparse.ArgumentParser()
|
|
action = parser.add_argument('--foo')
|
|
self.assertEqual(action.dest, 'foo')
|
|
action = parser.add_argument('-b', '--bar')
|
|
self.assertEqual(action.dest, 'bar')
|
|
action = parser.add_argument('-x', '-y')
|
|
self.assertEqual(action.dest, 'x')
|
|
|
|
def test_misc(self):
|
|
parser = argparse.ArgumentParser()
|
|
action = parser.add_argument('--foo', nargs='?', const=42,
|
|
default=84, type=int, choices=[1, 2],
|
|
help='FOO', metavar='BAR', dest='baz')
|
|
self.assertEqual(action.nargs, '?')
|
|
self.assertEqual(action.const, 42)
|
|
self.assertEqual(action.default, 84)
|
|
self.assertEqual(action.type, int)
|
|
self.assertEqual(action.choices, [1, 2])
|
|
self.assertEqual(action.help, 'FOO')
|
|
self.assertEqual(action.metavar, 'BAR')
|
|
self.assertEqual(action.dest, 'baz')
|
|
|
|
|
|
# ================================
|
|
# Argument conflict handling tests
|
|
# ================================
|
|
|
|
class TestConflictHandling(TestCase):
|
|
|
|
def test_bad_type(self):
|
|
self.assertRaises(ValueError, argparse.ArgumentParser,
|
|
conflict_handler='foo')
|
|
|
|
def test_conflict_error(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('-x')
|
|
self.assertRaises(argparse.ArgumentError,
|
|
parser.add_argument, '-x')
|
|
parser.add_argument('--spam')
|
|
self.assertRaises(argparse.ArgumentError,
|
|
parser.add_argument, '--spam')
|
|
|
|
def test_resolve_error(self):
|
|
get_parser = argparse.ArgumentParser
|
|
parser = get_parser(prog='PROG', conflict_handler='resolve')
|
|
|
|
parser.add_argument('-x', help='OLD X')
|
|
parser.add_argument('-x', help='NEW X')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [-x X]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x X NEW X
|
|
'''))
|
|
|
|
parser.add_argument('--spam', metavar='OLD_SPAM')
|
|
parser.add_argument('--spam', metavar='NEW_SPAM')
|
|
self.assertEqual(parser.format_help(), textwrap.dedent('''\
|
|
usage: PROG [-h] [-x X] [--spam NEW_SPAM]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
-x X NEW X
|
|
--spam NEW_SPAM
|
|
'''))
|
|
|
|
def test_subparser_conflict(self):
|
|
parser = argparse.ArgumentParser()
|
|
sp = parser.add_subparsers()
|
|
sp.add_parser('fullname', aliases=['alias'])
|
|
self.assertRaisesRegex(ValueError,
|
|
'conflicting subparser: fullname',
|
|
sp.add_parser, 'fullname')
|
|
self.assertRaisesRegex(ValueError,
|
|
'conflicting subparser: alias',
|
|
sp.add_parser, 'alias')
|
|
self.assertRaisesRegex(ValueError,
|
|
'conflicting subparser alias: fullname',
|
|
sp.add_parser, 'other', aliases=['fullname'])
|
|
self.assertRaisesRegex(ValueError,
|
|
'conflicting subparser alias: alias',
|
|
sp.add_parser, 'other', aliases=['alias'])
|
|
|
|
|
|
# =============================
|
|
# Help and Version option tests
|
|
# =============================
|
|
|
|
class TestOptionalsHelpVersionActions(TestCase):
|
|
"""Test the help and version actions"""
|
|
|
|
def assertPrintHelpExit(self, parser, args_str):
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(args_str.split())
|
|
self.assertEqual(parser.format_help(), cm.exception.stdout)
|
|
|
|
def assertArgumentParserError(self, parser, *args):
|
|
self.assertRaises(ArgumentParserError, parser.parse_args, args)
|
|
|
|
def test_version(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('-v', '--version', action='version', version='1.0')
|
|
self.assertPrintHelpExit(parser, '-h')
|
|
self.assertPrintHelpExit(parser, '--help')
|
|
self.assertRaises(AttributeError, getattr, parser, 'format_version')
|
|
|
|
def test_version_format(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PPP')
|
|
parser.add_argument('-v', '--version', action='version', version='%(prog)s 3.5')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['-v'])
|
|
self.assertEqual('PPP 3.5\n', cm.exception.stdout)
|
|
|
|
def test_version_no_help(self):
|
|
parser = ErrorRaisingArgumentParser(add_help=False)
|
|
parser.add_argument('-v', '--version', action='version', version='1.0')
|
|
self.assertArgumentParserError(parser, '-h')
|
|
self.assertArgumentParserError(parser, '--help')
|
|
self.assertRaises(AttributeError, getattr, parser, 'format_version')
|
|
|
|
def test_version_action(self):
|
|
parser = ErrorRaisingArgumentParser(prog='XXX')
|
|
parser.add_argument('-V', action='version', version='%(prog)s 3.7')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['-V'])
|
|
self.assertEqual('XXX 3.7\n', cm.exception.stdout)
|
|
|
|
def test_no_help(self):
|
|
parser = ErrorRaisingArgumentParser(add_help=False)
|
|
self.assertArgumentParserError(parser, '-h')
|
|
self.assertArgumentParserError(parser, '--help')
|
|
self.assertArgumentParserError(parser, '-v')
|
|
self.assertArgumentParserError(parser, '--version')
|
|
|
|
def test_alternate_help_version(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('-x', action='help')
|
|
parser.add_argument('-y', action='version')
|
|
self.assertPrintHelpExit(parser, '-x')
|
|
self.assertArgumentParserError(parser, '-v')
|
|
self.assertArgumentParserError(parser, '--version')
|
|
self.assertRaises(AttributeError, getattr, parser, 'format_version')
|
|
|
|
def test_help_version_extra_arguments(self):
|
|
parser = ErrorRaisingArgumentParser()
|
|
parser.add_argument('--version', action='version', version='1.0')
|
|
parser.add_argument('-x', action='store_true')
|
|
parser.add_argument('y')
|
|
|
|
# try all combinations of valid prefixes and suffixes
|
|
valid_prefixes = ['', '-x', 'foo', '-x bar', 'baz -x']
|
|
valid_suffixes = valid_prefixes + ['--bad-option', 'foo bar baz']
|
|
for prefix in valid_prefixes:
|
|
for suffix in valid_suffixes:
|
|
format = '%s %%s %s' % (prefix, suffix)
|
|
self.assertPrintHelpExit(parser, format % '-h')
|
|
self.assertPrintHelpExit(parser, format % '--help')
|
|
self.assertRaises(AttributeError, getattr, parser, 'format_version')
|
|
|
|
|
|
# ======================
|
|
# str() and repr() tests
|
|
# ======================
|
|
|
|
class TestStrings(TestCase):
|
|
"""Test str() and repr() on Optionals and Positionals"""
|
|
|
|
def assertStringEqual(self, obj, result_string):
|
|
for func in [str, repr]:
|
|
self.assertEqual(func(obj), result_string)
|
|
|
|
def test_optional(self):
|
|
option = argparse.Action(
|
|
option_strings=['--foo', '-a', '-b'],
|
|
dest='b',
|
|
type='int',
|
|
nargs='+',
|
|
default=42,
|
|
choices=[1, 2, 3],
|
|
required=False,
|
|
help='HELP',
|
|
metavar='METAVAR')
|
|
string = (
|
|
"Action(option_strings=['--foo', '-a', '-b'], dest='b', "
|
|
"nargs='+', const=None, default=42, type='int', "
|
|
"choices=[1, 2, 3], required=False, help='HELP', "
|
|
"metavar='METAVAR', deprecated=False)")
|
|
self.assertStringEqual(option, string)
|
|
|
|
def test_argument(self):
|
|
argument = argparse.Action(
|
|
option_strings=[],
|
|
dest='x',
|
|
type=float,
|
|
nargs='?',
|
|
default=2.5,
|
|
choices=[0.5, 1.5, 2.5],
|
|
required=True,
|
|
help='H HH H',
|
|
metavar='MV MV MV')
|
|
string = (
|
|
"Action(option_strings=[], dest='x', nargs='?', "
|
|
"const=None, default=2.5, type=%r, choices=[0.5, 1.5, 2.5], "
|
|
"required=True, help='H HH H', metavar='MV MV MV', "
|
|
"deprecated=False)" % float)
|
|
self.assertStringEqual(argument, string)
|
|
|
|
def test_namespace(self):
|
|
ns = argparse.Namespace(foo=42, bar='spam')
|
|
string = "Namespace(foo=42, bar='spam')"
|
|
self.assertStringEqual(ns, string)
|
|
|
|
def test_namespace_starkwargs_notidentifier(self):
|
|
ns = argparse.Namespace(**{'"': 'quote'})
|
|
string = """Namespace(**{'"': 'quote'})"""
|
|
self.assertStringEqual(ns, string)
|
|
|
|
def test_namespace_kwargs_and_starkwargs_notidentifier(self):
|
|
ns = argparse.Namespace(a=1, **{'"': 'quote'})
|
|
string = """Namespace(a=1, **{'"': 'quote'})"""
|
|
self.assertStringEqual(ns, string)
|
|
|
|
def test_namespace_starkwargs_identifier(self):
|
|
ns = argparse.Namespace(**{'valid': True})
|
|
string = "Namespace(valid=True)"
|
|
self.assertStringEqual(ns, string)
|
|
|
|
def test_parser(self):
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
string = (
|
|
"ArgumentParser(prog='PROG', usage=None, description=None, "
|
|
"formatter_class=%r, conflict_handler='error', "
|
|
"add_help=True)" % argparse.HelpFormatter)
|
|
self.assertStringEqual(parser, string)
|
|
|
|
# ===============
|
|
# Namespace tests
|
|
# ===============
|
|
|
|
class TestNamespace(TestCase):
|
|
|
|
def test_constructor(self):
|
|
ns = argparse.Namespace()
|
|
self.assertRaises(AttributeError, getattr, ns, 'x')
|
|
|
|
ns = argparse.Namespace(a=42, b='spam')
|
|
self.assertEqual(ns.a, 42)
|
|
self.assertEqual(ns.b, 'spam')
|
|
|
|
def test_equality(self):
|
|
ns1 = argparse.Namespace(a=1, b=2)
|
|
ns2 = argparse.Namespace(b=2, a=1)
|
|
ns3 = argparse.Namespace(a=1)
|
|
ns4 = argparse.Namespace(b=2)
|
|
|
|
self.assertEqual(ns1, ns2)
|
|
self.assertNotEqual(ns1, ns3)
|
|
self.assertNotEqual(ns1, ns4)
|
|
self.assertNotEqual(ns2, ns3)
|
|
self.assertNotEqual(ns2, ns4)
|
|
self.assertTrue(ns1 != ns3)
|
|
self.assertTrue(ns1 != ns4)
|
|
self.assertTrue(ns2 != ns3)
|
|
self.assertTrue(ns2 != ns4)
|
|
|
|
def test_equality_returns_notimplemented(self):
|
|
# See issue 21481
|
|
ns = argparse.Namespace(a=1, b=2)
|
|
self.assertIs(ns.__eq__(None), NotImplemented)
|
|
self.assertIs(ns.__ne__(None), NotImplemented)
|
|
|
|
|
|
# ===================
|
|
# File encoding tests
|
|
# ===================
|
|
|
|
class TestEncoding(TestCase):
|
|
|
|
def _test_module_encoding(self, path):
|
|
path, _ = os.path.splitext(path)
|
|
path += ".py"
|
|
with open(path, 'r', encoding='utf-8') as f:
|
|
f.read()
|
|
|
|
def test_argparse_module_encoding(self):
|
|
self._test_module_encoding(argparse.__file__)
|
|
|
|
def test_test_argparse_module_encoding(self):
|
|
self._test_module_encoding(__file__)
|
|
|
|
# ===================
|
|
# ArgumentError tests
|
|
# ===================
|
|
|
|
class TestArgumentError(TestCase):
|
|
|
|
def test_argument_error(self):
|
|
msg = "my error here"
|
|
error = argparse.ArgumentError(None, msg)
|
|
self.assertEqual(str(error), msg)
|
|
|
|
# =======================
|
|
# ArgumentTypeError tests
|
|
# =======================
|
|
|
|
class TestArgumentTypeError(TestCase):
|
|
|
|
def test_argument_type_error(self):
|
|
|
|
def spam(string):
|
|
raise argparse.ArgumentTypeError('spam!')
|
|
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', add_help=False)
|
|
parser.add_argument('x', type=spam)
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['XXX'])
|
|
self.assertEqual('usage: PROG x\nPROG: error: argument x: spam!\n',
|
|
cm.exception.stderr)
|
|
|
|
# =========================
|
|
# MessageContentError tests
|
|
# =========================
|
|
|
|
class TestMessageContentError(TestCase):
|
|
|
|
def test_missing_argument_name_in_message(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', usage='')
|
|
parser.add_argument('req_pos', type=str)
|
|
parser.add_argument('-req_opt', type=int, required=True)
|
|
parser.add_argument('need_one', type=str, nargs='+')
|
|
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args([])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertRegex(msg, 'req_opt')
|
|
self.assertRegex(msg, 'need_one')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['myXargument'])
|
|
msg = str(cm.exception)
|
|
self.assertNotIn(msg, 'req_pos')
|
|
self.assertRegex(msg, 'req_opt')
|
|
self.assertRegex(msg, 'need_one')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['myXargument', '-req_opt=1'])
|
|
msg = str(cm.exception)
|
|
self.assertNotIn(msg, 'req_pos')
|
|
self.assertNotIn(msg, 'req_opt')
|
|
self.assertRegex(msg, 'need_one')
|
|
|
|
def test_optional_optional_not_in_message(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', usage='')
|
|
parser.add_argument('req_pos', type=str)
|
|
parser.add_argument('--req_opt', type=int, required=True)
|
|
parser.add_argument('--opt_opt', type=bool, nargs='?',
|
|
default=True)
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args([])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertRegex(msg, 'req_opt')
|
|
self.assertNotIn(msg, 'opt_opt')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args(['--req_opt=1'])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertNotIn(msg, 'req_opt')
|
|
self.assertNotIn(msg, 'opt_opt')
|
|
|
|
def test_optional_positional_not_in_message(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', usage='')
|
|
parser.add_argument('req_pos')
|
|
parser.add_argument('optional_positional', nargs='?', default='eggs')
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args([])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertNotIn(msg, 'optional_positional')
|
|
|
|
|
|
# ================================================
|
|
# Check that the type function is called only once
|
|
# ================================================
|
|
|
|
class TestTypeFunctionCallOnlyOnce(TestCase):
|
|
|
|
def test_type_function_call_only_once(self):
|
|
def spam(string_to_convert):
|
|
self.assertEqual(string_to_convert, 'spam!')
|
|
return 'foo_converted'
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--foo', type=spam, default='bar')
|
|
args = parser.parse_args('--foo spam!'.split())
|
|
self.assertEqual(NS(foo='foo_converted'), args)
|
|
|
|
|
|
# ==============================================
|
|
# Check that deprecated arguments output warning
|
|
# ==============================================
|
|
|
|
class TestDeprecatedArguments(TestCase):
|
|
|
|
def test_deprecated_option(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('-f', '--foo', deprecated=True)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--foo', 'spam'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['-f', 'spam'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '-f' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--foo', 'spam', '-f', 'ham'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--foo' is deprecated")
|
|
self.assertRegex(stderr, "warning: option '-f' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 2)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--foo', 'spam', '--foo', 'ham'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
def test_deprecated_boolean_option(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('-f', '--foo', action=argparse.BooleanOptionalAction, deprecated=True)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--foo'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['-f'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '-f' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--no-foo'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--no-foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['--foo', '--no-foo'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: option '--foo' is deprecated")
|
|
self.assertRegex(stderr, "warning: option '--no-foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 2)
|
|
|
|
def test_deprecated_arguments(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('foo', nargs='?', deprecated=True)
|
|
parser.add_argument('bar', nargs='?', deprecated=True)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args([])
|
|
stderr = stderr.getvalue()
|
|
self.assertEqual(stderr.count('is deprecated'), 0)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['spam'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: argument 'foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['spam', 'ham'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: argument 'foo' is deprecated")
|
|
self.assertRegex(stderr, "warning: argument 'bar' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 2)
|
|
|
|
def test_deprecated_varargument(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('foo', nargs='*', deprecated=True)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args([])
|
|
stderr = stderr.getvalue()
|
|
self.assertEqual(stderr.count('is deprecated'), 0)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['spam'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: argument 'foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['spam', 'ham'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: argument 'foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
def test_deprecated_subparser(self):
|
|
parser = argparse.ArgumentParser()
|
|
subparsers = parser.add_subparsers()
|
|
subparsers.add_parser('foo', aliases=['baz'], deprecated=True)
|
|
subparsers.add_parser('bar')
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['bar'])
|
|
stderr = stderr.getvalue()
|
|
self.assertEqual(stderr.count('is deprecated'), 0)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['foo'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: command 'foo' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
with captured_stderr() as stderr:
|
|
parser.parse_args(['baz'])
|
|
stderr = stderr.getvalue()
|
|
self.assertRegex(stderr, "warning: command 'baz' is deprecated")
|
|
self.assertEqual(stderr.count('is deprecated'), 1)
|
|
|
|
|
|
# ==================================================================
|
|
# Check semantics regarding the default argument and type conversion
|
|
# ==================================================================
|
|
|
|
class TestTypeFunctionCalledOnDefault(TestCase):
|
|
|
|
def test_type_function_call_with_non_string_default(self):
|
|
def spam(int_to_convert):
|
|
self.assertEqual(int_to_convert, 0)
|
|
return 'foo_converted'
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--foo', type=spam, default=0)
|
|
args = parser.parse_args([])
|
|
# foo should *not* be converted because its default is not a string.
|
|
self.assertEqual(NS(foo=0), args)
|
|
|
|
def test_type_function_call_with_string_default(self):
|
|
def spam(int_to_convert):
|
|
return 'foo_converted'
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--foo', type=spam, default='0')
|
|
args = parser.parse_args([])
|
|
# foo is converted because its default is a string.
|
|
self.assertEqual(NS(foo='foo_converted'), args)
|
|
|
|
def test_no_double_type_conversion_of_default(self):
|
|
def extend(str_to_convert):
|
|
return str_to_convert + '*'
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--test', type=extend, default='*')
|
|
args = parser.parse_args([])
|
|
# The test argument will be two stars, one coming from the default
|
|
# value and one coming from the type conversion being called exactly
|
|
# once.
|
|
self.assertEqual(NS(test='**'), args)
|
|
|
|
def test_issue_15906(self):
|
|
# Issue #15906: When action='append', type=str, default=[] are
|
|
# providing, the dest value was the string representation "[]" when it
|
|
# should have been an empty list.
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--test', dest='test', type=str,
|
|
default=[], action='append')
|
|
args = parser.parse_args([])
|
|
self.assertEqual(args.test, [])
|
|
|
|
# ======================
|
|
# parse_known_args tests
|
|
# ======================
|
|
|
|
class TestParseKnownArgs(TestCase):
|
|
|
|
def test_arguments_tuple(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.parse_args(())
|
|
|
|
def test_arguments_list(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.parse_args([])
|
|
|
|
def test_arguments_tuple_positional(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('x')
|
|
parser.parse_args(('x',))
|
|
|
|
def test_arguments_list_positional(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('x')
|
|
parser.parse_args(['x'])
|
|
|
|
def test_optionals(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--foo')
|
|
args, extras = parser.parse_known_args('--foo F --bar --baz'.split())
|
|
self.assertEqual(NS(foo='F'), args)
|
|
self.assertEqual(['--bar', '--baz'], extras)
|
|
|
|
def test_mixed(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('-v', nargs='?', const=1, type=int)
|
|
parser.add_argument('--spam', action='store_false')
|
|
parser.add_argument('badger')
|
|
|
|
argv = ["B", "C", "--foo", "-v", "3", "4"]
|
|
args, extras = parser.parse_known_args(argv)
|
|
self.assertEqual(NS(v=3, spam=True, badger="B"), args)
|
|
self.assertEqual(["C", "--foo", "4"], extras)
|
|
|
|
def test_zero_or_more_optional(self):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('x', nargs='*', choices=('x', 'y'))
|
|
args = parser.parse_args([])
|
|
self.assertEqual(NS(x=[]), args)
|
|
|
|
|
|
class TestDoubleDash(TestCase):
|
|
def test_single_argument_option(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('-f', '--foo')
|
|
parser.add_argument('bar', nargs='*')
|
|
|
|
args = parser.parse_args(['--foo=--'])
|
|
self.assertEqual(NS(foo='--', bar=[]), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument -f/--foo: expected one argument',
|
|
parser.parse_args, ['--foo', '--'])
|
|
args = parser.parse_args(['-f--'])
|
|
self.assertEqual(NS(foo='--', bar=[]), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument -f/--foo: expected one argument',
|
|
parser.parse_args, ['-f', '--'])
|
|
args = parser.parse_args(['--foo', 'a', '--', 'b', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', 'b', '--foo', 'c'])
|
|
self.assertEqual(NS(foo='c', bar=['a', 'b']), args)
|
|
args = parser.parse_args(['a', '--', 'b', '--foo', 'c'])
|
|
self.assertEqual(NS(foo=None, bar=['a', 'b', '--foo', 'c']), args)
|
|
args = parser.parse_args(['a', '--', 'b', '--', 'c', '--foo', 'd'])
|
|
self.assertEqual(NS(foo=None, bar=['a', 'b', '--', 'c', '--foo', 'd']), args)
|
|
|
|
def test_multiple_argument_option(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('-f', '--foo', nargs='*')
|
|
parser.add_argument('bar', nargs='*')
|
|
|
|
args = parser.parse_args(['--foo=--'])
|
|
self.assertEqual(NS(foo=['--'], bar=[]), args)
|
|
args = parser.parse_args(['--foo', '--'])
|
|
self.assertEqual(NS(foo=[], bar=[]), args)
|
|
args = parser.parse_args(['-f--'])
|
|
self.assertEqual(NS(foo=['--'], bar=[]), args)
|
|
args = parser.parse_args(['-f', '--'])
|
|
self.assertEqual(NS(foo=[], bar=[]), args)
|
|
args = parser.parse_args(['--foo', 'a', 'b', '--', 'c', 'd'])
|
|
self.assertEqual(NS(foo=['a', 'b'], bar=['c', 'd']), args)
|
|
args = parser.parse_args(['a', 'b', '--foo', 'c', 'd'])
|
|
self.assertEqual(NS(foo=['c', 'd'], bar=['a', 'b']), args)
|
|
args = parser.parse_args(['a', '--', 'b', '--foo', 'c', 'd'])
|
|
self.assertEqual(NS(foo=None, bar=['a', 'b', '--foo', 'c', 'd']), args)
|
|
args, argv = parser.parse_known_args(['a', 'b', '--foo', 'c', '--', 'd'])
|
|
self.assertEqual(NS(foo=['c'], bar=['a', 'b']), args)
|
|
self.assertEqual(argv, ['--', 'd'])
|
|
|
|
def test_multiple_double_dashes(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('foo')
|
|
parser.add_argument('bar', nargs='*')
|
|
|
|
args = parser.parse_args(['--', 'a', 'b', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', '--', 'b', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', 'b', '--', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', '--', 'b', '--', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
|
|
args = parser.parse_args(['--', '--', 'a', '--', 'b', 'c'])
|
|
self.assertEqual(NS(foo='--', bar=['a', '--', 'b', 'c']), args)
|
|
|
|
def test_remainder(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('foo')
|
|
parser.add_argument('bar', nargs='...')
|
|
|
|
args = parser.parse_args(['--', 'a', 'b', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', '--', 'b', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', 'c']), args)
|
|
args = parser.parse_args(['a', 'b', '--', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
|
|
args = parser.parse_args(['a', '--', 'b', '--', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['b', '--', 'c']), args)
|
|
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('--foo')
|
|
parser.add_argument('bar', nargs='...')
|
|
args = parser.parse_args(['--foo', 'a', '--', 'b', '--', 'c'])
|
|
self.assertEqual(NS(foo='a', bar=['--', 'b', '--', 'c']), args)
|
|
|
|
def test_subparser(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('foo')
|
|
subparsers = parser.add_subparsers()
|
|
parser1 = subparsers.add_parser('run')
|
|
parser1.add_argument('-f')
|
|
parser1.add_argument('bar', nargs='*')
|
|
|
|
args = parser.parse_args(['x', 'run', 'a', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f='c', bar=['a', 'b']), args)
|
|
args = parser.parse_args(['x', 'run', 'a', 'b', '--', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f=None, bar=['a', 'b', '-f', 'c']), args)
|
|
args = parser.parse_args(['x', 'run', 'a', '--', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f=None, bar=['a', 'b', '-f', 'c']), args)
|
|
args = parser.parse_args(['x', 'run', '--', 'a', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f=None, bar=['a', 'b', '-f', 'c']), args)
|
|
args = parser.parse_args(['x', '--', 'run', 'a', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f='c', bar=['a', 'b']), args)
|
|
args = parser.parse_args(['--', 'x', 'run', 'a', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo='x', f='c', bar=['a', 'b']), args)
|
|
args = parser.parse_args(['x', 'run', '--', 'a', '--', 'b'])
|
|
self.assertEqual(NS(foo='x', f=None, bar=['a', '--', 'b']), args)
|
|
args = parser.parse_args(['x', '--', 'run', '--', 'a', '--', 'b'])
|
|
self.assertEqual(NS(foo='x', f=None, bar=['a', '--', 'b']), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"invalid choice: '--'",
|
|
parser.parse_args, ['--', 'x', '--', 'run', 'a', 'b'])
|
|
|
|
def test_subparser_after_multiple_argument_option(self):
|
|
parser = argparse.ArgumentParser(exit_on_error=False)
|
|
parser.add_argument('--foo', nargs='*')
|
|
subparsers = parser.add_subparsers()
|
|
parser1 = subparsers.add_parser('run')
|
|
parser1.add_argument('-f')
|
|
parser1.add_argument('bar', nargs='*')
|
|
|
|
args = parser.parse_args(['--foo', 'x', 'y', '--', 'run', 'a', 'b', '-f', 'c'])
|
|
self.assertEqual(NS(foo=['x', 'y'], f='c', bar=['a', 'b']), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"invalid choice: '--'",
|
|
parser.parse_args, ['--foo', 'x', '--', '--', 'run', 'a', 'b'])
|
|
|
|
|
|
# ===========================
|
|
# parse_intermixed_args tests
|
|
# ===========================
|
|
|
|
class TestIntermixedArgs(TestCase):
|
|
def test_basic(self):
|
|
# test parsing intermixed optionals and positionals
|
|
parser = argparse.ArgumentParser(prog='PROG')
|
|
parser.add_argument('--foo', dest='foo')
|
|
bar = parser.add_argument('--bar', dest='bar', required=True)
|
|
parser.add_argument('cmd')
|
|
parser.add_argument('rest', nargs='*', type=int)
|
|
argv = 'cmd --foo x 1 --bar y 2 3'.split()
|
|
args = parser.parse_intermixed_args(argv)
|
|
# rest gets [1,2,3] despite the foo and bar strings
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1, 2, 3]), args)
|
|
|
|
args, extras = parser.parse_known_args(argv)
|
|
# cannot parse the '1,2,3'
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1]), args)
|
|
self.assertEqual(["2", "3"], extras)
|
|
args, extras = parser.parse_known_intermixed_args(argv)
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1, 2, 3]), args)
|
|
self.assertEqual([], extras)
|
|
|
|
# unknown optionals go into extras
|
|
argv = 'cmd --foo x --error 1 2 --bar y 3'.split()
|
|
args, extras = parser.parse_known_intermixed_args(argv)
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1, 2, 3]), args)
|
|
self.assertEqual(['--error'], extras)
|
|
argv = 'cmd --foo x 1 --error 2 --bar y 3'.split()
|
|
args, extras = parser.parse_known_intermixed_args(argv)
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1, 2, 3]), args)
|
|
self.assertEqual(['--error'], extras)
|
|
argv = 'cmd --foo x 1 2 --error --bar y 3'.split()
|
|
args, extras = parser.parse_known_intermixed_args(argv)
|
|
self.assertEqual(NS(bar='y', cmd='cmd', foo='x', rest=[1, 2, 3]), args)
|
|
self.assertEqual(['--error'], extras)
|
|
|
|
# restores attributes that were temporarily changed
|
|
self.assertIsNone(parser.usage)
|
|
self.assertEqual(bar.required, True)
|
|
|
|
def test_remainder(self):
|
|
# Intermixed and remainder are incompatible
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
parser.add_argument('-z')
|
|
parser.add_argument('x')
|
|
parser.add_argument('y', nargs='...')
|
|
argv = 'X A B -z Z'.split()
|
|
# intermixed fails with '...' (also 'A...')
|
|
# self.assertRaises(TypeError, parser.parse_intermixed_args, argv)
|
|
with self.assertRaises(TypeError) as cm:
|
|
parser.parse_intermixed_args(argv)
|
|
self.assertRegex(str(cm.exception), r'\.\.\.')
|
|
|
|
def test_required_exclusive(self):
|
|
# required mutually exclusive group; intermixed works fine
|
|
parser = argparse.ArgumentParser(prog='PROG', exit_on_error=False)
|
|
group = parser.add_mutually_exclusive_group(required=True)
|
|
group.add_argument('--foo', action='store_true', help='FOO')
|
|
group.add_argument('--spam', help='SPAM')
|
|
parser.add_argument('badger', nargs='*', default='X', help='BADGER')
|
|
args = parser.parse_intermixed_args('--foo 1 2'.split())
|
|
self.assertEqual(NS(badger=['1', '2'], foo=True, spam=None), args)
|
|
args = parser.parse_intermixed_args('1 --foo 2'.split())
|
|
self.assertEqual(NS(badger=['1', '2'], foo=True, spam=None), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'one of the arguments --foo --spam is required',
|
|
parser.parse_intermixed_args, '1 2'.split())
|
|
self.assertEqual(group.required, True)
|
|
|
|
def test_required_exclusive_with_positional(self):
|
|
# required mutually exclusive group with positional argument
|
|
parser = argparse.ArgumentParser(prog='PROG', exit_on_error=False)
|
|
group = parser.add_mutually_exclusive_group(required=True)
|
|
group.add_argument('--foo', action='store_true', help='FOO')
|
|
group.add_argument('--spam', help='SPAM')
|
|
group.add_argument('badger', nargs='*', default='X', help='BADGER')
|
|
args = parser.parse_intermixed_args(['--foo'])
|
|
self.assertEqual(NS(foo=True, spam=None, badger='X'), args)
|
|
args = parser.parse_intermixed_args(['a', 'b'])
|
|
self.assertEqual(NS(foo=False, spam=None, badger=['a', 'b']), args)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'one of the arguments --foo --spam badger is required',
|
|
parser.parse_intermixed_args, [])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument badger: not allowed with argument --foo',
|
|
parser.parse_intermixed_args, ['--foo', 'a', 'b'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument badger: not allowed with argument --foo',
|
|
parser.parse_intermixed_args, ['a', '--foo', 'b'])
|
|
self.assertEqual(group.required, True)
|
|
|
|
def test_invalid_args(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG')
|
|
self.assertRaises(ArgumentParserError, parser.parse_intermixed_args, ['a'])
|
|
|
|
|
|
class TestIntermixedMessageContentError(TestCase):
|
|
# case where Intermixed gives different error message
|
|
# error is raised by 1st parsing step
|
|
def test_missing_argument_name_in_message(self):
|
|
parser = ErrorRaisingArgumentParser(prog='PROG', usage='')
|
|
parser.add_argument('req_pos', type=str)
|
|
parser.add_argument('-req_opt', type=int, required=True)
|
|
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_args([])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertRegex(msg, 'req_opt')
|
|
|
|
with self.assertRaises(ArgumentParserError) as cm:
|
|
parser.parse_intermixed_args([])
|
|
msg = str(cm.exception)
|
|
self.assertRegex(msg, 'req_pos')
|
|
self.assertRegex(msg, 'req_opt')
|
|
|
|
# ==========================
|
|
# add_argument metavar tests
|
|
# ==========================
|
|
|
|
class TestAddArgumentMetavar(TestCase):
|
|
|
|
EXPECTED_MESSAGE = "length of metavar tuple does not match nargs"
|
|
|
|
def do_test_no_exception(self, nargs, metavar):
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument("--foo", nargs=nargs, metavar=metavar)
|
|
|
|
def do_test_exception(self, nargs, metavar):
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(ValueError) as cm:
|
|
parser.add_argument("--foo", nargs=nargs, metavar=metavar)
|
|
self.assertEqual(cm.exception.args[0], self.EXPECTED_MESSAGE)
|
|
|
|
# Unit tests for different values of metavar when nargs=None
|
|
|
|
def test_nargs_None_metavar_string(self):
|
|
self.do_test_no_exception(nargs=None, metavar="1")
|
|
|
|
def test_nargs_None_metavar_length0(self):
|
|
self.do_test_exception(nargs=None, metavar=tuple())
|
|
|
|
def test_nargs_None_metavar_length1(self):
|
|
self.do_test_no_exception(nargs=None, metavar=("1",))
|
|
|
|
def test_nargs_None_metavar_length2(self):
|
|
self.do_test_exception(nargs=None, metavar=("1", "2"))
|
|
|
|
def test_nargs_None_metavar_length3(self):
|
|
self.do_test_exception(nargs=None, metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=?
|
|
|
|
def test_nargs_optional_metavar_string(self):
|
|
self.do_test_no_exception(nargs="?", metavar="1")
|
|
|
|
def test_nargs_optional_metavar_length0(self):
|
|
self.do_test_exception(nargs="?", metavar=tuple())
|
|
|
|
def test_nargs_optional_metavar_length1(self):
|
|
self.do_test_no_exception(nargs="?", metavar=("1",))
|
|
|
|
def test_nargs_optional_metavar_length2(self):
|
|
self.do_test_exception(nargs="?", metavar=("1", "2"))
|
|
|
|
def test_nargs_optional_metavar_length3(self):
|
|
self.do_test_exception(nargs="?", metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=*
|
|
|
|
def test_nargs_zeroormore_metavar_string(self):
|
|
self.do_test_no_exception(nargs="*", metavar="1")
|
|
|
|
def test_nargs_zeroormore_metavar_length0(self):
|
|
self.do_test_exception(nargs="*", metavar=tuple())
|
|
|
|
def test_nargs_zeroormore_metavar_length1(self):
|
|
self.do_test_no_exception(nargs="*", metavar=("1",))
|
|
|
|
def test_nargs_zeroormore_metavar_length2(self):
|
|
self.do_test_no_exception(nargs="*", metavar=("1", "2"))
|
|
|
|
def test_nargs_zeroormore_metavar_length3(self):
|
|
self.do_test_exception(nargs="*", metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=+
|
|
|
|
def test_nargs_oneormore_metavar_string(self):
|
|
self.do_test_no_exception(nargs="+", metavar="1")
|
|
|
|
def test_nargs_oneormore_metavar_length0(self):
|
|
self.do_test_exception(nargs="+", metavar=tuple())
|
|
|
|
def test_nargs_oneormore_metavar_length1(self):
|
|
self.do_test_exception(nargs="+", metavar=("1",))
|
|
|
|
def test_nargs_oneormore_metavar_length2(self):
|
|
self.do_test_no_exception(nargs="+", metavar=("1", "2"))
|
|
|
|
def test_nargs_oneormore_metavar_length3(self):
|
|
self.do_test_exception(nargs="+", metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=...
|
|
|
|
def test_nargs_remainder_metavar_string(self):
|
|
self.do_test_no_exception(nargs="...", metavar="1")
|
|
|
|
def test_nargs_remainder_metavar_length0(self):
|
|
self.do_test_no_exception(nargs="...", metavar=tuple())
|
|
|
|
def test_nargs_remainder_metavar_length1(self):
|
|
self.do_test_no_exception(nargs="...", metavar=("1",))
|
|
|
|
def test_nargs_remainder_metavar_length2(self):
|
|
self.do_test_no_exception(nargs="...", metavar=("1", "2"))
|
|
|
|
def test_nargs_remainder_metavar_length3(self):
|
|
self.do_test_no_exception(nargs="...", metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=A...
|
|
|
|
def test_nargs_parser_metavar_string(self):
|
|
self.do_test_no_exception(nargs="A...", metavar="1")
|
|
|
|
def test_nargs_parser_metavar_length0(self):
|
|
self.do_test_exception(nargs="A...", metavar=tuple())
|
|
|
|
def test_nargs_parser_metavar_length1(self):
|
|
self.do_test_no_exception(nargs="A...", metavar=("1",))
|
|
|
|
def test_nargs_parser_metavar_length2(self):
|
|
self.do_test_exception(nargs="A...", metavar=("1", "2"))
|
|
|
|
def test_nargs_parser_metavar_length3(self):
|
|
self.do_test_exception(nargs="A...", metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=1
|
|
|
|
def test_nargs_1_metavar_string(self):
|
|
self.do_test_no_exception(nargs=1, metavar="1")
|
|
|
|
def test_nargs_1_metavar_length0(self):
|
|
self.do_test_exception(nargs=1, metavar=tuple())
|
|
|
|
def test_nargs_1_metavar_length1(self):
|
|
self.do_test_no_exception(nargs=1, metavar=("1",))
|
|
|
|
def test_nargs_1_metavar_length2(self):
|
|
self.do_test_exception(nargs=1, metavar=("1", "2"))
|
|
|
|
def test_nargs_1_metavar_length3(self):
|
|
self.do_test_exception(nargs=1, metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=2
|
|
|
|
def test_nargs_2_metavar_string(self):
|
|
self.do_test_no_exception(nargs=2, metavar="1")
|
|
|
|
def test_nargs_2_metavar_length0(self):
|
|
self.do_test_exception(nargs=2, metavar=tuple())
|
|
|
|
def test_nargs_2_metavar_length1(self):
|
|
self.do_test_exception(nargs=2, metavar=("1",))
|
|
|
|
def test_nargs_2_metavar_length2(self):
|
|
self.do_test_no_exception(nargs=2, metavar=("1", "2"))
|
|
|
|
def test_nargs_2_metavar_length3(self):
|
|
self.do_test_exception(nargs=2, metavar=("1", "2", "3"))
|
|
|
|
# Unit tests for different values of metavar when nargs=3
|
|
|
|
def test_nargs_3_metavar_string(self):
|
|
self.do_test_no_exception(nargs=3, metavar="1")
|
|
|
|
def test_nargs_3_metavar_length0(self):
|
|
self.do_test_exception(nargs=3, metavar=tuple())
|
|
|
|
def test_nargs_3_metavar_length1(self):
|
|
self.do_test_exception(nargs=3, metavar=("1",))
|
|
|
|
def test_nargs_3_metavar_length2(self):
|
|
self.do_test_exception(nargs=3, metavar=("1", "2"))
|
|
|
|
def test_nargs_3_metavar_length3(self):
|
|
self.do_test_no_exception(nargs=3, metavar=("1", "2", "3"))
|
|
|
|
|
|
class TestInvalidNargs(TestCase):
|
|
|
|
EXPECTED_INVALID_MESSAGE = "invalid nargs value"
|
|
EXPECTED_RANGE_MESSAGE = ("nargs for store actions must be != 0; if you "
|
|
"have nothing to store, actions such as store "
|
|
"true or store const may be more appropriate")
|
|
|
|
def do_test_range_exception(self, nargs):
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(ValueError) as cm:
|
|
parser.add_argument("--foo", nargs=nargs)
|
|
self.assertEqual(cm.exception.args[0], self.EXPECTED_RANGE_MESSAGE)
|
|
|
|
def do_test_invalid_exception(self, nargs):
|
|
parser = argparse.ArgumentParser()
|
|
with self.assertRaises(ValueError) as cm:
|
|
parser.add_argument("--foo", nargs=nargs)
|
|
self.assertEqual(cm.exception.args[0], self.EXPECTED_INVALID_MESSAGE)
|
|
|
|
# Unit tests for different values of nargs
|
|
|
|
def test_nargs_alphabetic(self):
|
|
self.do_test_invalid_exception(nargs='a')
|
|
self.do_test_invalid_exception(nargs="abcd")
|
|
|
|
def test_nargs_zero(self):
|
|
self.do_test_range_exception(nargs=0)
|
|
|
|
# ============================
|
|
# from argparse import * tests
|
|
# ============================
|
|
|
|
class TestImportStar(TestCase):
|
|
|
|
def test(self):
|
|
for name in argparse.__all__:
|
|
self.assertTrue(hasattr(argparse, name))
|
|
|
|
def test_all_exports_everything_but_modules(self):
|
|
items = [
|
|
name
|
|
for name, value in vars(argparse).items()
|
|
if not (name.startswith("_") or name == 'ngettext')
|
|
if not inspect.ismodule(value)
|
|
]
|
|
self.assertEqual(sorted(items), sorted(argparse.__all__))
|
|
|
|
|
|
class TestWrappingMetavar(TestCase):
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.parser = ErrorRaisingArgumentParser(
|
|
'this_is_spammy_prog_with_a_long_name_sorry_about_the_name'
|
|
)
|
|
# this metavar was triggering library assertion errors due to usage
|
|
# message formatting incorrectly splitting on the ] chars within
|
|
metavar = '<http[s]://example:1234>'
|
|
self.parser.add_argument('--proxy', metavar=metavar)
|
|
|
|
def test_help_with_metavar(self):
|
|
help_text = self.parser.format_help()
|
|
self.assertEqual(help_text, textwrap.dedent('''\
|
|
usage: this_is_spammy_prog_with_a_long_name_sorry_about_the_name
|
|
[-h] [--proxy <http[s]://example:1234>]
|
|
|
|
options:
|
|
-h, --help show this help message and exit
|
|
--proxy <http[s]://example:1234>
|
|
'''))
|
|
|
|
|
|
class TestExitOnError(TestCase):
|
|
|
|
def setUp(self):
|
|
self.parser = argparse.ArgumentParser(exit_on_error=False,
|
|
fromfile_prefix_chars='@')
|
|
self.parser.add_argument('--integers', metavar='N', type=int)
|
|
|
|
def test_exit_on_error_with_good_args(self):
|
|
ns = self.parser.parse_args('--integers 4'.split())
|
|
self.assertEqual(ns, argparse.Namespace(integers=4))
|
|
|
|
def test_exit_on_error_with_bad_args(self):
|
|
with self.assertRaises(argparse.ArgumentError):
|
|
self.parser.parse_args('--integers a'.split())
|
|
|
|
def test_unrecognized_args(self):
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'unrecognized arguments: --foo bar',
|
|
self.parser.parse_args, '--foo bar'.split())
|
|
|
|
def test_unrecognized_intermixed_args(self):
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'unrecognized arguments: --foo bar',
|
|
self.parser.parse_intermixed_args, '--foo bar'.split())
|
|
|
|
def test_required_args(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar, baz$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_with_metavar(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', metavar='BaZ')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar, BaZ$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_n(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs=3)
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar, baz$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_n_with_metavar(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs=3, metavar=('B', 'A', 'Z'))
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar, B, A, Z$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_optional(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs='?')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_zero_or_more(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs='*')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_one_or_more(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs='+')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar, baz$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_one_or_more_with_metavar(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs='+', metavar=('BaZ1', 'BaZ2'))
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
r'the following arguments are required: bar, BaZ1\[, BaZ2]$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_args_remainder(self):
|
|
self.parser.add_argument('bar')
|
|
self.parser.add_argument('baz', nargs='...')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'the following arguments are required: bar$',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_required_mutually_exclusive_args(self):
|
|
group = self.parser.add_mutually_exclusive_group(required=True)
|
|
group.add_argument('--bar')
|
|
group.add_argument('--baz')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'one of the arguments --bar --baz is required',
|
|
self.parser.parse_args, [])
|
|
|
|
def test_conflicting_mutually_exclusive_args_optional_with_metavar(self):
|
|
group = self.parser.add_mutually_exclusive_group()
|
|
group.add_argument('--bar')
|
|
group.add_argument('baz', nargs='?', metavar='BaZ')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument BaZ: not allowed with argument --bar$',
|
|
self.parser.parse_args, ['--bar', 'a', 'b'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument --bar: not allowed with argument BaZ$',
|
|
self.parser.parse_args, ['a', '--bar', 'b'])
|
|
|
|
def test_conflicting_mutually_exclusive_args_zero_or_more_with_metavar1(self):
|
|
group = self.parser.add_mutually_exclusive_group()
|
|
group.add_argument('--bar')
|
|
group.add_argument('baz', nargs='*', metavar=('BAZ1',))
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument BAZ1: not allowed with argument --bar$',
|
|
self.parser.parse_args, ['--bar', 'a', 'b'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
'argument --bar: not allowed with argument BAZ1$',
|
|
self.parser.parse_args, ['a', '--bar', 'b'])
|
|
|
|
def test_conflicting_mutually_exclusive_args_zero_or_more_with_metavar2(self):
|
|
group = self.parser.add_mutually_exclusive_group()
|
|
group.add_argument('--bar')
|
|
group.add_argument('baz', nargs='*', metavar=('BAZ1', 'BAZ2'))
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
r'argument BAZ1\[, BAZ2]: not allowed with argument --bar$',
|
|
self.parser.parse_args, ['--bar', 'a', 'b'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
r'argument --bar: not allowed with argument BAZ1\[, BAZ2]$',
|
|
self.parser.parse_args, ['a', '--bar', 'b'])
|
|
|
|
def test_ambiguous_option(self):
|
|
self.parser.add_argument('--foobaz')
|
|
self.parser.add_argument('--fooble', action='store_true')
|
|
self.parser.add_argument('--foogle')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"ambiguous option: --foob could match --foobaz, --fooble",
|
|
self.parser.parse_args, ['--foob'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"ambiguous option: --foob=1 could match --foobaz, --fooble$",
|
|
self.parser.parse_args, ['--foob=1'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"ambiguous option: --foob could match --foobaz, --fooble$",
|
|
self.parser.parse_args, ['--foob', '1', '--foogle', '2'])
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"ambiguous option: --foob=1 could match --foobaz, --fooble$",
|
|
self.parser.parse_args, ['--foob=1', '--foogle', '2'])
|
|
|
|
def test_os_error(self):
|
|
self.parser.add_argument('file')
|
|
self.assertRaisesRegex(argparse.ArgumentError,
|
|
"No such file or directory: 'no-such-file'",
|
|
self.parser.parse_args, ['@no-such-file'])
|
|
|
|
|
|
class TestProgName(TestCase):
|
|
source = textwrap.dedent('''\
|
|
import argparse
|
|
parser = argparse.ArgumentParser()
|
|
parser.parse_args()
|
|
''')
|
|
|
|
def setUp(self):
|
|
self.dirname = 'package' + os_helper.FS_NONASCII
|
|
self.addCleanup(os_helper.rmtree, self.dirname)
|
|
os.mkdir(self.dirname)
|
|
|
|
def make_script(self, dirname, basename, *, compiled=False):
|
|
script_name = script_helper.make_script(dirname, basename, self.source)
|
|
if not compiled:
|
|
return script_name
|
|
py_compile.compile(script_name, doraise=True)
|
|
os.remove(script_name)
|
|
pyc_file = import_helper.make_legacy_pyc(script_name)
|
|
return pyc_file
|
|
|
|
def make_zip_script(self, script_name, name_in_zip=None):
|
|
zip_name, _ = script_helper.make_zip_script(self.dirname, 'test_zip',
|
|
script_name, name_in_zip)
|
|
return zip_name
|
|
|
|
def check_usage(self, expected, *args, **kwargs):
|
|
res = script_helper.assert_python_ok('-Xutf8', *args, '-h', **kwargs)
|
|
self.assertEqual(res.out.splitlines()[0].decode(),
|
|
f'usage: {expected} [-h]')
|
|
|
|
def test_script(self, compiled=False):
|
|
basename = os_helper.TESTFN
|
|
script_name = self.make_script(self.dirname, basename, compiled=compiled)
|
|
self.check_usage(os.path.basename(script_name), script_name, '-h')
|
|
|
|
def test_script_compiled(self):
|
|
self.test_script(compiled=True)
|
|
|
|
def test_directory(self, compiled=False):
|
|
dirname = os.path.join(self.dirname, os_helper.TESTFN)
|
|
os.mkdir(dirname)
|
|
self.make_script(dirname, '__main__', compiled=compiled)
|
|
self.check_usage(f'{py} {dirname}', dirname)
|
|
dirname2 = os.path.join(os.curdir, dirname)
|
|
self.check_usage(f'{py} {dirname2}', dirname2)
|
|
|
|
def test_directory_compiled(self):
|
|
self.test_directory(compiled=True)
|
|
|
|
def test_module(self, compiled=False):
|
|
basename = 'module' + os_helper.FS_NONASCII
|
|
modulename = f'{self.dirname}.{basename}'
|
|
self.make_script(self.dirname, basename, compiled=compiled)
|
|
self.check_usage(f'{py} -m {modulename}',
|
|
'-m', modulename, PYTHONPATH=os.curdir)
|
|
|
|
def test_module_compiled(self):
|
|
self.test_module(compiled=True)
|
|
|
|
def test_package(self, compiled=False):
|
|
basename = 'subpackage' + os_helper.FS_NONASCII
|
|
packagename = f'{self.dirname}.{basename}'
|
|
subdirname = os.path.join(self.dirname, basename)
|
|
os.mkdir(subdirname)
|
|
self.make_script(subdirname, '__main__', compiled=compiled)
|
|
self.check_usage(f'{py} -m {packagename}',
|
|
'-m', packagename, PYTHONPATH=os.curdir)
|
|
self.check_usage(f'{py} -m {packagename}',
|
|
'-m', packagename + '.__main__', PYTHONPATH=os.curdir)
|
|
|
|
def test_package_compiled(self):
|
|
self.test_package(compiled=True)
|
|
|
|
def test_zipfile(self, compiled=False):
|
|
script_name = self.make_script(self.dirname, '__main__', compiled=compiled)
|
|
zip_name = self.make_zip_script(script_name)
|
|
self.check_usage(f'{py} {zip_name}', zip_name)
|
|
|
|
def test_zipfile_compiled(self):
|
|
self.test_zipfile(compiled=True)
|
|
|
|
def test_directory_in_zipfile(self, compiled=False):
|
|
script_name = self.make_script(self.dirname, '__main__', compiled=compiled)
|
|
name_in_zip = 'package/subpackage/__main__' + ('.py', '.pyc')[compiled]
|
|
zip_name = self.make_zip_script(script_name, name_in_zip)
|
|
dirname = os.path.join(zip_name, 'package', 'subpackage')
|
|
self.check_usage(f'{py} {dirname}', dirname)
|
|
|
|
def test_directory_in_zipfile_compiled(self):
|
|
self.test_directory_in_zipfile(compiled=True)
|
|
|
|
# =================
|
|
# Translation tests
|
|
# =================
|
|
|
|
class TestTranslations(TestTranslationsBase):
|
|
|
|
def test_translations(self):
|
|
self.assertMsgidsEqual(argparse)
|
|
|
|
|
|
def tearDownModule():
|
|
# Remove global references to avoid looking like we have refleaks.
|
|
RFile.seen = {}
|
|
WFile.seen = set()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
# To regenerate translation snapshots
|
|
if len(sys.argv) > 1 and sys.argv[1] == '--snapshot-update':
|
|
update_translation_snapshots(argparse)
|
|
sys.exit(0)
|
|
unittest.main()
|