Source code for robot.writer.datafilewriter

#  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
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

import os

from robot.errors import DataError
from robot.utils import binary_file_writer, file_writer, PY2

from .filewriters import FileWriter

[docs]class DataFileWriter(object): """Object to write parsed test data file objects back to disk.""" def __init__(self, **options): """ :param `**options`: A :class:`.WritingContext` is created based on these. """ self._options = options
[docs] def write(self, datafile): """Writes given `datafile` using `**options`. :param datafile: The parsed test data object to be written :type datafile: :py:class:`~robot.parsing.model.TestCaseFile`, :py:class:`~robot.parsing.model.ResourceFile`, :py:class:`~robot.parsing.model.TestDataDirectory` """ with WritingContext(datafile, **self._options) as ctx: FileWriter(ctx).write(datafile)
[docs]class WritingContext(object): """Contains configuration used in writing a test data file to disk.""" txt_format = 'txt' html_format = 'html' tsv_format = 'tsv' robot_format = 'robot' txt_column_count = 8 html_column_count = 5 tsv_column_count = 8 _formats = [txt_format, html_format, tsv_format, robot_format] def __init__(self, datafile, format='', output=None, pipe_separated=False, txt_separating_spaces=4, line_separator='\n'): """ :param datafile: The datafile to be written. :type datafile: :py:class:`~robot.parsing.model.TestCaseFile`, :py:class:`~robot.parsing.model.ResourceFile`, :py:class:`~robot.parsing.model.TestDataDirectory` :param str format: Output file format. If omitted, read from the extension of the `source` attribute of the given `datafile`. :param output: An open, file-like object used in writing. If omitted, value of `source` attribute of the given `datafile` is used to construct a new file object. :param bool pipe_separated: Whether to use pipes as separator when output file format is txt. :param int txt_separating_spaces: Number of separating spaces between cells in space separated format. :param str line_separator: Line separator used in output files. If `output` is not given, an output file is created based on the source of the given datafile and value of `format`. Examples: Write output in a StringIO instance using format of `datafile.source`:: WriteConfiguration(datafile, output=StringIO) Output file is created from `datafile.source` by stripping extension and replacing it with `html`:: WriteConfiguration(datafile, format='html') """ self.datafile = datafile self.pipe_separated = pipe_separated self.line_separator = line_separator self._given_output = output self.format = self._validate_format(format) or self._format_from_file() self.txt_separating_spaces = txt_separating_spaces self.output = output def __enter__(self): if not self.output: path = self._output_path() if PY2 and self.format == self.tsv_format: self.output = binary_file_writer(path) else: self.output = file_writer(path, newline=self.line_separator) return self def __exit__(self, *exc_info): if self._given_output is None: self.output.close() def _validate_format(self, format): format = format.lower() if format else '' if format and format not in self._formats: raise DataError('Invalid format: %s' % format) return format def _format_from_file(self): return self._format_from_extension(self._source_from_file()) def _format_from_extension(self, path): return os.path.splitext(path)[1][1:].lower() def _output_path(self): return '%s.%s' % (self._base_name(), self.format) def _base_name(self): return os.path.splitext(self._source_from_file())[0] def _source_from_file(self): return getattr(self.datafile, 'initfile', self.datafile.source)