Sådan tilføjes kommandolinjeargumenter til et Python -script

Hvis du har udviklet et Python -script eller -program, der primært er beregnet til at blive kørt i terminalemulatorer eller endda GUI -apps, kan tilføjelse af kommandolinjeargumenter forbedre dets anvendelighed, kodelæsbarhed, applikationsstruktur og generelle brugervenlighed af applikationen for slutbrugerne. Disse kommandolinjeargumenter kaldes også optioner eller switches og fungerer på samme måde som argumenter, du normalt ser i bash -scripts og andre C / C ++ - baserede programmer.

For at tilføje argumenter til Python-scripts skal du bruge et indbygget modul med navnet argparse. Som navnet antyder, analyserer det kommandolinjeargumenter, der blev brugt under lancering af et Python -script eller -program. Disse analyserede argumenter kontrolleres også af argparse -modulet for at sikre, at de er af korrekt type. Der rejses fejl, hvis der er ugyldige værdier i argumenter.

Brug af det argparse modul kan bedst forstås gennem eksempler. Nedenfor er nogle kodeeksempler, der får dig i gang med argparse -modulet.

Eksempel 1: Generer hjælpeargument og meddelelse

Overvej nedenstående kodeeksempel:

Den første erklæring importerer argparse -modulet. Dernæst oprettes en ny forekomst af ArgumentParser -objekt, og en kort beskrivelse af programmet leveres som et argument. ArgumentParser -objektet er nødvendigt for at konvertere kommandolinjeargumentværdier til datatyper, som Python forstår. Dette gøres ved hjælp af parse_args -metoden for ArgumentParser -objekt, som vist i den sidste sætning.

Forudsat at du har gemt kodeeksemplet angivet ovenfor i en fil med navnet test.py, får du hjælpemeddelelser relateret til programmet ved at køre kommandoerne herunder.

Du bør få noget output svarende til dette:

Bemærk, at der ikke er tilføjet nogen logik til at håndtere analyserede argumenter og konvertere dem til objekter til ovenstående kodeeksempel. Derfor vises hjælpemeddelelser til individuelle argumenter ikke i output. Når du tilføjer logik til håndtering af værdier for analyserede argumenter i dit program, begynder hjælpemeddelelser at vise beskrivelse for individuelle argumenter.

Eksempel 2: Håndter et strengargument

For at tilføje argumenter, der accepteres af dit python -script, skal du bruge metoden add_argument. Tag et kig på følgende kode:

Der er tilføjet en ny erklæring, der viser brug af metoden add_argument. Ethvert argument tilføjet ved lancering af scriptet vil blive behandlet som et print_string -objekt af ArgumentParser.

Bemærk, at add_argument -metoden som standard behandler værdier hentet fra argumenter som strenge, så du ikke behøver eksplicit at angive typen i dette tilfælde. En standardværdi på None tildeles også tilføjede argumenter, medmindre de tilsidesættes.

Tag endnu engang et kig på hjælpemeddelelsen:

En af linjerne i output siger positionelle argumenter. Da der ikke er defineret noget nøgleord til argument, behandles argumentet i øjeblikket som et positionelt argument, hvor rækkefølgen og placeringen af ​​det leverede argument har direkte effekt på programmet. Positioneringsargumenter er også obligatoriske, medmindre du manuelt ændrer deres adfærd.

For at definere og analysere valgfrie argumenter kan du bruge - (dobbelt bindestreg) og ændre deres standardværdier ved hjælp af standardargumentet.

Når du nu kører test.py script uden noget argument, skal du få en tilfældig streng. som output. Du kan også valgfrit bruge søgeordet –print_string til at udskrive en valgfri streng.

Bemærk, at du kan gøre et valgfrit argument obligatorisk ved at bruge et ekstra påkrævet = sandt argument.

Endelig kan du også definere stenografiversioner af argumentet ved hjælp af - (enkelt bindestreg) for at reducere verbositet.

Kørsel af følgende kommando skulle give dig det samme resultat som ovenfor:

Eksempel 3: Håndter et heltalsargument

For at håndtere argumenter, der har brug for heltalsværdier, skal du indstille type nøgleord til int for at tillade validering og fejl i tilfælde af, at betingelsen ikke er opfyldt.

Prøv at køre følgende kommando:

Du bør få en fejl som denne:

Hvis du angiver en heltalsværdi, får du det korrekte resultat:

Eksempel 4: Håndter True og False Toggles

Du kan videregive argumenter uden værdier for at behandle dem som sandt og falsk flag ved hjælp af handlingsargumentet.

Kør kommandoen herunder for at få en simpel True som output:

Hvis du kører scriptet uden -p -argumentet, tildeles der i stedet en falsk værdi. Værdien store_true for handlingsordet tildeler variabel print_string en sand værdi, når -p -argumentet eksplicit er angivet, ellers tildeles variablen False.

Eksempel 5: Behandl argumentværdier som liste

Hvis du vil have flere værdier på én gang og gemme dem på listen, skal du angive nargs -nøgleord i følgende format:

Kør følgende kommando for at teste koden ovenfor:

Du bør få noget output som dette:

Konklusion

Argparse -modulet er temmelig omfattende med masser af muligheder for at justere adfærd for kommandolinjeapplikationer og analysere brugerleverede værdier. Disse eksempler berører kun den grundlæggende brug af argparse -modulet. For avancerede og komplekse applikationer har du muligvis brug for forskellige implementeringer. Besøg officiel dokumentation for en fuldstændig forklaring af modulet.