historic Namespace Reference

Functions
def	AddEmailListVar (vars)
	ajoute une liste de variable dans les prefs à envoyer par mail More...
def	AddPrefListVar (vars)
	ajoute une liste de variable dans les prefs à enregistrer More...
def	ArchiverHistorique (forcer=False, RenameFile=True)
	Archive le fichier à la première utilisation de l'année. More...
def	EnvoyerMail (ListeClVar=None, piecejointe=None)
	Envoi d'un mail. More...
def	GetPreference (Preference="", EtatParDefaut=None)
	renvoie le contenu d'une préférence, si non trouvée alors renvoie None More...
def	HistAjoutLigne (*arg)
	ajouter une ligne au fichier historique More...
def	PrefLoad (ListeClVar)
	lire le fichier pref et charger les pref si Fin Exec --> fin si Exec en cours --> ajouter les km à historique + ajouter erreur More...
def	PrefWrite (ListVariables, NormalEnd=False)
	ecrire le fichier pref : ouvrir le fichier en mode ecrase, écrire les variable dont le nom est contenu dans la liste PrefListVar More...
def	StrListVal (TabVal)
	Transforme une liste de parametre en chaine. More...
def	WritePreference (Preference, Valeur)
	ecrit la Valeur dans la préférence Preference More...

Variables
	CheminDossier = os.getcwd()
	chemin vers les fichiers historique CheminDossier = os.path.dirname(file) More...
string	ConfSeparateurVal = " = "
string	ConfSeparateurVar = "\n"
list	EmailListVar = []
	Liste des variables envoyées par mail si option configurée EnvoyerMail (voir plus bas). More...
string	FichierHistName = CheminDossier + "/historique.txt"
string	FichierPrefName = CheminDossier + "/AutoPref.txt"
string	ListeAlarmeDemarre = ""
	Chaine contenant la liste des lignes d'alarmes depuis qu'on a démarré envoyé dans le mail lorsqu'on quitte. More...
dictionary	ListePreference = {}
	liste des préférence non associés à une ClVariable More...
list	PrefListVar = []
	liste contenant les variables de ListVariables à sauvegarder dans les prefs. More...
bool	SAUVEGARDE_ANNUELLE = True
	variables à sauvegarder une fois par an : More...

Function Documentation

AddEmailListVar()

def historic.AddEmailListVar

(

vars

)

ajoute une liste de variable dans les prefs à envoyer par mail

Parameters

vars	: (array of ClVar) : liste de ClVar que l'on veur envoyer par mail (si possible) à à l'extinction.

AddPrefListVar()

def historic.AddPrefListVar

(

vars

)

ajoute une liste de variable dans les prefs à enregistrer

Parameters

vars	(array of ClVar) : liste de ClVar dont on veut sauvegarder en tant que pref.

ArchiverHistorique()

def historic.ArchiverHistorique	(		forcer = False,
			RenameFile = True
	)

Archive le fichier à la première utilisation de l'année.

Au début de chaque nouvelle année, prépare un fichier zip avec les fichiers de pref, et l'envoie par mail avec EnvoyerMail()

Parameters

forcer	(boolean, default = false) : permet de forcer l'envoie, même si ce n'est pas un changement d'année
RenameFile	(boolean, default = True) : If True, the file is rename width date and a new file is begin.

Date

• 5.0 : CRÉATION début d'implémentation, mais ne fonctionne pas. ;-)
• 6.0 22/03/2020 Modification pendant le confinement coronavirus :
  • activation du service annuel (c'était pas fini d'être implémenté)
  • ajout forcer = False pour envoyer le fichier "à la main"

EnvoyerMail()

def historic.EnvoyerMail	(		ListeClVar = None,
			piecejointe = None
	)

Envoi d'un mail.

Utilise les préférences Mail_Serveur, Mail_Port, Mail_Address, Mail_Password.
Pour ne pas utiliser, laisser Mail_Password vide.

Parameters

ListeClVar	: liste de ClVariable
piecejointe	(string) : chemin vers une pièce jointe à envoyer.

Date

28/11/2018 5.1 création

GetPreference()

def historic.GetPreference	(		Preference = "",
			EtatParDefaut = None
	)

renvoie le contenu d'une préférence, si non trouvée alors renvoie None

Parameters

Preference	= "" (string) : the name of written preference, usualy = the name of ClVar
EtatParDefaut	= None , the default state, returned if the pref is not found. The format must be the same of the relativ ClVar

Returns

: a string, usualy for ClVariable.ReadPref()

Date

5.3 fevrier 2019 création

HistAjoutLigne()

def historic.HistAjoutLigne

(

*

arg

)

ajouter une ligne au fichier historique

Parameters

*arg	(string) : argument envoyé à StrListVal, doit être un tableau de valeurs

Date

01/04/2016 CREATION

PrefLoad()

def historic.PrefLoad

(

ListeClVar

)

lire le fichier pref et charger les pref
si Fin Exec --> fin
si Exec en cours --> ajouter les km à historique + ajouter erreur

Parameters

ListeClVar

: ListeClVar dictionnaire des ClVariables

Date

• 10/06/2016 création
• 5.0 sept 2018 modification : suppression de l'evaluation de la var, appel de la fonction ClVar.ReadPref(string)
• 5.2 janv 2019 modification : possibilité lire des pref sans variable dans ListePreference = {}
• 5.4 nov 2019 modification : possibilité d'avoir une pref au format texte
• 6.2 été 2020 :modification : suppression mode test
  

PrefWrite()

def historic.PrefWrite	(		ListVariables,
			NormalEnd = False
	)

ecrire le fichier pref :
ouvrir le fichier en mode ecrase,
écrire les variable dont le nom est contenu dans la liste PrefListVar

Parameters

ListVariables
NormalEnd	= False : doit etre True lorsqu'on quitte le programme, doit rester False pour les sauvegarde régulière (toutes les X minutes)

Date

• 5.0 sept 2018 modification : l'enregistrement pass par ClVar.WritePref(string)
• 5.2 janv 2019 modification : possibilité d'écrire des pref sans variable avec ListePreference = {}

StrListVal()

def historic.StrListVal

(

TabVal

)

Transforme une liste de parametre en chaine.

• les txt sont tronqués sur 9 caracteres
• les nmb sont arondis à 3 décimales et sont soit au format 0.001 ou 9.999e-4

  Parameters

  TabVal

  (array of value int, float, etc.) the list to return in string

WritePreference()

def historic.WritePreference	(		Preference,
			Valeur
	)

ecrit la Valeur dans la préférence Preference

Parameters

Preference	(string) : the name of the preference, , usualy = the name of ClVar
Valeur	the value to write, usualye returned be ClVariable.WritePref()

Date

Création : 5.3 fevrier 2019

Variable Documentation

CheminDossier

CheminDossier = os.getcwd()

chemin vers les fichiers historique CheminDossier = os.path.dirname(file)

ConfSeparateurVal

string ConfSeparateurVal = " = "

ConfSeparateurVar

string ConfSeparateurVar = "\n"

EmailListVar

list EmailListVar = []

Liste des variables envoyées par mail si option configurée EnvoyerMail (voir plus bas).

à partir de appli 5.3 ces tableau sont remplis dans /parts/
Utiliser AddEmailListVar() pour ajouter des variables à cettye liste (voir Apply.py).

FichierHistName

string FichierHistName = CheminDossier + "/historique.txt"

FichierPrefName

string FichierPrefName = CheminDossier + "/AutoPref.txt"

ListeAlarmeDemarre

string ListeAlarmeDemarre = ""

Chaine contenant la liste des lignes d'alarmes depuis qu'on a démarré envoyé dans le mail lorsqu'on quitte.

ListePreference

dictionary ListePreference = {}

liste des préférence non associés à une ClVariable

PrefListVar

list PrefListVar = []

liste contenant les variables de ListVariables à sauvegarder dans les prefs.

à partir de appli 5.3 ces tableau sont remplis dans /parts/
Utiliser AddPrefListVar() pour ajouter des variables (voir Apply.py).

SAUVEGARDE_ANNUELLE

bool SAUVEGARDE_ANNUELLE = True

variables à sauvegarder une fois par an :