tablate.type package

Submodules

tablate.type.defaults module

tablate.type.primitives module

tablate.type.type_global module

class tablate.type.type_global.ConsoleGlobals(outer_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>)

Bases: object

outer_styles: OuterStyles

frame_styles: FrameStyles

column_styles: ColumnStyles

text_styles: TextStyles

class tablate.type.type_global.HtmlGlobals(html_container_styles=<factory>, html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, css_injection='', styler=<factory>, column_baselines=<factory>)

Bases: object

html_container_styles: HtmlContainerStyles

html_frame_styles: HtmlFrameStyles

html_column_styles: HtmlColumnStyles

html_text_styles: HtmlTextStyles

css_injection: str = ''

styler: Optional[CssStyler]

column_baselines: List[int]

class tablate.type.type_global.Globals(console=<factory>, html=<factory>)

Bases: object

console: ConsoleGlobals

html: HtmlGlobals

class tablate.type.type_global.GlobalsStore(args, store)

Bases: object

args: dict

store: Globals

tablate.type.type_input module

class tablate.type.type_input.HtmlContainerStylesInput

Bases: TypedDict

html_container_border_weight: Optional[int]

html_container_border_style: Optional[Literal['none', 'thin', 'thick', 'double']]

html_container_border_color: Optional[str]

html_container_padding: Union[int, List[int], None]

html_container_width: Optional[str]

class tablate.type.type_input.FrameStylesInput

Bases: TypedDict

frame_divider: Literal['none', 'blank', 'thin', 'thick', 'double']

max_lines: Optional[int]

multiline: Optional[bool]

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

class tablate.type.type_input.HtmlFrameStylesInput

Bases: TypedDict

html_frame_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']]

html_frame_divider_weight: Optional[int]

html_frame_divider_color: Optional[str]

html_max_lines: Optional[int]

html_multiline: Optional[bool]

html_background: Optional[str]

class tablate.type.type_input.ColumnStylesInput

Bases: TypedDict

column_divider: Literal['blank', 'thin', 'thick', 'double']

padding: int

background_padding: int

class tablate.type.type_input.TextStylesInput

Bases: TypedDict

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']]

text_align: Optional[Literal['left', 'center', 'right']]

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

class tablate.type.type_input.HtmlColumnStylesInput

Bases: TypedDict

html_column_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']]

html_column_divider_weight: Optional[int]

html_column_divider_color: Optional[str]

html_padding: Union[int, List[int], None]

class tablate.type.type_input.HtmlTextStylesInput

Bases: TypedDict

html_text_style: Optional[Literal['normal', 'bold', 'italic']]

html_text_align: Optional[Literal['left', 'center', 'right', 'justify']]

html_text_color: Optional[str]

html_text_size: Optional[int]

class tablate.type.type_input.RowsStylesInput

Bases: TypedDict

row_line_divider: Literal['none', 'blank', 'thin', 'thick', 'double']

odds_background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

evens_background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

class tablate.type.type_input.HtmlRowsStylesInput

Bases: TypedDict

html_row_line_divider_weight: Optional[int]

html_row_line_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']]

html_row_line_divider_color: Optional[str]

html_odds_background: Optional[str]

html_evens_background: Optional[str]

class tablate.type.type_input.HtmlColumnInput

Bases: TypedDict

padding: Union[int, List[int], None]

divider_style: Optional[Literal['none', 'thin', 'thick', 'double']]

divider_weight: Optional[int]

divider_color: Optional[str]

text_style: Optional[Literal['normal', 'bold', 'italic']]

text_align: Optional[Literal['left', 'center', 'right', 'justify']]

text_color: Optional[str]

background: Optional[str]

class tablate.type.type_input.BaseColumnInput

Bases: TypedDict

width: Union[int, str, None]

padding: int

divider: Literal['blank', 'thin', 'thick', 'double']

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']]

text_align: Optional[Literal['left', 'center', 'right']]

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

html_styles: Optional[HtmlColumnInput]

class tablate.type.type_input.GridColumnInput

Bases: dict

string: Union[str, int, float]

width: Union[int, str, None]

padding: int

divider: Literal['blank', 'thin', 'thick', 'double']

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']]

text_align: Optional[Literal['left', 'center', 'right']]

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

html_styles: Optional[HtmlColumnInput]

class tablate.type.type_input.BaseTableColumnInput

Bases: dict

string: Union[str, int, float]

width: Union[int, str, None]

padding: int

divider: Literal['blank', 'thin', 'thick', 'double']

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']]

text_align: Optional[Literal['left', 'center', 'right']]

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

html_styles: Optional[HtmlColumnInput]

class tablate.type.type_input.TableColumnInput

Bases: dict

key: str

width: Union[int, str, None]

padding: int

divider: Literal['blank', 'thin', 'thick', 'double']

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']]

text_align: Optional[Literal['left', 'center', 'right']]

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]

html_styles: Optional[HtmlColumnInput]

string: Union[str, int, float]

class tablate.type.type_input.BaseStylesInput

Bases: TypedDict

frame_styles: FrameStylesInput

column_styles: ColumnStylesInput

text_styles: TextStylesInput

tablate.type.type_input.TableHeaderFrameStylesInput

alias of BaseStylesInput

class tablate.type.type_input.TableBodyFrameStylesInput

Bases: dict

row_styles: RowsStylesInput

frame_styles: FrameStylesInput

column_styles: ColumnStylesInput

text_styles: TextStylesInput

class tablate.type.type_input.HtmlStylesInput

Bases: TypedDict

html_frame_styles: HtmlFrameStylesInput

html_column_styles: HtmlColumnStylesInput

html_text_styles: HtmlTextStylesInput

class tablate.type.type_input.HtmlTextFrameStylesInput

Bases: TypedDict

html_frame_styles: HtmlFrameStylesInput

html_text_styles: HtmlTextStylesInput

tablate.type.type_input.HtmlGridFrameStylesInput

alias of HtmlStylesInput

class tablate.type.type_input.HtmlTableFrameStylesInput

Bases: dict

html_row_styles: HtmlRowsStylesInput

html_frame_styles: HtmlFrameStylesInput

html_column_styles: HtmlColumnStylesInput

html_text_styles: HtmlTextStylesInput

tablate.type.type_input.HtmlTableHeaderStylesInput

alias of HtmlStylesInput

tablate.type.type_store module

class tablate.type.type_store.BaseFrameStore(frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>)

Bases: object

frame_styles: FrameStyles

column_styles: ColumnStyles

text_styles: TextStyles

class tablate.type.type_store.BaseTableFrameStore(frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>, row_styles=<factory>)

Bases: BaseFrameStore

row_styles: TableRowsStyles

class tablate.type.type_store.HtmlFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>)

Bases: object

html_frame_styles: HtmlFrameStyles

html_column_styles: HtmlColumnStyles

html_text_styles: HtmlTextStyles

class tablate.type.type_store.HtmlTableFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, html_row_styles=<factory>)

Bases: HtmlFrameStore

html_row_styles: HtmlTableRowsStyles

class tablate.type.type_store.FrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>)

Bases: BaseFrameStore, HtmlFrameStore

frame_styles: FrameStyles

column_styles: ColumnStyles

text_styles: TextStyles

class tablate.type.type_store.TableFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, html_row_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>, row_styles=<factory>)

Bases: BaseTableFrameStore, HtmlTableFrameStore

row_styles: TableRowsStyles

frame_styles: FrameStyles

column_styles: ColumnStyles

text_styles: TextStyles

class tablate.type.type_store.GridFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>, type='text', name='', column_list=<factory>)

Bases: FrameStore

type: Union[Literal['grid'], Literal['text']] = 'text'

name: str = ''

column_list: List[GridColumnInput]

class tablate.type.type_store.TableHeaderFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>, type='table_header', name='', column_list=<factory>)

Bases: FrameStore

type: Literal['table_header'] = 'table_header'

name: str = ''

column_list: List[TableColumnInput]

class tablate.type.type_store.TableBodyFrameStore(html_frame_styles=<factory>, html_column_styles=<factory>, html_text_styles=<factory>, frame_styles=<factory>, column_styles=<factory>, text_styles=<factory>, type='table_body', name='', hide_header=False, column_list=<factory>, row_list=<factory>, row_styles=<factory>, html_row_styles=<factory>)

Bases: FrameStore

type: Literal['table_body'] = 'table_body'

name: str = ''

hide_header: bool = False

column_list: List[TableColumnInput]

row_list: List[Dict[str, Union[str, int, float]]]

row_styles: TableRowsStyles

html_row_styles: HtmlTableRowsStyles

class tablate.type.type_store.FrameDict(name, type, args, store)

Bases: object

name: str

type: Literal['text', 'grid', 'table']

args: dict

store: Union[GridFrameStore, Tuple[Optional[TableHeaderFrameStore], TableBodyFrameStore], None]

tablate.type.type_style module

class tablate.type.type_style.OuterStyles(container_border='thick', container_padding=1, container_width=120, background_padding=1)

Bases: object

container_border: Optional[Literal['blank', 'thin', 'thick', 'double']] = 'thick'

container_padding: Optional[int] = 1

container_width: Optional[int] = 120

background_padding: int = 1

class tablate.type.type_style.FrameStyles(frame_divider='thick', max_lines=None, multiline=True, background=None, trunc_value='...')

Bases: object

frame_divider: Optional[Literal['none', 'blank', 'thin', 'thick', 'double']] = 'thick'

max_lines: Optional[int] = None

multiline: Optional[bool] = True

background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']] = None

trunc_value: Optional[str] = '...'

class tablate.type.type_style.ColumnStyles(column_divider='thin', padding=1, background_padding=None)

Bases: object

column_divider: Optional[Literal['blank', 'thin', 'thick', 'double']] = 'thin'

padding: Optional[int] = 1

background_padding: Optional[int] = None

class tablate.type.type_style.TextStyles(text_style='normal', text_align='left', text_color=None)

Bases: object

text_style: Optional[Literal['normal', 'bold', 'underlined', 'bold_underlined']] = 'normal'

text_align: Optional[Literal['left', 'center', 'right']] = 'left'

text_color: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']] = None

class tablate.type.type_style.TableRowsStyles(row_line_divider='thin', odds_background=None, evens_background=None)

Bases: object

row_line_divider: Optional[Literal['none', 'blank', 'thin', 'thick', 'double']] = 'thin'

odds_background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']] = None

evens_background: Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']] = None

class tablate.type.type_style.HtmlContainerStyles(html_container_border_weight=1, html_container_border_style='thick', html_container_border_color='black', html_container_padding=<factory>, html_container_width='100%', html_px_multiplier=1, html_default_colors=True)

Bases: object

html_container_border_weight: Optional[int] = 1

html_container_border_style: Optional[Literal['none', 'thin', 'thick', 'double']] = 'thick'

html_container_border_color: Optional[str] = 'black'

html_container_padding: Union[int, List[int], None]

html_container_width: Optional[str] = '100%'

html_px_multiplier: int = 1

html_default_colors: bool = True

class tablate.type.type_style.HtmlFrameStyles(html_frame_divider_style='thick', html_frame_divider_weight=1, html_frame_divider_color='black', html_max_lines=None, html_multiline=True, html_background=None, html_px_multiplier=1)

Bases: object

html_frame_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']] = 'thick'

html_frame_divider_weight: Optional[int] = 1

html_frame_divider_color: Optional[str] = 'black'

html_max_lines: Optional[int] = None

html_multiline: Optional[bool] = True

html_background: Optional[str] = None

html_px_multiplier: int = 1

class tablate.type.type_style.HtmlColumnStyles(html_column_divider_style='thin', html_column_divider_weight=1, html_column_divider_color='black', html_padding=1)

Bases: object

html_column_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']] = 'thin'

html_column_divider_weight: Optional[int] = 1

html_column_divider_color: Optional[str] = 'black'

html_padding: Union[int, List[int], None] = 1

class tablate.type.type_style.HtmlTextStyles(html_text_style='normal', html_text_align='left', html_text_color=None, html_text_size=16)

Bases: object

html_text_style: Optional[Literal['normal', 'bold', 'italic']] = 'normal'

html_text_align: Optional[Literal['left', 'center', 'right', 'justify']] = 'left'

html_text_color: Optional[str] = None

html_text_size: Optional[int] = 16

class tablate.type.type_style.HtmlTableRowsStyles(html_row_line_divider_weight=1, html_row_line_divider_style='thin', html_row_line_divider_color='black', html_odds_background=None, html_evens_background=None)

Bases: object

html_row_line_divider_weight: Optional[int] = 1

html_row_line_divider_style: Optional[Literal['none', 'thin', 'thick', 'double']] = 'thin'

html_row_line_divider_color: Optional[str] = 'black'

html_odds_background: Optional[str] = None

html_evens_background: Optional[str] = None

Module contents