API Reference¶

Core¶

xlsx2html.core.xlsx2html(filepath, output=None, locale='en', sheet=None, parse_formula=False, default_cell_border=None, inline_styles=False)[source]¶

Parameters

filepath¶ (Union[BinaryIO, str, Workbook]) – xlsx file
output¶ (Union[TextIO, str, None]) – to path or file like, defaults to None
locale¶ (str) – en or zh_TW. defaults to en
sheet¶ (Union[int, str, None]) – sheet name or idx, defaults to None what means get active sheet
parse_formula¶ (bool) – If True - enable parse formulas. defaults to False
default_cell_border¶ (Union[str, Dict[str, Optional[str]], None]) – default border style. Can use short str like 1px solid black or dict like {'width': '1px', 'style': 'solid', 'color': 'black'}
inline_styles¶ (bool) – store styles inline

Return type

TextIO

Returns

File like object

class xlsx2html.core.XLSX2HTMLConverter(filepath, locale='en', parse_formula=False, inline_styles=False, display_grid=False, default_border_style=None, formula_wb=None, parser=None, renderer=None)[source]¶

Bases: object

Parameters

filepath¶ (str | BinaryIO | openpyxl.Workbook) – xlsx file
locale¶ (str) – en or zh_TW. defaults to en
parse_formula¶ (bool) – If True - enable parse formulas. defaults to False
formula_fb¶ – If parse_formula set to True and type filepath as openpyxl.Workbook then pass formula_wb=openpyxl.load_workbook(filepath, data_only=False)
default_border_style¶ (Union[str, Dict[str, Optional[str]], None]) – default border style. Can use short str like 1px solid black or dict like {'width': '1px', 'style': 'solid', 'color': 'black'}
inline_styles¶ (bool) – store styles inline
display_grid¶ (bool) – Show column letters and row numbers. If XLSX2HTMLConverter.default_border_style is none - do enabled gray grid

filepath: Union[BinaryIO, str, openpyxl.workbook.workbook.Workbook]¶

locale: str = 'en'¶

parse_formula: bool = False¶

inline_styles: bool = False¶

display_grid: bool = False¶

default_border_style: Optional[Union[str, Dict[str, Optional[str]]]] = None¶

wb: openpyxl.workbook.workbook.Workbook¶

formula_wb: Optional[openpyxl.workbook.workbook.Workbook] = None¶

parser: dataclasses.InitVar = None¶

renderer: dataclasses.InitVar = None¶

get_table(sheet=None, extra_attrs=None)[source]¶

Parameters

sheet¶ (Union[int, str, None]) – sheet name or idx, defaults to None what means get active sheet
extra_attrs¶ (Optional[Dict[str, Optional[str]]]) – additional attributes for <table> like class or id

Return type

ConverterTableResult

Returns

get_tables(sheets=None, extra_attrs=None)[source]¶

Parameters

sheets¶ (Optional[Iterable[Union[int, str, None]]]) – list of sheet name or idx. By defaults get all sheets
extra_attrs¶ (Optional[Dict[str, Optional[str]]]) – additional attributes to <table …> like class or id

Return type

List[ConverterTableResult]

Returns

get_html(sheet=None)[source]¶

Get full html with table

Parameters: sheet¶ (Union[int, str, None]) – sheet name or idx, defaults to None what means get active sheet
Return type: str
Returns: full html as string

get_html_stream(output=None, sheet=None)[source]¶

Parameters

output¶ (Union[TextIO, str, None]) – to path or file like, defaults to None
sheet¶ (Union[int, str, None]) – sheet name or idx, defaults to None what means get active sheet

Return type

TextIO

Returns

File like object

class xlsx2html.core.ConverterTableResult(html, css='')[source]¶

Bases: object

Parameters

html¶ (str) – html of table
css¶ (str) – css contents If XLSX2HTMLConverter.optimize_styles set to False then css is empty

html: str¶

css: str = ''¶

Parser¶

class xlsx2html.parser.parser.Column(index, letter, width, hidden=False)[source]¶

Bases: object

index: int¶

letter: str¶

width: float¶

hidden: bool = False¶

class xlsx2html.parser.parser.MergedCellInfo(colspan=None, rowspan=None, cells=<factory>)[source]¶

Bases: object

colspan: Optional[int] = None¶

rowspan: Optional[int] = None¶

cells: List[openpyxl.cell.cell.Cell]¶

class xlsx2html.parser.parser.ParserResult(cols, rows, images)[source]¶

Bases: object

cols: List[xlsx2html.parser.parser.Column]¶

rows: List[List[xlsx2html.parser.cell.CellInfo]]¶

images: Dict[Tuple[int, int], List[xlsx2html.parser.image.ImageInfo]]¶

class xlsx2html.parser.parser.XLSXParser(wb, locale='en', parse_formula=False, fb=None)[source]¶

Bases: object

get_sheet_names()[source]¶

Return type: List[str]

get_sheet(sheet=None)[source]¶

Return type: ParserResult

static get_columns(ws, max_col)[source]¶

Return type: List[Column]

static get_images(ws)[source]¶

Return type: Dict[Tuple[int, int], List[ImageInfo]]

get_cell_data(cell, f_cell=None)[source]¶

Return type: CellInfo

static merge_borders(cells)[source]¶

Return type: Optional[Borders]

class xlsx2html.parser.cell.Border(style, color=None)[source]¶

Bases: object

style: str¶

color: Optional[str] = None¶

class xlsx2html.parser.cell.Borders(top=None, left=None, right=None, bottom=None, diagonal_up=None, diagonal_down=None)[source]¶

Bases: object

top: Optional[xlsx2html.parser.cell.Border] = None¶

left: Optional[xlsx2html.parser.cell.Border] = None¶

right: Optional[xlsx2html.parser.cell.Border] = None¶

bottom: Optional[xlsx2html.parser.cell.Border] = None¶

diagonal_up: Optional[xlsx2html.parser.cell.Border] = None¶

diagonal_down: Optional[xlsx2html.parser.cell.Border] = None¶

class xlsx2html.parser.cell.Fill(pattern, color)[source]¶

Bases: object

pattern: str¶

color: Optional[str]¶

class xlsx2html.parser.cell.Font(size, color=None, italic=False, underline=False, bold=False, strike=False, overline=False, outline=False, shadow=False)[source]¶

Bases: object

size: int¶

color: Optional[str] = None¶

italic: bool = False¶

underline: bool = False¶

bold: bool = False¶

strike: bool = False¶

overline: bool = False¶

outline: bool = False¶

shadow: bool = False¶

class xlsx2html.parser.cell.Alignment(horizontal=None, vertical=None, indent=None, text_rotation=None)[source]¶

Bases: object

horizontal: Optional[str] = None¶

vertical: Optional[str] = None¶

indent: Optional[float] = None¶

text_rotation: Optional[int] = None¶

class xlsx2html.parser.cell.CellInfo(id, column, column_letter, row, coordinate, value, formatted_value, alignment, colspan=None, rowspan=None, height=19, border=None, fill=None, font=None)[source]¶

Bases: object

id: str¶

column: int¶

column_letter: str¶

row: int¶

coordinate: str¶

value: Any¶

formatted_value: str¶

alignment: xlsx2html.parser.cell.Alignment¶

colspan: Optional[int] = None¶

rowspan: Optional[int] = None¶

height: int = 19¶

border: Optional[xlsx2html.parser.cell.Borders] = None¶

fill: Optional[xlsx2html.parser.cell.Fill] = None¶

font: Optional[xlsx2html.parser.cell.Font] = None¶

classmethod from_cell(cell, f_cell, _locale=None)[source]¶

Return type: CellInfo

static get_border(cell)[source]¶

Return type: Optional[Borders]

class xlsx2html.parser.image.Point(x, y)[source]¶

Bases: object

x: int¶

y: int¶

class xlsx2html.parser.image.ImageInfo(col, row, offset, width, height, src)[source]¶

Bases: object

col: int¶

row: int¶

offset: xlsx2html.parser.image.Point¶

width: int¶

height: int¶

src: str¶

classmethod from_ws_image(ws_image)[source]¶

Return type: ImageInfo

Renderer¶

class xlsx2html.render.html.HtmlRenderer(display_grid=False, default_border_style=None, table_attrs=None, inline_styles=False)[source]¶

Bases: object

render(result)[source]¶

Return type: str

render_table(result, attrs=None)[source]¶

Return type: str

render_header(cols)[source]¶

Return type: str

render_lineno(lineno)[source]¶

Return type: str

render_columns(cols)[source]¶

Return type: str

render_column(col)[source]¶

Return type: str

render_cell(cell, images, attrs=None)[source]¶

Return type: str

get_border_style_from_cell(cell)[source]¶

Return type: Dict[str, Optional[str]]

get_diagonal_border_style(border)[source]¶

Return type: Dict

get_styles_from_cell(cell, extra_style=None)[source]¶

Return type: Dict[str, Optional[str]]

render_image(image)[source]¶

Return type: str

build_style_cache(rows)[source]¶

Return type: None

render_css()[source]¶

Return type: str

Formatters¶

class xlsx2html.format.number.ColorNumberPattern(*args, **kwargs)[source]¶

Bases: babel.numbers.NumberPattern

apply(value, locale, **kwargs)[source]¶

Renders into a string a number following the defined pattern.

Forced decimal quantization is active by default so we’ll produce a number string that is strictly following CLDR pattern definitions.

Parameters

value¶ (decimal.Decimal|float|int) – The value to format. If this is not a Decimal object, it will be cast to one.
locale¶ (str|babel.core.Locale) – The locale to use for formatting.
currency¶ (str|None) – Which currency, if any, to format as.
currency_digits¶ (bool) – Whether or not to use the currency’s precision. If false, the pattern’s precision is used.
decimal_quantization¶ (bool) – Whether decimal numbers should be forcibly quantized to produce a formatted output strictly matching the CLDR definition for the locale.
force_frac¶ – DEPRECATED - a forced override for self.frac_prec for a single formatting invocation.

Returns

Formatted decimal string.

Return type

str

apply_color(value, formatted)[source]¶

Return type: str

class xlsx2html.format.number.PatternParser(pattern)[source]¶

Bases: object

apply(number, locale)[source]¶

Return type: str

xlsx2html.format.number.format_decimal(number, format=None, locale='en_US_POSIX')[source]¶

Return the given decimal number formatted for a specific locale.

>>> format_decimal(1.2345, locale='en_US')
'1.234'
>>> format_decimal(1.2346, locale='en_US')
'1.235'
>>> format_decimal(-1.2346, locale='en_US')
'-1.235'
>>> format_decimal(1.2345, locale='sv_SE')
'1,234'
>>> format_decimal(1.2345, locale='de')
'1,234'

The appropriate thousands grouping and the decimal separator are used for each locale:

>>> format_decimal(12345.5, locale='en_US')
'12,345.5'

Parameters

number¶ (Any) – the number to format
format¶ (Optional[str]) –
locale¶ (str) – the Locale object or locale identifier

Return type

str

xlsx2html.format.dt.normalize_datetime_format(fmt, fixed_for_time=False)[source]¶

Return type: str

xlsx2html.format.dt.format_date(date, fmt, locale='en_US_POSIX')[source]¶

Return type: str

xlsx2html.format.dt.format_datetime(datetime, fmt, locale='en_US_POSIX', tzinfo=None)[source]¶

Return type: str

xlsx2html.format.dt.format_time(time, fmt, locale='en_US_POSIX', tzinfo=None, date=None)[source]¶

Return type: str

xlsx2html.format.dt.format_timedelta(timedelta, fmt)[source]¶

Return type: str

xlsx2html.format.locale.parse_locale_code(code)[source]¶

>>> parse_locale_code('-404')
'zh_Hant_TW'
>>> parse_locale_code('404')
'zh_Hant_TW'
>>> parse_locale_code('0404')
'zh_Hant_TW'
>>> parse_locale_code('58050')

Return type: Optional[str]

xlsx2html.format.locale.extract_locale_from_format(fmt)[source]¶

>>> extract_locale_from_format('[$-404]e/m/d')
('zh_Hant_TW', 'e/m/d')
>>> extract_locale_from_format('[$USD-404]e/m/d')
('zh_Hant_TW', 'e/m/d')
>>> extract_locale_from_format('[$$-404]#.00')
('zh_Hant_TW', '#.00')
>>> extract_locale_from_format('[RED]e/m/d')
(None, '[RED]e/m/d')

Return type: Tuple[Optional[str], str]

class xlsx2html.format.hyperlink.Hyperlink(title, location=None, target=None, href=None)[source]¶

Bases: object

title: str¶

location: Optional[str] = None¶

target: Optional[str] = None¶

href: Optional[str] = None¶

xlsx2html.format.hyperlink.resolve_cell(worksheet, coord)[source]¶

Return type: Cell

xlsx2html.format.hyperlink.resolve_hyperlink_formula(cell, f_cell=None)[source]¶

Return type: Optional[Hyperlink]

xlsx2html.format.hyperlink.get_hyperlink(value, cell, f_cell=None)[source]¶

Return type: Optional[Hyperlink]

xlsx2html.format.hyperlink.format_hyperlink(value, cell, f_cell=None)[source]¶

Return type: str