handlers.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 copy import copy
 
from robotide.lib.robot.utils import (getdoc, getshortdoc, is_java_init, is_java_method,
                         is_list_like, printable_name, split_tags_from_doc,
                         type_name)
from robotide.lib.robot.errors import DataError
from robotide.lib.robot.model import Tags
 
from .arguments import (ArgumentSpec, DynamicArgumentParser,
                        JavaArgumentCoercer, JavaArgumentParser,
                        PythonArgumentParser)
from .dynamicmethods import GetKeywordTypes
from .librarykeywordrunner import (EmbeddedArgumentsRunner,
                                   LibraryKeywordRunner, RunKeywordRunner)
from .runkwregister import RUN_KW_REGISTER
 
 
def Handler(library, name, method):
    if RUN_KW_REGISTER.is_run_keyword(library.orig_name, name):
        return _RunKeywordHandler(library, name, method)
    if is_java_method(method):
        return _JavaHandler(library, name, method)
    else:
        return _PythonHandler(library, name, method)
 
 
def DynamicHandler(library, name, method, doc, argspec, tags=None):
    if RUN_KW_REGISTER.is_run_keyword(library.orig_name, name):
        return _DynamicRunKeywordHandler(library, name, method, doc, argspec, tags)
    return _DynamicHandler(library, name, method, doc, argspec, tags)
 
 
def InitHandler(library, method, docgetter=None):
    Init = _PythonInitHandler if not is_java_init(method) else _JavaInitHandler
    return Init(library, '__init__', method, docgetter)
 
 
class _RunnableHandler():
 
    def __init__(self, library, handler_name, handler_method, doc='', tags=None):
        self.librarylibrary = library
        self._handler_name_handler_name = handler_name
        self.namename = self._get_name_get_name(handler_name, handler_method)
        self.argumentsarguments = self._parse_arguments_parse_arguments(handler_method)
        self._method_method = self._get_initial_handler_get_initial_handler(library, handler_name,
                                                 handler_method)
        doc, tags_from_doc = split_tags_from_doc(doc or '')
        tags_from_attr = self._get_tags_from_attribute_get_tags_from_attribute(handler_method)
        self._doc_doc = doc
        self.tagstags = Tags(tuple(tags_from_doc) +
                         tuple(tags_from_attr) +
                         tuple(tags or ()))
 
    def _get_name(self, handler_name, handler_method):
        robot_name = getattr(handler_method, 'robot_name', None)
        name = robot_name or printable_name(handler_name, code_style=True)
        if not name:
            raise DataError('Keyword name cannot be empty.')
        return name
 
    def _parse_arguments(self, handler_method):
        raise NotImplementedError
 
    def _get_tags_from_attribute(self, handler_method):
        tags = getattr(handler_method, 'robot_tags', ())
        if not is_list_like(tags):
            raise DataError("Expected tags to be list-like, got %s."
                            % type_name(tags))
        return tags
 
    def _get_initial_handler(self, library, name, method):
        if library.scope.is_global:
            return self._get_global_handler_get_global_handler(method, name)
        return None
 
    def resolve_arguments(self, args, variables=None):
        return self.argumentsarguments.resolve(args, variables)
 
    @property
    doc = property
    
    def doc(self):
        return self._doc_doc
 
    @property
    longname = property
    
    def longname(self):
        return '%s.%s' % (self.librarylibrary.name, self.namename)
 
    @property
    shortdoc = property
    
    def shortdoc(self):
        return getshortdoc(self.docdocdoc)
 
    @property
    libname = property
    
    def libname(self):
        return self.librarylibrary.name
 
    def create_runner(self, name):
        return LibraryKeywordRunner(self)
 
    def current_handler(self):
        if self._method_method:
            return self._method_method
        return self._get_handler_get_handler(self.librarylibrary.get_instance(), self._handler_name_handler_name)
 
    def _get_global_handler(self, method, name):
        return method
 
    def _get_handler(self, lib_instance, handler_name):
        return getattr(lib_instance, handler_name)
 
 
class _PythonHandler(_RunnableHandler):
 
    def __init__(self, library, handler_name, handler_method):
        _RunnableHandler.__init__(self, library, handler_name, handler_method,
                                  getdoc(handler_method))
 
    def _parse_arguments(self, handler_method):
        return PythonArgumentParser().parse(handler_method, self.longnamelongnamelongname)
 
 
class _JavaHandler(_RunnableHandler):
 
    def __init__(self, library, handler_name, handler_method):
        _RunnableHandler.__init__(self, library, handler_name, handler_method)
        signatures = self._get_signatures_get_signatures(handler_method)
        self._arg_coercer_arg_coercer = JavaArgumentCoercer(signatures, self.argumentsarguments)
 
    def _parse_arguments(self, handler_method):
        signatures = self._get_signatures_get_signatures(handler_method)
        return JavaArgumentParser().parse(signatures, self.longnamelongnamelongname)
 
    def _get_signatures(self, handler):
        code_object = getattr(handler, 'im_func', handler)
        return code_object.argslist[:code_object.nargs]
 
    def resolve_arguments(self, args, variables=None):
        positional, named = self.argumentsarguments.resolve(args, variables,
                                                   dict_to_kwargs=True)
        arguments = self._arg_coercer_arg_coercer.coerce(positional, named,
                                             dryrun=not variables)
        return arguments, []
 
 
class _DynamicHandler(_RunnableHandler):
 
    def __init__(self, library, handler_name, dynamic_method, doc='',
                 argspec=None, tags=None):
        self._argspec_argspec = argspec
        self._run_keyword_method_name_run_keyword_method_name = dynamic_method.name
        self._supports_kwargs_supports_kwargs = dynamic_method.supports_kwargs
        _RunnableHandler.__init__(self, library, handler_name,
                                  dynamic_method.method, doc, tags)
 
    def _parse_arguments(self, handler_method):
        spec = DynamicArgumentParser().parse(self._argspec_argspec, self.longnamelongnamelongname)
        if not self._supports_kwargs_supports_kwargs:
            if spec.kwargs:
                raise DataError("Too few '%s' method parameters for **kwargs "
                                "support." % self._run_keyword_method_name_run_keyword_method_name)
            if spec.kwonlyargs:
                raise DataError("Too few '%s' method parameters for "
                                "keyword-only arguments support."
                                % self._run_keyword_method_name_run_keyword_method_name)
        spec.types = GetKeywordTypes(self.librarylibrary.get_instance())(self._handler_name_handler_name)
        return spec
 
    def resolve_arguments(self, arguments, variables=None):
        positional, named = self.argumentsarguments.resolve(arguments, variables)
        if not self._supports_kwargs_supports_kwargs:
            positional, named = self.argumentsarguments.map(positional, named)
        return positional, named
 
    def _get_handler(self, lib_instance, handler_name):
        runner = getattr(lib_instance, self._run_keyword_method_name_run_keyword_method_name)
        return self._get_dynamic_handler_get_dynamic_handler(runner, handler_name)
 
    def _get_global_handler(self, method, name):
        return self._get_dynamic_handler_get_dynamic_handler(method, name)
 
    def _get_dynamic_handler(self, runner, name):
        def handler(*positional, **kwargs):
            if self._supports_kwargs_supports_kwargs:
                return runner(name, positional, kwargs)
            else:
                return runner(name, positional)
        return handler
 
 
class _RunKeywordHandler(_PythonHandler):
 
    def create_runner(self, name):
        default_dry_run_keywords = ('name' in self.argumentsarguments.positional and
                                    self._args_to_process_args_to_process_args_to_process)
        return RunKeywordRunner(self, default_dry_run_keywords)
 
    @property
    _args_to_process = property
    
    def _args_to_process(self):
        return RUN_KW_REGISTER.get_args_to_process(self.librarylibrary.orig_name,
                                                   self.namename)
 
    def resolve_arguments(self, args, variables=None):
        args_to_process = self._args_to_process_args_to_process_args_to_process
        return self.argumentsarguments.resolve(args, variables, resolve_named=False,
                                      resolve_variables_until=args_to_process)
 
 
class _DynamicRunKeywordHandler(_DynamicHandler, _RunKeywordHandler):
    
    _parse_arguments = _RunKeywordHandler._parse_arguments
    resolve_arguments = _RunKeywordHandler.resolve_arguments
 
 
class _PythonInitHandler(_PythonHandler):
 
    def __init__(self, library, handler_name, handler_method, docgetter):
        _PythonHandler.__init__(self, library, handler_name, handler_method)
        self._docgetter_docgetter = docgetter
 
    @property
    doc = property
    
    def doc(self):
        if self._docgetter_docgetter:
            self._doc_doc_doc = self._docgetter_docgetter() or self._doc_doc_doc
            self._docgetter_docgetter = None
        return self._doc_doc_doc
 
    def _parse_arguments(self, handler_method):
        parser = PythonArgumentParser(type='Test Library')
        return parser.parse(handler_method, self.librarylibrary.name)
 
 
class _JavaInitHandler(_JavaHandler):
 
    def __init__(self, library, handler_name, handler_method, docgetter):
        _JavaHandler.__init__(self, library, handler_name, handler_method)
        self._docgetter_docgetter = docgetter
 
    @property
    doc = property
    
    def doc(self):
        if self._docgetter_docgetter:
            self._doc_doc_doc = self._docgetter_docgetter() or self._doc_doc_doc
            self._docgetter_docgetter = None
        return self._doc_doc_doc
 
    def _parse_arguments(self, handler_method):
        parser = JavaArgumentParser(type='Test Library')
        signatures = self._get_signatures_get_signatures(handler_method)
        return parser.parse(signatures, self.librarylibrary.name)
 
 
class EmbeddedArgumentsHandler():
 
    def __init__(self, name_regexp, orig_handler):
        self.argumentsarguments = ArgumentSpec()  # Show empty argument spec for Libdoc
        self.name_regexpname_regexp = name_regexp
        self._orig_handler_orig_handler = orig_handler
 
    def __getattr__(self, item):
        return getattr(self._orig_handler_orig_handler, item)
 
    @property
    library = property
    
    def library(self):
        return self._orig_handler_orig_handler.library
 
    @library.setter
    
    def library(self, library):
        self._orig_handler_orig_handler.library = library
 
    def matches(self, name):
        return self.name_regexpname_regexp.match(name) is not None
 
    def create_runner(self, name):
        return EmbeddedArgumentsRunner(self, name)
 
    def __copy__(self):
        orig_handler = copy(self._orig_handler_orig_handler)
        return EmbeddedArgumentsHandler(self.name_regexpname_regexp, orig_handler)