Skip to content

mdtable

mdtable

Module for markdowntable

Functions

get_char_line 

get_char_line(col_widths, used_char='-')

Returns one row line with the same char (used_char)

Source code in niceml/mkdocs/mdtable.py 
32
33
34
35
36
37
38
def get_char_line(col_widths: List[int], used_char: str = "-"):
    """Returns one row line with the same char (used_char)"""
    assert len(used_char) == 1
    line: str = "|"
    for cur_col_width in col_widths:
        line += used_char * (cur_col_width + 2) + "|"
    return line + "\n"

get_md_table 

get_md_table(headings, col_widths, contents)

Creates a markdown table as str

Source code in niceml/mkdocs/mdtable.py 
 5
 6
 7
 8
 9
10
11
12
13
def get_md_table(
    headings: List[str], col_widths: List[int], contents: List[List[str]]
) -> str:
    """Creates a markdown table as str"""
    table_str = get_table_line(col_widths, headings)
    table_str += get_char_line(col_widths)
    for cur_content in contents:
        table_str += get_table_line(col_widths, cur_content)
    return table_str

get_table_line 

get_table_line(col_widths, contents)

Creates one line in an mdtable

Source code in niceml/mkdocs/mdtable.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def get_table_line(col_widths: List[int], contents: List[str]) -> str:
    """Creates one line in an mdtable"""
    line: str = "|"
    for index, cur_col_width in enumerate(col_widths):
        cur_content: str = ""
        if len(contents) > index:
            cur_content = contents[index]
        line += (
            " "
            + cur_content[:cur_col_width]
            + " " * max(0, cur_col_width - len(cur_content))
            + " |"
        )
    return line + "\n"