1.2.2. AfficheurCLI

Module pour les intéractions avec la ligne de commande.

class cli.afficheur_cli.AfficheurCLI[source]

Bases : object

Représente une classe pour afficher des informations dans la ligne de commande.

_thread_chargement

Le thread de l’animation de chargement.

Type:: Union[None,Thread]

_thread_chargement_termine

L’évènement pour demander au thread de l’animation de chargement de s’arrêter lorsque le chargement est terminé.

Type:: Event

_thread_chargement_erreur

L’évènement pour demander au thread de l’animation de chargement de s’arrêter lorsque une erreur s’est produite.

Type:: Event

_animations_actuelles

Les éléments visuels pour l’animation de chargement.

Type:: dict

Class-level variables:

cvar COULEUR_MESSAGE_NORMAL (str):: La couleur pour les messages normaux en CLI.
cvar COULEUR_MESSAGE_ERREUR (str):: La couleur pour les messages d’erreur en CLI.

COULEUR_MESSAGE_ERREUR = '\x1b[31m'

COULEUR_MESSAGE_NORMAL = '\x1b[37m'

affiche_erreur(message: str, exception: Exception) → None[source]

Permet d’écrire un message d’erreur dans la ligne de commande avec la bonne couleur.

Paramètres:

message (str) – Le message à afficher.
exception (Exception) – L’exception à afficher.

Renvoie:

None

Lève:

TypeError – Le paramètre message n’est pas une chaîne de caractères ou le paramètre exception n’est pas une instance de la classe Exception.

affiche_message(message: str) → None[source]

Permet d’écrire un message commun dans la ligne de commande avec la bonne couleur.

Paramètres:: message (str) – Le message à afficher.
Renvoie:: None
Lève:: TypeError – Le paramètre message n’est pas une chaîne de caractères.

lance_animation_chargement() → None[source]

Lance une animation de chargement dans la ligne de commande via un thread non bloquant. Si l’animation de chargement est déjà en cours, cette méthode ne fait rien.

Renvoie:: None

reecrire_ligne(message: str) → None[source]

Permet d’écrire des caractères par dessus la dernière ligne dans la ligne de commande.

Paramètres:: message (str) – Les caractères à afficher.
Renvoie:: None
Lève:: TypeError – Le paramètre message n’est pas une chaîne de caractères.

stop_animation_chargement(erreur: bool = False) → None[source]

Lance une demande d’arrêt au thread qui gère l’animation de chargement en cours. Si aucune animation n’est en cours, cette méthode ne fait rien.

Paramètres:: erreur (bool) – Indique si la demande d’arrêt est dûe à une erreur ou non.
Renvoie:: None