Skip to content

embedded

EmbeddedArguments

Source code in src/robot/running/arguments/embedded.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class EmbeddedArguments:

    def __init__(self, name: re.Pattern,
                 args: Sequence[str] = (),
                 custom_patterns: 'Mapping[str, str]|None' = None):
        self.name = name
        self.args = tuple(args)
        self.custom_patterns = custom_patterns or None

    @classmethod
    def from_name(cls, name: str) -> 'EmbeddedArguments|None':
        return EmbeddedArgumentParser().parse(name) if '${' in name else None

    def match(self, name: str) -> 're.Match|None':
        return self.name.fullmatch(name)

    def map(self, args: Sequence[Any]) -> 'list[tuple[str, Any]]':
        self.validate(args)
        return list(zip(self.args, args))

    def validate(self, args: Sequence[Any]):
        """Validate that embedded args match custom regexps.

        Initial validation is done already when matching keywords, but this
        validation makes sure arguments match also if they are given as variables.

        Currently, argument not matching only causes a deprecation warning, but
        that will be changed to ``ValueError`` in RF 8.0:
        https://github.com/robotframework/robotframework/issues/4069
        """
        if not self.custom_patterns:
            return
        for name, value in zip(self.args, args):
            if name in self.custom_patterns and isinstance(value, str):
                pattern = self.custom_patterns[name]
                if not re.fullmatch(pattern, value):
                    # TODO: Change to `raise ValueError(...)` in RF 8.0.
                    context = EXECUTION_CONTEXTS.current
                    context.warn(f"Embedded argument '{name}' got value {value!r} "
                                 f"that does not match custom pattern {pattern!r}. "
                                 f"The argument is still accepted, but this behavior "
                                 f"will change in Robot Framework 8.0.")

validate(args)

Validate that embedded args match custom regexps.

Initial validation is done already when matching keywords, but this validation makes sure arguments match also if they are given as variables.

Currently, argument not matching only causes a deprecation warning, but that will be changed to ValueError in RF 8.0: #4069

Source code in src/robot/running/arguments/embedded.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def validate(self, args: Sequence[Any]):
    """Validate that embedded args match custom regexps.

    Initial validation is done already when matching keywords, but this
    validation makes sure arguments match also if they are given as variables.

    Currently, argument not matching only causes a deprecation warning, but
    that will be changed to ``ValueError`` in RF 8.0:
    https://github.com/robotframework/robotframework/issues/4069
    """
    if not self.custom_patterns:
        return
    for name, value in zip(self.args, args):
        if name in self.custom_patterns and isinstance(value, str):
            pattern = self.custom_patterns[name]
            if not re.fullmatch(pattern, value):
                # TODO: Change to `raise ValueError(...)` in RF 8.0.
                context = EXECUTION_CONTEXTS.current
                context.warn(f"Embedded argument '{name}' got value {value!r} "
                             f"that does not match custom pattern {pattern!r}. "
                             f"The argument is still accepted, but this behavior "
                             f"will change in Robot Framework 8.0.")