5.1.2.1. Excel writer classes

5.1.2.1.1. Xlsx table writer

class pytablewriter.ExcelXlsxTableWriter(**kwargs)[source]

Bases: pytablewriter.writer.binary._excel.ExcelTableWriter

A table writer class for Excel file format: .xlsx (newer or equal to Office 2007).

write_table()

Write a table to the current opened worksheet.

Raises

IOError – If failed to write data to the worksheet.

Examples

Excel Sheet

Note

Specific values in the tabular data are converted when writing:

  • None: written as an empty string

  • inf: written as Inf

  • nan: written as NaN

add_style_filter(style_filter: pytablewriter.style._theme.StyleFilterFunc) None

Add a style filter function to the writer.

Parameters

style_filter

A function that called for each cell in the table to apply a style to table cells. The function will be required to implement the following Protocol:

class StyleFilterFunc(Protocol):
    def __call__(self, cell: Cell, **kwargs: Any) -> Optional[Style]:
        ...

If more than one style filter function is added to the writer, it will be called from the last one added. These style functions should return None when not needed to apply styles. If all of the style functions returned None, default_style will be applied.

You can pass keyword arguments to style filter functions via style_filter_kwargs. In default, the attribute includes:

  • writer: the writer instance that the caller of a style_filter function

clear_theme() None

Remove all of the style filters.

close() None

Close the current workbook.

property column_styles: List[Optional[pytablewriter.style._style.Style]]

Output Style for each column.

Returns

Return type

list of Style

property default_style: pytablewriter.style._style.Style

Default Style of table cells.

dump(output: str, close_after_write: bool = True, **kwargs) None

Write a worksheet to the current workbook.

Parameters
  • output (str) – Path to the workbook file to write.

  • close_after_write (bool, optional) – Close the workbook after write. Defaults to True.

property first_data_col: int

Index of the first column of the table. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property first_data_row: int

Index of the first row of the data (table body). :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property first_header_row: int

Index of the first row of the header. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property format_name: str

Format name for the writer.

Returns

str

from_csv(csv_source: str, delimiter: str = ',') None

Set tabular attributes to the writer from a character-separated values (CSV) data source. Following attributes are set to the writer by the method:

table_name also be set if the CSV data source is a file. In that case, table_name is as same as the filename.

Parameters

csv_source (str) – Input CSV data source either can be designated CSV text or CSV file path.

Examples

Using CSV as tabular data source

Dependency Packages
from_dataframe(dataframe, add_index_column: bool = False, overwrite_type_hints: bool = True) None

Set tabular attributes to the writer from pandas.DataFrame. Following attributes are set by the method:

Parameters
  • dataframe (pandas.DataFrame or str) – Input pandas.DataFrame object or pickle.

  • add_index_column (bool, optional) – If True, add a column of index of the dataframe. Defaults to False.

  • overwrite_type_hints (bool) – If True, Overwrite type hints with dtypes within the DataFrame.

Example

Using pandas DataFrame as tabular data source

from_series(series, add_index_column: bool = True) None

Set tabular attributes to the writer from pandas.Series. Following attributes are set by the method:

Parameters
  • series (pandas.Series) – Input pandas.Series object.

  • add_index_column (bool, optional) – If True, add a column of index of the series. Defaults to True.

from_tabledata(value: tabledata._core.TableData, is_overwrite_table_name: bool = True) None

Set following attributes from TableData

And create worksheet named from table_name ABC if not existed yet.

Parameters

value (tabledata.TableData) – Input table data.

from_tablib(tablib_dataset) None

Set tabular attributes to the writer from tablib.Dataset.

from_writer(writer: pytablewriter.writer._table_writer.AbstractTableWriter, is_overwrite_table_name: bool = True) None

Set tabular attributes to the writer from an another table writer class incetance.

property headers: Sequence[str]

Headers of a table to be outputted.

property last_data_col: Optional[int]

Index of the last column of the table. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property last_data_row: Optional[int]

Index of the last row of the data (table body). :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property last_header_row: int

Index of the last row of the header. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

make_worksheet(sheet_name: Optional[str] = None) None

Make a worksheet to the current workbook.

Parameters

sheet_name (str) – Name of the worksheet to create. The name will be automatically generated (like "Sheet1") if the sheet_name is empty.

open(file_path: str) None

Open an Excel workbook file.

Parameters

file_path (str) – Excel workbook file path to open.

set_style(column: Union[str, int], style: pytablewriter.style._style.Style) None

Set Style for a specific column.

Parameters
  • column (int or str) – Column specifier. column index or header name correlated with the column.

  • style (Style) – Style value to be set to the column.

Raises

ValueError – If the column specifier is invalid.

set_theme(theme: str, **kwargs) None

Set style filters for a theme.

Parameters

theme (str) – Name of the theme. pytablewriter theme plugin must be installed corresponding to the theme name.

Raises

RuntimeError – Raised when a theme plugin does not installed.

property support_split_write: bool

Represents the writer class supported iterative table writing (write_table_iter method).

Returns

True if the writer supported iterative table writing.

Return type

bool

property table_format

Get the format of the writer.

Returns

Return type

TableFormat

property table_name: str

Name of a table.

property tabledata: tabledata._core.TableData

Get tabular data of the writer.

Returns

Return type

tabledata.TableData

property type_hints: List[Optional[Type[typepy.type._base.AbstractType]]]

Type hints for each column of the tabular data. Writers convert data for each column using the type hints information before writing tables when you call write_xxx methods.

Acceptable values are as follows:

  • None (automatically detect column type from values in the column)

  • pytablewriter.typehint.Bool

  • pytablewriter.typehint.DateTime

  • pytablewriter.typehint.Dictionary

  • pytablewriter.typehint.Infinity

  • pytablewriter.typehint.Integer

  • pytablewriter.typehint.IpAddress

  • pytablewriter.typehint.List

  • pytablewriter.typehint.Nan

  • pytablewriter.typehint.NoneType

  • pytablewriter.typehint.NullString

  • pytablewriter.typehint.RealNumber

  • pytablewriter.typehint.String

If a type-hint value is not None, the writer tries to convert data for each data in a column to type-hint class. If the type-hint value is None or failed to convert data, the writer automatically detect column data type from the column data.

If type_hints is None, the writer detects data types for all of the columns automatically and writes a table by using detected column types.

Defaults to None.

Examples
property value_matrix: Sequence

Data of a table to be outputted.

write_table(**kwargs) None

Write a table to the stream.

write_table_iter(**kwargs) None

Write a table with iteration. “Iteration” means that divide the table writing into multiple processes. This method is useful, especially for large data. The following are premises to execute this method:

  • set iterator to the value_matrix

  • set the number of iterations to the iteration_length attribute

Call back function (Optional): Callback function is called when for each of the iteration of writing a table is completed. To set call back function, set a callback function to the write_callback attribute.

Raises

pytablewriter.NotSupportedError – If the class does not support this method.

Note

Following classes do not support this method: HtmlTableWriter, RstGridTableWriter, RstSimpleTableWriter. support_split_write attribute return True if the class is supporting this method.

5.1.2.1.2. Xls table writer

class pytablewriter.ExcelXlsTableWriter(**kwargs)[source]

Bases: pytablewriter.writer.binary._excel.ExcelTableWriter

A table writer class for Excel file format: .xls (older or equal to Office 2003).

xlwt package required to use this class.

write_table()

Write a table to the current opened worksheet.

Raises

IOError – If failed to write data to the worksheet.

Note

Specific values in the tabular data are converted when writing:

  • None: written as an empty string

  • inf: written as Inf

  • nan: written as NaN

add_style_filter(style_filter: pytablewriter.style._theme.StyleFilterFunc) None

Add a style filter function to the writer.

Parameters

style_filter

A function that called for each cell in the table to apply a style to table cells. The function will be required to implement the following Protocol:

class StyleFilterFunc(Protocol):
    def __call__(self, cell: Cell, **kwargs: Any) -> Optional[Style]:
        ...

If more than one style filter function is added to the writer, it will be called from the last one added. These style functions should return None when not needed to apply styles. If all of the style functions returned None, default_style will be applied.

You can pass keyword arguments to style filter functions via style_filter_kwargs. In default, the attribute includes:

  • writer: the writer instance that the caller of a style_filter function

clear_theme() None

Remove all of the style filters.

close() None

Close the current workbook.

property column_styles: List[Optional[pytablewriter.style._style.Style]]

Output Style for each column.

Returns

Return type

list of Style

property default_style: pytablewriter.style._style.Style

Default Style of table cells.

dump(output: str, close_after_write: bool = True, **kwargs) None

Write a worksheet to the current workbook.

Parameters
  • output (str) – Path to the workbook file to write.

  • close_after_write (bool, optional) – Close the workbook after write. Defaults to True.

property first_data_col: int

Index of the first column of the table. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property first_data_row: int

Index of the first row of the data (table body). :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property first_header_row: int

Index of the first row of the header. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property format_name: str

Format name for the writer.

Returns

str

from_csv(csv_source: str, delimiter: str = ',') None

Set tabular attributes to the writer from a character-separated values (CSV) data source. Following attributes are set to the writer by the method:

table_name also be set if the CSV data source is a file. In that case, table_name is as same as the filename.

Parameters

csv_source (str) – Input CSV data source either can be designated CSV text or CSV file path.

Examples

Using CSV as tabular data source

Dependency Packages
from_dataframe(dataframe, add_index_column: bool = False, overwrite_type_hints: bool = True) None

Set tabular attributes to the writer from pandas.DataFrame. Following attributes are set by the method:

Parameters
  • dataframe (pandas.DataFrame or str) – Input pandas.DataFrame object or pickle.

  • add_index_column (bool, optional) – If True, add a column of index of the dataframe. Defaults to False.

  • overwrite_type_hints (bool) – If True, Overwrite type hints with dtypes within the DataFrame.

Example

Using pandas DataFrame as tabular data source

from_series(series, add_index_column: bool = True) None

Set tabular attributes to the writer from pandas.Series. Following attributes are set by the method:

Parameters
  • series (pandas.Series) – Input pandas.Series object.

  • add_index_column (bool, optional) – If True, add a column of index of the series. Defaults to True.

from_tabledata(value: tabledata._core.TableData, is_overwrite_table_name: bool = True) None

Set following attributes from TableData

And create worksheet named from table_name ABC if not existed yet.

Parameters

value (tabledata.TableData) – Input table data.

from_tablib(tablib_dataset) None

Set tabular attributes to the writer from tablib.Dataset.

from_writer(writer: pytablewriter.writer._table_writer.AbstractTableWriter, is_overwrite_table_name: bool = True) None

Set tabular attributes to the writer from an another table writer class incetance.

property headers: Sequence[str]

Headers of a table to be outputted.

property last_data_col: Optional[int]

Index of the last column of the table. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property last_data_row: Optional[int]

Index of the last row of the data (table body). :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

property last_header_row: int

Index of the last row of the header. :rtype: int

Note

This attributes available after execution of the write_table() method.

Type

return

make_worksheet(sheet_name: Optional[str] = None) None

Make a worksheet to the current workbook.

Parameters

sheet_name (str) – Name of the worksheet to create. The name will be automatically generated (like "Sheet1") if the sheet_name is empty.

open(file_path: str) None

Open an Excel workbook file.

Parameters

file_path (str) – Excel workbook file path to open.

set_style(column: Union[str, int], style: pytablewriter.style._style.Style) None

Set Style for a specific column.

Parameters
  • column (int or str) – Column specifier. column index or header name correlated with the column.

  • style (Style) – Style value to be set to the column.

Raises

ValueError – If the column specifier is invalid.

set_theme(theme: str, **kwargs) None

Set style filters for a theme.

Parameters

theme (str) – Name of the theme. pytablewriter theme plugin must be installed corresponding to the theme name.

Raises

RuntimeError – Raised when a theme plugin does not installed.

property support_split_write: bool

Represents the writer class supported iterative table writing (write_table_iter method).

Returns

True if the writer supported iterative table writing.

Return type

bool

property table_format

Get the format of the writer.

Returns

Return type

TableFormat

property table_name: str

Name of a table.

property tabledata: tabledata._core.TableData

Get tabular data of the writer.

Returns

Return type

tabledata.TableData

property type_hints: List[Optional[Type[typepy.type._base.AbstractType]]]

Type hints for each column of the tabular data. Writers convert data for each column using the type hints information before writing tables when you call write_xxx methods.

Acceptable values are as follows:

  • None (automatically detect column type from values in the column)

  • pytablewriter.typehint.Bool

  • pytablewriter.typehint.DateTime

  • pytablewriter.typehint.Dictionary

  • pytablewriter.typehint.Infinity

  • pytablewriter.typehint.Integer

  • pytablewriter.typehint.IpAddress

  • pytablewriter.typehint.List

  • pytablewriter.typehint.Nan

  • pytablewriter.typehint.NoneType

  • pytablewriter.typehint.NullString

  • pytablewriter.typehint.RealNumber

  • pytablewriter.typehint.String

If a type-hint value is not None, the writer tries to convert data for each data in a column to type-hint class. If the type-hint value is None or failed to convert data, the writer automatically detect column data type from the column data.

If type_hints is None, the writer detects data types for all of the columns automatically and writes a table by using detected column types.

Defaults to None.

Examples
property value_matrix: Sequence

Data of a table to be outputted.

write_table(**kwargs) None

Write a table to the stream.

write_table_iter(**kwargs) None

Write a table with iteration. “Iteration” means that divide the table writing into multiple processes. This method is useful, especially for large data. The following are premises to execute this method:

  • set iterator to the value_matrix

  • set the number of iterations to the iteration_length attribute

Call back function (Optional): Callback function is called when for each of the iteration of writing a table is completed. To set call back function, set a callback function to the write_callback attribute.

Raises

pytablewriter.NotSupportedError – If the class does not support this method.

Note

Following classes do not support this method: HtmlTableWriter, RstGridTableWriter, RstSimpleTableWriter. support_split_write attribute return True if the class is supporting this method.