blockparsers.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 ..lexer import Token
from ..model import TestCase, Keyword, For, If, Try, While
 
 
 
class Parser:
 
    def __init__(self, model):
        self.modelmodel = model
 
    def handles(self, statement):
        raise NotImplementedError
 
    def parse(self, statement):
        raise NotImplementedError
 
 
class BlockParser(Parser):
    unhandled_tokens = Token.HEADER_TOKENS | frozenset((Token.TESTCASE_NAME,
                                                        Token.KEYWORD_NAME))
 
    def __init__(self, model):
        Parser.__init__(self, model)
        self.nested_parsersnested_parsers = {
            Token.FOR: ForParser,
            Token.IF: IfParser,
            Token.INLINE_IF: IfParser,
            Token.TRY: TryParser,
            Token.WHILE: WhileParser
        }
 
    def handles(self, statement):
        return statement.type not in self.unhandled_tokensunhandled_tokens
 
    def parse(self, statement):
        parser_class = self.nested_parsersnested_parsers.get(statement.type)
        if parser_class:
            parser = parser_class(statement)
            self.modelmodel.body.append(parser.model)
            return parser
        self.modelmodel.body.append(statement)
        return None
 
 
class TestCaseParser(BlockParser):
 
    def __init__(self, header):
        BlockParser.__init__(self, TestCase(header))
 
 
class KeywordParser(BlockParser):
 
    def __init__(self, header):
        BlockParser.__init__(self, Keyword(header))
 
 
class NestedBlockParser(BlockParser):
 
    def handles(self, statement):
        return BlockParser.handles(self, statement) and \
               not getattr(self.modelmodel, 'end', False)
 
    def parse(self, statement):
        if statement.type == Token.END:
            self.modelmodel.end = statement
            return None
        return BlockParser.parse(self, statement)
 
 
class ForParser(NestedBlockParser):
 
    def __init__(self, header):
        NestedBlockParser.__init__(self, For(header))
 
 
class IfParser(NestedBlockParser):
 
    def __init__(self, header, handle_end=True):
        super().__init__(If(header))
        self.handle_endhandle_end = handle_end
 
    def parse(self, statement):
        if statement.type in (Token.ELSE_IF, Token.ELSE):
            parser = IfParser(statement, handle_end=False)
            self.modelmodel.orelse = parser.model
            return parser
        return NestedBlockParser.parse(self, statement)
 
    def handles(self, statement):
        if statement.type == Token.END and not self.handle_endhandle_end:
            return False
        return super().handles(statement)
 
 
class TryParser(NestedBlockParser):
 
    def __init__(self, header, handle_end=True):
        super().__init__(Try(header))
        self.handle_endhandle_end = handle_end
 
    def parse(self, statement):
        if statement.type in (Token.EXCEPT, Token.ELSE, Token.FINALLY):
            parser = TryParser(statement, handle_end=False)
            self.modelmodel.next = parser.model
            return parser
        return super().parse(statement)
 
    def handles(self, statement):
        if statement.type == Token.END and not self.handle_endhandle_end:
            return False
        return super().handles(statement)
 
 
class WhileParser(NestedBlockParser):
 
    def __init__(self, header):
        super().__init__(While(header))