Skip to content

Конфигурационные файлы: INI и TOML ​

Приложение имеет параметры: адрес сервера, порт, куда писать лог. Их не зашивают в код — тогда каждое изменение требовало бы пересборки. Параметры выносят в конфигурационный файл. Два распространённых формата: старый добрый INI и современный TOML.

INI: configparser ​

INI-файл — секции в квадратных скобках и внутри них пары «ключ = значение»:

ini
[server]
host = localhost
port = 8080

[logging]
file = phone_book.log
level = INFO

Модуль configparser — в стандартной библиотеке:

py
import configparser

config = configparser.ConfigParser()
config.read('app.ini')

print(config['server']['host'])   # localhost
print(config['server']['port'])   # 8080 — но это строка!

Важно: INI не хранит типы — всё строки. Порт приводите сами:

py
port = int(config['server']['port'])

Запись в INI:

py
import configparser

config = configparser.ConfigParser()
config['storage'] = {'path': 'books/'}

with open('app.ini', 'w') as f:
    config.write(f)

Структура configparser — тот же словарь: config ведёт себя как вложенный словарь {секция: {ключ: значение}}, плюс секция DEFAULT.

TOML: tomllib ​

TOML (Tom's Obvious, Minimal Language) — современный ответ на INI. Главное отличие: типы. Число — число, логическое — логическое:

toml
[server]
host = "localhost"
port = 8080

[logging]
file = "phone_book.log"
enabled = true

Читается в Python 3.11+ стандартным модулем tomllib:

py
import tomllib

with open('app.toml', 'rb') as f:   # обязательно режим 'rb'!
    config = tomllib.load(f)

print(config['server']['port'])   # 8080 — это int
print(type(config['logging']['enabled']))  # <class 'bool'>

Обратите внимание на 'rb': tomllib читает байты, а не строки. Запись в TOML в стандартной библиотеке нет (есть сторонний tomli_w) — TOML в Python чаще «только для чтения».

Зачем конфиг, а не код ​

  • параметры меняются без правки кода: один файл — и приложение ведёт себя иначе;
  • разные среды: app.dev.ini и app.prod.ini рядом, переключаетесь одним словом;
  • секреты и пути не лежат в истории git вместе с кодом;
  • конфиг читает и человек, и программа — один формат на двоих.

Телефонная книга: конфиг ​

Приложение «телефонная книга» имеет и свои настройки:

ini
[general]
owner = Vita
book_file = phone_book.csv

[logging]
file = phone_book.log
py
import configparser

config = configparser.ConfigParser()
config.read('app.ini')

print(config['general']['owner'])       # Vita
print(config['general']['book_file'])   # phone_book.csv

Плюсы и минусы ​

INITOML
Типынет, всё строкиесть: int, bool, float, списки
В стандартной библиотекеconfigparser (чтение и запись)tomllib (только чтение, Python 3.11+)
Вложенностьсекциисекции + таблицы
Кому нравитсястарые системы, простые утилитыновые проекты (Cargo, Python-утилиты)

Общий минус обоих: нет вложенности «глубже секций» — это форматы для настроек, а не для хранения данных.

Итог ​

INI и TOML — форматы «настроек приложения». Данные в них не хранят — хранят параметры. Последний формат курса — pickle: он умеет сохранить любой объект Python, но со строгим ограничением по безопасности.


Упражнения ​

  1. Создайте файл app.ini (в редакторе) с секциями [server] (host = localhost, port = 8080) и [logging] (file = phone_book.log, level = INFO). Прочитайте его через configparser и напечатайте host, port и уровень лога.
py
import configparser
# допишите код ниже
  1. Напечатайте строку вида сервер: localhost:8080, где host и port взяты из app.ini. В комментарии объясните, почему port пришлось приводить к int.
py
import configparser
# допишите код ниже
  1. Кодом добавьте в конфиг новую секцию [storage] с ключом path = books/ и запишите результат в app_changed.ini. Прочитайте новый файл и проверьте, что секция на месте.
py
import configparser
# допишите код ниже
  1. Создайте файл app.toml (в редакторе) с содержимым:
toml
[server]
host = "localhost"
port = 8080

[logging]
enabled = true

Прочитайте его через tomllib (помните про режим 'rb') и напечатайте port и enabled вместе с типами (type()). Чем результат отличается от INI?

py
import tomllib
# допишите код ниже
  1. В комментарии к коду объясните: почему configparser-конфиг удобно держать рядом с кодом, а секреты (пароли, ключи) — нет. Какие два формата этого курса лучше всего подходят для настроек приложения и почему?
py
# допишите ответ ниже