This is a class representing a workbook and all its contents. When creating Excel files with xlwt, you will normally start by instantiating an object of this class.
This method is used to create Worksheets in a Workbook.
- sheetname – The name to use for this sheet, as it will appear in the tabs at the bottom of the Excel application.
- cell_overwrite_ok – If
True, cells in the added worksheet will not raise an exception if written to more than once.
Worksheetthat was added.
This method is used to save the Workbook to a file in native Excel format.
Parameters: filename_or_stream – This can be a string containing a filename of the file, in which case the excel file is saved to disk using the name provided. It can also be a stream object with a write method, such as a
StringIO, in which case the data for the excel file is written to the stream.
Worksheet(sheetname, parent_book, cell_overwrite_ok=False)¶
This is a class representing the contents of a sheet in a workbook.
You don’t normally create instances of this class yourself. They are returned from calls to
write(r, c, label='', style=<xlwt.Style.XFStyle object>)¶
This method is used to write a cell to a
- r – The zero-relative number of the row in the worksheet to which the cell should be written.
- c – The zero-relative number of the column in the worksheet to which the cell should be written.
- label –
The data value to be written.
unicodeinstance is written as is. A
bytesinstance is converted to
unicodeusing the encoding, which defaults to
ascii, specified when the
Workbookinstance was created.
boolinstance will show up as
Nonecauses the cell to be blank: no data, only formatting.
xlwt.Formulainstance causes an Excel formula to be written.
- style –
A style, also known as an XF (extended format), is an
XFStyleobject, which encapsulates the formatting applied to the cell and its contents.
XFStyleobjects are best set up using the
easyxf()function. They may also be set up by setting attributes in
Protectionobjects then setting those objects and a format string as attributes of an
The XF record is able to store explicit cell formatting attributes or the attributes of a cell style. Explicit formatting includes the reference to a cell style XF record. This allows to extend a defined cell style with some explicit attributes. The formatting attributes are divided into 6 groups:
|Number format||Number format index (index to FORMAT record)|
|Font||Font index (index to FONT record)|
|Alignment||Horizontal and vertical alignment, text wrap, indentation, orientation/rotation, text direction|
|Border||Border line styles and colours|
|Background||Background area style and colours|
|Protection||Cell locked, formula hidden|
For each group a flag in the cell XF record specifies whether to use the attributes contained in that XF record or in the referenced style XF record. In style XF records, these flags specify whether the attributes will overwrite explicit cell formatting when the style is applied to a cell. Changing a cell style (without applying this style to a cell) will change all cells which already use that style and do not contain explicit cell attributes for the changed style attributes. If a cell XF record does not contain explicit attributes in a group (if the attribute group flag is not set), it repeats the attributes of its style XF record.
easyxf(strg_to_parse='', num_format_str=None, field_sep=', ', line_sep=';', intro_sep=':', esc_char='\\', debug=False)¶
This function is used to create and configure
XFStyleobjects for use with (for example) the
It takes a string to be parsed to obtain attribute values for
Refer to the examples in the file examples/xlwt_easyxf_simple_demo.py and to the xf_dict dictionary in
Various synonyms including color/colour, center/centre and gray/grey are allowed. Case is irrelevant (except maybe in font names).
-may be used instead of
font: bold on; align: wrap on, vert centre, horiz center
Parameters: num_format_str –
To get the “number format string” of an existing cell whose format you want to reproduce, select the cell and click on Format/Cells/Number/Custom. Otherwise, refer to Excel help.