argumentresolver.py

Go to the documentation of this file.

#  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
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
from robotide.lib.robot.errors import DataError
from robotide.lib.robot.utils import is_string, is_dict_like, split_from_equals
from robotide.lib.robot.variables import VariableSplitter
 
from .argumentvalidator import ArgumentValidator
 
 
class ArgumentResolver():
 
    def __init__(self, argspec, resolve_named=True,
                 resolve_variables_until=None, dict_to_kwargs=False):
        self._named_resolver_named_resolver = NamedArgumentResolver(argspec) \
            if resolve_named else NullNamedArgumentResolver()
        self._variable_replacer_variable_replacer = VariableReplacer(resolve_variables_until)
        self._dict_to_kwargs_dict_to_kwargs = DictToKwargs(argspec, dict_to_kwargs)
        self._argument_validator_argument_validator = ArgumentValidator(argspec)
 
    def resolve(self, arguments, variables=None):
        positional, named = self._named_resolver_named_resolver.resolve(arguments, variables)
        positional, named = self._variable_replacer_variable_replacer.replace(positional, named,
                                                            variables)
        positional, named = self._dict_to_kwargs_dict_to_kwargs.handle(positional, named)
        self._argument_validator_argument_validator.validate(positional, named,
                                          dryrun=variables is None)
        return positional, named
 
 
class NamedArgumentResolver():
 
    def __init__(self, argspec):
        self._argspec_argspec = argspec
 
    def resolve(self, arguments, variables=None):
        positional = []
        named = []
        for arg in arguments:
            if self._is_dict_var_is_dict_var(arg):
                named.append(arg)
            elif self._is_named_is_named(arg, named, variables):
                named.append(split_from_equals(arg))
            elif named:
                self._raise_positional_after_named_raise_positional_after_named()
            else:
                positional.append(arg)
        return positional, named
 
    def _is_dict_var(self, arg):
        return (is_string(arg) and arg[:2] == '&{' and arg[-1] == '}' and
                VariableSplitter(arg).is_dict_variable())
 
    def _is_named(self, arg, previous_named, variables=None):
        name, value = split_from_equals(arg)
        if value is None:
            return False
        if variables:
            name = variables.replace_scalar(name)
        argspec = self._argspec_argspec
        if previous_named or name in argspec.kwonlyargs or argspec.kwargs:
            return True
        return argspec.supports_named and name in argspec.positional
 
    def _raise_positional_after_named(self):
        raise DataError("%s '%s' got positional argument after named arguments."
                        % (self._argspec_argspec.type, self._argspec_argspec.name))
 
 
class NullNamedArgumentResolver():
 
    def resolve(self, arguments, variables=None):
        return arguments, {}
 
 
class DictToKwargs():
 
    def __init__(self, argspec, enabled=False):
        self._maxargs_maxargs = argspec.maxargs
        self._enabled_enabled = enabled and bool(argspec.kwargs)
 
    def handle(self, positional, named):
        if self._enabled_enabled and self._extra_arg_has_kwargs_extra_arg_has_kwargs(positional, named):
            named = positional.pop().items()
        return positional, named
 
    def _extra_arg_has_kwargs(self, positional, named):
        if named or len(positional) != self._maxargs_maxargs + 1:
            return False
        return is_dict_like(positional[-1])
 
 
class VariableReplacer():
 
    def __init__(self, resolve_until=None):
        self._resolve_until_resolve_until = resolve_until
 
    def replace(self, positional, named, variables=None):
        # `variables` is None in dry-run mode and when using Libdoc.
        if variables:
            positional = variables.replace_list(positional, self._resolve_until_resolve_until)
            named = list(self._replace_named_replace_named(named, variables.replace_scalar))
        else:
            positional = list(positional)
            named = [item for item in named if isinstance(item, tuple)]
        return positional, named
 
    def _replace_named(self, named, replace_scalar):
        for item in named:
            for name, value in self._get_replaced_named_get_replaced_named(item, replace_scalar):
                if not is_string(name):
                    raise DataError('Argument names must be strings.')
                yield name, value
 
    def _get_replaced_named(self, item, replace_scalar):
        if not isinstance(item, tuple):
            return replace_scalar(item).items()
        name, value = item
        return [(replace_scalar(name), replace_scalar(value))]