namespace.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 copy
import os
from collections import OrderedDict
from itertools import chain
 
from robot.errors import DataError, KeywordError
from robot.libraries import STDLIBS
from robot.output import LOGGER, Message
from robot.utils import (RecommendationFinder, eq, find_file, is_string, normalize,
                         printable_name, seq2str2)
 
from .context import EXECUTION_CONTEXTS
from .importer import ImportCache, Importer
from .model import Import
from .runkwregister import RUN_KW_REGISTER
from .usererrorhandler import UserErrorHandler
from .userkeyword import UserLibrary
 
IMPORTER = Importer()
 
 
class Namespace:
    
    _default_libraries = ('BuiltIn', 'Reserved', 'Easter')
    
    _library_import_by_path_ends = ('.py', '/', os.sep)
    
    _variables_import_by_path_ends = _library_import_by_path_ends + ('.yaml', '.yml')
 
    def __init__(self, variables, suite, resource, languages):
        LOGGER.info(f"Initializing namespace for suite '{suite.longname}'.")
        self.variablesvariables = variables
        self.languageslanguages = languages
        self._imports_imports = resource.imports
        self._kw_store_kw_store = KeywordStore(resource, languages)
        self._imported_variable_files_imported_variable_files = ImportCache()
        self._suite_name_suite_name = suite.longname
        self._running_test_running_test = False
 
    @property
    libraries = property
    
    def libraries(self):
        return self._kw_store_kw_store.libraries.values()
 
    def handle_imports(self):
        self._import_default_libraries_import_default_libraries()
        self._handle_imports_handle_imports(self._imports_imports)
 
    def _import_default_libraries(self):
        for name in self._default_libraries_default_libraries:
            self.import_libraryimport_library(name, notify=name == 'BuiltIn')
 
    def _handle_imports(self, import_settings):
        for item in import_settings:
            try:
                if not item.name:
                    raise DataError(f'{item.type} setting requires value.')
                self._import_import(item)
            except DataError as err:
                item.report_invalid_syntax(err.message)
 
    def _import(self, import_setting):
        action = {'Library': self._import_library_import_library,
                  'Resource': self._import_resource_import_resource,
                  'Variables': self._import_variables_import_variables}[import_setting.type]
        action(import_setting)
 
    def import_resource(self, name, overwrite=True):
        self._import_resource_import_resource(Import('Resource', name), overwrite=overwrite)
 
    def _import_resource(self, import_setting, overwrite=False):
        path = self._resolve_name_resolve_name(import_setting)
        self._validate_not_importing_init_file_validate_not_importing_init_file(path)
        if overwrite or path not in self._kw_store_kw_store.resources:
            resource = IMPORTER.import_resource(path, self.languageslanguages)
            self.variablesvariables.set_from_variable_table(resource.variables, overwrite)
            user_library = UserLibrary(resource)
            self._kw_store_kw_store.resources[path] = user_library
            self._handle_imports_handle_imports(resource.imports)
            LOGGER.imported("Resource", user_library.name,
                            importer=import_setting.source,
                            source=path)
        else:
            LOGGER.info(f"Resource file '{path}' already imported by "
                        f"suite '{self._suite_name}'.")
 
    def _validate_not_importing_init_file(self, path):
        name = os.path.splitext(os.path.basename(path))[0]
        if name.lower() == '__init__':
            raise DataError(f"Initialization file '{path}' cannot be imported as "
                            f"a resource file.")
 
    def import_variables(self, name, args, overwrite=False):
        self._import_variables_import_variables(Import('Variables', name, args), overwrite)
 
    def _import_variables(self, import_setting, overwrite=False):
        path = self._resolve_name_resolve_name(import_setting)
        args = self._resolve_args_resolve_args(import_setting)
        if overwrite or (path, args) not in self._imported_variable_files_imported_variable_files:
            self._imported_variable_files_imported_variable_files.add((path, args))
            self.variablesvariables.set_from_file(path, args, overwrite)
            LOGGER.imported("Variables", os.path.basename(path),
                            args=list(args),
                            importer=import_setting.source,
                            source=path)
        else:
            msg = f"Variable file '{path}'"
            if args:
                msg += f" with arguments {seq2str2(args)}"
            LOGGER.info(f"{msg} already imported by suite '{self._suite_name}'.")
 
    def import_library(self, name, args=(), alias=None, notify=True):
        self._import_library_import_library(Import('Library', name, args, alias),
                             notify=notify)
 
    def _import_library(self, import_setting, notify=True):
        name = self._resolve_name_resolve_name(import_setting)
        lib = IMPORTER.import_library(name, import_setting.args,
                                      import_setting.alias, self.variablesvariables)
        if lib.name in self._kw_store_kw_store.libraries:
            LOGGER.info(f"Library '{lib.name}' already imported by suite "
                        f"'{self._suite_name}'.")
            return
        if notify:
            LOGGER.imported("Library", lib.name,
                            args=list(import_setting.args),
                            originalname=lib.orig_name,
                            importer=import_setting.source,
                            source=lib.source)
        self._kw_store_kw_store.libraries[lib.name] = lib
        lib.start_suite()
        if self._running_test_running_test:
            lib.start_test()
 
    def _resolve_name(self, setting):
        name = setting.name
        try:
            name = self.variablesvariables.replace_string(name)
        except DataError as err:
            self._raise_replacing_vars_failed_raise_replacing_vars_failed(setting, err)
        if self._is_import_by_path_is_import_by_path(setting.type, name):
            return find_file(name, setting.directory, file_type=setting.type)
        return name
 
    def _raise_replacing_vars_failed(self, setting, error):
        raise DataError(f"Replacing variables from setting '{setting.type}' "
                        f"failed: {error}")
 
    def _is_import_by_path(self, import_type, path):
        if import_type == 'Library':
            return path.lower().endswith(self._library_import_by_path_ends_library_import_by_path_ends)
        if import_type == 'Variables':
            return path.lower().endswith(self._variables_import_by_path_ends_variables_import_by_path_ends)
        return True
 
    def _resolve_args(self, import_setting):
        try:
            return self.variablesvariables.replace_list(import_setting.args)
        except DataError as err:
            self._raise_replacing_vars_failed_raise_replacing_vars_failed(import_setting, err)
 
    def set_search_order(self, new_order):
        old_order = self._kw_store_kw_store.search_order
        self._kw_store_kw_store.search_order = new_order
        return old_order
 
    def start_test(self):
        self._running_test_running_test = True
        self.variablesvariables.start_test()
        for lib in self.librarieslibrarieslibraries:
            lib.start_test()
 
    def end_test(self):
        self.variablesvariables.end_test()
        for lib in self.librarieslibrarieslibraries:
            lib.end_test()
        self._running_test_running_test = True
 
    def start_suite(self):
        self.variablesvariables.start_suite()
 
    def end_suite(self, suite):
        for lib in self.librarieslibrarieslibraries:
            lib.end_suite()
        if not suite.parent:
            IMPORTER.close_global_library_listeners()
        self.variablesvariables.end_suite()
 
    def start_user_keyword(self):
        self.variablesvariables.start_keyword()
 
    def end_user_keyword(self):
        self.variablesvariables.end_keyword()
 
    def get_library_instance(self, libname):
        return self._kw_store_kw_store.get_library(libname).get_instance()
 
    def get_library_instances(self):
        return dict((name, lib.get_instance())
                    for name, lib in self._kw_store_kw_store.libraries.items())
 
    def reload_library(self, libname_or_instance):
        library = self._kw_store_kw_store.get_library(libname_or_instance)
        library.reload()
        return library
 
    def get_runner(self, name, recommend_on_failure=True):
        try:
            return self._kw_store_kw_store.get_runner(name, recommend_on_failure)
        except DataError as error:
            return UserErrorHandler(error, name)
 
 
class KeywordStore:
 
    def __init__(self, resource, languages):
        self.user_keywordsuser_keywords = UserLibrary(resource, resource_file=False)
        self.librarieslibraries = OrderedDict()
        self.resourcesresources = ImportCache()
        self.search_ordersearch_order = ()
        self.languageslanguages = languages
 
    def get_library(self, name_or_instance):
        if name_or_instance is None:
            raise DataError("Library can not be None.")
        if is_string(name_or_instance):
            return self._get_lib_by_name_get_lib_by_name(name_or_instance)
        return self._get_lib_by_instance_get_lib_by_instance(name_or_instance)
 
    def _get_lib_by_name(self, name):
        if name in self.librarieslibraries:
            return self.librarieslibraries[name]
        matches = [lib for lib in self.librarieslibraries.values() if eq(lib.name, name)]
        if len(matches) == 1:
            return matches[0]
        self._no_library_found_no_library_found(name, multiple=bool(matches))
 
    def _no_library_found(self, name, multiple=False):
        if multiple:
            raise DataError(f"Multiple libraries matching '{name}' found.")
        raise DataError(f"No library '{name}' found.")
 
    def _get_lib_by_instance(self, instance):
        for lib in self.librarieslibraries.values():
            if lib.get_instance(create=False) is instance:
                return lib
        self._no_library_found_no_library_found(instance)
 
    def get_runner(self, name, recommend=True):
        runner = self._get_runner_get_runner(name)
        if runner is None:
            self._raise_no_keyword_found_raise_no_keyword_found(name, recommend)
        return runner
 
    def _raise_no_keyword_found(self, name, recommend=True):
        if name.strip(': ').upper() == 'FOR':
            raise KeywordError(
                f"Support for the old FOR loop syntax has been removed. "
                f"Replace '{name}' with 'FOR', end the loop with 'END', and "
                f"remove escaping backslashes."
            )
        if name == '\\':
            raise KeywordError(
                "No keyword with name '\\' found. If it is used inside a for "
                "loop, remove escaping backslashes and end the loop with 'END'."
            )
        message = f"No keyword with name '{name}' found."
        if recommend:
            finder = KeywordRecommendationFinder(self.user_keywordsuser_keywords,
                                                 self.librarieslibraries,
                                                 self.resourcesresources)
            raise KeywordError(finder.recommend_similar_keywords(name, message))
        else:
            raise KeywordError(message)
 
    def _get_runner(self, name):
        if not name:
            raise DataError('Keyword name cannot be empty.', syntax=True)
        if not is_string(name):
            raise DataError('Keyword name must be a string.', syntax=True)
        runner = self._get_runner_from_suite_file_get_runner_from_suite_file(name)
        if not runner and '.' in name:
            runner = self._get_explicit_runner_get_explicit_runner(name)
        if not runner:
            runner = self._get_implicit_runner_get_implicit_runner(name)
        if not runner:
            runner = self._get_bdd_style_runner_get_bdd_style_runner(name, self.languageslanguages.bdd_prefixes)
        return runner
 
    def _get_bdd_style_runner(self, name, prefixes):
        parts = name.split()
        for index in range(1, len(parts)):
            prefix = ' '.join(parts[:index]).title()
            if prefix in prefixes:
                runner = self._get_runner_get_runner(' '.join(parts[index:]))
                if runner:
                    runner = copy.copy(runner)
                    runner.name = name
                    return runner
        return None
 
    def _get_implicit_runner(self, name):
        runner = self._get_runner_from_resource_files_get_runner_from_resource_files(name)
        if not runner:
            runner = self._get_runner_from_libraries_get_runner_from_libraries(name)
        return runner
 
    def _get_runner_from_suite_file(self, name):
        if name not in self.user_keywordsuser_keywords.handlers:
            return None
        handlers = self.user_keywordsuser_keywords.handlers.get_handlers(name)
        if len(handlers) > 1:
            handlers = self._select_best_matches_select_best_matches(handlers)
            if len(handlers) > 1:
                self._raise_multiple_keywords_found_raise_multiple_keywords_found(handlers, name)
        runner = handlers[0].create_runner(name, self.languageslanguages)
        ctx = EXECUTION_CONTEXTS.current
        caller = ctx.user_keywords[-1] if ctx.user_keywords else ctx.test
        if caller and runner.source != caller.source:
            if self._exists_in_resource_file_exists_in_resource_file(name, caller.source):
                message = (
                    f"Keyword '{caller.longname}' called keyword '{name}' that exists "
                    f"both in the same resource file as the caller and in the suite "
                    f"file using that resource. The keyword in the suite file is used "
                    f"now, but this will change in Robot Framework 6.0."
                )
                runner.pre_run_messages += Message(message, level='WARN'),
        return runner
 
    def _select_best_matches(self, handlers):
        # "Normal" matches are considered exact and win over embedded matches.
        normal = [hand for hand in handlers if not hand.supports_embedded_args]
        if normal:
            return normal
        matches = [hand for hand in handlers
                   if not self._is_worse_match_than_others_is_worse_match_than_others(hand, handlers)]
        return matches or handlers
 
    def _is_worse_match_than_others(self, candidate, alternatives):
        for other in alternatives:
            if (candidate is not other
                    and self._is_better_match_is_better_match(other, candidate)
                    and not self._is_better_match_is_better_match(candidate, other)):
                return True
        return False
 
    def _is_better_match(self, candidate, other):
        # Embedded match is considered better than another if the other matches
        # it, but it doesn't match the other.
        return other.matches(candidate.name) and not candidate.matches(other.name)
 
    def _exists_in_resource_file(self, name, source):
        for resource in self.resourcesresources.values():
            if resource.source == source and name in resource.handlers:
                return True
        return False
 
    def _get_runner_from_resource_files(self, name):
        handlers = [handler for res in self.resourcesresources.values()
                    for handler in res.handlers_for(name)]
        if not handlers:
            return None
        if len(handlers) > 1:
            handlers = self._prioritize_same_file_or_public_prioritize_same_file_or_public(handlers)
            if len(handlers) > 1:
                handlers = self._select_best_matches_select_best_matches(handlers)
                if len(handlers) > 1:
                    handlers = self._filter_based_on_search_order_filter_based_on_search_order(handlers)
        if len(handlers) != 1:
            self._raise_multiple_keywords_found_raise_multiple_keywords_found(handlers, name)
        return handlers[0].create_runner(name, self.languageslanguages)
 
    def _get_runner_from_libraries(self, name):
        handlers = [handler for lib in self.librarieslibraries.values()
                    for handler in lib.handlers_for(name)]
        if not handlers:
            return None
        pre_run_message = None
        if len(handlers) > 1:
            handlers = self._select_best_matches_select_best_matches(handlers)
            if len(handlers) > 1:
                handlers = self._filter_based_on_search_order_filter_based_on_search_order(handlers)
                if len(handlers) > 1:
                    handlers, pre_run_message = self._filter_stdlib_handler_filter_stdlib_handler(handlers)
        if len(handlers) != 1:
            self._raise_multiple_keywords_found_raise_multiple_keywords_found(handlers, name)
        runner = handlers[0].create_runner(name, self.languageslanguages)
        if pre_run_message:
            runner.pre_run_messages += (pre_run_message,)
        return runner
 
    def _prioritize_same_file_or_public(self, handlers):
        user_keywords = EXECUTION_CONTEXTS.current.user_keywords
        if user_keywords:
            parent_source = user_keywords[-1].source
            matches = [h for h in handlers if h.source == parent_source]
            if matches:
                return matches
        matches = [handler for handler in handlers if not handler.private]
        return matches or handlers
 
    def _filter_based_on_search_order(self, handlers):
        for libname in self.search_ordersearch_order:
            matches = [hand for hand in handlers if eq(libname, hand.libname)]
            if matches:
                return matches
        return handlers
 
    def _filter_stdlib_handler(self, handlers):
        warning = None
        if len(handlers) != 2:
            return handlers, warning
        stdlibs_without_remote = STDLIBS - {'Remote'}
        if handlers[0].library.orig_name in stdlibs_without_remote:
            standard, custom = handlers
        elif handlers[1].library.orig_name in stdlibs_without_remote:
            custom, standard = handlers
        else:
            return handlers, warning
        if not RUN_KW_REGISTER.is_run_keyword(custom.library.orig_name, custom.name):
            warning = self._custom_and_standard_keyword_conflict_warning_custom_and_standard_keyword_conflict_warning(custom, standard)
        return [custom], warning
 
    def _custom_and_standard_keyword_conflict_warning(self, custom, standard):
        custom_with_name = standard_with_name = ''
        if custom.library.name != custom.library.orig_name:
            custom_with_name = f" imported as '{custom.library.name}'"
        if standard.library.name != standard.library.orig_name:
            standard_with_name = f" imported as '{standard.library.name}'"
        return Message(
            f"Keyword '{standard.name}' found both from a custom library "
            f"'{custom.library.orig_name}'{custom_with_name} and a standard library "
            f"'{standard.library.orig_name}'{standard_with_name}. The custom keyword "
            f"is used. To select explicitly, and to get rid of this warning, use "
            f"either '{custom.longname}' or '{standard.longname}'.", level='WARN'
        )
 
    def _get_explicit_runner(self, name):
        handlers_and_names = [
            (handler, kw_name)
            for owner_name, kw_name in self._yield_owner_and_kw_names_yield_owner_and_kw_names(name)
            for handler in self._yield_handlers_yield_handlers(owner_name, kw_name)
        ]
        if not handlers_and_names:
            return None
        if len(handlers_and_names) == 1:
            handler, kw_name = handlers_and_names[0]
        else:
            handlers = [h for h, n in handlers_and_names]
            matches = self._select_best_matches_select_best_matches(handlers)
            if len(matches) > 1:
                self._raise_multiple_keywords_found_raise_multiple_keywords_found(handlers, name, implicit=False)
            handler, kw_name = handlers_and_names[handlers.index(matches[0])]
        return handler.create_runner(kw_name, self.languageslanguages)
 
    def _yield_owner_and_kw_names(self, full_name):
        tokens = full_name.split('.')
        for i in range(1, len(tokens)):
            yield '.'.join(tokens[:i]), '.'.join(tokens[i:])
 
    def _yield_handlers(self, owner_name, name):
        for owner in chain(self.librarieslibraries.values(), self.resourcesresources.values()):
            if eq(owner.name, owner_name) and name in owner.handlers:
                yield from owner.handlers.get_handlers(name)
 
    def _raise_multiple_keywords_found(self, handlers, name, implicit=True):
        if any(hand.supports_embedded_args for hand in handlers):
            error = f"Multiple keywords matching name '{name}' found"
        else:
            error = f"Multiple keywords with name '{name}' found"
            if implicit:
                error += ". Give the full name of the keyword you want to use"
        names = sorted(hand.longname for hand in handlers)
        raise KeywordError('\n    '.join([error+':'] + names))
 
 
class KeywordRecommendationFinder:
 
    def __init__(self, user_keywords, libraries, resources):
        self.user_keywordsuser_keywords = user_keywords
        self.librarieslibraries = libraries
        self.resourcesresources = resources
 
    
    def recommend_similar_keywords(self, name, message):
        candidates = self._get_candidates_get_candidates('.' in name)
        finder = RecommendationFinder(
            lambda name: normalize(candidates.get(name, name), ignore='_')
        )
        return finder.find_and_format(name, candidates, message,
                                      check_missing_argument_separator=True)
 
    @staticmethod
    def format_recommendations(message, recommendations):
        return RecommendationFinder().format(message, recommendations)
 
    def _get_candidates(self, use_full_name):
        names = {}
        for owner, name in self._get_all_handler_names_get_all_handler_names():
            full_name = f'{owner}.{name}' if owner else name
            names[full_name] = full_name if use_full_name else name
        return names
 
    
    def _get_all_handler_names(self):
        handlers = [('', printable_name(handler.name, True))
                    for handler in self.user_keywordsuser_keywords.handlers]
        for library in chain(self.librarieslibraries.values(), self.resourcesresources.values()):
            if library.name != 'Reserved':
                handlers.extend(
                    ((library.name or '',
                      printable_name(handler.name, code_style=True))
                     for handler in library.handlers))
        return sorted(handlers)