fileparser.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.
 
import os.path
 
from robot.utils import is_pathlike, is_string
 
from ..lexer import Token
from ..model import (File, CommentSection, SettingSection, VariableSection,
                     TestCaseSection, KeywordSection)
 
from .blockparsers import Parser, TestCaseParser, KeywordParser
 
 
class FileParser(Parser):
 
    def __init__(self, source=None):
        super().__init__(File(source=self._get_path_get_path(source)))
 
    def _get_path(self, source):
        if not source:
            return None
        if is_string(source) and '\n' not in source and os.path.isfile(source):
            return source
        if is_pathlike(source) and source.is_file():
            return str(source)
        return None
 
    def handles(self, statement):
        return True
 
    def parse(self, statement):
        parser_class = {
            Token.SETTING_HEADER: SettingSectionParser,
            Token.VARIABLE_HEADER: VariableSectionParser,
            Token.TESTCASE_HEADER: TestCaseSectionParser,
            Token.TASK_HEADER: TestCaseSectionParser,
            Token.KEYWORD_HEADER: KeywordSectionParser,
            Token.COMMENT_HEADER: CommentSectionParser,
            Token.CONFIG: ImplicitCommentSectionParser,
            Token.COMMENT: ImplicitCommentSectionParser,
            Token.ERROR: ImplicitCommentSectionParser,
            Token.EOL: ImplicitCommentSectionParser
        }[statement.type]
        parser = parser_class(statement)
        self.modelmodel.sections.append(parser.model)
        return parser
 
 
class SectionParser(Parser):
    model_class = None
 
    def __init__(self, header):
        super().__init__(self.model_classmodel_class(header))
 
    def handles(self, statement):
        return statement.type not in Token.HEADER_TOKENS
 
    def parse(self, statement):
        self.modelmodel.body.append(statement)
        return None
 
 
class SettingSectionParser(SectionParser):
    model_class = SettingSection
 
 
class VariableSectionParser(SectionParser):
    model_class = VariableSection
 
 
class CommentSectionParser(SectionParser):
    model_class = CommentSection
 
 
class ImplicitCommentSectionParser(SectionParser):
 
    def model_class(self, statement):
        return CommentSection(body=[statement])
 
 
class TestCaseSectionParser(SectionParser):
    model_class = TestCaseSection
 
    def parse(self, statement):
        if statement.type == Token.TESTCASE_NAME:
            parser = TestCaseParser(statement)
            self.modelmodel.body.append(parser.model)
            return parser
        return SectionParser.parse(self, statement)
 
 
class KeywordSectionParser(SectionParser):
    model_class = KeywordSection
 
    def parse(self, statement):
        if statement.type == Token.KEYWORD_NAME:
            parser = KeywordParser(statement)
            self.modelmodel.body.append(parser.model)
            return parser
        return SectionParser.parse(self, statement)