def parses_sys_argv_style_list_of_strings(self):
"parses sys.argv-style list of strings"
# Doesn't-blow-up tests FTL
mytask = Context(name="mytask")
mytask.add_arg("arg")
p = Parser(contexts=[mytask])
p.parse_argv(["mytask", "--arg", "value"])
def value_requiring_core_flags_also_work_correctly(self):
"value-requiring core flags also work correctly"
initial = Context(args=[Argument("hide")])
task1 = Context("mytask")
parser = Parser(initial=initial, contexts=[task1])
result = parser.parse_argv(["mytask", "--hide", "both"])
assert result[0].args.hide.value == "both"
def by_itself_base_case(self):
task1 = Context("mytask")
init = Context(args=[Argument("help", optional=True)])
parser = Parser(initial=init, contexts=[task1])
result = parser.parse_argv(["mytask", "--help"])
assert len(result) == 2
assert result[0].args.help.value == "mytask"
assert "help" not in result[1].args
def core_flags_work_normally_when_no_conflict(self):
# Initial parse context with an --echo, plus a no-args task
initial = Context(args=[self._echo()])
task1 = Context("mytask")
parser = Parser(initial=initial, contexts=[task1])
# Call with --echo in the per-task context, expect the core
# context got updated (vs an error)
result = parser.parse_argv(["mytask", "--echo"])
assert result[0].args.echo.value is True
def other_tokens_afterwards_raise_parse_errors(self):
# NOTE: this is because of the special-casing where we supply
# the task name as the value when the flag is literally named
# "help".
task1 = Context("mytask")
init = Context(args=[Argument("help", optional=True)])
parser = Parser(initial=init, contexts=[task1])
with raises(ParseError, match=r".*foobar.*"):
parser.parse_argv(["mytask", "--help", "foobar"])
def when_conflict_per_task_args_win_out(self):
# Initial parse context with an --echo, plus task w/ same
initial = Context(args=[self._echo()])
task1 = Context("mytask", args=[self._echo()])
parser = Parser(initial=initial, contexts=[task1])
# Call with --echo in the per-task context, expect the task
# context got updated, and not core.
result = parser.parse_argv(["mytask", "--echo"])
assert result[0].args.echo.value is False
assert result[1].args.echo.value is True
def core_bool_but_per_task_string(self):
# Initial parse context with bool --hide, and a task with a
# regular (string) --hide
initial = Context(
args=[Argument("hide", kind=bool, default=False)]
)
task1 = Context("mytask", args=[Argument("hide")])
parser = Parser(initial=initial, contexts=[task1])
# Expect that, because the task's version wins, we're able to
# call it with a value. (If there were weird bugs where the
# core flag informed the parsing, this would fail.)
result = parser.parse_argv(["mytask", "--hide", "both"])
assert result[0].args.hide.value is False
assert result[1].args.hide.value == "both"
def clones_noninitial_contexts(self):
a = Argument("foo")
assert a.value is None
c = Context(name="mytask", args=(a,))
p = Parser(contexts=(c,))
assert p.contexts["mytask"] is c
r = p.parse_argv(["mytask", "--foo", "val"])
assert p.contexts["mytask"] is c
c2 = r[0]
assert c2 is not c
a2 = c2.args["foo"]
assert a2 is not a
assert a.value is None
assert a2.value == "val"
def clones_initial_context(self):
a = Argument("foo", kind=bool)
assert a.value is None
c = Context(args=(a,))
p = Parser(initial=c)
assert p.initial is c
r = p.parse_argv(["--foo"])
assert p.initial is c
c2 = r[0]
assert c2 is not c
a2 = c2.args["foo"]
assert a2 is not a
assert a.value is None
assert a2.value is True
def iterables_work_correctly_outside_a_vacuum(self):
# Undetected bug where I was primarily focused on the -vvv use
# case...'normal' incrementables never left 'waiting for value'
# state in the parser! so _subsequent_ task names & such never got
# parsed right, always got appended to the list.
c = Context("mytask", args=[Argument("mylist", kind=list)])
c2 = Context("othertask")
argv = [
"mytask",
"--mylist",
"val",
"--mylist",
"val2",
"othertask",
]
result = Parser([c, c2]).parse_argv(argv)
# When bug present, result only has one context (for 'mytask') and
# its 'mylist' consists of ['val', 'val2', 'othertask']. (the
# middle '--mylist' was handled semi-correctly.)
mylist = result[0].args.mylist.value
assert mylist == ["val", "val2"]
contexts = len(result)
err = "Got {} parse context results instead of 2!".format(contexts)
assert contexts == 2, err
assert result[1].name == "othertask"
def task_args_work_correctly(self):
task1 = Context("mytask", args=(Argument("meh"),))
result = Parser((task1,)).parse_argv(
["mytask", "--meh", "mehval1", "mytask", "--meh", "mehval2"]
)
assert result[0].args.meh.value == "mehval1"
assert result[1].args.meh.value == "mehval2"
def always_includes_initial_context_if_one_was_given(self):
# Even if no core/initial flags were seen
t1 = Context("t1")
init = Context()
result = Parser((t1,), initial=init).parse_argv(["t1"])
assert result[0].name is None
assert result[1].name == "t1"
def arguments_which_take_values_get_defaults_overridden_correctly(
self
): # noqa
args = (Argument("arg", kind=str), Argument("arg2", kind=int))
c = Context("mytask", args=args)
argv = ["mytask", "--arg", "myval", "--arg2", "25"]
result = Parser((c,)).parse_argv(argv)
assert result[0].args["arg"].value == "myval"
assert result[0].args["arg2"].value == 25
def returned_arguments_not_given_contain_default_values(self):
# I.e. a Context with args A and B, invoked with no mention of B,
# should result in B existing in the result, with its default value
# intact, and not e.g. None, or the arg not existing.
a = Argument("name", kind=str)
b = Argument("age", default=7)
c = Context("mytask", args=(a, b))
Parser((c,)).parse_argv(["mytask", "--name", "blah"])
assert c.args["age"].value == 7
def handles_multiple_boolean_flags_per_context(self):
c = Context(
"mytask",
args=(Argument("foo", kind=bool), Argument("bar", kind=bool)),
)
r = Parser([c]).parse_argv(["mytask", "--foo", "--bar"])
a = r[0].args
assert a.foo.value is True
assert a.bar.value is True
class parsing_errors:
def setup(self):
self.p = Parser([Context(name="foo", args=[Argument("bar")])])
def missing_flag_values_raise_ParseError(self):
with raises(ParseError):
self.p.parse_argv(["foo", "--bar"])
def attaches_context_to_ParseErrors(self):
try:
self.p.parse_argv(["foo", "--bar"])
except ParseError as e:
assert e.context is not None
def attached_context_is_None_outside_contexts(self):
try:
Parser().parse_argv(["wat"])
except ParseError as e:
assert e.context is None
def _parser(self, arguments=None):
if arguments is None:
arguments = (
Argument(
names=("foo", "f"), optional=True, default="mydefault"
),
)
self.context = Context("mytask", args=arguments)
self.parser = Parser([self.context])
return self.parser
def omitted_positional_args_raises_ParseError(self):
try:
arg = Argument("pos", positional=True)
arg2 = Argument("morepos", positional=True)
mytask = Context(name="mytask", args=[arg, arg2])
Parser(contexts=[mytask]).parse_argv(["mytask"])
except ParseError as e:
expected = "'mytask' did not receive required positional arguments: 'pos', 'morepos'" # noqa
assert str(e) == expected
else:
assert False, "Did not raise ParseError!"
def positional_args_eat_otherwise_valid_context_names(self):
mytask = Context(
"mytask",
args=[
Argument("pos", positional=True),
Argument("nonpos", default="default"),
],
)
Context("lolwut")
result = Parser([mytask]).parse_argv(["mytask", "lolwut"])
r = result[0]
assert r.args["pos"].value == "lolwut"
assert r.args["nonpos"].value == "default"
assert len(result) == 1 # Not 2
def positional_args_can_still_be_given_as_flags(self):
# AKA "positional args can come anywhere in the context"
pos1 = Argument("pos1", positional=True)
pos2 = Argument("pos2", positional=True)
nonpos = Argument("nonpos", positional=False, default="lol")
mytask = Context("mytask", args=[pos1, pos2, nonpos])
assert mytask.positional_args == [pos1, pos2]
r = Parser([mytask]).parse_argv(
[
"mytask",
"--nonpos",
"wut",
"--pos2",
"pos2val",
"pos1val",
]
)[0]
assert r.args["pos1"].value == "pos1val"
assert r.args["pos2"].value == "pos2val"
assert r.args["nonpos"].value == "wut"
def ignore_unknown_does_not_mutate_rest_of_argv(self):
p = Parser([Context("ugh")], ignore_unknown=True)
r = p.parse_argv(["ugh", "what", "-nowai"])
# NOT: ['what', '-n', '-w', '-a', '-i']
assert r.unparsed == ["what", "-nowai"]
def ignore_unknown_returns_unparsed_argv_instead(self):
r = Parser(ignore_unknown=True).parse_argv(["foo", "bar", "--baz"])
assert r.unparsed == ["foo", "bar", "--baz"]
def unparsed_does_not_share_state(self):
r = Parser(ignore_unknown=True).parse_argv(["self"])
assert r.unparsed == ["self"]
r2 = Parser(ignore_unknown=True).parse_argv(["contained"])
assert r.unparsed == ["self"] # NOT ['self', 'contained']
assert r2.unparsed == ["contained"] # NOT ['self', 'contained']
def raises_error_if_unknown_contexts_found(self):
with raises(ParseError):
Parser().parse_argv(["foo", "bar"])
def returns_only_contexts_mentioned(self):
task1 = Context("mytask")
task2 = Context("othertask")
result = Parser((task1, task2)).parse_argv(["othertask"])
assert len(result) == 1
assert result[0].name == "othertask"
def can_take_initial_context(self):
c = Context()
p = Parser(initial=c)
assert p.initial == c
def setup(self):
self.context = Context(
"mytask", args=(Argument("foo", kind=str), Argument("bar"))
)
argv = ["mytask", "--foo", "foo-val", "--", "my", "remainder"]
self.result = Parser((self.context,)).parse_argv(argv)
def returned_contexts_are_in_order_given(self):
t1, t2 = Context("t1"), Context("t2")
r = Parser((t1, t2)).parse_argv(["t2", "t1"])
assert [x.name for x in r] == ["t2", "t1"]
def _parser(self):
return Parser(self.c.to_contexts())
def ignore_unknown_defaults_to_False(self):
assert Parser().ignore_unknown is False
