Komentoriviargumenttien lisääminen Python -komentosarjaan

Jos olet kehittänyt Python -komentosarjan tai -sovelluksen, joka on tarkoitettu käytettäväksi ensisijaisesti pääteemulaattoreissa tai jopa GUI -sovelluksissa, komentoriviargumenttien lisääminen voi parantaa sen käytettävyyttä, koodin luettavuutta, sovellusrakennetta ja sovelluksen yleistä käyttäjäystävällisyyttä loppukäyttäjille. Näitä komentoriviargumenteja kutsutaan myös vaihtoehdoiksi tai kytkimiksi ja ne toimivat samalla tavalla kuin argumentit, joita tavallisesti näet bash -komentosarjoissa ja muissa C / C ++ -ohjelmissa.

Jos haluat lisätä argumentteja Python-komentosarjoihin, sinun on käytettävä sisäänrakennettua moduulia nimeltä argparse. Kuten nimestä voi päätellä, se jäsentää Python -komentosarjan tai -sovelluksen käynnistämisen yhteydessä käytetyt komentoriviargumentit. Näitä jäsennettyjä argumentteja tarkistaa myös argparse -moduuli varmistaakseen, että ne ovat oikean tyyppisiä. Virheitä syntyy, jos argumentteissa on virheellisiä arvoja.

Argparse -moduulin käyttö voidaan parhaiten ymmärtää esimerkkien avulla. Alla on joitain koodinäytteitä, joiden avulla pääset alkuun argparse -moduulin kanssa.

Esimerkki 1: Luo ohjeväite ja viesti

Harkitse alla olevaa koodinäytettä:

Ensimmäinen lausunto tuo argparse -moduulin. Seuraavaksi luodaan uusi ArgumentParser -objektin esiintymä ja annetaan ohjelman lyhyt kuvaus argumenttina. ArgumentParser -objektia tarvitaan komentoriviargumenttien muuntamiseen Pythonin ymmärtämiin tietotyyppeihin. Tämä tehdään ArgumentParser -objektin parse_args -menetelmällä, kuten viimeisessä lauseessa on esitetty.

Olettaen, että olet tallentanut yllä mainitun koodinäytteen tiedostoon nimeltä test.py, suorittamalla alla olevat komennot saat ohjelmaan liittyviä ohjeviestejä.

Sinun pitäisi saada jotain tämänkaltaista lähtöä:

Huomaa, että yllä mainittuun koodinäytteeseen ei ole lisätty logiikkaa jäsennettyjen argumenttien käsittelemiseksi ja niiden muuntamiseksi objekteiksi. Näin ollen yksittäisten argumenttien ohjeviestit eivät näy tulostuksessa. Kun olet lisännyt logiikan jäsennettyjen argumenttien arvojen käsittelyyn ohjelmassasi, ohjeviestit alkavat näyttää yksittäisten argumenttien kuvauksia.

Esimerkki 2: Käsittele merkkijono -argumenttia

Jos haluat lisätä argumentteja, jotka python -skriptisi hyväksyy, sinun on käytettävä add_argument -menetelmää. Katso seuraava koodi:

Lisätty uusi lausunto, joka osoittaa add_argument -menetelmän käytön. ArgumentParser käsittelee komentosarjaa käynnistettäessä lisättyjä argumentteja print_string -objektina.

Huomaa, että add_argument -menetelmä käsittelee oletusarvoisesti argumentteista haetut arvot merkkijonoina, joten sinun ei tarvitse erikseen määrittää tyyppiä tässä tapauksessa. Myös lisäargumenteille määritetään oletusarvo Ei mitään, ellei niitä ohiteta.

Katso vielä kerran ohjetta:

Yksi tulosten riveistä kertoo sijaintiargumentit. Koska argumentille ei ole määritelty avainsanaa, argumenttia käsitellään tällä hetkellä positioargumenttina, jossa annetun argumentin järjestyksellä ja sijainnilla on suora vaikutus ohjelmaan. Paikkatiedot ovat myös pakollisia, ellet muuta manuaalisesti niiden käyttäytymistä.

Voit määrittää ja jäsentää valinnaisia ​​argumentteja käyttämällä - (kaksoisviiva) ja muuttaa niiden oletusarvoja oletusargumentin avulla.

Kun suoritat test.py -komentosarjan ilman argumentteja, sinun pitäisi saada satunnainen merkkijono. tuotoksena. Voit myös halutessasi käyttää -print_string -avainsanaa minkä tahansa valitsemasi merkkijonon tulostamiseen.

Huomaa, että voit tehdä valinnaisen argumentin pakolliseksi käyttämällä ylimääräistä pakollista = True -argumenttia.

Lopuksi voit myös määritellä argumentin lyhytversiot käyttämällä - (yksi viiva) monisanaisuuden vähentämiseksi.

Seuraavan komennon suorittamisen pitäisi antaa sinulle sama tulos kuin yllä:

Esimerkki 3: Käsittele kokonaislukuväitettä

Jotta voit käsitellä kokonaislukuarvoja tarvitsevia argumentteja, sinun on määritettävä tyypin avainsanaksi int, jotta se voi vahvistaa ja heittää virheitä, jos ehto ei täyty.

Kokeile suorittaa seuraava komento:

Sinun pitäisi saada seuraavanlainen virhe:

Jos annat kokonaislukuarvon, saat oikean tuloksen:

Esimerkki 4: Käsittele oikeita ja vääriä vaihtokytkimiä

Voit välittää argumentteja ilman arvoja, jotta voit käsitellä niitä tosi- ja vääriä lippuja käyttämällä toimintaargumenttia.

Suorita alla oleva komento saadaksesi yksinkertaisen True -tuloksen:

Jos suoritat komentosarjan ilman -p -argumenttia, sille annetaan Väärä arvo. Toiminta -avainsanan arvo store_true antaa print_string -muuttujalle True -arvon aina, kun -p -argumentti on nimenomaisesti määritetty, muuten muuttujalle annetaan False.

Esimerkki 5: Käsittele argumenttiarvot luettelona

Jos haluat saada useita arvoja kerralla ja tallentaa ne luetteloon, sinun on annettava nargs -avainsana seuraavassa muodossa:

Testaa yllä oleva koodi suorittamalla seuraava komento:

Sinun pitäisi saada jonkinlainen tulos seuraavalla tavalla:

Johtopäätös

Argparse -moduuli on melko kattava, ja siinä on paljon vaihtoehtoja komentorivisovellusten käyttäytymisen ja käyttäjän toimittamien arvojen jäsentämiseksi. Nämä esimerkit koskevat vain argparse -moduulin peruskäyttöä. Edistyneissä ja monimutkaisissa sovelluksissa saatat tarvita erilaisia ​​toteutuksia. Vieraile virallista dokumentaatiota saadaksesi täydellisen selityksen moduulista.