Free Press

• NOM
• SYNOPSIS
• DESCRIPTION
• Fonction read_config_file
  • Syntaxe
  • Arguments

  .

  • Valeur de retour
  • Description
• NOTES
  • Fonction non exportée par défaut
  • Migré loin de ConfigFile dans Config ::File
• AUTHOR
• VERSION

Config::File – Parse un simple fichier de configuration

use Config::File;

my $config_hash = Config ::File::read_config_file($configuration_file);

DESCRIPTION

read_config_file parcourt un fichier de configuration simple et stocke ses valeurs dans une référence de hachage anonyme. La syntaxe du fichier de configuration est la suivante:

 # This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.

Les options peuvent être regroupées lors de la création de groupes:

Puis les valeurs peuvent être récupérées en utilisant cette syntaxe:

 $hash_config->{CLUSTER_ONE}{data};

Il peut y avoir autant de sous-options dans un groupe que nécessaire.

 BIG_CLUSTER = data

est récupéré par : $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};

Il y a quelques restrictions quant aux noms des clés. Tout d’abord, tous les caractères doivent être alphabétiques, numériques, des traits de soulignement ou des traits d’union, les crochets étant autorisés pour le regroupement. C’est-à-dire que les clés doivent se conformer à /^+$/

Cela signifie également qu’aucun espace n’est autorisé dans la partie clé de la ligne.

 CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong

Fonction read_config_file

 Config::File::read_config_file($file);

Arguments

$file est le fichier de configuration.

Valeur de retour

Cette fonction renvoie une référence de hachage. Chaque clé du hachage est une valeur définie dans le fichier de configuration.

Description

read_config_fileParse un fichier de configuration un met en place certaines valeurs dans une référence de hachage.

Fonction non exportée par défaut

Dans les versions jusqu’à 1.0, la fonction read_config_file était exportée dans l’espace de nom du programme appelant – A partir de la version 1.1, rien n’est exporté par défaut. Vous pouvez soit qualifier complètement read_config_file, soit l’importer explicitement dans votre espace de noms:

Qualification complète de read_config_file

 use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);

Importation explicite de read_config_file

 use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);

Migration de ConfigFile vers Config::File

A partir de la version 1.4, afin d’inclure ce module dans le CPAN, j’ai décidé de m’éloigner du nom très peu standard de ConfigFile et de renommer le module en Config::File. Un petit module de redirection est mis en place, donc le code actuel utilisant ce module ne se casse pas, mais l’utilisation de l’espace de nom ConfigFile est dépréciée (et émettra donc un avertissement). Veuillez mettre à jour votre code!

AUTHOR

Le développement a été commencé par Sebastien J. Gross <[email protected]>. Maintenu par Gunnar Wolf <[email protected]> jusqu’en 2018 où l’Université de Stockholm (Johan Wassberg et Mikael Nordin) a repris la maintenance.

Tous droits réservés. Ce programme est un logiciel libre ; vous pouvez le redistribuer et/ou le modifier selon les termes de la GPL.

VERSION

Version 1.54 Copyright (c) 2002 Sebastien J. Gross. Tous droits réservés. Copyright (c) 2003-2018 Gunnar Wolf. Tous droits réservés. Copyright (c) 2018- Université de Stockholm. Tous droits réservés. Ce programme est un logiciel libre ; vous pouvez le redistribuer et/ou le modifier selon les termes de la GPL v2 (ou ultérieure, à votre choix).

 cpanm Config::File 

 perl -MCPAN -e shell install Config::File