Python Argparse eksempler

“Tolkningen av kommandolinjeargumenter er fremsatt ved bruk av Python -modulen Argparse. Ved å tilby brukerinngangselementer som skal behandles, vil Argparse bli brukt til å gi tilpasning og gjenbruk av programmet i stedet for eksplisitt å spesifisere variabler i funksjonen.”

Kommandolinjegrensesnitt

En metode for å forhandle med et kommandolinjeskript ville være gjennom kommandolinjegrensesnittet eller CLI. Selv om Python har flere moduler som vi kan bruke til å konstruere kommandolinjegrensesnitt for forskjellige skript, er Python Argparse -pakken nå den effektive metoden for å gjøre det.

Argparse -modulen for Python ble gjort tilgjengelig som en del av standardrammen. Det er den foretrukne metoden for å lage et Python -grensesnitt. De tidligere "getopt" og "optparse" -bibliotekene ble erstattet med denne, da de manglet flere avgjørende funksjonaliteter.

Bruk av ArgParse -modulen

Dette er bruken av Python Argparse -modulen:

• • Gir forskjellige enheter med argumenter for et enkelt element.
  • Støtter bruk av posisjonsparametere.
  • Tillat mellomliggende for underkommandoer.
  • Aktiver modifisering av prefikselementene.

Basert på visse parametere, kan en primær kommandolinje -parser bruke flere kommandolinje -parsers.

Bruk av et kommandolinjegrensesnitt

Nå som vi er klar over hva et kommandolinjegrensesnitt er, kan vi være opptatt av når det vil være aktuelt å innlemme det i programmet. Den generelle regelen er at vi vil tenke på et kommandolinjegrensesnitt hvis vi bestemmer oss for å tilby en brukervennlig metode for å tilpasse prosjektet.

Den passende teknikken er å bruke Python Argparse -modulen. Det er en fin måte å håndtere verdien ved å konstruere et kommandolinjegrensesnitt ved hjelp av Python ArgParse -modulen med mindre vi konstruerer et komplisert kommandolinjeskript som krever en konfigurasjonsfil for. På denne måten kan brukeren utpeke hvis konfigurasjonsfil skal bruke.

Hvordan konstruere et kommandolinjegrensesnitt ved å bruke Python Argparse -pakke

Det er 4 faser å bruke Python Argparse -modulen:

• • Inkluder Argparse -rammeverket i Python.
  • Konstruer analyseren.
  • Gi analyseren valgfrie og posisjonsparametere.
  • Kjør parse_args () -funksjon.

Et brukerdefinert objekt med en grunnleggende attributt for hver inngangsparameter oppnådd fra kommandolinjen er det vi kan få etter å ha ringt metoden Parse_Args ().

La oss utføre forskjellige eksempler der vi bruker Argparse -modulen.

Eksempel nr. 1

Et effektivt grensesnitt for behandling av kommandolinjeparametere er gitt av Argparse -verktøyet. Det viser programmets generelle bruk, instruksjon og unntak. Bruken av passende kommandolinjeparametere er demonstrert i den etterfølgende illustrasjonen.

Dette eksemplet beregner sirkelens område ved å bruke en radius med én parameter fra kommandolinjen. For å legge til parametere og analysere dem, er ArgumentParser -objektets parser blitt konstruert. En radiusparameter blir lagt til av brukeren, selv om den er igjen som en valgfri parameter. Metoden ville ikke returnere et unntak og angi parameterverdien til ingen hvis brukeren ikke vil gi en verdi for det, som sett i scenariet nedenfor.

Importer Argparse
Parser = Argparse.ArgumentParser (beskrivelse = 'Finn radius for en gitt sirkel')
analyser.add_argument ('-r', '-radius', type = int, hjelp = 'beregnet radius for en gitt sirkel')
Args = Parser.parse_args ()
def main ():
Trykk (Args.radius)
hoved()

I starten av programmet vil vi importere overskriftsfilen "Argparse". I neste trinn vil vi initialisere en variabel "parser", og samtidig vil vi kalle ArgumentPraser () -metoden. Denne funksjonen er relatert til Argparse -modulen. Vi har gitt "beskrivelsen" som parameter for ArgumentPraser () -funksjonen. Deretter legger vi til forskjellige parametere slik at vi bruker funksjonen add_argument () funksjon. Denne funksjonen har tre parametere som inkluderer sirkelens radius, datatypen på radius og verdien av "hjelp" -argumentet ".

Etter å ha spesifisert argumentene, vil vi påkalle funksjonen Parse_Args () av ​​Parser -pakken. La oss nå definere kroppen til Main () -metoden. Innenfor denne funksjonen har vi brukt funksjonstrykket () for å vise radien til den gitte sirkelen. Til slutt bruker vi Main () -metoden.

Eksempel nr. 2

Den "påkrevde" er et argument for Add_Argument () -metoden til ArgumentParser -objektet. Parametere for attributtet “F” eller “Foo” er unødvendige og vil derfor bli eliminert som standard. Parameteren "påkrevd" behov kan settes til sant hvis brukeren ønsker å sette inn denne parameteren. Som vist nedenfor, når vi setter et attributt som "påkrevd", men ikke spesifiser en verdi for dette, returnerer kompilatoren et unntak.

Importer Argparse
Parser = Argparse.ArgumentParser (beskrivelse = 'Bestem radius for hvilken som helst sirkel', prog = 'Programmet', bruk = '%(prog) s [alternativer]')
analyser.add_argument ('-r', '-radius', type = int, nødvendig = true, hjelp = 'beregnet radius av en gitt sirkel')
Args = Parser.parse_args ()
def main ():
Trykk (Args.radius)
hoved()

Først av alt skal vi integrere modulen "Argparse". Følgende trinn innebærer å initialisere variabelen “Parser” og anvende ArgumentParser () -metoden samtidig. Denne metoden er assosiert med Argparse -pakken. Argumentene for ArgumentParser () -metoden er beskrivelse og prog.

Deretter legger vi til noen tilleggsparametere ved å bruke Add_Argument () -metoden. Radius of the Circle, radiusens datatype og verdien av "hjelp" -parameteren er de fire argumentene for denne funksjonen. Vi setter verdien av den "nødvendige" parameteren til "True".

I tillegg til dette, vil vi kalle metoden Parse_Args () av ​​parser -overskriften etter å ha gitt argumentene. Da vil vi definere hovedfunksjonens kroppsfunksjon. Print () -metoden har blitt brukt her i kroppen til hovedfunksjonen for å vise sirkelens radius. Vi bruker endelig Main () -funksjonen.

Konklusjon

Ved å fullføre denne artikkelen, forstår vi nå et kommandolinjegrensesnitt og metoden for å konstruere et enkelt kommandolinjeargument ved å bruke Argparse -pakken. Vi diskuterte også hva Python Argparse -modulen er og hvorfor brukere vil bruke den hvis de må generere kommandolinje Python -kode. Hvordan og når du effektivt skal bygge et grunnleggende grensesnitt ved å bruke Argparse -rammen. Vi observerte også den innovative bruken av Argparse -modulen. Et effektivt kommandolinjegrensesnitt kan gi brukerne en mekanisme for å engasjere seg i systemet sitt.