Class PrettyTable

Return a new PrettyTable instance

Arguments:

encoding - Unicode encoding scheme used to decode any encoded input field_names - list or tuple of field names fields - list or tuple of field names to include in displays start - index of first data row to include in output end - index of last data row to include in output PLUS ONE (list slice style) header - print a header showing field names (True or False) header_style - stylisation to apply to field names in header ("cap", "title", "upper", "lower" or None) border - print a border around the table (True or False) hrules - controls printing of horizontal rules after rows. Allowed values: FRAME, HEADER, ALL, NONE vrules - controls printing of vertical rules between columns. Allowed values: FRAME, ALL, NONE int_format - controls formatting of integer data float_format - controls formatting of floating point data padding_width - number of spaces on either side of column data (only used if left and right paddings are None) left_padding_width - number of spaces on left hand side of column data right_padding_width - number of spaces on right hand side of column data vertical_char - single character string used to draw vertical lines horizontal_char - single character string used to draw horizontal lines junction_char - single character string used to draw line junctions sortby - name of field to sort rows by sort_key - sorting key function, applied to data points before sorting valign - default valign for each row (None, "t", "m" or "b") reversesort - True or False to sort in descending or ascending order

Overrides: object.__init__

str(x)

Overrides: object.__str__

(inherited documentation)

Add a row to the table

Arguments:

row - row of data, should be a list with as many elements as the table has fields

Delete a row to the table

Arguments:

row_index - The index of the row you want to delete. Indexing starts at 0.

Add a column to the table.

Arguments:

fieldname - name of the field to contain the new column of data column - column of data, should be a list with as many elements as the table has rows align - desired alignment for this column - "l" for left, "c" for centre and "r" for right valign - desired vertical alignment for new columns - "t" for top, "m" for middle and "b" for bottom

Return string representation of table in current state.

Arguments:

start - index of first data row to include in output end - index of last data row to include in output PLUS ONE (list slice style) fields - names of fields (columns) to include header - print a header showing field names (True or False) border - print a border around the table (True or False) hrules - controls printing of horizontal rules after rows. Allowed values: ALL, FRAME, HEADER, NONE vrules - controls printing of vertical rules between columns. Allowed values: FRAME, ALL, NONE int_format - controls formatting of integer data float_format - controls formatting of floating point data padding_width - number of spaces on either side of column data (only used if left and right paddings are None) left_padding_width - number of spaces on left hand side of column data right_padding_width - number of spaces on right hand side of column data vertical_char - single character string used to draw vertical lines horizontal_char - single character string used to draw horizontal lines junction_char - single character string used to draw line junctions sortby - name of field to sort rows by sort_key - sorting key function, applied to data points before sorting reversesort - True or False to sort in descending or ascending order print empty - if True, stringify just the header for an empty table, if False return an empty string

Return string representation of HTML formatted version of table in current state.

Arguments:

start - index of first data row to include in output end - index of last data row to include in output PLUS ONE (list slice style) fields - names of fields (columns) to include header - print a header showing field names (True or False) border - print a border around the table (True or False) hrules - controls printing of horizontal rules after rows. Allowed values: ALL, FRAME, HEADER, NONE vrules - controls printing of vertical rules between columns. Allowed values: FRAME, ALL, NONE int_format - controls formatting of integer data float_format - controls formatting of floating point data padding_width - number of spaces on either side of column data (only used if left and right paddings are None) left_padding_width - number of spaces on left hand side of column data right_padding_width - number of spaces on right hand side of column data sortby - name of field to sort rows by sort_key - sorting key function, applied to data points before sorting attributes - dictionary of name/value pairs to include as HTML attributes in the <table> tag xhtml - print <br/> tags if True, <br> tags if false

field_names

Get Method:

_get_field_names(self)

Set Method:

_set_field_names(self, val)

align

Get Method:

_get_align(self)

Set Method:

_set_align(self, val)

valign

Get Method:

_get_valign(self)

Set Method:

_set_valign(self, val)

max_width

Get Method:

_get_max_width(self)

Set Method:

_set_max_width(self, val)

fields

List or tuple of field names to include in displays

Arguments:

fields - list or tuple of field names to include in displays

Get Method:

_get_fields(self) - List or tuple of field names to include in displays

Set Method:

_set_fields(self, val)

start

Start index of the range of rows to print

Arguments:

start - index of first data row to include in output

Get Method:

_get_start(self) - Start index of the range of rows to print

Set Method:

_set_start(self, val)

end

End index of the range of rows to print

Arguments:

end - index of last data row to include in output PLUS ONE (list slice style)

Get Method:

_get_end(self) - End index of the range of rows to print

Set Method:

_set_end(self, val)

sortby

Name of field by which to sort rows

Arguments:

sortby - field name to sort by

Get Method:

_get_sortby(self) - Name of field by which to sort rows

Set Method:

_set_sortby(self, val)

reversesort

Controls direction of sorting (ascending vs descending)

Arguments:

reveresort - set to True to sort by descending order, or False to sort by ascending order

Get Method:

_get_reversesort(self) - Controls direction of sorting (ascending vs descending)

Set Method:

_set_reversesort(self, val)

sort_key

Sorting key function, applied to data points before sorting

Arguments:

sort_key - a function which takes one argument and returns something to be sorted

Get Method:

_get_sort_key(self) - Sorting key function, applied to data points before sorting

Set Method:

_set_sort_key(self, val)

header

Controls printing of table header with field names

Arguments:

header - print a header showing field names (True or False)

Get Method:

_get_header(self) - Controls printing of table header with field names

Set Method:

_set_header(self, val)

header_style

Controls stylisation applied to field names in header

Arguments:

header_style - stylisation to apply to field names in header ("cap", "title", "upper", "lower" or None)

Get Method:

_get_header_style(self) - Controls stylisation applied to field names in header

Set Method:

_set_header_style(self, val)

border

Controls printing of border around table

Arguments:

border - print a border around the table (True or False)

Get Method:

_get_border(self) - Controls printing of border around table

Set Method:

_set_border(self, val)

hrules

Controls printing of horizontal rules after rows

Arguments:

hrules - horizontal rules style. Allowed values: FRAME, ALL, HEADER, NONE

Get Method:

_get_hrules(self) - Controls printing of horizontal rules after rows

Set Method:

_set_hrules(self, val)

vrules

Controls printing of vertical rules between columns

Arguments:

vrules - vertical rules style. Allowed values: FRAME, ALL, NONE

Get Method:

_get_vrules(self) - Controls printing of vertical rules between columns

Set Method:

_set_vrules(self, val)

int_format

Controls formatting of integer data Arguments:

int_format - integer format string

Get Method:

_get_int_format(self) - Controls formatting of integer data Arguments:

Set Method:

_set_int_format(self, val)

float_format

Controls formatting of floating point data Arguments:

float_format - floating point format string

Get Method:

_get_float_format(self) - Controls formatting of floating point data Arguments:

Set Method:

_set_float_format(self, val)

padding_width

The number of empty spaces between a column's edge and its content

Arguments:

padding_width - number of spaces, must be a positive integer

Get Method:

_get_padding_width(self) - The number of empty spaces between a column's edge and its content

Set Method:

_set_padding_width(self, val)

left_padding_width

The number of empty spaces between a column's left edge and its content

Arguments:

left_padding - number of spaces, must be a positive integer

Get Method:

_get_left_padding_width(self) - The number of empty spaces between a column's left edge and its content

Set Method:

_set_left_padding_width(self, val)

right_padding_width

The number of empty spaces between a column's right edge and its content

Arguments:

right_padding - number of spaces, must be a positive integer

Get Method:

_get_right_padding_width(self) - The number of empty spaces between a column's right edge and its content

Set Method:

_set_right_padding_width(self, val)

vertical_char

The charcter used when printing table borders to draw vertical lines

Arguments:

vertical_char - single character string used to draw vertical lines

Get Method:

_get_vertical_char(self) - The charcter used when printing table borders to draw vertical lines

Set Method:

_set_vertical_char(self, val)

horizontal_char

The charcter used when printing table borders to draw horizontal lines

Arguments:

horizontal_char - single character string used to draw horizontal lines

Get Method:

_get_horizontal_char(self) - The charcter used when printing table borders to draw horizontal lines

Set Method:

_set_horizontal_char(self, val)

junction_char

The charcter used when printing table borders to draw line junctions

Arguments:

junction_char - single character string used to draw line junctions

Get Method:

_get_junction_char(self) - The charcter used when printing table borders to draw line junctions

Set Method:

_set_junction_char(self, val)

format

Controls whether or not HTML tables are formatted to match styling options

Arguments:

format - True or False

Get Method:

_get_format(self) - Controls whether or not HTML tables are formatted to match styling options

Set Method:

_set_format(self, val)

print_empty

Controls whether or not empty tables produce a header and frame or just an empty string

Arguments:

print_empty - True or False

Get Method:

_get_print_empty(self) - Controls whether or not empty tables produce a header and frame or just an empty string

Set Method:

_set_print_empty(self, val)

attributes

A dictionary of HTML attribute name/value pairs to be included in the <table> tag when printing HTML

Arguments:

attributes - dictionary of attributes

Get Method:

_get_attributes(self) - A dictionary of HTML attribute name/value pairs to be included in the <table> tag when printing HTML

Set Method:

_set_attributes(self, val)