Изучаем модуль argparse

О модуле argparse

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

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

Уходим от Jupyter Notebook

Использовать модуль argparse будет нерациональным в Jupyter Notebook, поскольку вы не просто запустите скрипт, а именно работать средствами от данной среды разработки. Автономным скриптом будет куда удобнее работать с модулем argparse.

Для чего нужен модуль argparse?

Модуль argparse предоставляет нам возможность разбирать аргументы, передаваемые скрипту при его запуске из командной строки, также есть возможность пользоваться этими аргументами в скрипте. Простыми словами модуль предоставляет скрипту некие данные во время его запуска, далее этими данными скрипт сможет пользоваться во время запуска кода.

Также модулем argparse при необходимости можно изменить поведение скрипта или при необходимости передавать ему некие данные, если автор скрипта это предусмотрел. Таким образом нам не обязательно редактировать программный код.

Возьмем в пример тот факт, что вы хотите написать скрипт для преобразования видеофайлов в обычные изображения при помощи библиотеки OpenCV. Для работы, нужно чтобы скрипт знал, где храняться видеофайлы, а также файл, в который нам нужно поместить готовый результат. Можно решить эту проблемой следующим путем: позволяем пользователю скрипта вводить путь к файлам, вводя их в качестве аргументов командной строки при запуске. Для этого нам понадобиться модуль argparse. Пример кода:

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