AI Agents · Aula

Análise de argumentos e texto de ajuda

Argumentos obrigatórios versus opcionais, validação de tipos e ajuda gerada automaticamente.

Análise de argumentos e texto de ajuda é uma aula grátis de AI Agents no CoddyKit. Esta é a aula 3 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de AI Agents, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de AI Agents inclui 4 aulas no total.

Um bom projeto de CLI começa com bons argumentos

Uma interface de argumentos de um agente de CLI bem projetada permite que os usuários descubram como usar a ferramenta apenas com --help. Cada argumento deve ter um nome, um tipo, um valor padrão e uma descrição claros.

Argumentos com nomes inadequados ou sem documentação tornam as ferramentas frustrantes de usar e difíceis de manter.

Argumentos obrigatórios versus opcionais

Os argumentos obrigatórios precisam ser fornecidos — a CLI é encerrada com um erro se eles estiverem ausentes. Os argumentos opcionais têm um valor default= e podem ser omitidos. Decidir quais pertencem a cada categoria molda a experiência de uso da ferramenta.

import argparse

parser = argparse.ArgumentParser(description='AI Agent CLI')

# Required: no default, must be provided
parser.add_argument(
    '--query', '-q',
    type=str,
    required=True,
    help='Question to send to the agent'
)

# Optional: has a default, can be omitted
parser.add_argument(
    '--model', '-m',
    type=str,
    default='gpt-4o-mini',
    help='Model name (default: gpt-4o-mini)'
)

parser.add_argument(
    '--max-tokens',
    type=int,
    default=1000,
    help='Maximum tokens in response (default: 1000)'
)

args = parser.parse_args(['--query', 'test'])
print(args.query, args.model, args.max_tokens)

Validação de tipos

O parâmetro type= converte automaticamente a entrada textual e a valida. Use tipos integrados, como int, float e bool, ou uma função personalizada para validações mais complexas.

import argparse

def positive_int(value: str) -> int:
    n = int(value)
    if n <= 0:
        raise argparse.ArgumentTypeError(f'{value} must be a positive integer')
    return n

parser = argparse.ArgumentParser()
parser.add_argument('--temperature', type=float, help='LLM temperature 0.0-2.0')
parser.add_argument('--max-results', type=positive_int, default=5,
                    help='Number of results to return (must be > 0)')
parser.add_argument('--timeout', type=float, default=30.0,
                    help='Request timeout in seconds')

# These would be rejected with helpful error messages:
# --temperature abc     -> invalid float value
# --max-results -1      -> must be positive integer
args = parser.parse_args(['--temperature', '0.7', '--max-results', '3'])
print(args.temperature, args.max_results)

Opções: restringindo valores válidos

O parâmetro choices=[...] restringe o argumento a um conjunto fixo de valores permitidos. O argparse faz essa validação automaticamente e lista as opções no texto de ajuda.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(
    '--format',
    choices=['json', 'text', 'markdown'],
    default='text',
    help='Output format: json, text, or markdown'
)

parser.add_argument(
    '--model',
    choices=['gpt-4o', 'gpt-4o-mini', 'claude-3-5-sonnet', 'gemini-1.5-flash'],
    default='gpt-4o-mini',
    help='Model to use'
)

# Error if invalid value given:
# python agent.py --format xml
# agent.py: error: argument --format: invalid choice: 'xml'
# (choose from 'json', 'text', 'markdown')
args = parser.parse_args(['--format', 'json'])
print(args.format)  # 'json'

Sinalizadores booleanos com store_true

Sinalizadores booleanos são alternâncias de presença e ausência — nenhum valor é fornecido. Use action='store_true' para definir um sinalizador como True quando ele estiver presente e como False quando estiver ausente.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(
    '--verbose', '-v',
    action='store_true',
    help='Enable verbose output showing agent reasoning steps'
)

parser.add_argument(
    '--no-cache',
    action='store_true',
    help='Disable response caching'
)

parser.add_argument(
    '--dry-run',
    action='store_true',
    help='Parse arguments but do not run the agent'
)

# Usage: python agent.py --query 'test' --verbose
args = parser.parse_args(['--verbose'])
print(f'verbose={args.verbose}')    # True
print(f'no_cache={args.no_cache}')  # False
print(f'dry_run={args.dry_run}')    # False

metavar: controlando a exibição do texto de ajuda

Por padrão, o argparse exibe o nome do argumento em letras maiúsculas no texto de ajuda: --query QUERY. Use metavar= para exibir um marcador mais informativo, como QUESTION ou URL.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(
    '--query',
    type=str,
    metavar='QUESTION',  # shown in help as: --query QUESTION
    required=True,
    help='Natural language question for the agent'
)

parser.add_argument(
    '--url',
    type=str,
    metavar='URL',       # shown in help as: --url URL
    help='URL to scrape and summarize'
)

parser.add_argument(
    '--temperature',
    type=float,
    metavar='0.0-2.0',   # shown in help as: --temperature 0.0-2.0
    default=0.7
)

# Help output:
# --query QUESTION    Natural language question for the agent
# --url URL           URL to scrape and summarize
print('metavar makes help text more informative')

Múltiplos valores com nargs

Use nargs='+' para aceitar um ou mais valores ou nargs='*' para aceitar zero ou mais. Isso é útil para passar listas de URLs, etiquetas ou caminhos de arquivos ao agente.

import argparse

parser = argparse.ArgumentParser()

parser.add_argument(
    '--urls',
    nargs='+',       # one or more URLs
    metavar='URL',
    help='URLs to analyze (space-separated)'
)

parser.add_argument(
    '--tags',
    nargs='*',       # zero or more tags
    default=[],
    help='Optional tags for filtering results'
)

# Usage: python agent.py --urls https://a.com https://b.com --tags ai research
args = parser.parse_args(
    ['--urls', 'https://a.com', 'https://b.com', '--tags', 'ai']
)
print(args.urls)  # ['https://a.com', 'https://b.com']
print(args.tags)  # ['ai']

Subcomandos com add_subparsers()

Subcomandos, como git commit e git push, dão a cada comando seu próprio conjunto de argumentos. Use add_subparsers() para defini-los no argparse.

import argparse

parser = argparse.ArgumentParser(description='AI Agent CLI')
subparsers = parser.add_subparsers(dest='command', help='Available commands')

# 'ask' subcommand
ask_parser = subparsers.add_parser('ask', help='Ask the agent a question')
ask_parser.add_argument('question', type=str, help='Question to ask')
ask_parser.add_argument('--model', default='gpt-4o-mini')

# 'search' subcommand
search_parser = subparsers.add_parser('search', help='Research a topic')
search_parser.add_argument('topic', type=str, help='Topic to research')
search_parser.add_argument('--depth', type=int, default=3, choices=[1, 2, 3])

args = parser.parse_args(['ask', 'What is Python?', '--model', 'gpt-4o'])
print(args.command)   # 'ask'
print(args.question)  # 'What is Python?'
print(args.model)     # 'gpt-4o'

Escrevendo um bom texto de ajuda

Um bom texto de ajuda responde a três perguntas: o que este argumento faz, quais valores são válidos e qual é o valor padrão? Escreva o texto de ajuda do ponto de vista do usuário, não de quem implementou a ferramenta.

import argparse

parser = argparse.ArgumentParser(
    description='AI Research Agent — answers questions using web search and LLMs.',
    epilog='Example: python agent.py --query "What is quantum computing?" --format json'
)

# Bad help text:
parser.add_argument('--t', type=float, help='t value')  # cryptic

# Good help text:
parser.add_argument(
    '--temperature',
    type=float,
    default=0.7,
    metavar='0.0-2.0',
    help='Sampling temperature for the LLM. Lower = more focused, higher = more creative. (default: 0.7)'
)

print('Good help text explains what, how, and default value')

Grupos de argumentos para CLIs complexas

Quando uma CLI tem muitos argumentos, agrupe-os por tema usando add_argument_group(). Isso torna a saída de --help muito mais fácil de ler.

import argparse

parser = argparse.ArgumentParser(description='AI Agent CLI')

# Group 1: required inputs
required_group = parser.add_argument_group('Required')
required_group.add_argument('--query', required=True, help='Question to ask')

# Group 2: LLM settings
llm_group = parser.add_argument_group('LLM Settings')
llm_group.add_argument('--model', default='gpt-4o-mini', help='Model name')
llm_group.add_argument('--temperature', type=float, default=0.7)
llm_group.add_argument('--max-tokens', type=int, default=1000)

# Group 3: output settings
output_group = parser.add_argument_group('Output')
output_group.add_argument('--format', choices=['text', 'json'], default='text')
output_group.add_argument('--verbose', action='store_true')

print('Argument groups organize --help output by category')

Alternativas por variáveis de ambiente

Permita que os argumentos recorram a variáveis de ambiente quando não forem fornecidos. Assim, os usuários podem definir valores padrão no perfil do interpretador de comandos sem precisar digitá-los todas as vezes.

import argparse
import os

os.environ['OPENAI_API_KEY'] = 'sk-proj-demo-key'

parser = argparse.ArgumentParser()

parser.add_argument(
    '--api-key',
    type=str,
    default=os.environ.get('OPENAI_API_KEY'),
    help='OpenAI API key (default: $OPENAI_API_KEY env var)'
)

parser.add_argument(
    '--model',
    type=str,
    default=os.environ.get('AGENT_MODEL', 'gpt-4o-mini'),
    help='Model to use (default: $AGENT_MODEL or gpt-4o-mini)'
)

args = parser.parse_args([])

if not args.api_key:
    parser.error('--api-key is required (or set OPENAI_API_KEY environment variable)')

print(f'Model: {args.model}')

Verificação de conhecimento: análise de argumentos

Verifique sua compreensão sobre as técnicas de análise de argumentos de CLI.

Recapitulação: análise de argumentos e texto de ajuda

Agora você sabe criar uma interface de argumentos de CLI completa e fácil de usar:

Use required=True para argumentos obrigatórios e default= para os opcionais
Valide os tipos de entrada com type= e funções validadoras personalizadas
Restrinja os valores com choices=[...]
Use action='store_true' para sinalizadores booleanos
Melhore a legibilidade da ajuda com metavar= e textos claros de help=
Aceite múltiplos valores com nargs='+'
Use subcomandos e grupos de argumentos para CLIs complexas
Recorra a variáveis de ambiente para configurações comuns

Perguntas Frequentes

A aula “Análise de argumentos e texto de ajuda” é grátis?

Sim — o texto completo de “Análise de argumentos e texto de ajuda” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de AI Agents, atualize para CoddyKit PRO. O curso de AI Agents inclui 4 aulas no total.

O que vou aprender em “Análise de argumentos e texto de ajuda”?

Argumentos obrigatórios versus opcionais, validação de tipos e ajuda gerada automaticamente. Você pratica AI Agents com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar AI Agents?

Nenhuma experiência prévia é necessária. AI Agents no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 3 de 4.

Quanto tempo leva a aula “Análise de argumentos e texto de ajuda”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de AI Agents?

Sim. Cada aula de AI Agents inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

Criando interfaces de agentes de linha de comando
Agentes interativos no estilo REPL
Análise de argumentos e texto de ajuda
Transmitindo a saída em agentes de CLI

← Voltar para AI Agents