userkeyword.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.
 
import os
 
from robotide.lib.robot.errors import DataError
from robotide.lib.robot.output import LOGGER
from robotide.lib.robot.utils import getshortdoc, is_string, unic
 
from .builder import ResourceFileBuilder
from .arguments import EmbeddedArguments, UserKeywordArgumentParser
from .handlerstore import HandlerStore
from .userkeywordrunner import UserKeywordRunner, EmbeddedArgumentsRunner
from .usererrorhandler import UserErrorHandler
 
 
class UserLibrary():
    TEST_CASE_FILE_TYPE = HandlerStore.TEST_CASE_FILE_TYPE
    RESOURCE_FILE_TYPE = HandlerStore.RESOURCE_FILE_TYPE
 
    def __init__(self, source, source_type=RESOURCE_FILE_TYPE):
        if is_string(source):
            resource = ResourceFileBuilder().build(source)
        else:
            resource = source
        source = resource.source
        basename = os.path.basename(source) if source else None
        self.namename = os.path.splitext(basename)[0] \
            if source_type == self.RESOURCE_FILE_TYPERESOURCE_FILE_TYPE else None
        self.docdoc = resource.doc
        self.handlershandlers = HandlerStore(basename, source_type)
        self.sourcesource = source
        self.source_typesource_type = source_type
        for kw in resource.keywords:
            try:
                handler = self._create_handler_create_handler(kw)
            except DataError as error:
                handler = UserErrorHandler(error, kw.name, self.namename)
                self._log_creating_failed_log_creating_failed(handler, error)
            embedded = isinstance(handler, EmbeddedArgumentsHandler)
            try:
                self.handlershandlers.add(handler, embedded)
            except DataError as error:
                self._log_creating_failed_log_creating_failed(handler, error)
 
    def _create_handler(self, kw):
        embedded = EmbeddedArguments(kw.name)
        if not embedded:
            return UserKeywordHandler(kw, self.namename)
        if kw.args:
            raise DataError('Keyword cannot have both normal and embedded '
                            'arguments.')
        return EmbeddedArgumentsHandler(kw, self.namename, embedded)
 
    def _log_creating_failed(self, handler, error):
        LOGGER.error("Error in %s '%s': Creating keyword '%s' failed: %s"
                     % (self.source_typesource_type.lower(), self.sourcesource,
                        handler.name, error.message))
 
 
# TODO: Should be merged with running.model.UserKeyword
 
class UserKeywordHandler():
 
    def __init__(self, keyword, libname):
        self.namename = keyword.name
        self.libnamelibname = libname
        self.docdoc = unic(keyword.doc)
        self.tagstags = keyword.tags
        self.argumentsarguments = UserKeywordArgumentParser().parse(tuple(keyword.args),
                                                           self.longnamelongnamelongname)
        self._kw_kw = keyword
        self.timeouttimeout = keyword.timeout
        self.keywordskeywords = keyword.keywords.normal
        self.return_valuereturn_value = tuple(keyword.return_)
        self.teardownteardown = keyword.keywords.teardown
 
    @property
    longname = property
    
    def longname(self):
        return '%s.%s' % (self.libnamelibname, self.namename) if self.libnamelibname else self.namename
 
    @property
    shortdoc = property
    
    def shortdoc(self):
        return getshortdoc(self.docdoc)
 
    def create_runner(self, name):
        return UserKeywordRunner(self)
 
 
class EmbeddedArgumentsHandler(UserKeywordHandler):
 
    def __init__(self, keyword, libname, embedded):
        UserKeywordHandler.__init__(self, keyword, libname)
        self.keywordkeyword = keyword
        self.embedded_nameembedded_name = embedded.name
        self.embedded_argsembedded_args = embedded.args
 
    def matches(self, name):
        return self.embedded_nameembedded_name.match(name) is not None
 
    def create_runner(self, name):
        return EmbeddedArgumentsRunner(self, name)