Создаем конфигурационный файл своими руками

1. Введение

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

Но для начала, давайте определимся что же понимается под термином конфигурационный файл.

1.1 Определение

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

1.2 Подготовка

Весь код, представленный в статье, написан с использованием замечательной IDE PyCharm, вы можете скачать бесплатную версию Community edition по этой ссылке, или же использовать любую другую удобную вам IDE или редактор.

2. Создаем конфигурационный файл

2.1 logging.basicConfig - наш тестовый объект

Откройте вашу IDE или текстовый редактор и создайте 2 файла: configuration.py и main.py.

Предположим, что вы захотели добавить в ваше приложение возможность логирования с использованием модуля logging. Для этого, вам нужно будет передать соответствующие настройки (например, уровень логирования, имя файла, куда будут записываться логи, и режим записи в этот файл) в функцию basicConfig(). Все это можно записать в файл main.py следующим образом:

Рис .1 - logging

Чтобы проверить, что все работает, вы можете добавить в конец файла строку

logging.debug('Ваше лог сообщение')

и выполнить этот файл:

python main.py

После успешного выполнения, у вас появится файл log.log с одним единственным сообщением, которое вы указали выше. При последующем запуске, это сообщение будет перезаписано. Вы можете изменить режим записи логов, заменив filemode на 'a', чтобы при каждом последующем выполнении приложения логи добавлялись в конец файла.

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

2.2 Модуль configparser

Для создания конфигурационного файла мы будем использовать модуль configparser. Поэтому первым делом импортируем его:

import configparser

Допустим, мы хотим чтобы наш конфигурационный файл имел поля level, filename, filemode, которые относятся к логированию, и еще одно дополнительное поле, например url нашей главной странички. Файл с такой структурой мог бы выглядеть следующим образом:

Рис. 2 - Конфигурационный файл

Для этого, создадим объект configparser:

config = configparser.ConfigParser()

и определим секции [LOGGING] и [URL] с соответствующими полями. Это можно сделать так:

Рис. 3 - Секции конфигурационного файла

Последним шагом будет непосредственное создание конфигурационного файла. Давайте укажем что должно получиться в итоге в файле configuration.py.

Рис. 4 - configuration.py

Здесь 'crazy_python.ini' - это имя нашего конфигурационного файла. Все что осталось сделать, это выполнить данный скрипт:

python configuration.py

После выполнения скрипта у вас будет создан конфигурационный файл, указанный на рисунке 2.

Использование

Чтобы использовать созданный нами файл, снова откроем main.py и загрузим конфигурационный файл:

Рис. 5 - Загрузка

Теперь, когда мы загрузили наш файл, мы можем обращаться к любым определенным в нем полям. Перепишем обращение к функции basicConfig(), указанное на рисунке 1:

Рис. 6 - Обращение к полем конфигурационного файла

Как видите, обращение к конфигурационному файлу аналогично работе с обычным словарем. Кроме этой записи, вы также можете использовать альтернативный синтаксис:

Рис. 7 - Метод get()

Заключение

На этом всё. Больше информации по модулю configparser вы можете посмотреть в официальной документации (ссылочка есть ниже).

Спасибо, что дочитали до конца. Ставьте лайки и приходите снова на мой канал CrazyPython.

Ссылки:

1. Загружаем PyCharm Community edition
2. Configparser - документация