Przykłady Python Argparse
Interfejs linii komend
Metodą negocjacji z skryptem wiersza poleceń byłaby za pośrednictwem interfejsu wiersza poleceń lub CLI. Chociaż Python ma kilka modułów, których możemy użyć do konstruowania interfejsów wiersza poleceń dla różnych skryptów, pakiet Python Argparse jest teraz wydajną metodą tego zrobienia.
Moduł ArgParse dla Pythona został udostępniony jako element standardowej struktury. Jest to preferowana metoda tworzenia interfejsu Pythona. Wcześniejsze biblioteki „getopt” i „optparse” zostały zastąpione tym, ponieważ brakowało im kilku kluczowych funkcji.
Zastosowania modułu ArgParse
Są to zastosowania modułu Argparse Python:
-
- Zapewnia różne jednostki argumentów dla jednego elementu.
- Obsługuje wykorzystanie parametrów pozycyjnych.
- Pozwól pośredniemu dla podkomendy.
- Włącz modyfikację elementów prefiks.
Na podstawie niektórych parametrów parser pierwotnego wiersza poleceń może wykorzystywać dodatkowe parsery wiersza poleceń.
Wykorzystanie interfejsu wiersza poleceń
Teraz, gdy zdajemy sobie sprawę z tego, czym jest interfejs wiersza poleceń, możemy się martwić, kiedy należy włączyć go do programu. Ogólna zasada polega na tym, że zastanowimy się nad interfejsem wiersza poleceń, jeśli zdecydujemy się zaoferować przyjazną dla użytkownika metodę dostosowywania projektu.
Odpowiednią techniką jest użycie modułu Argparse Python. Jest to świetny sposób obsługi wartości poprzez konstruowanie interfejsu wiersza poleceń za pomocą modułu argparse Python, chyba że konstruujemy skomplikowany skrypt wiersza poleceń, który wymaga funkcjonowania pliku konfiguracyjnego do funkcjonowania. W ten sposób może pozwolić użytkownikowi wyznaczyć, którego pliku konfiguracyjnego będzie używać.
Jak skonstruować interfejs wiersza poleceń za pomocą pakietu Python Argparse
Istnieją 4 fazy korzystania z modułu ArgParse Python:
-
- Dołącz ramy ArgParse w Python.
- Skonstruuj parser.
- Zapewnij parserowi opcjonalne i pozycyjne parametry.
- Uruchom funkcję parse_args ().
Obiekt zdefiniowany przez użytkownika z podstawowym atrybutem dla każdego parametru wejściowego uzyskanego z wiersza poleceń jest tym, co możemy uzyskać po wywołaniu metody parse_args ().
Wykonajmy różne przykłady, w których korzystamy z modułu ArgParse.
Przykład nr 1
Wydajny interfejs do przetwarzania parametrów wiersza poleceń jest dostarczany przez narzędzie ArgParse. Pokazuje ogólne wykorzystanie, instrukcje i wyjątki programu. Korzystanie z odpowiednich parametrów wiersza poleceń pokazano na kolejnej ilustracji.
Ten przykład oblicza obszar koła za pomocą promienia jednego parametru z wiersza poleceń. Aby dodać parametry i je przeanalizować, skonstruowano parser obiektu ArgumentParser. Parametr promienia jest dodawany przez użytkownika, chociaż pozostaje on jako parametr opcjonalny. Metoda nie zwróci wyjątku i nie ustawiłby wartości parametru na żaden, jeśli użytkownik nie poda wartości, jak pokazano w poniższym scenariuszu.
importować ArgParse
Parser = argParse.ArgumentParser (Opis = „Znajdź promień dowolnego okręgu”)
Parser.add_argument ('-r', '-promień', type = int, help = 'obliczony promień dowolnego okręgu')
args = parser.parse_args ()
def main ():
Drukuj (args.promień)
główny()
Na początku programu zaimportujemy plik nagłówka „ArgParse”. W następnym kroku zainicjujemy zmienną „parser”, a jednocześnie nazwiemy metodę ArgumentPraser (). Ta funkcja jest związana z modułem ArgParse. Podaliśmy „opis” jako parametr funkcji ArgumentPraser (). Następnie dodajemy różne parametry, dzięki czemu korzystamy z funkcji add_argument (). Ta funkcja ma trzy parametry, które obejmują promień okręgu, rodzaj danych promienia i wartość argumentu „Pomoc”.
Po określaniu argumentów wywołamy funkcję parse_args () pakietu parsera. Teraz zdefiniujmy ciało metody main (). W ramach tej funkcji używamy funkcji print () do wyświetlania promienia danego okręgu. Ostatecznie używamy metody Main ().
Przykład nr 2
„Wymagane” jest argumentem metody add_argument () obiektu ArgumentParser. Parametry atrybutu „f” lub „foo” są niepotrzebne i dlatego zostaną domyślnie wyeliminowane. Potrzeba parametru można ustawić na true, jeśli użytkownik chce wstawić ten parametr. Jak pokazano poniżej, ilekroć ustawiamy atrybut jako „wymagany”, ale nie określa wartości do tego, kompilator zwraca wyjątek.
importować ArgParse
Parser = argParse.ArgumentParser (Opis = „Określ promień dowolnego koła”, prog = „program”, użytkowe = '%(prog) s [opcje]')
Parser.add_argument ('-r', '-promień', type = int, wymagany = true, help = 'obliczono promień dowolnego okręgu')
args = parser.parse_args ()
def main ():
Drukuj (args.promień)
główny()
Przede wszystkim zintegrujemy moduł „ArgParse”. Poniższy krok obejmuje inicjowanie zmiennej „parser” i zastosowanie metody argumentParser () jednocześnie. Ta metoda jest powiązana z pakietem ArgParse. Argumenty za metodą ArgumentParser () to opis i prog.
Następnie dodajemy dodatkowe parametry za pomocą metody add_argument (). Promień okręgu, typ danych promienia i wartość parametru „Pomoc” to cztery argumenty dla tej funkcji. Ustawiamy wartość parametru „wymaganego” na „true”.
Oprócz tego wywołamy metodę parse_args () pliku nagłówka parsera po podaniu argumentów. Następnie zdefiniujemy ciało funkcji Main (). Metodę druku () zastosowano tutaj w korpusie głównej funkcji, aby pokazać promień koła. W końcu używamy funkcji Main ().
Wniosek
Wykonując ten artykuł, teraz rozumiemy interfejs wiersza poleceń i metodę konstruowania argumentu pojedynczego wiersza poleceń za pomocą pakietu ArgParse. Omówiliśmy także, czym jest moduł argparse Python i dlaczego użytkownicy będą go używać, jeśli będą musieli wygenerować kod wiersza poleceń Python. Jak i kiedy skutecznie zbudować podstawowy interfejs za pomocą ArgParse Framework. Zaobserwowaliśmy również innowacyjne wykorzystanie modułu ArgParse. Skuteczny interfejs wiersza poleceń może zapewnić użytkownikom mechanizm zaangażowania się w swój system.