Skip to content

continuous_timeseries.formatting#

Support for pretty formatting of our classes

Inspired by:

  • the difference between __repr__ and __str__ in Python (see e.g. https://realpython.com/python-repr-vs-str/)

  • the advice from the IPython docs about prettifying output (https://ipython.readthedocs.io/en/8.26.0/config/integrating.html#rich-display)

  • the way that xarray handles formatting (see https://github.com/pydata/xarray/blob/main/xarray/core/formatting.py)

  • the way that pint handles formatting (see e.g. this line )

Functions:

Name Description
add_html_attribute_row

Add a row for displaying an attribute's HTML value to a list of existing rows
apply_ct_html_styling

Apply continuous timeseries' HTML styling for displaying an instance
get_html_repr_safe

Get the HTML representation of an instance
make_html_attribute_table

Make an HTML table of attributes
to_html

Convert an instance to its html representation
to_pretty

Pretty-print an instance using IPython's pretty printer
to_str

Convert an instance to its string representation

add_html_attribute_row #

add_html_attribute_row(
    attribute_name: str,
    attribute_value_html: str,
    attribute_rows: list[str],
) -> list[str]

Add a row for displaying an attribute's HTML value to a list of existing rows

Parameters:

Name Type Description Default
attribute_name str

Attribute's name

 required
attribute_value_html str

Attribute's HTML value to display

 required
attribute_rows list[str]

Existing attribute rows

 required

Returns:

Type Description
list[str]

Attribute rows, with the new row appended
Source code in src/continuous_timeseries/formatting.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
def add_html_attribute_row(
    attribute_name: str, attribute_value_html: str, attribute_rows: list[str]
) -> list[str]:
    """
    Add a row for displaying an attribute's HTML value to a list of existing rows

    Parameters
    ----------
    attribute_name
        Attribute's name

    attribute_value_html
        Attribute's HTML value to display

    attribute_rows
        Existing attribute rows

    Returns
    -------
    :
        Attribute rows, with the new row appended
    """
    attribute_rows.append(
        "<tr>\n"
        f"  <th>{attribute_name}</th>\n"
        "  <td style='text-align:left;'>\n"
        f"{textwrap.indent(attribute_value_html, '    ')}\n"
        "  </td>\n"
        "</tr>"
    )

    return attribute_rows

apply_ct_html_styling #

apply_ct_html_styling(
    display_name: str, attribute_table: str
) -> str

Apply continuous timeseries' HTML styling for displaying an instance

Parameters:

Name Type Description Default
display_name str

Name to display as the instance's name

This appears as the title of the output table/div

 required
attribute_table str

Table of attributes of the instance.

Generally created with make_html_attribute_table.

 required

Returns:

Type Description
str

Formatted HTML with CSS styling included
Source code in src/continuous_timeseries/formatting.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
def apply_ct_html_styling(display_name: str, attribute_table: str) -> str:
    """
    Apply continuous timeseries' HTML styling for displaying an instance

    Parameters
    ----------
    display_name
        Name to display as the instance's name

        This appears as the title of the output table/div

    attribute_table
        Table of attributes of the instance.

        Generally created with [`make_html_attribute_table`][(m)].

    Returns
    -------
    :
        Formatted HTML with CSS styling included
    """
    css_style = """.continuous-timeseries-wrap {
  /*font-family: monospace;*/
  width: 540px;
}

.continuous-timeseries-header {
  padding: 6px 0 6px 3px;
}

.continuous-timeseries-header > div {
  display: inline;
  margin-top: 0;
  margin-bottom: 0;
}

.continuous-timeseries-cls {
  margin-left: 2px;
  margin-right: 10px;
}

.continuous-timeseries-cls {
  font-weight: bold;
}"""
    html_l = [
        "<div>",
        "  <style>",
        f"{css_style}",
        "  </style>",
        "  <div class='continuous-timeseries-wrap'>",
        "    <div class='continuous-timeseries-header'>",
        f"      <div class='continuous-timeseries-cls'>{display_name}</div>",
        textwrap.indent(attribute_table, "      "),
        "    </div>",
        "  </div>",
        "</div>",
    ]

    return "\n".join(html_l)

get_html_repr_safe #

get_html_repr_safe(
    instance: Any,
    escapes: tuple[tuple[str, str], ...] = (
        ("&", "&amp;"),
        ("<", "&lt;"),
        (">", "&gt;"),
    ),
) -> str

Get the HTML representation of an instance

Parameters:

Name Type Description Default
instance Any

Instance of which to get the HTML representation

 required
escapes tuple[tuple[str, str], ...]

Escape characters to apply when a raw string has to be used

 (('&', '&amp;'), ('<', '&lt;'), ('>', '&gt;'))

Returns:

Type Description
str

HTML representation.

If instance has a _repr_html_ method, this is used. Otherwise the string representation of instance is returned.
Source code in src/continuous_timeseries/formatting.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
def get_html_repr_safe(
    instance: Any,
    escapes: tuple[tuple[str, str], ...] = (
        ("&", "&amp;"),
        ("<", "&lt;"),
        (">", "&gt;"),
    ),
) -> str:
    """
    Get the HTML representation of an instance

    Parameters
    ----------
    instance
        Instance of which to get the HTML representation

    escapes
        Escape characters to apply when a raw string has to be used

    Returns
    -------
    :
        HTML representation.

        If `instance` has a `_repr_html_` method, this is used.
        Otherwise the string representation of `instance` is returned.
    """
    # Workaround to make our domain render nicely
    if isinstance(instance, (tuple, list)):
        elements_html = [get_html_repr_safe(v, escapes=escapes) for v in instance]
        elements_comma_separated = ", ".join(elements_html)

        if isinstance(instance, tuple):
            brackets = "()"

        if isinstance(instance, list):
            brackets = "[]"

        return f"{brackets[0]}{elements_comma_separated}{brackets[1]}"

    try:
        repr_html = cast(str, instance._repr_html_())
    except AttributeError:
        repr_html = str(instance)

        for raw, escaped in escapes:
            repr_html = repr_html.replace(raw, escaped)

    return repr_html

make_html_attribute_table #

make_html_attribute_table(
    attribute_rows: Iterable[str],
) -> str

Make an HTML table of attributes

Parameters:

Name Type Description Default
attribute_rows Iterable[str]

Attribute rows to put in the table

 required

Returns:

Type Description
str

HTML table of attribute rows
Source code in src/continuous_timeseries/formatting.py 
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def make_html_attribute_table(attribute_rows: Iterable[str]) -> str:
    """
    Make an HTML table of attributes

    Parameters
    ----------
    attribute_rows
        Attribute rows to put in the table

    Returns
    -------
    :
        HTML table of attribute rows
    """
    attribute_rows_for_table = textwrap.indent("\n".join(attribute_rows), "  ")
    html_l = [
        "<table><tbody>",
        f"{attribute_rows_for_table}",
        "</tbody></table>",
    ]

    return "\n".join(html_l)

to_html #

to_html(
    instance: Any,
    attrs_to_show: Iterable[str],
    prefix: str = "continuous_timeseries.",
    include_header: bool = True,
) -> str

Convert an instance to its html representation

Parameters:

Name Type Description Default
instance Any

Instance to convert

 required
attrs_to_show Iterable[str]

Attributes to include in the HTML representation.

 required
prefix str

Prefix to include in front of the instance name when displaying.

 'continuous_timeseries.'
include_header bool

Should the header be included when formatting the object?

 True

Returns:

Type Description
str

HTML representation of the instance
Source code in src/continuous_timeseries/formatting.py 
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
def to_html(
    instance: Any,
    attrs_to_show: Iterable[str],
    prefix: str = "continuous_timeseries.",
    include_header: bool = True,
) -> str:
    """
    Convert an instance to its html representation

    Parameters
    ----------
    instance
        Instance to convert

    attrs_to_show
        Attributes to include in the HTML representation.

    prefix
        Prefix to include in front of the instance name when displaying.

    include_header
        Should the header be included when formatting the object?

    Returns
    -------
    :
        HTML representation of the instance
    """
    instance_type = type(instance).__name__

    header = f"{prefix}{instance_type}"

    attribute_rows: list[str] = []
    for att in attrs_to_show:
        att_val = getattr(instance, att)

        if hasattr(att_val, "_repr_html_internal_row_"):
            # One of our objects
            att_val_html = att_val._repr_html_internal_row_()

        else:
            att_val_html = get_html_repr_safe(att_val)

        attribute_rows = add_html_attribute_row(att, att_val_html, attribute_rows)

    attribute_table = make_html_attribute_table(attribute_rows)
    if not include_header:
        return attribute_table

    return apply_ct_html_styling(display_name=header, attribute_table=attribute_table)

to_pretty #

to_pretty(
    instance: Any,
    attrs_to_show: Collection[str],
    p: RepresentationPrinter,
    cycle: bool,
    indent: int = 4,
) -> None

Pretty-print an instance using IPython's pretty printer

Parameters:

Name Type Description Default
instance Any

Instance to convert

 required
attrs_to_show Collection[str]

Attributes to include in the pretty representation.

 required
p RepresentationPrinter

Pretty printer

 required
cycle bool

Whether the pretty printer has detected a cycle or not.

 required
indent int

Indent to apply to the pretty printing group

 4
Source code in src/continuous_timeseries/formatting.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def to_pretty(
    instance: Any,
    attrs_to_show: Collection[str],
    p: IPython.lib.pretty.RepresentationPrinter,
    cycle: bool,
    indent: int = 4,
) -> None:
    """
    Pretty-print an instance using IPython's pretty printer

    Parameters
    ----------
    instance
        Instance to convert

    attrs_to_show
        Attributes to include in the pretty representation.

    p
        Pretty printer

    cycle
        Whether the pretty printer has detected a cycle or not.

    indent
        Indent to apply to the pretty printing group
    """
    instance_type = type(instance).__name__

    with p.group(indent, f"{instance_type}(", ")"):
        for i, att in enumerate(attrs_to_show):
            p.breakable("")  # type: ignore
            p.text(f"{att}=")  # type: ignore
            p.pretty(getattr(instance, att))  # type: ignore

            if i < len(attrs_to_show) - 1:
                p.text(",")  # type: ignore

to_str #

to_str(instance: Any, attrs_to_show: Iterable[str]) -> str

Convert an instance to its string representation

Only include specified attributes in the representation. Show the string representation of the attributes to show.

As a note, the point of this is to provide a helpful representation for users. The repr representation is intended for developers.

For more details, see e.g. https://realpython.com/python-repr-vs-str/

Parameters:

Name Type Description Default
instance Any

Instance to convert to str

 required
attrs_to_show Iterable[str]

Attributes to include in the string representation.

 required

Returns:

Type Description
str

String representation of the instance
Source code in src/continuous_timeseries/formatting.py 
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
def to_str(instance: Any, attrs_to_show: Iterable[str]) -> str:
    """
    Convert an instance to its string representation

    Only include specified attributes in the representation.
    Show the string representation of the attributes to show.

    As a note, the point of this is to provide a helpful representation for users.
    The `repr` representation is intended for developers.

    For more details, see e.g. https://realpython.com/python-repr-vs-str/

    Parameters
    ----------
    instance
        Instance to convert to str

    attrs_to_show
        Attributes to include in the string representation.

    Returns
    -------
    :
        String representation of the instance
    """
    instance_type = type(instance).__name__

    attribute_str = [f"{v}={getattr(instance, v)}" for v in attrs_to_show]

    res = f"{instance_type}({', '.join(attribute_str)})"

    return res