Outils¶
Dans ce module, plusieurs fonctions utilisées dans le reste du code sont disponibles pour créer des dictionnaires, modifier des paramètres ou convertir des prix, entre autres aspects.
- CPR.tools.get_params(file, numerical_key=False)¶
Fonction pour créer un dictionnaire à partir d’un fichier .csv.
- Paramètres
file (_io.TextIOWrapper) – fichier csv
numerical_key (bool, optional) – clé numérique, par défaut à Faux
- Renvoie
Dictionnaire de paramètres.
- Type renvoyé
dict
- CPR.tools.add_params_as_attr(inst, file)¶
Fonction pour ajouter des paramètres à une instance de la classe.
- Paramètres
inst (object) – instance de classe
file (_io.TextIOWrapper) – fichier csv
- CPR.tools.change_params(inst, extra_params)¶
Fonction qui met à jour la valeur de certains paramètres dans inst avec des valeurs prises dans extra_params.
- Paramètres
inst (dict) – paramètres
extra_params (dict) – paramètres à mettre à jour ainsi que leurs nouvelles valeurs
- CPR.tools.create_nom_real(year, prices)¶
Création d’une fonction convertissant les prix de réels à nominaux et de nominaux à réels, avec 2018 comme année de base.
- Paramètres
year (int) – année
prices (Prices) – instance de la classe Prices
- Renvoie
function – Fonction convertissant le nominal en réel.
function – Fonction convertissant le réel en nominal.
- CPR.tools.create_nom(year, prices)¶
Création d’une fonction convertissant les prix de réels à nominaux, avec 2018 comme année de base, utilisée à certaines fins spécifiques ailleurs dans le code.
- Paramètres
year (int) – année
prices (Prices) – instance de la classe Prices
- Renvoie
Fonction convertissant le réel en nominal.
- Type renvoyé
function