1
2
3
4
5
6
7
8
9
10
11
12
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
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
104
105
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
|
#!/usr/bin/env python3
"""Display sparklines from a sequence of numbers.
"""
from decimal import Decimal
from math import inf
from typing import Any, List, Optional
from milc import cli
spark_chars = '▁▂▃▄▅▆▇█'
def is_number(i: Any) -> bool:
"""Returns true if i is a number. Used to filter non-numbers from a list.
"""
return isinstance(i, (int, float, Decimal))
def sparkline(
number_list: List[Optional[int]],
*,
min_value: Optional[int] = None,
max_value: Optional[int] = None,
highlight_low: float = -inf,
highlight_high: float = inf,
highlight_low_color: str = '',
highlight_high_color: str = '',
negative_color: str = '{fg_red}',
positive_color: str = '',
highlight_low_reset: str = '{fg_reset}',
highlight_high_reset: str = '{fg_reset}',
negative_reset: str = '{fg_reset}',
positive_reset: str = '{fg_reset}',
) -> str:
"""Display a sparkline from a sequence of numbers.
If you wish to exclude extreme values, or you want to limit the set of characters used, you can adjust `min_value` and `max_value` to your own values. Values between your actual min/max will exclude datapoints, while values outside your actual min/max will compress your data into fewer sparks.
If you want to highlight data that is too low or too high you can use 'highlight_low' and `highlight_high` to set this. You will also need to set your colors, see below for more details.
By default this function will display negative numbers in red and positive numbers in the system default color. You can use `negative_color`, `negative_reset`, `positive_color`, and `positive_reset` to change this behavior.
If you wish to color your sparkline according to other rules it is recommended to generate it without color and then add color yourself.
### Arguments
min_value
The lowest value in your sparkline. If not provided it will be determined automatically.
max_value
The highest value in your sparkline. If not provided it will be determined automatically.
highlight_low
When a number is less than this value it will be highlighted with `highlight_low_color`.
highlight_high
When a number is greater than this value it will be highlighted with `highlight_high_color`.
highlight_low_color
A MILC or ANSI color code to apply to integers greater than highlight_low.
highlight_high_color
A MILC or ANSI color code to apply to integers greater than highlight_high.
negative_color
A MILC or ANSI color code to apply to integers less than 0.
positive_color
A MILC or ANSI color code to apply to integers greater than 0.
highlight_low_reset
A MILC or ANSI color code to reset the color code applied in `highlight_low_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
highlight_high_reset
A MILC or ANSI color code to reset the color code applied in `highlight_high_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
negative_reset
A MILC or ANSI color code to reset the color code applied in `negative_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
positive_reset
A MILC or ANSI color code to reset the color code applied in `positive_color`. This is usually `{fg_reset}`, `{bg_reset}`, or `{style_reset_all}`.
"""
if min_value is None:
min_value = min(filter(is_number, number_list)) # type: ignore[type-var]
if max_value is None:
max_value = max(filter(is_number, number_list)) # type: ignore[type-var]
int_range = max_value - min_value # type: ignore[operator]
sparks = []
for i in number_list:
# Handle non-numeric and out-of-bounds values
if not is_number(i):
sparks.append(' ')
continue
if i < min_value or i > max_value: # type: ignore[operator]
cli.log.debug('Skipping out of bounds value %s', i)
continue
# Determine the bucket for this value
spark_int = (i-min_value) / int_range * 8 # type: ignore[operator]
if spark_int > 7:
spark_int = 7
# Determine the color for this value
color = positive_color
reset = positive_reset
if i < 0: # type: ignore[operator]
color = negative_color
reset = negative_reset
if i < highlight_low: # type: ignore[operator]
color = highlight_low_color
reset = highlight_low_reset
if i > highlight_high: # type: ignore[operator]
color = highlight_high_color
reset = highlight_high_reset
if color == '':
reset = ''
# Add this spark to the list
sparks.append(''.join((color, spark_chars[int(spark_int)], reset)))
return ''.join(sparks)
|
