forked from 139bercy/decp-qualite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.py
333 lines (287 loc) · 11.6 KB
/
build.py
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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
274
275
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
326
327
328
329
330
331
332
333
""" Module contenant les fonctions pour construire les différents éléments de la page Web streamlit.
"""
import base64
from audit import audit_results_one_source
import streamlit as st
from decp_qualite import conf
from decp_qualite.audit import audit_results
from decp_qualite.audit import measures
def page_config():
"""Construit la configuration Streamlit de la page"""
st.set_page_config(
page_title=conf.web.titre_page,
page_icon="decp_qualite/web/static/favicon.ico",
layout="wide",
initial_sidebar_state="auto",
)
def sidebar(available_sources: list, available_dates: list):
"""Construit la barre latérale de la page.
Args:
available_sources (list): Listes de sources disponibles dans les données
available_dates (list): Listes de dates pour lesquelles la donnée est disponible
Returns:
str, str, str: Source, date courante et date de comparaison sélectionnées
"""
st.sidebar.markdown(conf.web.texte_haut_barre_laterale)
selected_page = st.sidebar.radio(
"Naviguer vers", [conf.web.page_resultats, conf.web.page_documentation]
)
selected_source = st.sidebar.selectbox("Source à analyser", available_sources)
sidebar_column_1, sidebar_column_2 = st.sidebar.columns(2)
month_formatter_lambda = lambda date: date.strftime("%b. %Y")
with sidebar_column_1:
current_date = st.selectbox(
"Mois courant",
available_dates,
index=len(available_dates) - 1,
format_func=month_formatter_lambda,
)
with sidebar_column_2:
old_date = st.selectbox(
"Mois à comparer",
available_dates,
index=0,
format_func=month_formatter_lambda,
)
st.sidebar.markdown(conf.web.texte_bas_barre_laterale)
return selected_page, selected_source, current_date, old_date
def get_zip_download_link(zip_path, client_file_name="file.zip"):
"""Generates a link allowing a ZIP file to be downloaded"""
with open(zip_path, "rb") as f:
bytes = f.read()
b64 = base64.b64encode(bytes).decode()
href = f"<a href=\"data:file/zip;base64,{b64}\" download='{client_file_name}'> {client_file_name} </a>"
return href
def download_button(path_results: str, path_details: str = None, parent_container=st):
"""Construit un bouton de téléchargement pour les données.
Args:
path_results (str): Chemin vers le fichier ZIP contenant les résultats d'audit
path_details (str, optional): Chemin vers le fichier ZIP contenant le détail par marché. Defaults to None.
parent_container ([type], optional): Container dans lequel construire le bouton. Defaults to st.
"""
if parent_container.button("Générer les liens de téléchargement"):
link_results = get_zip_download_link(
path_results, client_file_name="synthèse.zip"
)
if path_details is not None:
link_details = get_zip_download_link(
path_details, client_file_name="détails.zip"
)
parent_container.markdown(
f"Synthèse par source : {link_results} <br> Détails par marché : {link_details}",
unsafe_allow_html=True,
)
else:
parent_container.markdown(
f"Synthèse par source : {link_results}", unsafe_allow_html=True
)
def no_data_page():
"""Construit la partie principale de la page si aucune donnée n'est disponible"""
title()
st.error("Aucune donnée de résultat d'audit de qualité n'est disponible.")
def documentation_page():
"""Construit la partie principale de la page de documentation"""
title()
with open("indicateurs.md", "r", encoding="utf-8") as file:
markdown = file.read()
st.markdown(markdown, unsafe_allow_html=True)
def page(
current_results: audit_results_one_source.AuditResultsOneSource,
old_results: audit_results_one_source.AuditResultsOneSource,
):
"""Construit la partie principale de la page"""
title()
global_container(current_results, old_results)
details_container(current_results)
def title():
"""Construit le titre de la page"""
st.image("decp_qualite/web/static/logo.png", width=300)
st.title(conf.web.titre)
def get_metric_value_delta(current_value: float, old_value: float):
"""Construit les valeurs pour un élément 'streamlit.metric' à partir de la valeur courante et ancienne
Args:
current_value (float): Valeur actuelle
old_value (float): Ancienne valeure
Returns:
str, str: Chaîne pour la valeur et le delta de l'élément
"""
current_value = int(current_value * 100)
old_value = int(old_value * 100)
value = f"{current_value}" # " %"
delta = f"{current_value - old_value} pts"
return value, delta
def to_percentage(number: float):
"""Formatte un nombre en pourcentage. Exemple : 0.28 -> 28%
Args:
number (float): Nombre à convertir
Returns:
str: Pourcentage
"""
number = int(number * 100)
percentage = f"{number}" + "%"
return percentage
def global_container(
current_results: audit_results_one_source.AuditResultsOneSource,
old_results: audit_results_one_source.AuditResultsOneSource,
):
st.markdown(
f"*Source sélectionnée : {current_results.source} - {current_results.num_rows} marchés*"
)
"""Construit la section contenant les indicateurs de qualité globale"""
global_container = st.container()
global_container.subheader("Synthèse")
global_container.markdown(f"{conf.web.texte_synthese}")
(
global_col_1,
global_col_2,
global_col_3,
global_col_4,
global_col_5,
global_col_6,
global_col_7,
) = global_container.columns([2, 1, 1, 1, 1, 1, 1])
global_col_1.metric(
"Qualité globale",
*get_metric_value_delta(
current_results.general.valeur, old_results.general.valeur
),
)
global_col_1.markdown(f"*Rang source:* **{current_results.general.rang}**")
global_col_2.metric(
"Validité",
*get_metric_value_delta(
current_results.validite.valeur, old_results.validite.valeur
),
)
global_col_2.markdown(f"*Rang:* **{current_results.validite.rang}**")
global_col_3.metric(
"Complétude",
*get_metric_value_delta(
current_results.completude.valeur, old_results.completude.valeur
),
)
global_col_3.markdown(f"*Rang:* **{current_results.completude.rang}**")
global_col_4.metric(
"Conformité",
*get_metric_value_delta(
current_results.conformite.valeur, old_results.conformite.valeur
),
)
global_col_4.markdown(f"*Rang:* **{current_results.conformite.rang}**")
global_col_5.metric(
"Cohérence",
*get_metric_value_delta(
current_results.coherence.valeur, old_results.coherence.valeur
),
)
global_col_5.markdown(f"*Rang:* **{current_results.coherence.rang}**")
global_col_6.metric(
"Singularité",
*get_metric_value_delta(
current_results.singularite.valeur, old_results.singularite.valeur
),
)
global_col_6.markdown(f"*Rang:* **{current_results.singularite.rang}**")
global_col_7.metric(
"Exactitude",
*get_metric_value_delta(
current_results.exactitude.valeur, old_results.exactitude.valeur
),
)
global_col_7.markdown(f"*Rang:* **{current_results.exactitude.rang}**")
def details_container(current_results: audit_results_one_source.AuditResultsOneSource):
"""Construit la section contenant les indicateurs de qualité détaillés"""
details_container = st.container()
details_container.subheader("Détails des indicateurs")
details_container.markdown(f"{conf.web.texte_details}")
details_col_1, details_col_2, details_col_3 = details_container.columns(3)
detailed_singularite_container(details_col_1, current_results.singularite)
detailed_validite_container(details_col_1, current_results.validite)
detailed_completude_container(details_col_2, current_results.completude)
detailed_conformite_container(details_col_2, current_results.conformite)
detailed_exactitude_container(details_col_3, current_results.exactitude)
detailed_coherence_container(details_col_3, current_results.coherence)
def detailed_singularite_container(parent_element, singularite: measures.Singularite):
singularite_container = parent_element.container()
singularite_container.markdown("**Singularité**")
singularite_container.info(
f"""
**{to_percentage(singularite.identifiants_non_uniques)}** identifiants non uniques
"""
)
singularite_container.info(
f"""
**{to_percentage(singularite.lignes_dupliquees)}** lignes dupliquées
"""
)
def detailed_validite_container(parent_element, validite: measures.Validite):
validite_container = parent_element.container()
validite_container.markdown("**Validité**")
validite_container.info(
f"""
**{int(validite.jours_depuis_derniere_publication*100)}{"+" if validite.jours_depuis_derniere_publication==1.0 else ""}** jours depuis la dernière publication
"""
)
validite_container.info(
f"""
**{to_percentage(validite.depassements_delai_entre_notification_et_publication)}** dépassements du délai entre notification et publication
"""
)
def detailed_completude_container(parent_element, completude: measures.Completude):
completude_container = parent_element.container()
completude_container.markdown("**Complétude**")
completude_container.info(
f"""
**{to_percentage(completude.donnees_manquantes)}** données manquantes
"""
)
# Données manquantes et valeurs non renseignées sont calculées identiquement
# completude_container.info(
# f"""
# **{to_percentage(completude.valeurs_non_renseignees)}** valeurs non renseignées
# """
# )
def detailed_conformite_container(parent_element, conformite: measures.Conformite):
conformite_container = parent_element.container()
conformite_container.markdown("**Conformité**")
conformite_container.info(
f"""
**{to_percentage(conformite.caracteres_mal_encodes)}** caractères mal encodés
"""
)
conformite_container.info(
f"""
**{to_percentage(conformite.formats_non_valides)}** formats ou types non respectés
"""
)
conformite_container.info(
f"""
**{to_percentage(conformite.valeurs_non_valides)}** valeurs invalides
"""
)
def detailed_exactitude_container(parent_element, exactitude: measures.Exactitude):
exactitude_container = parent_element.container()
exactitude_container.markdown("**Exactitude**")
exactitude_container.info(
f"""
**{to_percentage(exactitude.valeurs_aberrantes)}** valeurs/montants aberrants
"""
)
exactitude_container.info(
f"""
**{to_percentage(exactitude.valeurs_extremes)}** valeurs extrêmes
"""
)
def detailed_coherence_container(parent_element, coherence: measures.Coherence):
coherence_container = parent_element.container()
coherence_container.markdown("**Cohérence**")
coherence_container.info(
f"""
**{to_percentage(coherence.incoherences_temporelles)}** incohérences temporelles entre notification/signature et publication
"""
)
coherence_container.info(
f"""
**{to_percentage(coherence.incoherences_montant_duree)}** incohérences entre montant et durée
"""
)