dynamicmethods.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 (get_error_message, is_java_method, is_bytes, is_unicode, is_tuple, py2to3)
 
from .arguments import JavaArgumentParser, PythonArgumentParser
 
 
def no_dynamic_method(*args):
    pass
 
 
@py2to3
class _DynamicMethod():
    
    _underscore_name = NotImplemented
 
    def __init__(self, lib):
        self.methodmethod = self._get_method_get_method(lib)
 
    def _get_method(self, lib):
        for name in self._underscore_name_underscore_name, self._camelCaseName_camelCaseName_camelCaseName:
            method = getattr(lib, name, None)
            if callable(method):
                return method
        return no_dynamic_method
 
    @property
    _camelCaseName = property
    
    def _camelCaseName(self):
        tokens = self._underscore_name_underscore_name.split('_')
        return ''.join([tokens[0]] + [t.capitalize() for t in tokens[1:]])
 
    @property
    name = property
    
    def name(self):
        return self.methodmethod.__name__
 
    def __call__(self, *args):
        try:
            return self._handle_return_value_handle_return_value(self.methodmethod(*args))
        except:
            raise DataError("Calling dynamic method '%s' failed: %s"
                            % (self.methodmethod.__name__, get_error_message()))
 
    def _handle_return_value(self, value):
        raise NotImplementedError
 
    def _to_string(self, value):
        if is_unicode(value):
            return value
        if is_bytes(value):
            return value.decode('UTF-8')
        if is_tuple(value):
            return f"{value[0]}={value[1]}"
        raise DataError('Return value must be string.')
 
    def _to_list_of_strings(self, value):
        try:
            return [self._to_string_to_string(v) for v in value]
        except (TypeError, DataError):
            raise DataError('Return value must be list of strings.')
 
    def __nonzero__(self):
        return self.methodmethod is not no_dynamic_method
 
 
class GetKeywordNames(_DynamicMethod):
    
    _underscore_name = 'get_keyword_names'
 
    def _handle_return_value(self, value):
        names = self._to_list_of_strings_to_list_of_strings(value or [])
        return list(self._remove_duplicates_remove_duplicates(names))
 
    def _remove_duplicates(self, names):
        seen = set()
        for name in names:
            if name not in seen:
                seen.add(name)
                yield name
 
 
class RunKeyword(_DynamicMethod):
    
    _underscore_name = 'run_keyword'
 
    @property
    supports_kwargs = property
    
    def supports_kwargs(self):
        if is_java_method(self.methodmethod):
            return self._supports_java_kwargs_supports_java_kwargs(self.methodmethod)
        return self._supports_python_kwargs_supports_python_kwargs(self.methodmethod)
 
    def _supports_python_kwargs(self, method):
        spec = PythonArgumentParser().parse(method)
        return len(spec.positional) == 3
 
    def _supports_java_kwargs(self, method):
        func = self.methodmethod.im_func if hasattr(method, 'im_func') else method
        signatures = func.argslist[:func.nargs]
        spec = JavaArgumentParser().parse(signatures)
        return (self._java_single_signature_kwargs_java_single_signature_kwargs(spec) or
                self._java_multi_signature_kwargs_java_multi_signature_kwargs(spec))
 
    def _java_single_signature_kwargs(self, spec):
        return len(spec.positional) == 1 and spec.varargs and spec.kwargs
 
    def _java_multi_signature_kwargs(self, spec):
        return len(spec.positional) == 3 and not (spec.varargs or spec.kwargs)
 
 
class GetKeywordDocumentation(_DynamicMethod):
    
    _underscore_name = 'get_keyword_documentation'
 
    def _handle_return_value(self, value):
        return self._to_string_to_string(value or '')
 
 
class GetKeywordArguments(_DynamicMethod):
    
    _underscore_name = 'get_keyword_arguments'
 
    def __init__(self, lib):
        _DynamicMethod.__init__(self, lib)
        self._supports_kwargs_supports_kwargs = RunKeyword(lib).supports_kwargs
 
    def _handle_return_value(self, value):
        if value is None:
            if self._supports_kwargs_supports_kwargs:
                return ['*varargs', '**kwargs']
            return ['*varargs']
        return self._to_list_of_strings_to_list_of_strings(value)
 
 
class GetKeywordTypes(_DynamicMethod):
    
    _underscore_name = 'get_keyword_types'
 
    def _handle_return_value(self, value):
        return value
 
 
class GetKeywordTags(_DynamicMethod):
    
    _underscore_name = 'get_keyword_tags'
 
    def _handle_return_value(self, value):
        return self._to_list_of_strings_to_list_of_strings(value or [])