Skip to content

md_util

Author: Heli Qi Affiliation: NAIST Date: 2022.07

get_list_strings(content_dict, header_bold=True)

Return the .md string for making a list.

Parameters:

Name Type Description Default
content_dict Dict

Dict The main body of the list. Each key-value item corresponds to a row. The key is the header name and the value is the content.

 required
header_bold bool

bool Controls whether the header names are bolded.

 True

Returns:

Type Description

The well-structured .md list string.
Source code in speechain/utilbox/md_util.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def get_list_strings(content_dict: Dict, header_bold: bool = True):
    """Return the .md string for making a list.

    Args:
        content_dict: Dict
            The main body of the list. Each key-value item corresponds to a row.
            The key is the header name and the value is the content.
        header_bold: bool
            Controls whether the header names are bolded.

    Returns:
        The well-structured .md list string.
    """

    list_strings = ""
    for header, content in content_dict.items():
        list_strings += (
            f"* {f'**{header}:**' if header_bold else f'{header}:'} {content}\n"
        )

    return list_strings

get_table_strings(contents, first_col=None, first_col_bold=True, headers=None, header_bold=True)

Return the .md string for making a table.

Parameters:

Name Type Description Default
contents List[List] or List

List[List] or List The main body of the table. Each list element corresponds to a row.

 required
first_col List

List The values of the first column. If not given, no first column will be added.

 None
first_col_bold bool

bool Controls whether the values of the first column is bolded.

 True
headers List

List The values of the table headers. If not given, no header will be added.

 None
header_bold bool

bool Controls whether the values of the header is bolded.

 True

Returns:

Type Description

The well-structured .md table string.
Source code in speechain/utilbox/md_util.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def get_table_strings(
    contents: List[List] or List,
    first_col: List = None,
    first_col_bold: bool = True,
    headers: List = None,
    header_bold: bool = True,
):
    """Return the .md string for making a table.

    Args:
        contents: List[List] or List
            The main body of the table. Each list element corresponds to a row.
        first_col: List
            The values of the first column. If not given, no first column will be added.
        first_col_bold: bool
            Controls whether the values of the first column is bolded.
        headers: List
            The values of the table headers. If not given, no header will be added.
        header_bold: bool
            Controls whether the values of the header is bolded.

    Returns:
        The well-structured .md table string.
    """
    if not isinstance(contents[0], List):
        contents = [contents]
    if first_col is not None:
        assert len(first_col) == len(
            contents
        ), "The lengths of first_col and contents don't match!"
    if headers is not None:
        if first_col is not None:
            assert (
                len(headers) == len(contents[0]) + 1
            ), "The lengths of headers and contents don't match!"
        else:
            assert len(headers) == len(
                contents[0]
            ), "The lengths of headers and contents don't match!"

    table_strings = ""
    if headers is not None:
        table_strings += (
            "|" + "|".join([f"**{h}**" if header_bold else h for h in headers]) + "|\n"
        )
    else:
        if first_col is None:
            table_strings += "|"
        table_strings += "|" + "|".join(["" for _ in range(len(contents[0]))]) + "|\n"

    table_strings += "|---|" + "".join(["---|" for _ in contents[0]]) + "\n"

    for i in range(len(contents)):
        if first_col is None:
            table_strings += "|"
        else:
            table_strings += (
                f"|{f'**{first_col[i]}**' if first_col_bold else first_col[i]}|"
            )
        table_strings += "|".join(contents[i]) + "|\n"

    return table_strings