Esempi di Python Argparse
Interfaccia della riga di comando
Un metodo per negoziare con uno script di riga di comando sarebbe tramite l'interfaccia della riga di comando o CLI. Sebbene Python abbia diversi moduli che possiamo usare per costruire interfacce della riga di comando per script diversi, il pacchetto Python ArgParse è ora il metodo efficiente per farlo.
Il modulo ArgParse per Python è stato reso disponibile come componente del framework standard. È il metodo preferito per la creazione di un'interfaccia Python. Le precedenti librerie "getopt" e "optparse" sono state sostituite con questo in quanto mancavano di diverse funzionalità cruciali.
Usi del modulo ArgParse
Questi sono gli usi del modulo Python ArgParse:
-
- Fornisce diverse unità di argomenti per un singolo articolo.
- Supporta l'utilizzo dei parametri posizionali.
- Consenti intermedi per i sottocomando.
- Abilita la modifica degli elementi del prefisso.
Sulla base di determinati parametri, un parser di riga di comando primario può utilizzare i parser di riga di comando aggiuntivi.
Utilizzo di un'interfaccia della riga di comando
Ora che siamo a conoscenza di ciò che è un'interfaccia della riga di comando, potremmo preoccuparci di quando sarebbe opportuno incorporarla nel programma. La regola generale è che penseremo a un'interfaccia della riga di comando se decidiamo di offrire un metodo intuitivo per personalizzare il progetto.
La tecnica adatta è usare il modulo Python ArgParse. È un ottimo modo per gestire il valore costruendo un'interfaccia della riga di comando utilizzando il modulo Python ArgParse a meno che non stiamo costruendo uno script di riga di comando complicato che richiede un file di configurazione per funzionare. In questo modo può consentire all'utente di designare il cui file di configurazione utilizzato.
Come costruire un'interfaccia di riga di comando usando il pacchetto Python ArgParse
Esistono 4 fasi nell'uso del modulo Python ArgParse:
-
- Includi il framework ArgParse in Python.
- Costruire il parser.
- Fornire al parser parametri opzionali e posizionali.
- Esegui la funzione Parse_args ().
Un oggetto definito dall'utente con un attributo di base per ogni parametro di input ottenuto dalla riga di comando è ciò che possiamo ottenere dopo aver chiamato il metodo Parse_args ().
Eseguiamo diversi esempi in cui utilizziamo il modulo ArgParse.
Esempio n. 1
Un'interfaccia efficiente per l'elaborazione dei parametri della riga di comando è fornita dallo strumento ArgParse. Mostra l'uso generale, l'istruzione ed eccezioni del programma. L'uso dei parametri della riga di comando appropriati è dimostrato nell'illustrazione successiva.
Questo esempio calcola l'area del cerchio usando un raggio di un parametro dalla riga di comando. Per aggiungere parametri e analizzarli, è stato costruito il parser oggetto ArgumentParser. Un parametro RADIUS viene aggiunto dall'utente, sebbene sia lasciato come parametro opzionale. Il metodo non restituirebbe un'eccezione e imposterebbe il valore del parametro su nessuna se l'utente non darà un valore, come mostrato nello scenario seguente.
importare argparse
Parser = ArgParse.ArgumentParser (Descrizione = 'Trova il raggio di ogni determinato cerchio')
parser.add_argument ('-r', '-raggio', type = int, help = 'raggio calcolato di ogni determinato cerchio')
args = parser.parse_args ()
def main ():
Stampa (args.raggio)
principale()
All'inizio del programma, importeremo il file di intestazione "Argparse". Nel prossimo passaggio, inizializzamo un "parser" variabile e, allo stesso tempo, chiameremo il metodo argomentapraser (). Questa funzione è correlata al modulo ArgParse. Abbiamo dato la "descrizione" come parametro della funzione argomentapraser (). Quindi aggiungiamo parametri diversi, quindi utilizziamo la funzione Add_argument (). Questa funzione ha tre parametri che includono il raggio del cerchio, il tipo di dati del raggio e il valore dell'argomento "aiuto".
Dopo aver specificato gli argomenti, invoceremo la funzione parse_args () del pacchetto parser. Ora definiamo il corpo del metodo principale (). All'interno di questa funzione, abbiamo utilizzato la funzione print () per visualizzare il raggio del cerchio dato. Alla fine, utilizziamo il metodo principale ().
Esempio n. 2
Il "richiesto" è un argomento del metodo add_argument () dell'oggetto argomentazioni. I parametri dell'attributo "F" o "foo" non sono necessari e, pertanto, saranno eliminati per impostazione predefinita. Il parametro "richiesto" può essere impostato su true se l'utente desidera inserire questo parametro. Come mostrato di seguito, ogni volta che impostiamo un attributo come "richiesto" ma non specifichiamo un valore per questo, il compilatore restituisce un'eccezione.
importare argparse
Parser = ArgParse.ArgumentParser (Descrizione = 'Determina raggio di qualsiasi cerchio', prog = 'il programma', Usage = '%(prog) s [opzioni]')
parser.add_argument ('-r', '-raggio', tipo = int, richiesto = true, help = 'raggio calcolato di ogni determinato cerchio')
args = parser.parse_args ()
def main ():
Stampa (args.raggio)
principale()
Prima di tutto, integremo il modulo "ArgParse". Il passaggio seguente prevede l'inizializzazione del metodo variabile "parser" e l'applicazione del metodo argomentali (). Questo metodo è associato al pacchetto ArgParse. Gli argomenti per l'argomentoParser () sono la descrizione e il prog.
Successivamente, aggiungiamo alcuni parametri aggiuntivi utilizzando il metodo add_argument (). Il raggio del cerchio, il tipo di dati del raggio e il valore del parametro "aiuto" sono i quattro argomenti per questa funzione. Impostiamo il valore del parametro "richiesto" su "true".
Inoltre, chiameremo il metodo parse_args () del file di intestazione del parser dopo aver fornito gli argomenti. Quindi definiremo il corpo della funzione principale (). Il metodo Print () è stato usato qui nel corpo della funzione principale per mostrare il raggio del cerchio. Finalmente usiamo la funzione principale ().
Conclusione
Completando questo articolo, ora comprendiamo un'interfaccia della riga di comando e il metodo di costruzione di un argomento di riga di comando singolo usando il pacchetto ArgParse. Abbiamo anche discusso di cosa sia il modulo Python ArgParse e perché gli utenti lo utilizzeranno se devono generare il codice Python della riga di comando. Come e quando costruire in modo efficiente un'interfaccia di base utilizzando il framework ArgParse. Abbiamo anche osservato l'uso innovativo del modulo ArgParse. Un'efficace interfaccia della riga di comando può fornire agli utenti un meccanismo per interagire con il proprio sistema.