Source code for robot.running.arguments.argumentvalidator

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

from robot.errors import DataError
from robot.utils import plural_or_not, seq2str
from robot.variables import is_list_variable

[docs]class ArgumentValidator(object): def __init__(self, argspec): """:type argspec: :py:class:`robot.running.arguments.ArgumentSpec`""" self._argspec = argspec
[docs] def validate(self, positional, named, dryrun=False): if dryrun and any(is_list_variable(arg) for arg in positional): return named = set(name for name, value in named) self._validate_no_multiple_values(positional, named, self._argspec) self._validate_no_positional_only_as_named(named, self._argspec) self._validate_positional_limits(positional, named, self._argspec) self._validate_no_mandatory_missing(positional, named, self._argspec) self._validate_no_named_only_missing(named, self._argspec) self._validate_no_extra_named(named, self._argspec)
def _validate_no_multiple_values(self, positional, named, spec): for name in spec.positional[:len(positional)]: if name in named and name not in spec.positional_only: self._raise_error("got multiple values for argument '%s'" % name) def _raise_error(self, message): raise DataError("%s '%s' %s." % (self._argspec.type.capitalize(),, message)) def _validate_no_positional_only_as_named(self, named, spec): if not spec.var_named: for name in named: if name in spec.positional_only: self._raise_error("does not accept argument '%s' as named " "argument" % name) def _validate_positional_limits(self, positional, named, spec): count = len(positional) + self._named_positionals(named, spec) if not spec.minargs <= count <= spec.maxargs: self._raise_wrong_count(count, spec) def _named_positionals(self, named, spec): return sum(1 for n in named if n in spec.positional_or_named) def _raise_wrong_count(self, count, spec): minend = plural_or_not(spec.minargs) if spec.minargs == spec.maxargs: expected = '%d argument%s' % (spec.minargs, minend) elif not spec.var_positional: expected = '%d to %d arguments' % (spec.minargs, spec.maxargs) else: expected = 'at least %d argument%s' % (spec.minargs, minend) if spec.var_named or spec.named_only: expected = expected.replace('argument', 'non-named argument') self._raise_error("expected %s, got %d" % (expected, count)) def _validate_no_mandatory_missing(self, positional, named, spec): for name in spec.positional[len(positional):]: if name not in spec.defaults and name not in named: self._raise_error("missing value for argument '%s'" % name) def _validate_no_named_only_missing(self, named, spec): defined = set(named) | set(spec.defaults) missing = [arg for arg in spec.named_only if arg not in defined] if missing: self._raise_error("missing named-only argument%s %s" % (plural_or_not(missing), seq2str(sorted(missing)))) def _validate_no_extra_named(self, named, spec): if not spec.var_named: extra = set(named) - set(spec.positional_or_named) - set(spec.named_only) if extra: self._raise_error("got unexpected named argument%s %s" % (plural_or_not(extra), seq2str(sorted(extra))))