datafilewriter.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
 
from robotide.lib.robot.errors import DataError
from robotide.lib.robot.utils import binary_file_writer, file_writer, PY2
 
from .filewriters import FileWriter
 
 
 
class DataFileWriter():
 
    
    def __init__(self, **options):
        self._options_options = options
 
    
    def write(self, datafile):
        with WritingContext(datafile, **self._options_options) as ctx:
            FileWriter(ctx).write(datafile)
 
 
 
class WritingContext():
    txt_format = 'txt'
    html_format = 'html'
    tsv_format = 'tsv'
    robot_format = 'robot'
    txt_column_count = 18
    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'):
        self.datafiledatafile = datafile
        self.pipe_separatedpipe_separated = pipe_separated
        self.line_separatorline_separator = line_separator
        self._given_output_given_output = output
        self.formatformat = self._validate_format_validate_format(format) or self._format_from_file_format_from_file()
        self.txt_separating_spacestxt_separating_spaces = txt_separating_spaces
        self.outputoutput = output
 
    def __enter__(self):
        if not self.outputoutput:
            path = self._output_path_output_path()
            if PY2 and self.formatformat == self.tsv_formattsv_format:
                self.outputoutput = binary_file_writer(path)
            else:
                self.outputoutput = file_writer(path, newline=self.line_separatorline_separator)
        return self
 
    def __exit__(self, *exc_info):
        if self._given_output_given_output is None:
            self.outputoutput.close()
 
    def _validate_format(self, format):
        format = format.lower() if format else ''
        if format and format not in self._formats_formats:
            raise DataError('Invalid format: %s' % format)
        return format
 
    def _format_from_file(self):
        return self._format_from_extension_format_from_extension(self._source_from_file_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_base_name(), self.formatformat)
 
    def _base_name(self):
        return os.path.splitext(self._source_from_file_source_from_file())[0]
 
    def _source_from_file(self):
        return getattr(self.datafiledatafile, 'initfile', self.datafiledatafile.source)