5.16.1 Gli oggetti RawConfigParser

Le istanze di RawConfigParser possiedono i seguenti metodi:

defaults( ): Restituisce un dizionario contenente i valori predefiniti a livello di istanza.

sections( ): Restituisce una lista delle sezioni disponibili; DEFAULT non viene incluso nella lista.

add_section( section): Aggiunge una sezione chiamata section all'istanza. Se già esiste una sezione con quel nome, viene sollevata l'eccezione DuplicateSectionError.

has_section( section): Indica se nella configurazione è presente la sezione richiesta. La sezione DEFAULT non viene riconosciuta.

options( section): Restituisce una lista delle opzioni disponibili nella sezione section specificata.

has_option( section, option): Se la sezione section esiste e contiene l'opzione option, restituisce True; altrimenti restituisce False. Nuovo nella versione 1.6.

read( filenames)

Tenta di leggere ed analizzare una lista di nomi di file, restituendo l'elenco di quelli analizzati con successo. Se filenames è una stringa o una stringa Unicode, viene trattata come un singolo nome di file. Se un file elencato in filenames non può essere aperto, quel file verrà ignorato. In questo modo è possibile specificare una lista di possibili locazioni di file di configurazione (per esempio, la directory corrente, l'home directory dell'utente ed alcune directory di sistema) ed ogni file di configurazione presente nella lista verrà letto. Se non esiste nessuno dei file nominati, l'istanza di ConfigParser conterrà un insieme di dati vuoto. Un'applicazione che richiede che dei valori iniziali siano caricati da un file, dovrebbe caricare il file o i file richiesti usando readfp() prima di chiamare read() per ogni file facoltativo:

import ConfigParser, os

config = ConfigParser.ConfigParser()
config.readfp(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')])

Modificato nella versione 2.4: Restituisce una lista dei file analizzati con successo.

readfp( fp[, filename]): Legge ed analizza dati di configurazione dall'oggetto file o simile a file in fp (viene usato solo il metodo readline()). Se filename viene omesso ed fp possiede un attributo name, viene usato questo come filename; il valore predefinito è "<???>".

get( section, option): Restituisce un valore option della sezione section.

getint( section, option): Un metodo comodo che converte in un intero l'opzione option nella sezione section specificata.

getfloat( section, option): Un metodo comodo che converte in un numero in virgola mobile l'opzione option nella sezione section specificata.

getboolean( section, option): Un metodo comodo che converte in un valore booleano l'opzione option nella sezione section specificata. Notate che i valori accettati per le opzioni sono "1", "yes", "true" e "on", che fa sì che il metodo restituisca il valore True e "0", "no", "false" e "off", che fa sì che ritorni False. Questi valori di stringa possono essere sia maiuscoli che minuscoli. Ogni altro valore solleverà l'eccezione ValueError.

items( section): Restituisce una lista di coppie (nome, valore) per ogni opzione nella sezione section.

set( section, option, value): Se la sezione section esiste, assegna all'opzione option il valore value; altrimenti solleva un'eccezione NoSectionError. value deve essere una stringa (str o unicode); altrimenti viene sollevata un'eccezione TypeError. Nuovo nella versione 1.6.

write( fileobject): Scrive la rappresentazione della configurazione nell'oggetto file specificato da fileobject. Questa configurazione potrà essere analizzata da una futura chiamata read(). Nuovo nella versione 1.6.

remove_option( section, option): Rimuove l'opzione option dalla sezione section specificata. Se la sezione non esiste, viene sollevata un'eccezione NoSectionError. Se l'opzione esiste viene rimossa e restituito True; altrimenti viene restituito False. Nuovo nella versione 1.6.

remove_section( section): Rimuove la sezione section dalla configurazione. Se la sezione esiste viene restituito True. Altrimenti viene restituito False.

optionxform( option): Trasforma il nome dell'opzione option come trovato in un file di input o come passato da un programma client nella forma che dovrebbe venire usata nelle strutture interne. L'implementazione predefinita restituisce una versione di option in lettere minuscole; eventuali modifiche a questo comportamento possono essere operate dalle sotto classi oppure attraverso un programma client che assegna un attributo di questo nome alle istanze. Assegnando questo a str(), per esempio, renderebbe i nomi di opzione sensibili alle differenze tra maiuscole e minuscole.

Vedete Circa questo documento... per informazioni su modifiche e suggerimenti.