tagstatistics.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 itertools import chain
import re
 
from robot.utils import NormalizedDict
 
from .stats import CombinedTagStat, TagStat
from .tags import TagPatterns
 
 
 
class TagStatistics:
 
    def __init__(self, combined_stats):
        #: Dictionary, where key is the name of the tag as a string and value
        #: is an instance of :class:`~robot.model.stats.TagStat`.
        self.tagstags = NormalizedDict(ignore='_')
        #: List of :class:`~robot.model.stats.CombinedTagStat` objects.
        self.combinedcombined = combined_stats
 
    def visit(self, visitor):
        visitor.visit_tag_statistics(self)
 
    def __iter__(self):
        return iter(sorted(chain(self.combinedcombined, self.tagstags.values())))
 
 
class TagStatisticsBuilder:
 
    def __init__(self, included=None, excluded=None, combined=None, docs=None,
                 links=None):
        self._included_included = TagPatterns(included)
        self._excluded_excluded = TagPatterns(excluded)
        self._reserved_reserved = TagPatterns('robot:*')
        self._info_info = TagStatInfo(docs, links)
        self.statsstats = TagStatistics(self._info_info.get_combined_stats(combined))
 
    def add_test(self, test):
        self._add_tags_to_statistics_add_tags_to_statistics(test)
        self._add_to_combined_statistics_add_to_combined_statistics(test)
 
    def _add_tags_to_statistics(self, test):
        for tag in test.tags:
            if self._is_included_is_included(tag) and not self._suppress_reserved_suppress_reserved(tag):
                if tag not in self.statsstats.tags:
                    self.statsstats.tags[tag] = self._info_info.get_stat(tag)
                self.statsstats.tags[tag].add_test(test)
 
    def _is_included(self, tag):
        if self._included_included and tag not in self._included_included:
            return False
        return tag not in self._excluded_excluded
 
    def _suppress_reserved(self, tag):
        return tag in self._reserved_reserved and tag not in self._included_included
 
    def _add_to_combined_statistics(self, test):
        for stat in self.statsstats.combined:
            if stat.match(test.tags):
                stat.add_test(test)
 
 
class TagStatInfo:
 
    def __init__(self, docs=None, links=None):
        self._docs_docs = [TagStatDoc(*doc) for doc in docs or []]
        self._links_links = [TagStatLink(*link) for link in links or []]
 
    def get_stat(self, tag):
        return TagStat(tag, self.get_docget_doc(tag), self.get_linksget_links(tag))
 
    def get_combined_stats(self, combined=None):
        return [self._get_combined_stat_get_combined_stat(*comb) for comb in combined or []]
 
    def _get_combined_stat(self, pattern, name=None):
        name = name or pattern
        return CombinedTagStat(pattern, name, self.get_docget_doc(name),
                               self.get_linksget_links(name))
 
    def get_doc(self, tag):
        return ' & '.join(doc.text for doc in self._docs_docs if doc.match(tag))
 
    def get_links(self, tag):
        return [link.get_link(tag) for link in self._links_links if link.match(tag)]
 
 
class TagStatDoc:
 
    def __init__(self, pattern, doc):
        self._matcher_matcher = TagPatterns(pattern)
        self.texttext = doc
 
    def match(self, tag):
        return self._matcher_matcher.match(tag)
 
 
class TagStatLink:
    
    _match_pattern_tokenizer = re.compile(r'(\*|\?+)')
 
    def __init__(self, pattern, link, title):
        self._regexp_regexp = self._get_match_regexp_get_match_regexp(pattern)
        self._link_link = link
        self._title_title = title.replace('_', ' ')
 
    def match(self, tag):
        return self._regexp_regexp.match(tag) is not None
 
    def get_link(self, tag):
        match = self._regexp_regexp.match(tag)
        if not match:
            return None
        link, title = self._replace_groups_replace_groups(self._link_link, self._title_title, match)
        return link, title
 
    def _replace_groups(self, link, title, match):
        for index, group in enumerate(match.groups()):
            placefolder = '%%%d' % (index+1)
            link = link.replace(placefolder, group)
            title = title.replace(placefolder, group)
        return link, title
 
    def _get_match_regexp(self, pattern):
        pattern = '^%s$' % ''.join(self._yield_match_pattern_yield_match_pattern(pattern))
        return re.compile(pattern, re.IGNORECASE)
 
    def _yield_match_pattern(self, pattern):
        for token in self._match_pattern_tokenizer_match_pattern_tokenizer.split(pattern):
            if token.startswith('?'):
                yield '(%s)' % ('.'*len(token))
            elif token == '*':
                yield '(.*)'
            else:
                yield re.escape(token)