Разработка консольных приложений с помощью Python

Расширенные примеры консольных программ

Многоуровневые команды с argparse (subparsers)

Для создания утилит, подобных git, где есть подкоманды, используется механизм subparsers. Каждая подкоманда имеет собственный набор аргументов.

import argparse

parser = argparse.ArgumentParser(description='Утилита для работы с репозиторием')
subparsers = parser.add_subparsers(dest='command')

# команда init
parser_init = subparsers.add_parser('init', help='Инициализировать репозиторий')
parser_init.add_argument('--bare', action='store_true', help='Создать bare-репозиторий')

# команда commit
parser_commit = subparsers.add_parser('commit', help='Создать коммит')
parser_commit.add_argument('-m', '--message', required=True, help='Сообщение коммита')
parser_commit.add_argument('--amend', action='store_true', help='Изменить последний коммит')

args = parser.parse_args()

if args.command == 'init':
    print('Инициализация...' if not args.bare else 'Инициализация bare...')
elif args.command == 'commit':
    print(f'Коммит: {args.message}', end='')
    if args.amend:
        print(' (изменён)')
    else:
        print()
else:
    parser.print_help()

$ python script.py commit -m "first commit"
Коммит: first commit

Группы команд с click

Click предлагает декоратор @click.group() для объединения команд.

import click

@click.group()
def cli():
    pass

@cli.command()
@click.option('--name', default='мир')
def hello(name):
    click.echo(f'Привет, {name}!')

@cli.command()
@click.argument('a', type=int)
@click.argument('b', type=int)
def add(a, b):
    click.echo(a + b)

if __name__ == '__main__':
    cli()

$ python script.py hello --name=Вася
Привет, Вася!
$ python script.py add 5 7
12

Прогресс-бар с tqdm для имитации загрузки файлов

Можно комбинировать tqdm с циклами и вложенными шкалами.

from tqdm import tqdm
import time

def download_file(url):
    time.sleep(0.1)
    return True

urls = ['http://example.com/file1', 'http://example.com/file2', 'http://example.com/file3']
with tqdm(total=len(urls), desc='Загрузка файлов', unit='файл') as pbar:
    for url in urls:
        download_file(url)
        pbar.set_postfix({'url': url[-15:]})
        pbar.update(1)

Загрузка файлов: 100%|██████████| 3/3 [00:00<00:00,  9.99файл/с, url=file3]

Цветной вывод логирования с цветом ошибок

Совмещение colorama и модуля logging даёт читаемые сообщения в консоли.

import logging
from colorama import Fore, Style, init

init()

class ColorFormatter(logging.Formatter):
    def format(self, record):
        if record.levelno == logging.ERROR:
            prefix = Fore.RED + 'ОШИБКА' + Style.RESET_ALL
        elif record.levelno == logging.WARNING:
            prefix = Fore.YELLOW + 'ПРЕДУПРЕЖДЕНИЕ' + Style.RESET_ALL
        else:
            prefix = Fore.GREEN + 'ИНФО' + Style.RESET_ALL
        return f'{prefix} {record.getMessage()}'

handler = logging.StreamHandler()
handler.setFormatter(ColorFormatter())
logger = logging.getLogger()
logger.addHandler(handler)
logger.setLevel(logging.INFO)

logger.info('Программа запущена')
logger.warning('Низкий заряд батареи')
logger.error('Ошибка соединения')

(вывод с цветами в терминале)
ИНФО Программа запущена
ПРЕДУПРЕЖДЕНИЕ Низкий заряд батареи
ОШИБКА Ошибка соединения

Использование sys.stdin для обработки потока ввода

Консольные программы часто читают данные из стандартного ввода, что позволяет использовать их в конвейере командной строки.

import sys

def filter_lines(keyword):
    for line in sys.stdin:
        if keyword in line:
            sys.stdout.write(line)

if __name__ == '__main__':
    if len(sys.argv) != 2:
        print('Использование: python script.py <ключевое_слово>', file=sys.stderr)
        sys.exit(1)
    filter_lines(sys.argv[1])

$ echo -e 'apple\nbanana\ncherry' | python script.py a
apple
banana

Пояснения: Скрипт читает строки из stdin, если они содержат заданное слово, выводит их в stdout. Это типичный фильтр для конвейеров.

Обработка сигналов (Graceful Shutdown)

Для корректного завершения консольной программы при нажатии Ctrl+C следует обработать сигнал SIGINT.

import signal
import sys
import time

running = True

def handler(signum, frame):
    global running
    print('\nЗавершение по сигналу...', file=sys.stderr)
    running = False

signal.signal(signal.SIGINT, handler)

while running:
    print('Работаю...')
    time.sleep(1)

print('Программа корректно завершена.')

Работаю...
Работаю...
^C
Завершение по сигналу...
Программа корректно завершена.