Настройка параметров при запуске Python скрипта

Расширенные примеры работы с параметрами запуска

Многоуровневый разбор с подкомандами через argparse

Пример программы для работы с задачами: добавление, удаление, список. Подкоманды реализованы через add_subparsers.

import argparse

parser = argparse.ArgumentParser(description='Управление задачами')
subparsers = parser.add_subparsers(dest='command', help='Доступные команды')

# Команда add
parser_add = subparsers.add_parser('add', help='Добавить задачу')
parser_add.add_argument('-t', '--title', required=True, help='Название задачи')
parser_add.add_argument('-p', '--priority', type=int, default=0, help='Приоритет')

# Команда remove
parser_remove = subparsers.add_parser('remove', help='Удалить задачу')
parser_remove.add_argument('id', type=int, help='Идентификатор задачи')

# Команда list
parser_list = subparsers.add_parser('list', help='Показать все задачи')
parser_list.add_argument('--all', action='store_true', help='Показать выполненные')

args = parser.parse_args()

if args.command == 'add':
    print(f'Добавлена задача "{args.title}" с приоритетом {args.priority}')
elif args.command == 'remove':
    print(f'Удалена задача с id={args.id}')
elif args.command == 'list':
    print('Список задач' + (', включая выполненные' if args.all else ''))
else:
    parser.print_help()

$ python todo.py add -t "Купить молоко" -p 2
Добавлена задача "Купить молоко" с приоритетом 2
$ python todo.py remove 5
Удалена задача с id=5
$ python todo.py list --all
Список задач, включая выполненные

Обработка нескольких значений одного аргумента

Параметр nargs позволяет принимать несколько значений. Например, передача списка имён.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--names', nargs='+', help='Одно или несколько имён')
parser.add_argument('--age', type=int, nargs='?', const=25, help='Возраст (опциональный)')

args = parser.parse_args()
print('Имена:', args.names)
print('Возраст:', args.age)

$ python multi.py --names Анна Иван Петр --age 30
Имена: ['Анна', 'Иван', 'Петр']
Возраст: 30
$ python multi.py --names Ольга
Имена: ['Ольга']
Возраст: 25   (значение по умолчанию const)

Чтение параметров из конфигурационного файла

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

import argparse
import json

parser = argparse.ArgumentParser()
parser.add_argument('--config', type=str, help='Путь к JSON конфигу')
parser.add_argument('--host', type=str)
parser.add_argument('--port', type=int)

args = parser.parse_args()

if args.config:
    with open(args.config, 'r') as f:
        config = json.load(f)
    # Значения из командной строки имеют приоритет
    for key, val in vars(args).items():
        if val is None and key in config:
            setattr(args, key, config[key])

print(f'Хост: {args.host}, Порт: {args.port}')

$ echo '{"host": "localhost", "port": 8080}' > config.json
$ python with_config.py --config config.json --port 9000
Хост: localhost, Порт: 9000

Обратите внимание: если аргумент передан в командной строке, он переопределяет значение из файла.

Пользовательские действия в argparse

Можно создать свой класс действия для нестандартной обработки, например, для накопления значений в список.

import argparse

class AppendListAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        current = getattr(namespace, self.dest, [])
        current.extend(values)
        setattr(namespace, self.dest, current)

parser = argparse.ArgumentParser()
parser.add_argument('--items', nargs='+', action=AppendListAction, help='Добавить элементы')

args = parser.parse_args()
print('Собранные элементы:', args.items)

$ python custom_action.py --items a b --items c d
Собранные элементы: ['a', 'b', 'c', 'd']

Обработка параметров с помощью sys.argv вручную

Иногда требуется минимальный парсинг без импорта сторонних модулей. Пример: поиск флага -v и значения после --file.

import sys

verbose = False
filename = None
i = 1
while i < len(sys.argv):
    arg = sys.argv[i]
    if arg == '-v':
        verbose = True
    elif arg == '--file':
        i += 1
        if i < len(sys.argv):
            filename = sys.argv[i]
        else:
            sys.exit('Не указано имя файла после --file')
    else:
        sys.exit(f'Неизвестный аргумент: {arg}')
    i += 1

print(f'Verbose: {verbose}, File: {filename}')

$ python manual.py -v --file data.txt
Verbose: True, File: data.txt

Комбинирование переменных окружения и argparse

Часто практикуется поддержка нескольких источников параметров с приоритетом: командная строка переопределяет переменные окружения.

import argparse
import os

parser = argparse.ArgumentParser()
parser.add_argument('--database-url', type=str, default=os.environ.get('DB_URL'))
parser.add_argument('--debug', action='store_true', default=os.environ.get('DEBUG', '0') == '1')

args = parser.parse_args()
print(f'URL базы: {args.database_url}')
print(f'Отладка: {args.debug}')

$ export DB_URL='postgres://user:pass@localhost/db'
$ export DEBUG=1
$ python combined.py --debug
URL базы: postgres://user:pass@localhost/db
Отладка: True
$ python combined.py --database-url 'sqlite:///test.db'
URL базы: sqlite:///test.db
Отладка: False