9.18 `distutils.fancy_getopt` -- Wrapper around the standard getopt module

Questo modulo fornisce un wrapper per il modulo standard getopt che fornisce le seguenti novità aggiuntive:

le opzioni corte e lunghe vengono tenute insieme
le opzioni hanno una stringa di help, cosicché fancy_getopt può potenzialmente creare un completo sommario del suo utilizzo
le opzioni impostano gli attributi degli oggetti passati
le opzioni logiche possono avere ``alias negativi'' -- per esempio --quiet è l'opzione negativa di --verbose, --quiet sulla riga di comando imposta verbose a falso

** Dovrebbe essere sostituito con optik (che è anche conosciuto come optparse in Python 2.3 e successivi). **

fancy_getopt( options, negative_opt, object, args): Funzione Wrapper. options è una lista di tuple triple "(long_option, short_option, help_string)" come descritto nel costruttore per FancyGetopt. negative_opt dovrebbe essere un dizionario che mappa i nomi delle opzioni ai nomi delle opzioni, sia la chiave che il valore dovrebbero essere nella lista options. object è un oggetto che verrà usato per memorizzare valori (si veda il metodo getopt() della classe FancyGetopt). args è la lista degli argomenti. Userà sys.argv[1:] se si passa None come args.

wrap_text( text, width): Imposta text a meno della larghezza width.
Dovrebbe essere sostituita con textwrap (che è disponibile in Python 2.3 e successivi).

class FancyGetopt( [option_table=None]): option_table è una lista di tuple triple: "(long_option, short_option, help_string)"
Se un'opzione prende un argomento, a long_option dovrebbe essere aggiunto '='; short_option dovrebbe essere solo un singolo carattere, in ogni caso, nessun ':'. short_option dovrebbe essere None se long_option non ha una corrispondente short_option. Tutte le tuple delle opzioni devono avere un'opzione lunga.

La classe FancyGetopt fornisce i seguenti metodi:

getopt( [args=None, object=None]): Analizza le opzioni da riga di comando in args. Le memorizza come attributi in object.
Se la variabile args è None o non viene indicata, usa sys.argv[1:]. Se la variabile object è None o non viene fornita, crea una nuova istanza OptionDummy, vi memorizza i valori dell'opzione e restituisce una tupla "(args,object)". Se la variabile object viene indicata, viene modificata sul posto e getopt() restituisce solo args; in entrambi i casi, la variabile args restituita è una copia modificata della lista args passata inizialmente, che viene lasciata inalterata.

get_option_order( ): Restituisce la lista delle tuple "(option, value)" processate dalla precedente esecuzione di getopt(). Solleva l'eccezione RuntimeError se getopt() non è stata già chiamata.

generate_help( [header=None]): Genera un testo di aiuto (una lista di stringhe, una per riga di output suggerita) dalla tabella delle opzioni per questo oggetto FancyGetopt.
Se indicato, stampa l'intestazione header fornita, all'inizio dell'help.

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

9.18 distutils.fancy_getopt -- Wrapper around the standard getopt module