Source code for robot.parsing.lexer.sections

#  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 normalize_whitespace

from .tokens import Token


[docs]class Sections(object):
    setting_markers = ('Settings', 'Setting')
    variable_markers = ('Variables', 'Variable')
    test_case_markers = ('Test Cases', 'Test Case', 'Tasks', 'Task')
    keyword_markers = ('Keywords', 'Keyword')
    comment_markers = ('Comments', 'Comment')

[docs]    def setting(self, statement):
        return self._handles(statement, self.setting_markers)

[docs]    def variable(self, statement):
        return self._handles(statement, self.variable_markers)

[docs]    def test_case(self, statement):
        return False

[docs]    def keyword(self, statement):
        return self._handles(statement, self.keyword_markers)

[docs]    def comment(self, statement):
        return self._handles(statement, self.comment_markers)

    def _handles(self, statement, markers):
        marker = statement[0].value
        return marker.startswith('*') and self._normalize(marker) in markers

    def _normalize(self, marker):
        return normalize_whitespace(marker).strip('* ').title()

[docs]    def lex_invalid(self, statement):
        message, fatal = self._get_invalid_section_error(statement[0].value)
        statement[0].set_error(message, fatal)
        for token in statement[1:]:
            token.type = Token.COMMENT

    def _get_invalid_section_error(self, header):
        raise NotImplementedError


[docs]class TestCaseFileSections(Sections):

[docs]    def test_case(self, statement):
        return self._handles(statement, self.test_case_markers)

    def _get_invalid_section_error(self, header):
        return ("Unrecognized section header '%s'. Valid sections: "
                "'Settings', 'Variables', 'Test Cases', 'Tasks', "
                "'Keywords' and 'Comments'." % header), False


[docs]class ResourceFileSections(Sections):

    def _get_invalid_section_error(self, header):
        name = self._normalize(header)
        if name in self.test_case_markers:
            message = "Resource file with '%s' section is invalid." % name
            fatal = True
        else:
            message = ("Unrecognized section header '%s'. Valid sections: "
                       "'Settings', 'Variables', 'Keywords' and 'Comments'."
                       % header)
            fatal = False
        return message, fatal


[docs]class InitFileSections(Sections):

    def _get_invalid_section_error(self, header):
        name = self._normalize(header)
        if name in self.test_case_markers:
            message = ("'%s' section is not allowed in suite initialization "
                       "file." % name)
        else:
            message = ("Unrecognized section header '%s'. Valid sections: "
                       "'Settings', 'Variables', 'Keywords' and 'Comments'."
                       % header)
        return message, False