Criando Programas Python de Linha de Comando

Introdução

A interface de linha de comando do Python, também conhecida como linha de comando ou interface de linha de comando (CLI), é uma forma de interagir com um programa de computador digitando comandos em um terminal ou prompt de comando. Ela permite que os usuários executem um programa e passem argumentos para ele, além de receber a saída do programa na forma de texto. A interface de linha de comando é particularmente útil para automatizar tarefas, executar scripts e realizar operações avançadas ou complexas que seriam difíceis ou impossíveis de fazer por meio de uma interface gráfica de usuário (GUI).

Neste laboratório, aprenderemos como usar o módulo argparse para criar interfaces de linha de comando para nossos programas Python. Começaremos com exemplos simples e passaremos gradualmente para outros mais complexos. Ao final deste laboratório, você deverá ter uma boa compreensão de como usar o módulo argparse para criar interfaces de linha de comando poderosas para seus programas Python.

Conquistas

• Módulo argparse
• Scripts Python

Importando o Módulo Argparse

O primeiro passo para usar o módulo argparse é importá-lo.

Você precisa criar um arquivo Python que conterá seu código.

touch my_program.py

Podemos fazer isso adicionando a seguinte linha de código ao início do nosso script Python:

import argparse

Criando um Objeto Parser

Uma vez que tenhamos importado o módulo argparse, podemos criar um objeto parser chamando a função ArgumentParser(). Esta função aceita vários argumentos opcionais, mas, por enquanto, forneceremos apenas uma descrição simples do nosso programa.

parser = argparse.ArgumentParser(description="Uma interface de linha de comando simples.")

Adicionando Argumentos

Agora que temos um objeto parser, podemos começar a adicionar argumentos a ele. Existem vários tipos de argumentos que podemos adicionar, como argumentos posicionais e argumentos opcionais. Por exemplo, podemos adicionar um argumento posicional como este:

parser.add_argument("name", help="Seu nome")

E um argumento opcional como este:

parser.add_argument("-n", "--number", help="Número de vezes para repetir a mensagem", type=int, default=1)

Analisando Argumentos

Uma vez que tenhamos adicionado todos os nossos argumentos, podemos analisá-los chamando a função parse_args() do nosso objeto parser. Esta função não recebe argumentos e retorna um objeto contendo os valores de todos os nossos argumentos.

args = parser.parse_args()

Usando os Argumentos

Agora que analisamos nossos argumentos, podemos usá-los em nosso programa. Por exemplo, podemos usar o argumento name como este:

print("Olá, " + args.name)

E o argumento opcional como este:

print("Olá, " + args.name * args.number)

Código Completo

Aqui está o código completo para o laboratório que inclui todas as etapas descritas acima:

import argparse

## Criando um objeto parser
parser = argparse.ArgumentParser(description="Uma interface de linha de comando simples.")

## Adicionando argumentos
parser.add_argument("name", help="Seu nome")
parser.add_argument("-n", "--number", help="Número de vezes para repetir a mensagem", type=int, default=1)

## Analisando argumentos
args = parser.parse_args()

## Usando os argumentos
print("Olá, " + args.name * args.number)

Você pode executar o script navegando até o diretório onde o arquivo está localizado na linha de comando e digitando python my_program.py seguido pelos argumentos que deseja passar para o script:

python my_program.py "John" --number 3

Isso imprimirá "Olá, JohnJohnJohn" no console.

Resumo

Neste laboratório, aprendemos como usar o módulo argparse para criar uma interface de linha de comando para um programa Python. Vimos como importar o módulo argparse, criar um objeto parser, adicionar argumentos ao parser, analisar os argumentos e usá-los em nosso programa. Com esse conhecimento, você deve ser capaz de criar interfaces de linha de comando poderosas para seus programas Python.