configparser.md
1> **Источник:** https://python-all.ru/3.11/library/configparser.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) – Парсер конфигурационных файлов89**Исходный код:** [Lib/configparser.py](https://python-all.ru/src/3.11/Lib/configparser.py)1011---1213Этот модуль предоставляет класс [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser), реализующий базовый язык конфигурации, структура которого аналогична файлам INI в Microsoft Windows. Его можно использовать для написания программ на Python, которые конечные пользователи могут легко настраивать.1415> **Примечание**16>17> Эта библиотека *не* интерпретирует и не записывает префиксы типов значений, используемые в расширенной версии синтаксиса INI из реестра Windows.1819> **См. также**20>21> **Модуль [`tomllib`](https://python-all.ru/3.11/library/tomllib.html#module-tomllib)**22>23> TOML – хорошо специфицированный формат для файлов конфигурации приложений. Он специально разработан как улучшенная версия INI.24>25> **Модуль [`shlex`](https://python-all.ru/3.11/library/shlex.html#module-shlex)**26>27> Поддержка создания мини-языков в стиле Unix shell, которые также можно использовать для файлов конфигурации приложений.28>29> **Модуль [`json`](https://python-all.ru/3.11/library/json.html#module-json)**30>31> Модуль `json` реализует подмножество синтаксиса JavaScript, которое иногда используется для конфигурации, но не поддерживает комментарии.3233## Быстрый старт3435Рассмотрим простейший конфигурационный файл, который выглядит так:3637```ini38[DEFAULT]39ServerAliveInterval = 4540Compression = yes41CompressionLevel = 942ForwardX11 = yes4344[forge.example]45User = hg4647[topsecret.server.example]48Port = 5002249ForwardX11 = no50```5152Структура INI-файлов описана [в следующем разделе](https://python-all.ru/3.11/library/configparser.html#supported-ini-file-structure). По существу, файл состоит из секций, каждая из которых содержит ключи со значениями. Класс [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) может читать и записывать такие файлы. Начнем с программного создания приведенного выше конфигурационного файла.5354```pycon55>>> import configparser56>>> config = configparser.ConfigParser()57>>> config['DEFAULT'] = {'ServerAliveInterval': '45',58... 'Compression': 'yes',59... 'CompressionLevel': '9'}60>>> config['forge.example'] = {}61>>> config['forge.example']['User'] = 'hg'62>>> config['topsecret.server.example'] = {}63>>> topsecret = config['topsecret.server.example']64>>> topsecret['Port'] = '50022' # изменяет парсер65>>> topsecret['ForwardX11'] = 'no' # то же самое66>>> config['DEFAULT']['ForwardX11'] = 'yes'67>>> with open('example.ini', 'w') as configfile:68... config.write(configfile)69...70```7172Как видите, парсер конфигураций можно использовать почти как словарь. Есть различия, [описанные далее](https://python-all.ru/3.11/library/configparser.html#mapping-protocol-access), но поведение очень близко к тому, что можно ожидать от словаря.7374Теперь, когда мы создали и сохранили конфигурационный файл, давайте прочитаем его и изучим содержащиеся в нем данные.7576```pycon77>>> config = configparser.ConfigParser()78>>> config.sections()79[]80>>> config.read('example.ini')81['example.ini']82>>> config.sections()83['forge.example', 'topsecret.server.example']84>>> 'forge.example' in config85True86>>> 'python.org' in config87False88>>> config['forge.example']['User']89'hg'90>>> config['DEFAULT']['Compression']91'yes'92>>> topsecret = config['topsecret.server.example']93>>> topsecret['ForwardX11']94'no'95>>> topsecret['Port']96'50022'97>>> for key in config['forge.example']: 98... print(key)99user100compressionlevel101serveraliveinterval102compression103forwardx11104>>> config['forge.example']['ForwardX11']105'yes'106```107108Как видно выше, API довольно прост. Единственная «магия» – это секция `DEFAULT`, которая предоставляет значения по умолчанию для всех остальных секций [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15). Также обратите внимание, что ключи в секциях нечувствительны к регистру и хранятся в нижнем регистре [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15).109110Можно загрузить несколько конфигураций в один объект [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser), при этом последняя добавленная конфигурация имеет наивысший приоритет. Любые конфликтующие ключи берутся из более новой конфигурации, а ранее существовавшие ключи сохраняются.111112```pycon113>>> another_config = configparser.ConfigParser()114>>> another_config.read('example.ini')115['example.ini']116>>> another_config['topsecret.server.example']['Port']117'50022'118>>> another_config.read_string("[topsecret.server.example]\nPort=48484")119>>> another_config['topsecret.server.example']['Port']120'48484'121>>> another_config.read_dict({"topsecret.server.example": {"Port": 21212}})122>>> another_config['topsecret.server.example']['Port']123'21212'124>>> another_config['topsecret.server.example']['ForwardX11']125'no'126```127128Это поведение эквивалентно вызову [`ConfigParser.read()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read) с несколькими файлами, переданными в параметр *filenames*.129130## Поддерживаемые типы данных131132Парсеры конфигураций не угадывают типы данных значений в конфигурационных файлах, а всегда хранят их внутри как строки. Это означает, что если вам нужны другие типы данных, преобразование нужно выполнять самостоятельно:133134```pycon135>>> int(topsecret['Port'])13650022137>>> float(topsecret['CompressionLevel'])1389.0139```140141Поскольку эта задача встречается часто, парсеры конфигураций предоставляют ряд удобных методов-геттеров для работы с целыми числами, числами с плавающей точкой и булевыми значениями. Последний тип наиболее интересен, потому что простая передача значения в `bool()` не даст результата, поскольку `bool('False')` все еще является `True`. Именно поэтому парсеры конфигураций также предоставляют метод [`getboolean()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getboolean). Этот метод нечувствителен к регистру и распознает булевы значения из `'yes'`/`'no'`, `'on'`/`'off'`, `'true'`/`'false'` и `'1'`/`'0'` [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15). Например:142143```pycon144>>> topsecret.getboolean('ForwardX11')145False146>>> config['forge.example'].getboolean('ForwardX11')147True148>>> config.getboolean('forge.example', 'Compression')149True150```151152Помимо [`getboolean()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getboolean), парсеры конфигураций также предоставляют эквивалентные методы [`getint()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getint) и [`getfloat()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getfloat). Вы можете зарегистрировать собственные преобразователи и настроить предоставленные. [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15)153154## Резервные значения155156Как и в словаре, для указания резервных значений можно использовать метод [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get) секции:157158```pycon159>>> topsecret.get('Port')160'50022'161>>> topsecret.get('CompressionLevel')162'9'163>>> topsecret.get('Cipher')164>>> topsecret.get('Cipher', '3des-cbc')165'3des-cbc'166```167168Обратите внимание, что значения по умолчанию имеют приоритет над резервными. Например, в нашем примере ключ `'CompressionLevel'` был указан только в секции `'DEFAULT'`. Если мы попытаемся получить его из секции `'topsecret.server.example'`, мы всегда получим значение по умолчанию, даже если указано резервное:169170```pycon171>>> topsecret.get('CompressionLevel', '3')172'9'173```174175Еще одна деталь: метод [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get) на уровне парсера предоставляет собственный, более сложный интерфейс, сохраненный для обратной совместимости. При использовании этого метода резервное значение можно передать через именованный аргумент `fallback`:176177```pycon178>>> config.get('forge.example', 'monster',179... fallback='No such things as monsters')180'No such things as monsters'181```182183Тот же аргумент `fallback` можно использовать с методами [`getint()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getint), [`getfloat()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getfloat) и [`getboolean()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getboolean), например:184185```pycon186>>> 'BatchMode' in topsecret187False188>>> topsecret.getboolean('BatchMode', fallback=True)189True190>>> config['DEFAULT']['BatchMode'] = 'no'191>>> topsecret.getboolean('BatchMode', fallback=True)192False193```194195## Поддерживаемая структура INI-файлов196197Конфигурационный файл состоит из секций, каждая из которых начинается с заголовка `[section]`, за которым следуют пары ключ/значение, разделенные определенной строкой (по умолчанию `=` или `:` [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15)). По умолчанию имена секций чувствительны к регистру, а ключи – нет [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15). Начальные и конечные пробелы удаляются из ключей и значений. Значения могут быть опущены, если парсер настроен на разрешение этого [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15); в этом случае разделитель ключа и значения также может быть опущен. Значения также могут занимать несколько строк, если они имеют отступ глубже, чем первая строка значения. В зависимости от режима парсера пустые строки могут рассматриваться как часть многострочных значений или игнорироваться.198199По умолчанию допустимое имя секции – любая строка, не содержащая ‘\\n’. Чтобы изменить это, см. [`ConfigParser.SECTCRE`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.SECTCRE).200201Конфигурационные файлы могут содержать комментарии, начинающиеся с определенных символов (по умолчанию `#` и `;` [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15)). Комментарии могут располагаться на отдельной пустой строке, возможно с отступом. [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15)202203Например:204205```ini206[Simple Values]207key=value208spaces in keys=allowed209spaces in values=allowed as well210spaces around the delimiter = obviously211you can also use : to delimit keys from values212213[All Values Are Strings]214values like this: 1000000215or this: 3.14159265359216are they treated as numbers? : no217integers, floats and booleans are held as: strings218can use the API to get converted values directly: true219220[Multiline Values]221chorus: I'm a lumberjack, and I'm okay222 I sleep all night and I work all day223224[No Values]225key_without_value226empty string value here =227228[You can use comments]229# как этот230; или этот231232# По умолчанию только в пустой строке.233# Встроенные комментарии могут быть вредны, поскольку не позволяют пользователям234# использовать разделительные символы как части значений.235# Тем не менее, это можно настроить.236237 [Sections Can Be Indented]238 can_values_be_as_well = True239 does_that_mean_anything_special = False240 purpose = formatting for readability241 multiline_values = are242 handled just fine as243 long as they are indented244 deeper than the first line245 of a value246 # Кстати, комментарии тоже можно делать с отступом.247```248249## Интерполяция значений250251Помимо основной функциональности, [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser) поддерживает интерполяцию. Это означает, что значения могут обрабатываться перед тем, как быть возвращёнными из вызовов `get()`.252253#### `class configparser.BasicInterpolation`254255Реализация по умолчанию, используемая в [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser). Она позволяет значениям содержать строки форматирования, ссылающиеся на другие значения в том же разделе или на значения в специальном разделе по умолчанию [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15). Дополнительные значения по умолчанию можно указать при инициализации.256257Например:258259```ini260[Paths]261home_dir: /Users262my_dir: %(home_dir)s/lumberjack263my_pictures: %(my_dir)s/Pictures264265[Escape]266# используйте %% для экранирования символа % (% – единственный символ, требующий экранирования):267gain: 80%%268```269270В примере выше [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser) с параметром *interpolation*, установленным в `BasicInterpolation()`, преобразовал бы `%(home_dir)s` в значение `home_dir` (в данном случае `/Users`). `%(my_dir)s`, в свою очередь, преобразовалось бы в `/Users/lumberjack`. Все подстановки выполняются по требованию, поэтому ключи, используемые в цепочке ссылок, не обязаны быть указаны в каком-либо определённом порядке в конфигурационном файле.271272Если `interpolation` установлен в `None`, анализатор просто вернёт `%(my_dir)s/Pictures` как значение `my_pictures` и `%(home_dir)s/lumberjack` как значение `my_dir`.273274#### `class configparser.ExtendedInterpolation`275276Альтернативный обработчик для интерполяции, реализующий более сложный синтаксис, используемый, например, в `zc.buildout`. Расширенная интерполяция использует `${section:option}` для обозначения значения из другого раздела. Интерполяция может быть многоуровневой. Для удобства, если часть `section:` опущена, интерполяция по умолчанию берётся из текущего раздела (а также из значений по умолчанию из специального раздела).277278Например, конфигурация, заданная выше с базовой интерполяцией, с расширенной интерполяцией будет выглядеть так:279280```ini281[Paths]282home_dir: /Users283my_dir: ${home_dir}/lumberjack284my_pictures: ${my_dir}/Pictures285286[Escape]287# используйте $$ для экранирования символа $ ($ – единственный символ, требующий экранирования):288cost: $$80289```290291Значения из других разделов также можно получать:292293```ini294[Common]295home_dir: /Users296library_dir: /Library297system_dir: /System298macports_dir: /opt/local299300[Frameworks]301Python: 3.2302path: ${Common:system_dir}/Library/Frameworks/303304[Arthur]305nickname: Two Sheds306last_name: Jackson307my_dir: ${Common:home_dir}/twosheds308my_pictures: ${my_dir}/Pictures309python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}310```311312## Доступ через протокол отображения313314Новое в версии 3.2.315316Доступ через протокол отображения – это общее название функциональности, позволяющей использовать пользовательские объекты как словари. В случае [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) реализация интерфейса отображения использует нотацию `parser['section']['option']`.317318`parser['section']`, в частности, возвращает прокси для данных раздела в анализаторе. Это означает, что значения не копируются, а берутся из исходного анализатора по требованию. Что ещё более важно: при изменении значений в прокси-разделе они фактически изменяются и в исходном анализаторе.319320Объекты [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) ведут себя максимально близко к настоящим словарям. Интерфейс отображения реализован полностью и соответствует абстрактному базовому классу [`MutableMapping`](https://python-all.ru/3.11/library/collections.abc.html#collections.abc.MutableMapping). Однако есть несколько различий, которые следует учитывать:321322- По умолчанию все ключи в разделах доступны без учёта регистра [\[1\]](https://python-all.ru/3.11/library/configparser.html#id15). Например, `for option in parser["section"]` возвращает только имена опций, приведённые к `optionxform`. По умолчанию это означает ключи в нижнем регистре. В то же время для раздела, содержащего ключ `'a'`, оба выражения вернут `True`:323324 ```python325 "a" in parser["section"]326 "A" in parser["section"]327 ```328- Все разделы также содержат значения `DEFAULTSECT`, то есть `.clear()`, применённый к разделу, может не оставить его видимо пустым. Это связано с тем, что значения по умолчанию нельзя удалить из раздела (технически их там нет). Если они переопределены в разделе, удаление приводит к тому, что значение по умолчанию снова становится видимым. Попытка удалить значение по умолчанию вызывает [`KeyError`](https://python-all.ru/3.11/library/exceptions.html#KeyError).329- `DEFAULTSECT` нельзя удалить из анализатора:330331 - попытка удалить его вызывает [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError),332 - `parser.clear()` оставляет его нетронутым,333 - `parser.popitem()` никогда его не возвращает.334- `parser.get(section, option, **kwargs)` – второй аргумент **не** является запасным значением. Однако обратите внимание, что методы `get()` на уровне раздела совместимы как с протоколом отображения, так и с классическим API configparser.335- `parser.items()` совместим с протоколом отображения (возвращает список пар *название\_раздела*, *прокси\_раздела*, включая DEFAULTSECT). Однако этот метод также может быть вызван с аргументами: `parser.items(section, raw, vars)`. Последний вызов возвращает список пар *опция*, *значение* для указанного `section`, со всеми раскрытыми интерполяциями (если не указан `raw=True`).336337Протокол отображения реализован поверх существующего устаревшего API, поэтому подклассы, переопределяющие исходный интерфейс, по-прежнему должны работать с отображением, как и ожидается.338339## Настройка поведения анализатора340341Вариантов формата INI почти столько же, сколько приложений, его использующих. [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) прилагает большие усилия для поддержки максимально широкого набора стилей INI. Функциональность по умолчанию в основном продиктована историческим опытом, и вполне вероятно, что вам потребуется настроить некоторые возможности.342343Самый распространённый способ изменить поведение конкретного анализатора конфигурации – использовать опции `__init__()`:344345- *defaults*, значение по умолчанию: `None`346347 Эта опция принимает словарь пар ключ-значение, которые изначально помещаются в раздел `DEFAULT`. Это позволяет элегантно поддерживать лаконичные конфигурационные файлы, в которых не указываются значения, совпадающие с задокументированными значениями по умолчанию.348349 Подсказка: если нужно задать значения по умолчанию для конкретного раздела, используйте [`read_dict()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_dict) до чтения самого файла.350- *dict\_type*, значение по умолчанию: [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict)351352 Эта опция существенно влияет на поведение протокола отображения и на внешний вид записанных конфигурационных файлов. Со стандартным словарём каждый раздел хранится в порядке добавления в анализатор. То же самое касается опций внутри разделов.353354 Другой тип словаря можно использовать, например, для сортировки разделов и параметров при записи обратно.355356 Обратите внимание: существуют способы добавить набор пар ключ-значение за одну операцию. При использовании обычного словаря в таких операциях порядок ключей будет упорядочен. Например:357358 ```pycon359 >>> parser = configparser.ConfigParser()360 >>> parser.read_dict({'section1': {'key1': 'value1',361 ... 'key2': 'value2',362 ... 'key3': 'value3'},363 ... 'section2': {'keyA': 'valueA',364 ... 'keyB': 'valueB',365 ... 'keyC': 'valueC'},366 ... 'section3': {'foo': 'x',367 ... 'bar': 'y',368 ... 'baz': 'z'}369 ... })370 >>> parser.sections()371 ['section1', 'section2', 'section3']372 >>> [option for option in parser['section3']]373 ['foo', 'bar', 'baz']374 ```375- *allow\_no\_value*, значение по умолчанию: `False`376377 Известно, что некоторые конфигурационные файлы содержат настройки без значений, но в остальном соответствуют синтаксису, поддерживаемому [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser). Параметр *allow\_no\_value* конструктора можно использовать, чтобы указать, что такие значения следует принимать:378379 ```pycon380 >>> import configparser381382 >>> sample_config = """383 ... [mysqld]384 ... user = mysql385 ... pid-file = /var/run/mysqld/mysqld.pid386 ... skip-external-locking387 ... old_passwords = 1388 ... skip-bdb389 ... # we don't need ACID today390 ... skip-innodb391 ... """392 >>> config = configparser.ConfigParser(allow_no_value=True)393 >>> config.read_string(sample_config)394395 >>> # Настройки со значениями обрабатываются как и раньше:396 >>> config["mysqld"]["user"]397 'mysql'398399 >>> # Настройки без значений дают None:400 >>> config["mysqld"]["skip-bdb"]401402 >>> # Настройки, которые не указаны, по-прежнему вызывают ошибку:403 >>> config["mysqld"]["does-not-exist"]404 Traceback (most recent call last):405 ...406 KeyError: 'does-not-exist'407 ```408- *delimiters*, значение по умолчанию: `('=', ':')`409410 Разделители – это подстроки, которые отделяют ключи от значений внутри раздела. Первое вхождение такой подстроки в строке считается разделителем. Это означает, что значения (но не ключи) могут содержать разделители.411412 См. также аргумент *space\_around\_delimiters* для [`ConfigParser.write()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.write).413- *comment\_prefixes*, значение по умолчанию: `('#', ';')`414- *inline\_comment\_prefixes*, значение по умолчанию: `None`415416 Префиксы комментариев – это строки, указывающие начало допустимого комментария в конфигурационном файле. *comment\_prefixes* используются только на пустых строках (возможно, с отступом), тогда как *inline\_comment\_prefixes* могут использоваться после любого допустимого значения (например, названий разделов, параметров и пустых строк). По умолчанию строчные комментарии отключены, а в качестве префиксов для комментариев на всю строку используются `'#'` и `';'`.417418 Изменено в версии 3.2: В предыдущих версиях [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) поведение соответствовало `comment_prefixes=('#',';')` и `inline_comment_prefixes=(';',)`.419420 Обратите внимание: парсеры конфигурации не поддерживают экранирование префиксов комментариев, поэтому использование *inline\_comment\_prefixes* может помешать пользователям указывать значения параметров, содержащие символы, используемые как префиксы комментариев. Если сомневаетесь, избегайте установки *inline\_comment\_prefixes*. В любом случае, единственный способ сохранить символы префикса комментария в начале строки в многострочных значениях – это интерполировать префикс, например:421422 ```python423 >>> from configparser import ConfigParser, ExtendedInterpolation424 >>> parser = ConfigParser(interpolation=ExtendedInterpolation())425 >>> # можно также использовать стандартный BasicInterpolation426 >>> parser.read_string("""427 ... [DEFAULT]428 ... hash = #429 ...430 ... [hashes]431 ... shebang =432 ... ${hash}!/usr/bin/env python433 ... ${hash} -*- coding: utf-8 -*-434 ...435 ... extensions =436 ... enabled_extension437 ... another_extension438 ... #disabled_by_comment439 ... yet_another_extension440 ...441 ... interpolation not necessary = if # is not at line start442 ... even in multiline values = line #1443 ... line #2444 ... line #3445 ... """)446 >>> print(parser['hashes']['shebang'])447448 #!/usr/bin/env python449 # -*- coding: utf-8 -*-450 >>> print(parser['hashes']['extensions'])451452 enabled_extension453 another_extension454 yet_another_extension455 >>> print(parser['hashes']['interpolation not necessary'])456 if # is not at line start457 >>> print(parser['hashes']['even in multiline values'])458 line #1459 line #2460 line #3461 ```462- *strict*, значение по умолчанию: `True`463464 Если установлено `True`, парсер не допускает дублирования разделов или параметров при чтении из одного источника (с помощью [`read_file()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_file), [`read_string()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_string) или [`read_dict()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_dict)). В новых приложениях рекомендуется использовать строгие парсеры.465466 Изменено в версии 3.2: В предыдущих версиях [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) поведение соответствовало `strict=False`.467- *empty\_lines\_in\_values*, значение по умолчанию: `True`468469 В парсерах конфигурации значения могут занимать несколько строк, если их отступ больше, чем у ключа, к которому они относятся. По умолчанию парсеры также допускают, чтобы пустые строки были частью значений. В то же время сами ключи могут иметь произвольный отступ для улучшения читаемости. В результате, когда конфигурационные файлы становятся большими и сложными, пользователю легко потерять представление о структуре файла. Рассмотрим пример:470471 ```ini472 [Section]473 key = multiline474 value with a gotcha475476 this = is still a part of the multiline value of 'key'477 ```478479 Это может быть особенно проблематично для пользователя, если он использует пропорциональный шрифт для редактирования файла. Вот почему, если вашему приложению не нужны значения с пустыми строками, стоит рассмотреть возможность их запрета. Это приведёт к тому, что пустые строки будут каждый раз разделять ключи. В приведённом выше примере получилось бы два ключа: `key` и `this`.480- *default\_section*, значение по умолчанию: `configparser.DEFAULTSECT` (то есть `"DEFAULT"`)481482 Возможность выделить специальный раздел со значениями по умолчанию для других разделов или для интерполяции – это мощная концепция данной библиотеки, позволяющая пользователям создавать сложные декларативные конфигурации. Этот раздел обычно называется `"DEFAULT"`, однако его можно настроить на любое другое допустимое имя раздела. Некоторые типичные значения: `"general"` или `"common"`. Указанное имя используется для распознавания разделов по умолчанию при чтении из любого источника, а также при записи конфигурации обратно в файл. Текущее значение можно получить через атрибут `parser_instance.default_section` и изменить во время выполнения (например, для преобразования файлов из одного формата в другой).483- *interpolation*, значение по умолчанию: `configparser.BasicInterpolation`484485 Поведение интерполяции можно настроить, передав собственный обработчик через аргумент *interpolation*. `None` позволяет полностью отключить интерполяцию, `ExtendedInterpolation()` предоставляет более продвинутый вариант, вдохновлённый `zc.buildout`. Подробнее об этом в [соответствующем разделе документации](https://python-all.ru/3.11/library/configparser.html#interpolation-of-values). [`RawConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.RawConfigParser) имеет значение по умолчанию `None`.486- *converters*, значение по умолчанию: не задано487488 Парсеры конфигурации предоставляют геттеры значений параметров, выполняющие преобразование типов. По умолчанию реализованы [`getint()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getint), [`getfloat()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getfloat) и [`getboolean()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getboolean). Если нужны другие геттеры, пользователи могут определить их в подклассе или передать словарь, где каждый ключ – имя преобразователя, а каждое значение – вызываемый объект, реализующий это преобразование. Например, передача `{'decimal': decimal.Decimal}` добавит `getdecimal()` как на объект парсера, так и на все прокси разделов. Другими словами, станет возможным писать как `parser_instance.getdecimal('section', 'key', fallback=0)`, так и `parser_instance['section'].getdecimal('key', 0)`.489490 Если преобразователю требуется доступ к состоянию парсера, его можно реализовать как метод подкласса парсера конфигурации. Если имя этого метода начинается с `get`, он будет доступен на всех прокси разделов в dict-совместимой форме (см. пример `getdecimal()` выше).491492Более тонкую настройку можно выполнить, переопределив значения по умолчанию этих атрибутов парсера. Значения по умолчанию заданы на уровне классов, поэтому их можно переопределить в подклассах или путём присваивания атрибуту.493494#### `ConfigParser.BOOLEAN_STATES`495496По умолчанию при использовании [`getboolean()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.getboolean) парсеры конфигурации считают следующие значения `True`: `'1'`, `'yes'`, `'true'`, `'on'`, а следующие значения `False`: `'0'`, `'no'`, `'false'`, `'off'`. Вы можете переопределить это, указав свой словарь строк и соответствующих им логических значений. Например:497498```pycon499>>> custom = configparser.ConfigParser()500>>> custom['section1'] = {'funky': 'nope'}501>>> custom['section1'].getboolean('funky')502Traceback (most recent call last):503...504ValueError: Not a boolean: nope505>>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False}506>>> custom['section1'].getboolean('funky')507False508```509510Другие типичные логические пары: `accept`/`reject` или `enabled`/`disabled`.511512#### `ConfigParser.optionxform(option)`513514Этот метод преобразует имена параметров при каждой операции чтения, получения или установки. По умолчанию он приводит имя к нижнему регистру. Это также означает, что при записи конфигурационного файла все ключи будут в нижнем регистре. Переопределите этот метод, если такое поведение не подходит. Например:515516```pycon517>>> config = """518... [Section1]519... Key = Value520...521... [Section2]522... AnotherKey = Value523... """524>>> typical = configparser.ConfigParser()525>>> typical.read_string(config)526>>> list(typical['Section1'].keys())527['key']528>>> list(typical['Section2'].keys())529['anotherkey']530>>> custom = configparser.RawConfigParser()531>>> custom.optionxform = lambda option: option532>>> custom.read_string(config)533>>> list(custom['Section1'].keys())534['Key']535>>> list(custom['Section2'].keys())536['AnotherKey']537```538539> **Примечание**540>541> Функция optionxform преобразует имена параметров в каноническую форму. Это должна быть идемпотентная функция: если имя уже имеет каноническую форму, оно должно возвращаться без изменений.542543#### `ConfigParser.SECTCRE`544545Скомпилированное регулярное выражение для разбора заголовков разделов. По умолчанию сопоставляет `[section]` с именем `"section"`. Пробельные символы считаются частью имени раздела, поэтому `[ larch ]` будет прочитан как раздел с именем `" larch "`. Переопределите этот атрибут, если это не подходит. Например:546547```pycon548>>> import re549>>> config = """550... [Section 1]551... option = value552...553... [ Section 2 ]554... another = val555... """556>>> typical = configparser.ConfigParser()557>>> typical.read_string(config)558>>> typical.sections()559['Section 1', ' Section 2 ']560>>> custom = configparser.ConfigParser()561>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")562>>> custom.read_string(config)563>>> custom.sections()564['Section 1', 'Section 2']565```566567> **Примечание**568>569> Хотя объекты ConfigParser также используют атрибут `OPTCRE` для распознавания строк с опциями, переопределять его не рекомендуется, так как это помешает работе параметров конструктора *allow\_no\_value* и *delimiters*.570571## Примеры устаревшего API572573В основном из соображений обратной совместимости [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser) также предоставляет устаревший API с явными методами `get`/`set`. Хотя у методов, перечисленных ниже, есть свои обоснованные сценарии использования, для новых проектов предпочтительнее доступ через протокол отображения. Устаревший API иногда более продвинутый, низкоуровневый и откровенно неинтуитивный.574575Пример записи в файл конфигурации:576577```python578import configparser579580config = configparser.RawConfigParser()581582# Обратите внимание: используя функции set класса RawConfigParser, можно присваивать583# ключам внутренние значения, не являющиеся строками, но при попытке584# записи в файл или при получении значения в не-сыром режиме возникнет ошибка. Присваивание585# значений через протокол отображения или ConfigParser.set() не допускает586# выполнения таких присваиваний.587config.add_section('Section1')588config.set('Section1', 'an_int', '15')589config.set('Section1', 'a_bool', 'true')590config.set('Section1', 'a_float', '3.1415')591config.set('Section1', 'baz', 'fun')592config.set('Section1', 'bar', 'Python')593config.set('Section1', 'foo', '%(bar)s is %(baz)s!')594595# Записываем наш конфигурационный файл в 'example.cfg'596with open('example.cfg', 'w') as configfile:597 config.write(configfile)598```599600Пример повторного чтения файла конфигурации:601602```python603import configparser604605config = configparser.RawConfigParser()606config.read('example.cfg')607608# getfloat() вызывает исключение, если значение не является float.609# getint() и getboolean() делают то же самое для своих типов.610a_float = config.getfloat('Section1', 'a_float')611an_int = config.getint('Section1', 'an_int')612print(a_float + an_int)613614# Обратите внимание, что следующий вывод не интерполирует '%(bar)s' или '%(baz)s'.615# Это потому, что мы используем RawConfigParser().616if config.getboolean('Section1', 'a_bool'):617 print(config.get('Section1', 'foo'))618```619620Чтобы получить интерполяцию, используйте [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser):621622```python623import configparser624625cfg = configparser.ConfigParser()626cfg.read('example.cfg')627628# Установите необязательный аргумент *raw* метода get() в True, если требуется отключить629# интерполяцию в одной операции get.630print(cfg.get('Section1', 'foo', raw=False)) # -> "Python – это весело!"631print(cfg.get('Section1', 'foo', raw=True)) # -> "%(bar)s – это %(baz)s!"632633# Необязательный аргумент *vars* – это словарь с элементами, которые будут иметь634# приоритет при интерполяции.635print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation',636 'baz': 'evil'}))637638# Необязательный аргумент *fallback* можно использовать для предоставления запасного значения639print(cfg.get('Section1', 'foo'))640 # -> "Python – это весело!"641642print(cfg.get('Section1', 'foo', fallback='Monty is not.'))643 # -> "Python – это весело!"644645print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))646 # -> "Монстров не существует."647648# Голый вызов print(cfg.get('Section1', 'monster')) вызовет NoOptionError, но мы также можем использовать:649# но мы также можем использовать:650651print(cfg.get('Section1', 'monster', fallback=None))652 # -> None653```654655Значения по умолчанию доступны в обоих типах ConfigParsers. Они используются при интерполяции, если используемая опция не определена в другом месте.656657```python658import configparser659660# Новый экземпляр с 'bar' и 'baz', по умолчанию равными 'Life' и 'hard' соответственно.661config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'})662config.read('example.cfg')663664print(config.get('Section1', 'foo')) # -> "Python – это весело!"665config.remove_option('Section1', 'bar')666config.remove_option('Section1', 'baz')667print(config.get('Section1', 'foo')) # -> "Жизнь тяжела!"668```669670## Объекты ConfigParser671672#### `class configparser.ConfigParser(defaults=None, dict_type=dict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters={})`673674Основной парсер конфигурации. Когда задан *defaults*, он инициализируется как словарь внутренних значений по умолчанию. Когда задан *dict\_type*, он будет использоваться для создания словарей для списка разделов, опций внутри раздела и значений по умолчанию.675676Когда задан *delimiters*, он используется как набор подстрок, которые отделяют ключи от значений. Когда задан *comment\_prefixes*, он будет использоваться как набор подстрок, которые обозначают начало комментария в иначе пустых строках. Комментарии могут быть с отступом. Когда задан *inline\_comment\_prefixes*, он будет использоваться как набор подстрок, которые обозначают начало комментария в непустых строках.677678Когда *strict* равен `True` (по умолчанию), парсер не допускает повторяющихся разделов или опций при чтении из одного источника (файла, строки или словаря), вызывая [`DuplicateSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.DuplicateSectionError) или [`DuplicateOptionError`](https://python-all.ru/3.11/library/configparser.html#configparser.DuplicateOptionError). Когда *empty\_lines\_in\_values* равен `False` (по умолчанию: `True`), каждая пустая строка обозначает конец опции. В противном случае пустые строки внутри многострочной опции сохраняются как часть значения. Когда *allow\_no\_value* равен `True` (по умолчанию: `False`), опции без значений принимаются; значение для них равно `None`, и они сериализуются без завершающего разделителя.679680Когда задан *default\_section*, он указывает имя для специального раздела, содержащего значения по умолчанию для других разделов и для целей интерполяции (обычно называется `"DEFAULT"`). Это значение можно получить и изменить во время выполнения с помощью атрибута экземпляра `default_section`. Это не приведет к повторному разбору уже прочитанного файла конфигурации, но будет использоваться при записи разобранных настроек в новый файл конфигурации.681682Поведение интерполяции можно настроить, передав собственный обработчик через аргумент *interpolation*. `None` можно использовать для полного отключения интерполяции, `ExtendedInterpolation()` предоставляет более продвинутый вариант, вдохновлённый `zc.buildout`. Подробнее об этом в [соответствующем разделе документации](https://python-all.ru/3.11/library/configparser.html#interpolation-of-values).683684Все имена опций, используемые в интерполяции, передаются через метод [`optionxform()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.optionxform), как и любые другие ссылки на имена опций. Например, при использовании реализации по умолчанию [`optionxform()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.optionxform) (которая преобразует имена опций в нижний регистр) значения `foo %(bar)s` и `foo %(BAR)s` эквивалентны.685686Когда задан *converters*, это должен быть словарь, где каждый ключ представляет имя конвертера типов, а каждое значение – вызываемый объект, реализующий преобразование из строки в нужный тип данных. Каждый конвертер получает свой собственный соответствующий метод `get*()` на объекте парсера и прокси-объектах разделов.687688Изменено в версии 3.1: Значение по умолчанию *dict\_type* – [`collections.OrderedDict`](https://python-all.ru/3.11/library/collections.html#collections.OrderedDict).689690Изменено в версии 3.2: Были добавлены *allow\_no\_value*, *delimiters*, *comment\_prefixes*, *strict*, *empty\_lines\_in\_values*, *default\_section* и *interpolation*.691692Изменено в версии 3.5: Был добавлен аргумент *converters*.693694Изменено в версии 3.7: Аргумент *defaults* теперь читается с помощью [`read_dict()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_dict), что обеспечивает единообразное поведение парсера: нестроковые ключи и значения неявно преобразуются в строки.695696Изменено в версии 3.8: По умолчанию используется *dict\_type* [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict), поскольку теперь он сохраняет порядок вставки.697698#### `defaults()`699700Возвращает словарь, содержащий значения по умолчанию для экземпляра.701702#### `sections()`703704Возвращает список доступных разделов; *раздел по умолчанию* не включён в список.705706#### `add_section(section)`707708Добавляет раздел с именем *section* в экземпляр. Если раздел с таким именем уже существует, возбуждается [`DuplicateSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.DuplicateSectionError). Если передано имя *раздела по умолчанию*, возбуждается [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError). Имя раздела должно быть строкой; в противном случае возбуждается [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).709710Изменено в версии 3.2: Имена разделов, не являющиеся строками, вызывают [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).711712#### `has_section(section)`713714Указывает, присутствует ли в конфигурации указанный *раздел*. *Раздел по умолчанию* не учитывается.715716#### `options(section)`717718Возвращает список доступных параметров в указанном *разделе*.719720#### `has_option(section, option)`721722Если указанный *раздел* существует и содержит указанный *параметр*, вернуть [`True`](https://python-all.ru/3.11/library/constants.html#True); в противном случае вернуть [`False`](https://python-all.ru/3.11/library/constants.html#False). Если указанный *раздел* равен [`None`](https://python-all.ru/3.11/library/constants.html#None) или пустой строке, подразумевается DEFAULT.723724#### `read(filenames, encoding=None)`725726Пытается прочитать и разобрать итерируемый объект с именами файлов, возвращая список имён файлов, которые были успешно разобраны.727728If *filenames* is a string, a [`bytes`](https://python-all.ru/3.11/library/stdtypes.html#bytes) object or a [path-like object](https://python-all.ru/3.11/glossary.html#term-path-like-object), it is treated as a single filename. If a file named in *filenames* cannot be opened, that file will be ignored. This is designed so that you can specify an iterable of potential configuration file locations (for example, the current directory, the user’s home directory, and some system-wide directory), and all existing configuration files in the iterable will be read.729730Если ни один из указанных файлов не существует, экземпляр [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser) будет содержать пустой набор данных. Приложение, которому требуется загрузить начальные значения из файла, должно загрузить необходимый файл или файлы с помощью [`read_file()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_file) перед вызовом [`read()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read) для дополнительных файлов:731732```python733import configparser, os734735config = configparser.ConfigParser()736config.read_file(open('defaults.cfg'))737config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],738 encoding='cp1250')739```740741Изменено в версии 3.2: Добавлен параметр *encoding*. Ранее все файлы читались с использованием кодировки по умолчанию для [`open()`](https://python-all.ru/3.11/library/functions.html#open).742743Changed in version 3.6.1: The *filenames* parameter accepts a [path-like object](https://python-all.ru/3.11/glossary.html#term-path-like-object).744745Изменено в версии 3.7: Параметр *filenames* принимает объект [`bytes`](https://python-all.ru/3.11/library/stdtypes.html#bytes).746747#### `read_file(f, source=None)`748749Читает и разбирает данные конфигурации из *f*, который должен быть итерируемым объектом, возвращающим строки Unicode (например, файлы, открытые в текстовом режиме).750751Необязательный аргумент *source* задаёт имя читаемого файла. Если он не указан и *f* имеет атрибут `name`, то он используется для *source*; по умолчанию `'<???>'`.752753Новое в версии 3.2: Заменяет `readfp()`.754755#### `read_string(string, source='<string>')`756757Разбирает данные конфигурации из строки.758759Необязательный аргумент *source* задаёт контекстно-зависимое имя переданной строки. Если не указан, используется `'<string>'`. Обычно это путь файловой системы или URL.760761Новое в версии 3.2.762763#### `read_dict(dictionary, source='<dict>')`764765Загружает конфигурацию из любого объекта, предоставляющего метод `items()`, подобный словарю. Ключи – это имена разделов, значения – словари с ключами и значениями, которые должны присутствовать в разделе. Если используемый тип словаря сохраняет порядок, разделы и их ключи будут добавлены по порядку. Значения автоматически преобразуются в строки.766767Необязательный аргумент *source* задаёт контекстно-зависимое имя переданного словаря. Если не указан, используется `<dict>`.768769Этот метод можно использовать для копирования состояния между парсерами.770771Новое в версии 3.2.772773#### `get(section, option, *, raw=False, vars=None[, fallback])`774775Получает значение *параметра* для указанного *раздела*. Если указан *vars*, он должен быть словарём. *Параметр* ищется в *vars* (если указан), *разделе* и в *DEFAULTSECT* в указанном порядке. Если ключ не найден и указан *fallback*, он используется как запасное значение. `None` может быть указан в качестве *запасного значения*.776777Все операции `'%'` интерполяции раскрываются в возвращаемых значениях, если только аргумент *raw* не равен true. Значения для ключей интерполяции ищутся так же, как и параметр.778779Изменено в версии 3.2: Аргументы *raw*, *vars* и *fallback* стали только ключевыми, чтобы защитить пользователей от попытки использовать третий аргумент в качестве запасного значения *fallback* (особенно при использовании протокола отображения).780781#### `getint(section, option, *, raw=False, vars=None[, fallback])`782783Удобный метод, который преобразует *параметр* в указанном *разделе* в целое число. См. [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get) для объяснения *raw*, *vars* и *fallback*.784785#### `getfloat(section, option, *, raw=False, vars=None[, fallback])`786787Удобный метод, который приводит *option* в указанном разделе *section* к числу с плавающей запятой. См. [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get) для пояснения параметров *raw*, *vars* и *fallback*.788789#### `getboolean(section, option, *, raw=False, vars=None[, fallback])`790791Удобный метод, который приводит *option* в указанном *section* к логическому значению. Обратите внимание, что допустимыми значениями для параметра являются `'1'`, `'yes'`, `'true'` и `'on'`, при которых этот метод возвращает `True`, а `'0'`, `'no'`, `'false'` и `'off'` – `False`. Строковые значения проверяются без учёта регистра. Любое другое значение приведёт к возбуждению исключения [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError). См. [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get) для пояснения *raw*, *vars* и *fallback*.792793#### `items(raw=False, vars=None)`794795#### `items(section, raw=False, vars=None)`796797Если *section* не указан, возвращает список пар *section\_name*, *section\_proxy*, включая DEFAULTSECT.798799В противном случае возвращает список пар *name*, *value* для параметров в указанном *section*. Необязательные аргументы имеют тот же смысл, что и для метода [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get).800801Изменено в версии 3.8: Элементы, присутствующие в *vars*, больше не появляются в результате. Предыдущее поведение смешивало фактические параметры анализатора с переменными, предоставленными для интерполяции.802803#### `set(section, option, value)`804805Если указанный раздел существует, устанавливает заданный параметр в указанное значение; в противном случае возбуждает исключение [`NoSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.NoSectionError). *option* и *value* должны быть строками; в противном случае возбуждается исключение [`TypeError`](https://python-all.ru/3.11/library/exceptions.html#TypeError).806807#### `write(fileobject, space_around_delimiters=True)`808809Записывает представление конфигурации в указанный [файловый объект](https://python-all.ru/3.11/glossary.html#term-file-object), который должен быть открыт в текстовом режиме (принимает строки). Это представление может быть разобрано будущим вызовом [`read()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read). Если *space\_around\_delimiters* равно true, разделители между ключами и значениями окружаются пробелами.810811> **Примечание**812>813> Комментарии в исходном файле конфигурации не сохраняются при обратной записи конфигурации. Что считается комментарием, зависит от заданных значений *comment\_prefix* и *inline\_comment\_prefix*.814815#### `remove_option(section, option)`816817Удаляет указанный *option* из указанного *section*. Если раздел не существует, возбуждает исключение [`NoSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.NoSectionError). Если параметр существовал и был удалён, возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True); в противном случае возвращает [`False`](https://python-all.ru/3.11/library/constants.html#False).818819#### `remove_section(section)`820821Удаляет указанный *section* из конфигурации. Если раздел действительно существовал, возвращает `True`. В противном случае возвращает `False`.822823#### `optionxform(option)`824825Преобразует имя параметра *option*, как оно найдено во входном файле или передано клиентским кодом, в форму, которая должна использоваться во внутренних структурах. Реализация по умолчанию возвращает версию *option* в нижнем регистре; подклассы могут переопределить это, или клиентский код может установить атрибут с таким именем на экземплярах, чтобы повлиять на это поведение.826827Для использования этого метода не нужно создавать подкласс анализатора; можно также установить его на экземпляре, присвоив функцию, которая принимает строковый аргумент и возвращает строку. Установка его в `str`, например, сделает имена параметров чувствительными к регистру:828829```python830cfgparser = ConfigParser()831cfgparser.optionxform = str832```833834Обратите внимание, что при чтении файлов конфигурации пробельные символы вокруг имён параметров удаляются перед вызовом [`optionxform()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.optionxform).835836#### `readfp(fp, filename=None)`837838Устарело с версии 3.2: Используйте [`read_file()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.read_file) вместо.839840Изменено в версии 3.2: [`readfp()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.readfp) теперь выполняет итерацию по *fp* вместо вызова `fp.readline()`.841842Для существующего кода, вызывающего [`readfp()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.readfp) с аргументами, которые не поддерживают итерацию, следующий генератор можно использовать как обёртку вокруг файлоподобного объекта:843844```python845def readline_generator(fp):846 line = fp.readline()847 while line:848 yield line849 line = fp.readline()850```851852Вместо `parser.readfp(fp)` используйте `parser.read_file(readline_generator(fp))`.853854#### `configparser.MAX_INTERPOLATION_DEPTH`855856Максимальная глубина рекурсивной интерполяции для [`get()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.get), когда параметр *raw* равен false. Это актуально только при использовании *интерполяция* по умолчанию.857858## Объекты RawConfigParser859860#### `class configparser.RawConfigParser(defaults=None, dict_type=dict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT[, interpolation])`861862Устаревший вариант [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser). В нём интерполяция отключена по умолчанию, и он допускает нестроковые имена разделов, имена параметров и значения через свои небезопасные методы `add_section` и `set`, а также устаревшую обработку ключевого аргумента `defaults=`.863864Изменено в версии 3.8: По умолчанию используется *dict\_type* [`dict`](https://python-all.ru/3.11/library/stdtypes.html#dict), поскольку теперь он сохраняет порядок вставки.865866> **Примечание**867>868> Рассмотрите возможность использования [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser) – он проверяет типы сохраняемых внутри значений. Если интерполяция не нужна, можно использовать `ConfigParser(interpolation=None)`.869870#### `add_section(section)`871872Добавляет раздел с именем *section* в экземпляр. Если раздел с указанным именем уже существует, возникает [`DuplicateSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.DuplicateSectionError). Если передано имя *раздела по умолчанию*, возникает [`ValueError`](https://python-all.ru/3.11/library/exceptions.html#ValueError).873874Тип *section* не проверяется, что позволяет создавать разделы с нестроковыми именами. Это поведение не поддерживается и может вызывать внутренние ошибки.875876#### `set(section, option, value)`877878Если указанный раздел существует, устанавливает указанный параметр в заданное значение; иначе возбуждает [`NoSectionError`](https://python-all.ru/3.11/library/configparser.html#configparser.NoSectionError). Хотя для *внутреннего* хранения нестроковых значений можно использовать [`RawConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.RawConfigParser) (или [`ConfigParser`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser) с параметром *raw*, установленным в true), полная функциональность (включая интерполяцию и вывод в файлы) достигается только при использовании строковых значений.879880Этот метод позволяет пользователям присваивать нестроковые значения ключам внутри. Такое поведение не поддерживается и приведет к ошибкам при попытке записи в файл или получении значения в несыром режиме. **Используйте API протокола отображения**, который не допускает таких присваиваний.881882## Исключения883884#### `exception configparser.Error`885886Базовый класс для всех прочих исключений [`configparser`](https://python-all.ru/3.11/library/configparser.html#module-configparser).887888#### `exception configparser.NoSectionError`889890Исключение, возбуждаемое, когда указанный раздел не найден.891892#### `exception configparser.DuplicateSectionError`893894Исключение, возбуждаемое, если [`add_section()`](https://python-all.ru/3.11/library/configparser.html#configparser.ConfigParser.add_section) вызывается с именем уже существующего раздела, или в строгих парсерах, когда раздел встречается более одного раза в одном входном файле, строке или словаре.895896Изменено в версии 3.2: Добавлены необязательные атрибуты и параметры *source* и *lineno* в `__init__()`.897898#### `exception configparser.DuplicateOptionError`899900Исключение, возбуждаемое строгими парсерами, если один параметр встречается дважды при чтении из одного файла, строки или словаря. Это позволяет отлавливать опечатки и ошибки, связанные с регистром символов: например, в словаре может быть два ключа, представляющих один и тот же конфигурационный ключ, регистр которого не учитывается.901902#### `exception configparser.NoOptionError`903904Исключение, возбуждаемое, когда указанный параметр не найден в указанном разделе.905906#### `exception configparser.InterpolationError`907908Базовый класс для исключений, возбуждаемых при возникновении проблем во время выполнения строковой интерполяции.909910#### `exception configparser.InterpolationDepthError`911912Исключение, возбуждаемое, когда строковая интерполяция не может быть завершена, поскольку количество итераций превышает [`MAX_INTERPOLATION_DEPTH`](https://python-all.ru/3.11/library/configparser.html#configparser.MAX_INTERPOLATION_DEPTH). Подкласс [`InterpolationError`](https://python-all.ru/3.11/library/configparser.html#configparser.InterpolationError).913914#### `exception configparser.InterpolationMissingOptionError`915916Исключение, возбуждаемое, когда параметр, на который есть ссылка из значения, не существует. Подкласс [`InterpolationError`](https://python-all.ru/3.11/library/configparser.html#configparser.InterpolationError).917918#### `exception configparser.InterpolationSyntaxError`919920Исключение, возбуждаемое, когда исходный текст, в который вносятся подстановки, не соответствует требуемому синтаксису. Подкласс [`InterpolationError`](https://python-all.ru/3.11/library/configparser.html#configparser.InterpolationError).921922#### `exception configparser.MissingSectionHeaderError`923924Исключение, возбуждаемое при попытке разобрать файл, не содержащий заголовков разделов.925926#### `exception configparser.ParsingError`927928Исключение, возникающее при ошибках во время разбора файла.929930Изменено в версии 3.2: Атрибут `filename` и аргумент `__init__()` были переименованы в `source` для согласованности.931932Сноски933934\[1\]935936([1](https://python-all.ru/3.11/library/configparser.html#id1),[2](https://python-all.ru/3.11/library/configparser.html#id2),[3](https://python-all.ru/3.11/library/configparser.html#id3),[4](https://python-all.ru/3.11/library/configparser.html#id4),[5](https://python-all.ru/3.11/library/configparser.html#id5),[6](https://python-all.ru/3.11/library/configparser.html#id6),[7](https://python-all.ru/3.11/library/configparser.html#id7),[8](https://python-all.ru/3.11/library/configparser.html#id8),[9](https://python-all.ru/3.11/library/configparser.html#id9),[10](https://python-all.ru/3.11/library/configparser.html#id10),[11](https://python-all.ru/3.11/library/configparser.html#id11))937938Парсеры конфигураций допускают широкую настройку. Если вас интересует изменение поведения, описанного в сноске, обратитесь к разделу [Настройка поведения парсера](https://python-all.ru/3.11/library/configparser.html#customizing-parser-behaviour).939