Frappe Framework
API Dialog (Python)
Depuis une requête, msgprint parle à l’utilisateur connecté au bureau. throw affiche le message et lève une exception.
Cadre
Frappe fournit des dialogues standard. L’API JavaScript plus étendue est dans API Dialog. Les formes d’interface sont aussi résumées dans Types de dialogues.
frappe.msgprint
frappe.msgprint ne fonctionne que dans un cycle requête / réponse. Le message s’adresse à l’utilisateur du bureau (Desk) qui a lancé la requête.
Signature publiée : frappe.msgprint(msg, title, raise_exception, as_table, as_list, indicator, primary_action, is_minimizable, wide, realtime).
| Argument | Effet décrit |
|---|---|
msg | Message |
title | Titre de la fenêtre |
as_table | Si msg est une liste de listes, tableau HTML |
as_list | Si msg est une liste, liste HTML |
primary_action | Action principale serveur ou client |
raise_exception | Exception |
is_wide | Fenêtre large. La signature écrit wide. |
is_minimizable | L’utilisateur peut réduire la fenêtre |
realtime | Publication immédiate par websocket, au lieu du journal de la réponse |
L’exemple affiche « This file does not exist », titre Error, et lève FileNotFoundError.
primary_action contient une server_action ou une action client_side. Les deux valeurs publiées sont des chemins pointés. La fonction JavaScript doit être globale. hide_on_success ferme le message après succès. Les clés montrées sont label, server_action, client_action, hide_on_success et args. Le texte de la page dit « server_action ou client_side », et l’exemple fournit les deux clés en même temps.
frappe.throw
frappe.throw(msg, exc, title, is_minimizable, wide, as_list, primary_action) lève une exception et affiche un message dans le bureau. C’est une enveloppe de frappe.msgprint. Sans exc, l’exception est ValidationError. L’exemple passe FileNotFoundError.
Point d’attention
Hors d’un cycle de requête, msgprint ne s’adresse pas à un utilisateur du bureau. throw interrompt le traitement en plus d’afficher le message.