Określ format argumentów wejściowych argparse python


111

Mam skrypt w Pythonie, który wymaga pewnych danych wejściowych wiersza poleceń i używam argparse do ich analizowania. Dokumentacja wydawała mi się nieco zagmatwana i nie mogłem znaleźć sposobu, aby sprawdzić format w parametrach wejściowych. To, co mam na myśli przez sprawdzanie formatu, jest wyjaśnione w tym przykładowym skrypcie:

parser.add_argument('-s', "--startdate", help="The Start Date - format YYYY-MM-DD ", required=True)
parser.add_argument('-e', "--enddate", help="The End Date format YYYY-MM-DD (Inclusive)", required=True)
parser.add_argument('-a', "--accountid", type=int, help='Account ID for the account for which data is required (Default: 570)')
parser.add_argument('-o', "--outputpath", help='Directory where output needs to be stored (Default: ' + os.path.dirname(os.path.abspath(__file__)))

Muszę sprawdzić opcję -si -eczy dane wejściowe użytkownika są w formacie YYYY-MM-DD. Czy w argparse jest opcja, której nie wiem, która to umożliwia.

Odpowiedzi:


235

Zgodnie z dokumentacją :

typeArgumentem Słowo kluczowe add_argument()umożliwia wszelkie niezbędne rodzaj kontroli oraz typu konwersje mają być wykonane ... type=może wziąć każdy wywoływalnym że trwa jeden argument ciąg znaków i zwraca wartość przerobiona

Możesz zrobić coś takiego:

def valid_date(s):
    try:
        return datetime.strptime(s, "%Y-%m-%d")
    except ValueError:
        msg = "Not a valid date: '{0}'.".format(s)
        raise argparse.ArgumentTypeError(msg)

Następnie użyj tego jako type:

parser.add_argument("-s", 
                    "--startdate", 
                    help="The Start Date - format YYYY-MM-DD", 
                    required=True, 
                    type=valid_date)

Jeśli chodzi o inne pytanie, które zredagowałeś, czy możesz wskazać mi dokumentację (jeśli taka istnieje)?
Sohaib

Czy valid_date()zakłada, że ​​podany argument jest łańcuchem?
Stevoisiak

1
@StevenVascellaro tak, ale to właśnie definiuje API; „pobiera pojedynczy argument w postaci ciągu znaków” na cytat z dokumentacji.
jonrsharpe

71

Aby dodać do powyższej odpowiedzi, możesz użyć funkcji lambda, jeśli chcesz zachować ją w jednym wierszu. Na przykład:

parser.add_argument('--date', type=lambda d: datetime.strptime(d, '%Y%m%d'))

Stary wątek, ale pytanie wciąż było aktualne przynajmniej dla mnie!


6
To fajna sztuczka, chociaż jeśli przekażesz coś nieprawidłowego, komunikat o błędzie będzie po prostu invalid <lambda> value
brzmiał

38

Dla innych, którzy trafili na to przez wyszukiwarki: w Pythonie 3.7 możesz użyć standardowej .fromisoformatmetody klasy zamiast wymyślać koło dla dat zgodnych z ISO-8601, np .:

parser.add_argument('-s', "--startdate",
    help="The Start Date - format YYYY-MM-DD",
    required=True,
    type=datetime.date.fromisoformat)
parser.add_argument('-e', "--enddate",
    help="The End Date format YYYY-MM-DD (Inclusive)",
    required=True,
    type=datetime.date.fromisoformat)

5
Ponadto, dateutiljest parser ISO podejmuje szereg dodatkowych fmts które są nadal zgodne z ISO 8601-2004. Możesz użyć import dateutil.parser-> type=dateutil.parser.isoparselubtype=dateutil.parser.parse
Brad Solomon

@BradSolomon Rzeczywiście dobra sugestia (stąd moje +1), ale dateutiljest to pakiet innej firmy. Trzeba by było ocenić jego zalety w porównaniu z (małym) kłopotem związanym z dodatkową instalacją. YMMV.
Laryx Decidua
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.