Class s.i.c.CSVImporter(object):

Class to assist the process of importing csv files.

Class Variables	fields	field names, a list of strings
	optional_fields	optional field names, a list of strings
	dialect	optional, csv dialect, defaults to excel

Method	__init__	Create a new CSVImporter object.
Method	feed_file	Feeds csv data from filename to the importer
Method	feed	Feeds csv data from an iterable
Method	parse_date	Undocumented
Method	parse_multi	Undocumented
Method	set_lines_per_commit	Sets the number of lines which should be parsed between commits.
Method	set_dry	Tells the CSVImporter to run in dry mode, eg without committing
Class Method	get_by_type	Gets an importers class, instantiates it returns it
Method	process_one	Processes one line in a csv file, you can access the columns
Method	read	This can be overridden by as subclass which wishes to specialize
Method	before_start	This is called before all the lines are parsed but
Method	when_done	This is called after all the lines are parsed but

def __init__(self, lines=500, dry=False):

Create a new CSVImporter object.

Parameters	lines	see `set_lines_per_commit`
	dry	see `set_dry`

def feed_file(self, filename, skip=0):

Feeds csv data from filename to the importer

Parameters	filename	filename
	skip	optional, number of rows to initially skip

def feed(self, iterable, filename='<stdin>', skip=0):

Feeds csv data from an iterable

Parameters	iterable	an iterable
	filename	optinal, name of input file
	skip	optional, number of rows to initially skip

def parse_date(self, data):

Undocumented

def parse_multi(self, domain_class, field, trans):

Undocumented

def set_lines_per_commit(self, lines):

Sets the number of lines which should be parsed between commits. Defaults to 500. -1 means that the whole file should be parsed before committing

Parameters lines number of lines or

def set_dry(self, dry):

Tells the CSVImporter to run in dry mode, eg without committing anything.

Parameters dry dry mode

@classmethod
def get_by_type(cls, importer_type):

Gets an importers class, instantiates it returns it

def process_one(self, row, fields, trans):

Processes one line in a csv file, you can access the columns using attributes on the data object.

Parameters	row	object representing a row in the input
	fields	a list of fields set in data
	trans	a database transaction

def read(self, iterable):

This can be overridden by as subclass which wishes to specialize the CSV reader.

Parameters	iterable	a sequence of lines which are going to be read
Returns	a sequence of parsed items

def before_start(self, trans):

This is called before all the lines are parsed but after creating a transaction.

def when_done(self, trans):

This is called after all the lines are parsed but before committing.

API Documentation for Stoqlib, generated by pydoctor at 2009-07-14 16:00:32.