Python Argparse Ejemplos
Interfaz de línea de comando
Un método para negociar con un script de línea de comando sería a través de la interfaz de línea de comandos o CLI. Aunque Python tiene varios módulos que podemos usar para construir interfaces de línea de comandos para diferentes scripts, el paquete Python Argparse es ahora el método eficiente para hacerlo.
El módulo Argparse para Python se puso a disposición como un componente del marco estándar. Es el método preferido para crear una interfaz Python. Las bibliotecas anteriores de "getopt" y "optparse" fueron reemplazadas por esta, ya que carecían de varias funcionalidades cruciales.
Usos del módulo argparse
Estos son los usos del módulo Python Argparse:
-
- Proporciona diferentes unidades de argumentos para un solo artículo.
- Admite la utilización de parámetros posicionales.
- Permitir intermedio para subcomandos.
- Habilitar la modificación de los elementos de prefijo.
Basado en ciertos parámetros, un analizador de línea de comando primario puede utilizar analizadores de línea de comandos adicionales.
Utilización de una interfaz de línea de comandos
Ahora que somos conscientes de qué es una interfaz de línea de comandos, podríamos estar preocupados por cuándo sería apropiado incorporarla en el programa. La regla general es que pensaremos en una interfaz de línea de comando si decidimos ofrecer un método fácil de usar para personalizar el proyecto.
La técnica adecuada es usar el módulo Python Argparse. Es una excelente manera de manejar el valor construyendo una interfaz de línea de comando utilizando el módulo Python Argparse a menos que estemos construyendo un script de línea de comando complicado que requiere un archivo de configuración para funcionar. De esta manera puede permitir que el usuario designe cuyo archivo de configuración se utilice.
Cómo construir una interfaz de línea de comandos utilizando el paquete Python Argparse
Hay 4 fases para usar el módulo Python Argparse:
-
- Incluir el marco Argparse en Python.
- Construir el analizador.
- Proporcionar al analizador parser con parámetros opcionales y posicionales.
- Ejecutar la función parse_args ().
Un objeto definido por el usuario con un atributo básico para cada parámetro de entrada obtenido de la línea de comando es lo que podemos obtener después de llamar al método parse_args ().
Ejecutemos diferentes ejemplos en los que utilizamos el módulo argparse.
Ejemplo no 1
La herramienta Argparse proporciona una interfaz eficiente para procesar parámetros de línea de comando. Muestra el uso general del programa, la instrucción y las excepciones. El uso de parámetros de línea de comandos apropiados se demuestra en la ilustración siguiente.
Este ejemplo calcula el área del círculo utilizando un radio de un parámetro desde la línea de comando. Para agregar parámetros y analizarlos, se ha construido el analizador del objeto argumento. El usuario agrega un parámetro RADIUS, aunque se deja como un parámetro opcional. El método no devolvería una excepción y establecería el valor del parámetro en ninguno si el usuario no le dará un valor, como se ve en el escenario a continuación.
importar argparse
parser = argparse.ArgumentParser (descripción = 'Encuentra el radio de cualquier círculo dado')
pasador.add_argument ('-r', '-radio', type = int, ayuda = 'radio calculado de cualquier círculo dado')
Args = analizador.parse_args ()
Def Main ()::
Imprimir (Args.radio)
principal()
Al comienzo del programa, importaremos el archivo de encabezado "Argparse". En el siguiente paso, inicializaremos una variable "analizador", y al mismo tiempo, llamaremos al método argumentPraser (). Esta función está relacionada con el módulo argparse. Hemos dado la "descripción" como el parámetro de la función argumentPraser (). Luego agregamos diferentes parámetros para que utilizamos la función de función add_argument (). Esta función tiene tres parámetros que incluyen el radio del círculo, el tipo de datos del radio y el valor del argumento de "ayuda".
Después de especificar los argumentos, invocaremos la función parse_args () del paquete analizador. Ahora definamos el cuerpo del método principal (). Dentro de esta función, hemos estado utilizando la función impreso () para mostrar el radio del círculo dado. Al final, utilizamos el método main ().
Ejemplo no 2
El "requerido" es un argumento del método add_argument () del objeto argumento. Los parámetros del atributo "f" o "foo" son innecesarios y, por lo tanto, se eliminarán de forma predeterminada. La necesidad del parámetro "requerida" se puede establecer en True si el usuario desea insertar este parámetro. Como se muestra a continuación, cada vez que establecemos un atributo como "requerido" pero no especificamos un valor para esto, el compilador devuelve una excepción.
importar argparse
parser = argparse.ArgumentParser (Descripción = 'Determinar el radio de cualquier círculo', prog = 'el programa', use = '%(prog) s [opciones]')
pasador.add_argument ('-r', '-Radius', type = int, requería = true, ayuda = 'radio calculado de cualquier círculo')
Args = analizador.parse_args ()
Def Main ()::
Imprimir (Args.radio)
principal()
En primer lugar, vamos a integrar el módulo "Argparse". El siguiente paso implica inicializar la variable "analizador" y aplicar el método argumento () simultáneamente. Este método está asociado con el paquete Argparse. Los argumentos para el método argumentParser () son descripción y prog.
A continuación, agregamos algunos parámetros adicionales utilizando el método add_argument (). El radio del círculo, el tipo de datos del radio y el valor del parámetro de "ayuda" son los cuatro argumentos para esta función. Establecemos el valor del parámetro "requerido" en "verdadero".
Además de esto, llamaremos el método parse_args () del archivo de encabezado analizador después de proporcionar los argumentos. Entonces definiremos el cuerpo de la función principal (). El método print () se ha utilizado aquí en el cuerpo de la función principal para mostrar el radio del círculo. Finalmente usamos la función principal ().
Conclusión
Al completar este artículo, ahora comprendemos una interfaz de línea de comandos y el método de construir un solo argumento de línea de comandos utilizando el paquete Argparse. También discutimos qué es el módulo Python Argparse y por qué los usuarios lo utilizarán si tienen que generar el código de Python de la línea de comandos. Cómo y cuándo construir eficientemente una interfaz básica utilizando el marco Argparse. También observamos el uso innovador del módulo argparse. Una interfaz de línea de comandos efectiva puede proporcionar a los usuarios un mecanismo para comprometerse con su sistema.