tags.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 robot.utils import is_string, normalize, NormalizedDict, Matcher
 
 
class Tags:
    __slots__ = ['_tags', '_reserved']
 
    def __init__(self, tags=None):
        self._tags, self._reserved_reserved = self._init_tags_init_tags(tags)
 
    
    def robot(self, name):
        return name in self._reserved_reserved
 
    def _init_tags(self, tags):
        if not tags:
            return (), ()
        if is_string(tags):
            tags = (tags,)
        return self._normalize_normalize(tags)
 
    def _normalize(self, tags):
        normalized = NormalizedDict([(str(t), None) for t in tags], ignore='_')
        if '' in normalized:
            del normalized['']
        if 'NONE' in normalized:
            del normalized['NONE']
        reserved = tuple(tag.split(':')[1] for tag in normalized._keys
                         if tag[:6] == 'robot:')
        return tuple(normalized), reserved
 
    def add(self, tags):
        self.__init____init__(tuple(self) + tuple(Tags(tags)))
 
    def remove(self, tags):
        tags = TagPatterns(tags)
        self.__init____init__([t for t in self if not tags.match(t)])
 
    def match(self, tags):
        return TagPatterns(tags).match(self)
 
    def __contains__(self, tags):
        return self.matchmatch(tags)
 
    def __len__(self):
        return len(self._tags)
 
    def __iter__(self):
        return iter(self._tags)
 
    def __str__(self):
        return '[%s]' % ', '.join(self)
 
    def __repr__(self):
        return repr(list(self))
 
    def __eq__(self, other):
        if not isinstance(other, Tags):
            other = Tags(other)
        self_normalized = [normalize(tag, ignore='_') for tag in self]
        other_normalized = [normalize(tag, ignore='_') for tag in other]
        return sorted(self_normalized) == sorted(other_normalized)
 
    def __getitem__(self, index):
        item = self._tags[index]
        return item if not isinstance(index, slice) else Tags(item)
 
    def __add__(self, other):
        return Tags(tuple(self) + tuple(Tags(other)))
 
 
class TagPatterns:
 
    def __init__(self, patterns):
        self._patterns_patterns = tuple(TagPattern(p) for p in Tags(patterns))
 
    def match(self, tags):
        if not self._patterns_patterns:
            return False
        tags = tags if isinstance(tags, Tags) else Tags(tags)
        return any(p.match(tags) for p in self._patterns_patterns)
 
    def __contains__(self, tag):
        return self.matchmatch(tag)
 
    def __len__(self):
        return len(self._patterns_patterns)
 
    def __iter__(self):
        return iter(self._patterns_patterns)
 
    def __getitem__(self, index):
        return self._patterns_patterns[index]
 
    def __str__(self):
        return '[%s]' % ', '.join(str(pattern) for pattern in self)
 
 
def TagPattern(pattern):
    pattern = pattern.replace(' ', '')
    if 'NOT' in pattern:
        return NotTagPattern(*pattern.split('NOT'))
    if 'OR' in pattern:
        return OrTagPattern(pattern.split('OR'))
    if 'AND' in pattern or '&' in pattern:
        return AndTagPattern(pattern.replace('&', 'AND').split('AND'))
    return SingleTagPattern(pattern)
 
 
class SingleTagPattern:
 
    def __init__(self, pattern):
        self._matcher_matcher = Matcher(pattern, ignore='_')
 
    def match(self, tags):
        return self._matcher_matcher.match_any(tags)
 
    def __iter__(self):
        yield self
 
    def __str__(self):
        return self._matcher_matcher.pattern
 
    def __bool__(self):
        return bool(self._matcher_matcher)
 
 
class AndTagPattern:
 
    def __init__(self, patterns):
        self._patterns_patterns = tuple(TagPattern(p) for p in patterns)
 
    def match(self, tags):
        return all(p.match(tags) for p in self._patterns_patterns)
 
    def __iter__(self):
        return iter(self._patterns_patterns)
 
    def __str__(self):
        return ' AND '.join(str(pattern) for pattern in self)
 
 
class OrTagPattern:
 
    def __init__(self, patterns):
        self._patterns_patterns = tuple(TagPattern(p) for p in patterns)
 
    def match(self, tags):
        return any(p.match(tags) for p in self._patterns_patterns)
 
    def __iter__(self):
        return iter(self._patterns_patterns)
 
    def __str__(self):
        return ' OR '.join(str(pattern) for pattern in self)
 
 
class NotTagPattern:
 
    def __init__(self, must_match, *must_not_match):
        self._first_first = TagPattern(must_match)
        self._rest_rest = OrTagPattern(must_not_match)
 
    def match(self, tags):
        if not self._first_first:
            return not self._rest_rest.match(tags)
        return self._first_first.match(tags) and not self._rest_rest.match(tags)
 
    def __iter__(self):
        yield self._first_first
        for pattern in self._rest_rest:
            yield pattern
 
    def __str__(self):
        return ' NOT '.join(str(pattern) for pattern in self).lstrip()