PythonのconfigparserモジュールでINI形式の設定ファイルを読み書きする方法

configparserモジュールとは

Pythonの標準ライブラリに含まれるconfigparserモジュールは、Microsoft Windowsで古くから使われてきたINI形式の設定ファイルを読み書きするための機能を提供します。設定ファイルには通常「.ini」という拡張子が付けられます。

INIファイルの基本構造

INIファイルは複数のセクションで構成され、各セクションは[セクション名]というヘッダー行で始まります。角括弧の中にセクション名を記述します。セクションの後には、=または:で区切られたキーと値のペアが続きます。また、#や;で始まる行はコメントとして扱われます。以下にINIファイルのサンプルを示します。

[Settings]
# Set detailed log for additional debugging info
DetailedLog=1
RunStatus=1
StatusPort=6090
StatusRefresh=10
Archive=1
# Sets the location of the MV_FTP log file
LogFile=/opt/ecs/mvuser/MV_IPTel/log/MV_IPTel.log
Version=0.9 Build 4
ServerName=Unknown

[FTP]
# set the FTP server active
RunFTP=1
# defines the FTP control port
FTPPort=21
# Sets the location of the FTP data directory
FTPDir=/opt/ecs/mvuser/MV_IPTel/data/FTPdata
# set the admin Name
UserName=admin
# set the Password
Password=admin

ConfigParserクラスの使い方

configparserモジュールにはConfigParserクラスが定義されており、このクラスが設定ファイルの解析と、解析結果データベースの管理を担当します。ConfigParserオブジェクトは次のように生成します。

parser = configparser.ConfigParser()

ConfigParserクラスの主なメソッド一覧

設定ファイルの読み込み例

次のスクリプトは「sampleconfig.ini」ファイルを読み込んで解析し、セクションごとのキーと値を表示します。

import configparser
parser = configparser.ConfigParser()
parser.read('sampleconfig.ini')
for sect in parser.sections():
   print('Section:', sect)
   for k,v in parser.items(sect):
      print(' {} = {}'.format(k,v))
   print()

実行結果

Section: Settings
detailedlog = 1
runstatus = 1
statusport = 6090
statusrefresh = 10
archive = 1
logfile = /opt/ecs/mvuser/MV_IPTel/log/MV_IPTel.log
version = 0.9 Build 4
servername = Unknown

Section: FTP
runftp = 1
ftpport = 21
ftpdir = /opt/ecs/mvuser/MV_IPTel/data/FTPdata
username = admin
password = admin

実行結果を見ると、キー名がすべて小文字に変換されていることが分かります。これはConfigParserのデフォルト動作で、オプション名は内部的に小文字で保存されるためです。

設定ファイルの作成・書き出し方法

write()メソッドを使うと、設定内容をファイルに書き出せます。次のスクリプトでは、パーサーオブジェクトに新しいセクションとオプションを追加し、「test.ini」を表すファイルオブジェクトに書き出しています。

import configparser
parser = configparser.ConfigParser()
parser.add_section('Manager')
parser.set('Manager', 'Name', 'Ashok Kulkarni')
parser.set('Manager', 'email', 'ashok@gmail.com')
parser.set('Manager', 'password', 'secret')
fp=open('test.ini','w')
parser.write(fp)
fp.close()

補足：getboolean()で使える値

getboolean()メソッドは、"yes"/"no"、"on"/"off"、"true"/"false"、"1"/"0"といった文字列をTrue/Falseに変換できます。大文字・小文字は区別されないため、設定ファイル側の表記ゆれを気にせずに真偽値として取得できるのが便利です。