Модуль Argparse Python

Модуль argparse помогает создавать интерфейсы командной строки с позиционными аргументами, опциями, флагами и справочными сообщениями.

Модуль был добавлен в Python 3.2. Если вы используете Python 3.14, ArgumentParser также поддерживает параметры suggest_on_error и color.

import argparse

Используйте argparse, когда хотите, чтобы файл Python вел себя как небольшая терминальная программа.

python greet.py Ada --count 2

Модуль читает текст после имени скрипта, проверяет его и возвращает объект Python с разобранными значениями.

Создание парсера

ArgumentParser хранит аргументы, которые принимает ваша программа.

import argparse

parser = argparse.ArgumentParser(
    prog='greet',
    description='Greet a user from the command line',
)

parser.print_help()

usage: greet [-h]

Greet a user from the command line

options:
  -h, --help  show this help message and exit

Позиционные аргументы

Позиционные аргументы по умолчанию обязательны.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('name')

args = parser.parse_args(['Ada'])
print(args.name)

Ada

Необязательные аргументы и флаги

Необязательные аргументы обычно начинаются с - или --.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--count', type=int, default=1)
parser.add_argument('-v', '--verbose', action='store_true')

args = parser.parse_args(['--count', '3', '--verbose'])
print(args.count)
print(args.verbose)

3
True

Выбор значений и преобразование типов

Вы можете проверять значения во время разбора.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--mode', choices=['dev', 'prod'])
parser.add_argument('--port', type=int, default=8000)

args = parser.parse_args(['--mode', 'dev', '--port', '9000'])
print(args.mode)
print(args.port)

dev
9000

Подкоманды

Подкоманды полезны в инструментах вроде git commit или docker run.

import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest='command', required=True)

build_parser = subparsers.add_parser('build')
build_parser.add_argument('--release', action='store_true')

args = parser.parse_args(['build', '--release'])
print(args.command)
print(args.release)

build
True

Небольшой полный пример

Этот пример принимает имя и повторяет приветствие.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('name')
parser.add_argument('--count', type=int, default=1)

args = parser.parse_args(['Ada', '--count', '2'])

for _ in range(args.count):
    print(f'Hello {args.name}!')

Hello Ada!
Hello Ada!