File: html.py

package info (click to toggle)
gridtools 2.3.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 29,480 kB
  • sloc: cpp: 228,792; python: 17,561; javascript: 9,164; ansic: 4,101; sh: 850; makefile: 231; f90: 201
file content (179 lines) | stat: -rw-r--r-- 4,674 bytes parent folder | download | duplicates (3)
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
import contextlib
import pathlib
from xml.etree import ElementTree as et

from pyutils import log

_CSS = '''
    /* general style */
    body {
        font-family: sans-serif;
        display: flex;
        flex-wrap: wrap;
    }
    section {
        flex: 0 0 auto;
        align-items: center;
        box-sizing: border-box;
        padding: 20px;
    }
    h1 {
        width: 100%;
        padding: 20px;
    }
    /* table style */
    table {
        padding-bottom: 5em;
        border-collapse: collapse;
        table-layout:fixed;
        max-width: calc(100vw - 60px);
    }
    th {
        text-align: left;
        border-bottom: 1px solid black;
        padding: 0.5em;
        word-wrap:break-word;
    }
    td {
        padding: 0.5em;
        word-wrap:break-word;
    }
    /* styles for good/bad/unknown entries in table */
    .good {
        color: #81b113;
        background: #dfff79;
        font-weight: bold;
    }
    .bad {
        color: #c23424;
        background: #ffd0ac;
        font-weight: bold;
    }
    .unknown {
        color: #1f65c2;
        background: #d5ffff;
        font-weight: bold;
    }
    /* image-grid style */
    .grid-section {
        width: 100%;
    }
    .grid-container {
        width: 100%;
        display: grid;
        grid-template-columns: repeat(auto-fit, minmax(500px, 1fr));
    }
    img {
        width: 100%;
    }

'''


class Report:
    def __init__(self, data_dir, title):
        self.data_dir = pathlib.Path(data_dir)
        self.data_dir.mkdir()
        self.data_counter = 0

        self.html = et.Element('html')
        self._init_head()
        self.body = et.SubElement(self.html, 'body')
        header = et.SubElement(self.body, 'h1')
        header.text = title

    def _init_head(self):
        head = et.SubElement(self.html, 'head')
        et.SubElement(head, 'meta', charset='utf-8')
        et.SubElement(head,
                      'meta',
                      name='viewport',
                      content='width=device-width, initial-scale=1.0')
        et.SubElement(head,
                      'link',
                      rel='stylesheet',
                      href=str(self._write_css()))

    def _write_css(self):
        path, rel_path = self.get_data_path('.css')
        with path.open('w') as css_file:
            css_file.write(_CSS)
        log.debug(f'Successfully written CSS to {path}')
        return rel_path

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        if exc_type is None:
            self.write()
        return False

    def write(self):
        et.ElementTree(self.html).write(self.data_dir / 'index.html',
                                        encoding='utf-8',
                                        method='html')
        log.info(f'Successfully written HTML report to {self.data_dir}')

    def get_data_path(self, suffix=''):
        filename = f'{self.data_counter:03}{suffix}'
        self.data_counter += 1
        return self.data_dir / filename, filename

    @contextlib.contextmanager
    def _section(self, title):
        section = et.SubElement(self.body, 'section')
        if title:
            header = et.SubElement(section, 'h2')
            header.text = title
        yield section

    @contextlib.contextmanager
    def table(self, title=None):
        with self._section(title) as section:
            yield _Table(section)

    @contextlib.contextmanager
    def image_grid(self, title=None):
        with self._section(title) as section:
            section.set('class', 'grid-section')
            yield _Grid(section, self.get_data_path)


class _Table:
    def __init__(self, parent):
        self.html = et.SubElement(parent, 'table')
        self.first = True

    @contextlib.contextmanager
    def row(self):
        yield _TableRow(self.html, self.first)
        self.first = False


class _TableRow:
    def __init__(self, parent, header):
        self.html = et.SubElement(parent, 'tr')
        self.header = header

    def cell(self, text):
        elem = et.SubElement(self.html, 'th' if self.header else 'td')
        elem.text = text
        return elem

    def fill(self, *texts):
        return [self.cell(text) for text in texts]


class _Grid:
    def __init__(self, parent, get_data_path):
        self.html = et.SubElement(parent, 'div', {'class': 'grid-container'})
        self.get_data_path = get_data_path

    def image(self):
        path, rel_path = self.get_data_path('.png')
        et.SubElement(self.html, 'img', {
            'class': 'grid-item',
            'src': str(rel_path)
        })
        return path