Outils de lecture de paramètres

Informations

  • Fichier: Knu/Scripts/Librairies/outilsLecture.py

  • Auteur: Victor Baconnet

  • Date de dernière modification: 27 août 2021

Description

Liste de fonctions permettant de lire des options données par l’utilisateur.

Ces fonctions permettent de lire les options, avec plusieurs syntaxes possibles. Si l’option n’est pas trouvée, une valeur par défaut peut être donnée.

Exemple d’utilisation

import outilsLecture as olec
import numpy as np
import sys

tmax = olec.readValueOption(sys.argv, ["-tmax","--tmax"],
                            default = 0.0)

N = olec.readValueOption(sys.argv, ["-N","--N"],
                         default = 100, valueType = int)

file = olec.readFileOption(sys.argv, ["--file", "-file"],
                                 default = "out.csv", extension = "csv")

print("Tmax : ", tmax)
print("N    : ", N)
print("file : ", file)

Executions possibles:

$ python3 myscript.py
Tmax : 0.0
N    : 100
file : out.csv

$ python3 myscript.py --tmax 20.0 --N 41 -file wrongfile.csv
Tmax : 20.0
N    : 41
file : wrongfile.csv

Warning

Dans le dernier exemple, si l’utilisateur avait précisé wrongfile.txt, le programme aurait renvoyé une erreur.

Code source

Lien vers le code source

Fonctions

outilsLecture.readDirOption(options, possibleNames, default)

Lecture d’option au format : -repertoire <nom-repertoire>

Parameters

  • options (list) – Liste des options données par l’utilisateur

  • possibleNames (list) – Liste des options acceptées pour sélectionner ce paramètre (exemple: [“-dir”, “–dir”, “-DIR”])

  • default (string) – Valeur prise par défaut

Returns

path : le nom du répertoire donné en paramètre, sinon renvoie default

Return type

string

outilsLecture.readFileOption(options, possibleNames, default, extension='', checkPath=False)

Lecture d’option au format : -fichier <nom_fichier>

Parameters

  • options (list) – Liste des options données par l’utilisateur

  • possibleNames (list) – Liste des options acceptées pour sélectionner ce paramètre (exemple: [“-file”, “–file”, “-File”])

  • default (string) – Valeur prise par défaut

  • extension (string) – extension du fichier (exemple: “csv”)

Returns

filename : le nom du fichier donné en paramètre, sinon renvoie default

Return type

string

outilsLecture.readOption(options, possibleNames)

Lecture d’option seule

Parameters

  • options (list) – Liste des options données par l’utilisateur

  • possibleNames (list) – Liste des options acceptées pour sélectionner ce paramètre (exemple: [“-doThing”, “–doThing”, “-DOTHING”])

Returns

True si l’option est trouvée, False sinon

Return type

bool

outilsLecture.readValueOption(options, possibleNames, default, valueType=<class 'float'>)

Lecture d’option au format : -parametre <valeur>

Parameters

  • options (list) – Liste des options données par l’utilisateur

  • possibleNames (list) – Liste des options acceptées pour sélectionner ce paramètre (exemple: [“-val”, “–val”, “-VAL”])

  • default (string) – Valeur prise par défaut

  • valueType (type) – type de la valeur à lire (int, float)

Returns

filename : la valeur donnée en paramètre, sinon renvoie default

Return type

valueType