Features for the user messages

Detailed description

code_aster.Messages.Utmess.list_unit(code)

Retourne la liste des noms de fichiers (logiques) sur lesquels doit etre imprimé le message.

class code_aster.Messages.Utmess.MESSAGE_LOGGER(*args, **kws)

Bases: object

Classe gérant l’impression de messages. On ne crée qu’une instance de ce type (singleton). Cette instance est accessible dans le module aster_core pour les appels depuis le fortran.

__init__()

Initialisation

init_mpi_error()

Stocke les informations nécessaires pour la gestion des erreurs en MPI.

__call__(*args, **kwargs)

Raccourci pour simplifier l’appel depuis astermodule.c et UTMESS.

print_message(code, idmess, valk=(), vali=(), valr=(), exc_typ=None, exception=False, print_as=None, files=None, cc=True)

Appelé par la routine fortran U2MESG ou à la fonction python UTMESS pour afficher un message. L’impression de ce message est différée si le code est suivi d’un “+”. - code : ‘A’, ‘E’, ‘S’, ‘F’, ‘I’ - idmess : identificateur du message - valk, vali, valr : liste des chaines, entiers ou réels. Si exception==True, on lève une exception en cas d’erreur, sinon c’est l’appelant qui devra s’en charger (dans le C a priori). ‘print_as’, ‘files’, ‘cc’ : cf. print_buffer_content.

build_dict_args(valk, vali, valr)

Construit le dictionnaire de formatage du message.

decode_idmess(idmess)

Decode la chaine idmess.

load_cata_msg(catamess)

Retourne le dictionnaire de messages.

check_message(idmess, skip=False)

Check that a message exists.

Parameters:

• idmess (str) – Message id.

• skip (bool) – True to skip the check.

Raises:

KeyError – If the message does not exist.

get_message(code, idmess, valk=(), vali=(), valr=(), exc_typ=None)

Retourne le texte du message dans un dictionnaire dont les clés sont : ‘code’, ‘id_message’, ‘corps_message’

GetText(*args, **kwargs)

Retourne le texte du message pret a etre imprime.

init_buffer()

Initialise le buffer.

is_buffer_empty()

Tell if the buffer is currently empty

set_parent(idmess)

Store the parent id of the current message

add_to_buffer(dictmess)

Ajoute le message décrit dans le buffer en vue d’une impression ultérieure.

get_current_code()

Retourne le code du message du buffer = code du message le plus grave (cf. dgrav)

get_current_flags()

Retourne les flags du message du buffer = flags du premier.

get_current_id()

Retourne l’id du message du buffer = id du premier message

print_buffer_content(print_as=None, files=None, cc=True)

Extrait l’ensemble des messages du buffer dans un dictionnaire unique, imprime le message, et vide le buffer pour le message suivant. - code : celui du message le plus grave (cf. dgrav) - id : celui du premier message qui est affiché - corps : concaténation de tous les messages.

‘print’_as permet d’imprimer un message sur des fichiers autres que les fichiers habituels de ‘code’. Par ex, imprimer un message d’info sur ‘ERREUR’. ‘files’ : liste de noms de fichiers ou objets fichier dans lesquels écrire le message ‘cc’ : si True, on écrit comme d’habitude et dans les ‘files’, si False, on n’écrit que sur les fichiers habituels (MESSAGE, RESULTAT, ERREUR) ou bien dans ‘files’ si fournit.

disable_alarm(idmess, hide=False, skip=False)

Ignore l’alarme “idmess”.

reset_alarm(idmess, hide=False, skip=False)

Réactive l’alarme “idmess”.

is_alarm_disabled(idmess)

Doit-on ignorer l’alarme “idmess” ?

get_info_alarm(only_ignored=False)

Retourne la liste des alarmes émises, le nombre d’occurrence pour chacune d’elle et un indicateur disant si elle a été masquée ou pas.

get_info_alarm_nb(only_ignored=False)

Retourne le nombre d’alarme émises (et non masquées).

info_alarm(only_ignored=False)

Fournit les infos sur les alarmes activées.

update_counter(code, idmess)

Update the counters of alarms. The counter is updated only for the first message in the buffer. So it is important to call this method before adding the message into the buffer. Return True if everything is ok, False if the message will be skipped.

check_limit()

Vérifications des compteurs et réaction si besoin.

check_counter(info_alarm=0, silent=0)

Méthode “jusqu’ici tout va bien” ! (Interface C : chkmsg) Si des erreurs <E> se sont produites, on arrete le code en <F>. Appelée par FIN ou directement au cours de l’exécution d’une commande. Retourne un entier : 0 si tout est ok. Si silent==1, on n’émet pas de message, on ne s’arrete pas.

reset_command()

Méthode appelée entre les commandes. (Interface C : resmsg) On remet à zéro le compteur d’alarme, on vérifie les erreurs <E> en attente.

format_message(dictmess)

Formate le message décrit dans un dico : ‘code’ : A, E, S, F, I ‘id_message’ : identification du message ‘corps_message’ : texte

get_type_message(dictmess)

Retourne le type du message affiché. En cas d’erreur, si on lève une exception au lieu de s’arreter, on affiche le type de l’erreur.

affiche(unite, txt)

Affichage du message

onFatalError()

Récupérer le comportement en cas d’erreur fatale.

code_aster.Messages.Utmess.is_last_message(code)

Tell if a message ‘code’ is the last message or not.

code_aster.Messages.Utmess.UTMESS(code, idmess, valk=(), vali=(), valr=(), exc_typ=None, print_as=None, files=None, cc=True)

Utilitaire analogue à la routine fortran U2MESS/U2MESG avec les arguments optionnels.

Remarques : - Nommer les arguments permet de ne pas tous les passer. - Meme fonctionnement que U2MESG :

• appel à MessageLog

• puis exception ou abort en fonction du niveau d’erreur.

Parameters:

• code (str) – ‘A’, ‘E’, ‘S’, ‘F’, ‘I’

• idmess (str) – identificateur du message

• valk – liste des chaines, entiers ou réels.

• vali – liste des chaines, entiers ou réels.

• valr – liste des chaines, entiers ou réels.

code_aster.Messages.Utmess.ASSERT(condition, message='')

Remonter un assert dans un message.

code_aster.Messages.Utmess.message_exception(code, exc)

Retourne le message associé à une exception AsterError tel qu’il aurait été imprimé par UTMESS selon la valeur de code (‘I’, ‘A’, ‘S’, ‘F’, ‘Z’…).

code_aster.Messages.Utmess.MasquerAlarme(idmess)

Masque une alarme : ni affichee, ni comptee. Utilisation dans les macros : - MasquerAlarme(XXX) au debut de la macro - RetablirAlarme(XXX) a la fin de la macro Comme il s’agit d’un compteur qui est incremente puis decremente, il est imperatif qu’il y ait autant d’appel a MasquerAlarme qu’a RetablirAlarme.

code_aster.Messages.Utmess.RetablirAlarme(idmess)

Retablit l’etat initial pour l’alarme ‘idmess’.