Source code for robot.utils.restreader

#  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.errors import DataError

try:
    from docutils.core import publish_doctree
    from docutils.parsers.rst.directives import register_directive
    from docutils.parsers.rst.directives.body import CodeBlock
except ImportError:
    raise DataError("Using reStructuredText test data requires having "
                    "'docutils' module version 0.9 or newer installed.")


[docs]class CaptureRobotData(CodeBlock):
[docs] def run(self): if 'robotframework' in self.arguments: store = RobotDataStorage(self.state_machine.document) store.add_data(self.content) return []
register_directive('code', CaptureRobotData) register_directive('code-block', CaptureRobotData) register_directive('sourcecode', CaptureRobotData)
[docs]class RobotDataStorage(object): def __init__(self, doctree): if not hasattr(doctree, '_robot_data'): doctree._robot_data = [] self._robot_data = doctree._robot_data
[docs] def add_data(self, rows): self._robot_data.extend(rows)
[docs] def get_data(self): return '\n'.join(self._robot_data)
[docs] def has_data(self): return bool(self._robot_data)
[docs]def read_rest_data(rstfile): doctree = publish_doctree( rstfile.read(), source_path=rstfile.name, settings_overrides={ 'input_encoding': 'UTF-8', 'report_level': 4 }) store = RobotDataStorage(doctree) return store.get_data()