Python configparserで設定ファイルにコメント行を書き込みたい。

Question

Pythonのconfigparserを用いて設定ファイルを読み書きしています。
設定値の変更等は簡単に実装できるのですが、コメント行の扱いに困っています。

具体的には、読み込み時に記載していたコメント行が、書き出しの際に設定値のみ書き込みが行われ、
コメント行は書き込まれません。

特にconfigparserにこだわっているわけではないのですが、解決方法があればご教授ください。

###該当のソースコード

import configparser

config_ini = configparser.ConfigParser()
config_ini.read('config', encoding='utf-8')

config_ini.set('DEFAULT', 'test', 'TEST1')

with open('config1', 'w', encoding='utf-8') as file:
    config_ini.write(file)

# 残したいコメント
[DEFAULT]
test = TEST

###実行結果

[DEFAULT]
test = TEST1

###実現したいこと
設定ファイルに入力されている値を実行内容によって、上書きしたい時がある。
その際、configparserのwrite()を用いて設定ファイルを上書きすると、
設定値は実行中に変更したかどうかにかかわらず、すべて綺麗に書き出される。
一方、読み込み時に記載していたコメント行は書き出されず、消えてしまう。

下記のように書き出したファイルに、読み込んだファイルのコメント行を継承させたい。

# 残したいコメント
[DEFAULT]
test = TEST1

###補足情報
OS:Windows10
OSバージョン:1909
OSビルド:18363.900
Python: 3.7.7

Answer 1

ConfigParserの引数comment_prefixesに'/'を指定すると、コメント行が値のない行として扱われるらしく、書き込み時に消えません。
また、allow_no_valueをTrueに指定することで、コメント行のパースエラーを回避します。

参照：https://stackoverflow.com/questions/21476554/update-ini-file-without-removing-comments

import configparser

config_ini = configparser.ConfigParser(comment_prefixes='/', allow_no_value=True) # <--修正

config_ini.read('config', encoding='utf-8')

config_ini.set('DEFAULT', 'test', 'TEST1')
with open('config1', 'w', encoding='utf-8') as file:
    config_ini.write(file)

ただし、質問文のようにconfigファイルの一番最初の行が「#」で始まっている場合、上記を実行するとエラーが発生しました。
手元の環境だと、[DEFAULT]を一番最初に置き、次の行以下にコメント置くと正常に実行できました。

Comments

[Nishizawa1]

ご回答ありがとうございます。
なるほど！な解決策ですね。
確かに[DEFAULT]を最初に持っていくと、コメントが消えず残ってくれました。
この方法であれば標準ライブラリで対応できるので楽ですね。

今回はファイルの先頭にコメントを書きたかったので、先の回答者のConfigObjを使おうと思います。
ありがとうございました。

Answer 2

Update INI file without removing commentsの回答にてConfigObjが紹介されています。
動作は確認していませんので使い勝手などは分かりませんがconfigobj 5.0.6によると

All comments in the file are preserved

だそうです。

Comments

[Nishizawa1]

ご回答ありがとうございます。
ConfigObjを使用すると、以下のコードで実現したいことを達成できました。
```Python
import configobj

config = configobj.ConfigObj('config', encoding='utf-8')
config['DEFAULT']['test'] = 'TEST1'
config.write()
```

ありがとうございました。