sparksee.CSVWriter Class Reference

CSVWriter interface. More...

Inheritance diagram for sparksee.CSVWriter:

Inheritance graph
Collaboration diagram for sparksee.CSVWriter:

Collaboration graph

List of all members.

Public Member Functions

def set_auto_quotes
 Sets on/off the automatic quote mode.
def set_separator
 Sets the character used to separate fields in the file.
def set_quotes
 Sets the character used to quote fields.
def set_locale
 Sets the locale that will be used to write the file.
def write
 Writes the next row.
def set_forced_quotes
 Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.
def close
 Closes the writer.
def __init__
 Creates a new instance.
def open
 Opens the output file path.


Detailed Description

CSVWriter interface.

A very simple CSV writer implementing RowWriter.

It works as any other RowWriter, but open must be called once before the first write operation.

It uses the format RFC 4180: http://tools.ietf.org/html/rfc4180

You can use your own separators and quote characters. By default the separator is the comma (,) and the quote character is the double quotes (") and autoquote is enabled.

See the CSVReader locale documentation or the SPARKSEE User Manual.

Check out the 'Data export' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.CSVWriter.set_auto_quotes (   self,
  autoquotes 
)

Sets on/off the automatic quote mode.

If there are forced quotes, setting autoquotes on will clear them. If the autoquotes is set to off and no forced quotes are provided, there will not be any quote.

Parameters:
autoquotes [in] If TRUE it enables the automatic quote mode, if FALSE it disables it.

def sparksee.CSVWriter.set_separator (   self,
  sep 
)

Sets the character used to separate fields in the file.

Parameters:
sep [in] Separator character.
Exceptions:
RuntimeError null

def sparksee.CSVWriter.set_quotes (   self,
  quotes 
)

Sets the character used to quote fields.

Parameters:
quotes [in] Quote character.
Exceptions:
RuntimeError null

def sparksee.CSVWriter.set_locale (   self,
  localeStr 
)

Sets the locale that will be used to write the file.

Parameters:
localeStr [in] The locale string for the file encoding.

def sparksee.CSVWriter.write (   self,
  row 
)

Writes the next row.

Parameters:
row [in] Row of data.
Exceptions:
IOError If bad things happen during the write.
RuntimeError null

Reimplemented from sparksee.RowWriter.

def sparksee.CSVWriter.set_forced_quotes (   self,
  forcequotes 
)

Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.

Parameters:
forcequotes [in] A booleanList with the position for each column that must be quoted set to true.

def sparksee.CSVWriter.close (   self  ) 

Closes the writer.

Exceptions:
IOError If the close fails.
RuntimeError null

Reimplemented from sparksee.RowWriter.

def sparksee.CSVWriter.open (   self,
  f 
)

Opens the output file path.

Parameters:
f [in] Output file path.
Exceptions:
IOError If bad things happen opening the file.


Generated on Tue Jun 2 16:12:32 2015 for SparkseePython by  doxygen 1.5.6