robotide.lib.robot.writer.datafilewriter.WritingContext Class Reference

Contains configuration used in writing a test data file to disk. More...

Public Member Functions
def	__enter__ (self)
def	__exit__ (self, *exc_info)
def	__init__ (self, datafile, format='', output=None, pipe_separated=False, txt_separating_spaces=4, line_separator='\n')
	:param datafile: The datafile to be written. More...

Public Attributes
	datafile
	format
	line_separator
	output
	pipe_separated
	txt_separating_spaces

Static Public Attributes
int	html_column_count = 5
string	html_format = 'html'
string	robot_format = 'robot'
int	tsv_column_count = 8
string	tsv_format = 'tsv'
int	txt_column_count = 18
string	txt_format = 'txt'

Private Member Functions
def	_base_name (self)
def	_format_from_extension (self, path)
def	_format_from_file (self)
def	_output_path (self)
def	_source_from_file (self)
def	_validate_format (self, format)

Private Attributes
	_given_output

Static Private Attributes
list	_formats

Detailed Description

Contains configuration used in writing a test data file to disk.

Definition at line 46 of file datafilewriter.py.

Constructor & Destructor Documentation

__init__()

def robotide.lib.robot.writer.datafilewriter.WritingContext.__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')

Definition at line 87 of file datafilewriter.py.

Member Function Documentation

__enter__()

def robotide.lib.robot.writer.datafilewriter.WritingContext.__enter__

(

self

)

Definition at line 97 of file datafilewriter.py.

__exit__()

def robotide.lib.robot.writer.datafilewriter.WritingContext.__exit__	(		self,
		*	exc_info
	)

Definition at line 106 of file datafilewriter.py.

_base_name()

def robotide.lib.robot.writer.datafilewriter.WritingContext._base_name (   self )

private

Definition at line 125 of file datafilewriter.py.

_format_from_extension()

def robotide.lib.robot.writer.datafilewriter.WritingContext._format_from_extension (   self,   path  )

private

Definition at line 119 of file datafilewriter.py.

_format_from_file()

def robotide.lib.robot.writer.datafilewriter.WritingContext._format_from_file (   self )

private

Definition at line 116 of file datafilewriter.py.

_output_path()

def robotide.lib.robot.writer.datafilewriter.WritingContext._output_path (   self )

private

Definition at line 122 of file datafilewriter.py.

_source_from_file()

def robotide.lib.robot.writer.datafilewriter.WritingContext._source_from_file (   self )

private

Definition at line 128 of file datafilewriter.py.

_validate_format()

def robotide.lib.robot.writer.datafilewriter.WritingContext._validate_format (   self,   format  )

private

Definition at line 110 of file datafilewriter.py.

Member Data Documentation

_formats

robotide.lib.robot.writer.datafilewriter.WritingContext._formats

staticprivate

Definition at line 57 of file datafilewriter.py.

_given_output

robotide.lib.robot.writer.datafilewriter.WritingContext._given_output

private

Definition at line 92 of file datafilewriter.py.

datafile

robotide.lib.robot.writer.datafilewriter.WritingContext.datafile

Definition at line 89 of file datafilewriter.py.

format

robotide.lib.robot.writer.datafilewriter.WritingContext.format

Definition at line 93 of file datafilewriter.py.

html_column_count

int robotide.lib.robot.writer.datafilewriter.WritingContext.html_column_count = 5

static

Definition at line 52 of file datafilewriter.py.

html_format

string robotide.lib.robot.writer.datafilewriter.WritingContext.html_format = 'html'

static

Definition at line 48 of file datafilewriter.py.

line_separator

robotide.lib.robot.writer.datafilewriter.WritingContext.line_separator

Definition at line 91 of file datafilewriter.py.

output

robotide.lib.robot.writer.datafilewriter.WritingContext.output

Definition at line 95 of file datafilewriter.py.

pipe_separated

robotide.lib.robot.writer.datafilewriter.WritingContext.pipe_separated

Definition at line 90 of file datafilewriter.py.

robot_format

string robotide.lib.robot.writer.datafilewriter.WritingContext.robot_format = 'robot'

static

Definition at line 50 of file datafilewriter.py.

tsv_column_count

int robotide.lib.robot.writer.datafilewriter.WritingContext.tsv_column_count = 8

static

Definition at line 53 of file datafilewriter.py.

tsv_format

string robotide.lib.robot.writer.datafilewriter.WritingContext.tsv_format = 'tsv'

static

Definition at line 49 of file datafilewriter.py.

txt_column_count

int robotide.lib.robot.writer.datafilewriter.WritingContext.txt_column_count = 18

static

Definition at line 51 of file datafilewriter.py.

txt_format

string robotide.lib.robot.writer.datafilewriter.WritingContext.txt_format = 'txt'

static

Definition at line 47 of file datafilewriter.py.

txt_separating_spaces

robotide.lib.robot.writer.datafilewriter.WritingContext.txt_separating_spaces

Definition at line 94 of file datafilewriter.py.

---

The documentation for this class was generated from the following file:

• src/robotide/lib/robot/writer/datafilewriter.py