Especificar formato para argumentos de entrada argparse python

111

Tengo una secuencia de comandos de Python que requiere algunas entradas de línea de comando y estoy usando argparse para analizarlas. Encontré la documentación un poco confusa y no pude encontrar una manera de verificar un formato en los parámetros de entrada. Lo que quiero decir con verificar el formato se explica con este script de ejemplo:

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__)))

Necesito verificar la opción -sy -eque la entrada del usuario esté en el formato YYYY-MM-DD. ¿Hay una opción en argparse que no conozca que logre esto?

python python-2.7 argparse Sohaib
fuente

235

Según la documentación :

El typeargumento de palabra clave de add_argument()permite realizar cualquier verificación de tipo y conversión de tipo necesaria ... type=puede tomar cualquier invocable que tome un argumento de cadena única y devuelva el valor convertido

Podrías hacer algo como:

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)

Luego usa eso como type:

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

Jonrsharpe
fuente

Sobre la otra pregunta que editó, ¿puede indicarme la documentación (si corresponde) para eso?

Sohaib

¿ valid_date()Asume que el argumento dado es una cadena?

Stevoisiak

1

@StevenVascellaro sí, pero eso es lo que define la API; "toma un argumento de una sola cadena" según la cita de los documentos.

jonrsharpe

71

Solo para agregar a la respuesta anterior, puede usar una función lambda si desea mantenerla en una sola línea. Por ejemplo:

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

Hilo antiguo, ¡pero la pregunta seguía siendo relevante para mí al menos!

Evan V
fuente

6

Este es un buen truco, aunque si pasa algo no válido, el mensaje de error seráinvalid <lambda> value

Brad Solomon

38

Para otros que lo lograron a través de los motores de búsqueda: en Python 3.7, puede usar el .fromisoformatmétodo de clase estándar en lugar de reinventar la rueda para las fechas compatibles con ISO-8601, por ejemplo:

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)

Michał Górny
fuente

5

Además, dateutilel analizador ISO de ' toma una serie de formatos adicionales que aún cumplen con la norma ISO 8601-2004. Puede usar import dateutil.parser-> type=dateutil.parser.isoparseotype=dateutil.parser.parse

Brad Solomon

@BradSolomon De hecho, una buena sugerencia (de ahí mi +1), pero dateutiles un paquete de terceros. Uno tendría que juzgar sus beneficios frente a la (pequeña) molestia de instalarlo adicionalmente. YMMV.

Laryx Decidua

Especificar formato para argumentos de entrada argparse python

Respuestas: