Source code for robot.variables.finders

#  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
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

import re

    from java.lang.System import getProperties as get_java_properties, getProperty
    get_java_property = lambda name: getProperty(name) if name else None
except ImportError:
    get_java_property = lambda name: None
    get_java_properties = lambda: {}

from robot.errors import DataError, VariableError
from robot.utils import (get_env_var, get_env_vars, get_error_message, normalize,

from .evaluation import evaluate_expression
from .notfound import variable_not_found
from .search import search_variable, VariableMatch

NOT_FOUND = object()

[docs]class VariableFinder(object): def __init__(self, variable_store): self._finders = (StoredFinder(variable_store), NumberFinder(), EmptyFinder(), InlinePythonFinder(variable_store), EnvironmentFinder(), ExtendedFinder(self)) self._store = variable_store
[docs] def find(self, variable): match = self._get_match(variable) name = for finder in self._finders: if match.identifier in finder.identifiers: result = finder.find(name) if result is not NOT_FOUND: return result variable_not_found(name,
def _get_match(self, variable): if isinstance(variable, VariableMatch): return variable match = search_variable(variable) if not match.is_variable() or match.items: raise DataError("Invalid variable name '%s'." % variable) return match
[docs]class StoredFinder(object): identifiers = '$@&' def __init__(self, store): self._store = store
[docs] def find(self, name): return self._store.get(name, NOT_FOUND)
[docs]class NumberFinder(object): identifiers = '$'
[docs] def find(self, name): number = normalize(name)[2:-1] for converter in self._get_int, float: try: return converter(number) except ValueError: pass return NOT_FOUND
def _get_int(self, number): bases = {'0b': 2, '0o': 8, '0x': 16} if number.startswith(tuple(bases)): return int(number[2:], bases[number[:2]]) return int(number)
[docs]class EmptyFinder(object): identifiers = '$@&' empty = NormalizedDict({'${EMPTY}': u'', '@{EMPTY}': (), '&{EMPTY}': {}}, ignore='_')
[docs] def find(self, name): return self.empty.get(name, NOT_FOUND)
[docs]class InlinePythonFinder(object): identifiers = '$@&' def __init__(self, variables): self._variables = variables
[docs] def find(self, name): base = name[2:-1] if not base or base[0] != '{' or base[-1] != '}': return NOT_FOUND try: return evaluate_expression(base[1:-1].strip(), self._variables) except DataError as err: raise VariableError("Resolving variable '%s' failed: %s" % (name, err))
[docs]class ExtendedFinder(object): identifiers = '$@&' _match_extended = re.compile(r''' (.+?) # base name (group 1) ([^\s\w].+) # extended part (group 2) ''', re.UNICODE|re.VERBOSE).match def __init__(self, finder): self._find_variable = finder.find
[docs] def find(self, name): match = self._match_extended(name[2:-1]) if match is None: return NOT_FOUND base_name, extended = match.groups() try: variable = self._find_variable('${%s}' % base_name) except DataError as err: raise VariableError("Resolving variable '%s' failed: %s" % (name, err.message)) try: return eval('_BASE_VAR_' + extended, {'_BASE_VAR_': variable}) except: raise VariableError("Resolving variable '%s' failed: %s" % (name, get_error_message()))
[docs]class EnvironmentFinder(object): identifiers = '%'
[docs] def find(self, name): var_name, has_default, default_value = name[2:-1].partition('=') for getter in get_env_var, get_java_property: value = getter(var_name) if value is not None: return value if has_default: # in case if '' is desired default value return default_value variable_not_found(name, self._get_candidates(), "Environment variable '%s' not found." % name)
def _get_candidates(self): candidates = dict(get_java_properties()) candidates.update(get_env_vars()) return candidates