Exemplos de argparse em Python

“A interpretação dos argumentos da linha de comando foi feita pelo uso do módulo Python argparse. Ao fornecer aos elementos de entrada do usuário processados, o Argparse seria usado para dar personalização e reutilização do programa no lugar de especificar explicitamente variáveis ​​dentro da função.”

Interface da Linha de comando

Um método para negociar com um script de linha de comando seria através da interface da linha de comando ou CLI. Embora o Python tenha vários módulos que podemos usar para construir interfaces de linha de comando para diferentes scripts, o pacote Python argparse agora é o método eficiente para isso.

O módulo Argparse para Python foi disponibilizado como um componente da estrutura padrão. É o método preferido para criar uma interface python. As bibliotecas anteriores de "getopt" e "optparse" foram substituídas por esta, pois não possuíam várias funcionalidades cruciais.

Usos do módulo argparse

Estes são os usos do módulo Python Argparse:

• • Fornece diferentes unidades de argumentos para um único item.
  • Suporta a utilização de parâmetros posicionais.
  • Permitir intermediário para subcomandos.
  • Ativar modificação dos elementos do prefixo.

Com base em certos parâmetros, um analisador de linha de comando primário pode utilizar analisadores adicionais de linha de comando.

Utilização de uma interface de linha de comando

Agora que estamos cientes do que é uma interface de linha de comando, podemos nos preocupar com quando seria apropriado incorporá -lo ao programa. A regra geral é que pensaremos em uma interface de linha de comando se decidirmos oferecer um método fácil de personalizar o projeto.

A técnica adequada é usar o módulo python argparse. É uma ótima maneira de lidar com o valor construindo uma interface da linha de comando usando o módulo Python argparse, a menos que estejamos construindo um script de linha de comando complicado que requer um arquivo de configuração para funcionar. Dessa forma, pode permitir que o usuário designe cujo arquivo de configuração esteja usando.

Como construir uma interface da linha de comando usando o pacote Python ArgParse

Existem 4 fases para usar o módulo Python ArgParse:

• • Inclua a estrutura ArgParse em Python.
  • Construa o analisador.
  • Fornecer ao analisador parâmetros opcionais e posicionais.
  • Funcione função parse_args ().

Um objeto definido pelo usuário com um atributo básico para cada parâmetro de entrada obtido na linha de comando é o que podemos obter depois de chamar o método parse_args ().

Vamos executar exemplos diferentes nos quais utilizamos o módulo Argparse.

Exemplo nº 1

Uma interface eficiente para o processamento de parâmetros da linha de comando é fornecida pela ferramenta ArgParse. Ele mostra o uso geral do programa, a instrução e as exceções. O uso de parâmetros de linha de comando apropriados é demonstrado na ilustração seguinte.

Este exemplo calcula a área do círculo usando um raio de um parâmetro da linha de comando. Para adicionar parâmetros e analisá -los, o analisador de objeto ArgumentParser foi construído. Um parâmetro de raio é adicionado pelo usuário, embora seja deixado como um parâmetro opcional. O método não retornaria uma exceção e definiria o valor do parâmetro para nenhum se o usuário não der um valor para ele, como visto no cenário abaixo.

importar argparse
analisador = argparse.ArgumentParser (Descrição = 'Encontre o raio de qualquer círculo')
analisador.add_argument ('-r', '-raio', tipo = int, help = 'raio calculado de qualquer círculo')
args = analisador.parse_args ()
def main ():
Imprimir (args.raio)
principal()

No início do programa, importaremos o arquivo de cabeçalho "argparse". Na próxima etapa, inicializaremos uma variável "analisador" e, ao mesmo tempo, chamaremos o método do argumentoPraser (). Esta função está relacionada ao módulo argparse. Demos a "descrição" como o parâmetro da função ArgumentPraser (). Em seguida, adicionamos parâmetros diferentes para utilizar a função add_argument () função. Esta função possui três parâmetros que incluem o raio do círculo, o tipo de dados do raio e o valor do argumento de "ajuda".

Depois de especificar os argumentos, invocaremos a função parse_args () do pacote de analisador. Agora vamos definir o corpo do método principal (). Dentro desta função, estamos usando a função print () para exibir o raio do círculo especificado. No final, utilizamos o método principal ().

Exemplo nº 2

O "requerido" é um argumento do método add_argument () do objeto ArgumentParser. Os parâmetros do atributo "f" ou "foo" são desnecessários e, portanto, serão eliminados por padrão. O parâmetro "necessário" precisa ser definido como true se o usuário quiser inserir este parâmetro. Como mostrado abaixo, sempre que definimos um atributo como "necessário", mas não especifique um valor para isso, o compilador retorna uma exceção.

importar argparse
analisador = argparse.ArgumentParser (Descrição = 'Determine o raio de qualquer círculo', prog = 'The Program', USAGE = '%(prog) s [options]')
analisador.add_argument ('-r', '-raio', tipo = int, requerir = true, ajuda = 'raio calculado de qualquer círculo')
args = analisador.parse_args ()
def main ():
Imprimir (args.raio)
principal()

Primeiro de tudo, vamos integrar o módulo "argparse". A etapa a seguir envolve a inicialização da variável “analisador” e aplicação do método de argumentparser () simultaneamente. Este método está associado ao pacote argparse. Os argumentos para o método ArgumentParser () são descrição e prog.

Em seguida, adicionamos alguns parâmetros adicionais usando o método add_argument (). O raio do círculo, o tipo de dados do raio e o valor do parâmetro "help" são os quatro argumentos para esta função. Definimos o valor do parâmetro "necessário" como "verdadeiro".

Além disso, chamaremos o método parse_args () do arquivo de cabeçalho do analisador depois de fornecer os argumentos. Então vamos definir o corpo da função principal (). O método print () foi usado aqui no corpo da função principal para mostrar o raio do círculo. Finalmente usamos a função principal ().

Conclusão

Ao concluir este artigo, agora compreendemos uma interface da linha de comando e o método de construção de um único argumento da linha de comando usando o pacote argparse. Também discutimos qual é o módulo Python Argparse e por que os usuários o utilizarão se precisarem gerar código de python da linha de comando. Como e quando criar uma interface básica com eficiência usando a estrutura ArgParse. Também observamos o uso inovador do módulo Argparse. Uma interface de linha de comando eficaz pode fornecer aos usuários um mecanismo para se envolver com seu sistema.