526互联

python 修改ini文件参数，保留ini文件注释的方法--未测试

发布时间 2023-12-29 13:50:52作者: 柳道

使用configparser模块的write()方法在写入INI文件时默认会删除注释。要保留注释，您可以使用自定义的格式化器来处理INI文件的内容，并在写入文件时手动添加注释。

下面是一个示例代码，演示如何自定义一个格式化器，并在写入INI文件时保留注释：

python复制代码
import configparser  
  
class CommentedConfigParser(configparser.ConfigParser):  
    def write(self, fp):  
        """Write an .ini-format representation of the configuration state."""  
        if self._defaults:  
            fp.write("[%s]\n" % DEFAULTSECT)  
            for (key, value) in self._defaults.items():  
                fp.write("%s = %s\n" % (key, str(value).replace('\n', '\n\t')))  
            fp.write("\n")  
        for section in self._sections:  
            fp.write("[%s]\n" % section)  
            for (key, value) in self._sections[section].items():  
                if key == "__comment__":  
                    fp.write("# %s\n" % value)  
                else:  
                    fp.write("%s = %s\n" % (key, str(value).replace('\n', '\n\t')))  
            fp.write("\n")  
  
# 读取INI文件  
config = CommentedConfigParser()  
config.read('example.ini')  
  
# 修改参数值  
config.set('SectionName', 'ParameterName', 'NewValue')  
  
# 写入INI文件，保留注释  
with open('example.ini', 'w') as configfile:  
    config.write(configfile)

 

 

在上面的代码中，我们创建了一个继承自configparser.ConfigParser的自定义类CommentedConfigParser。在这个类中，我们重写了write()方法，将默认值和节点的注释以特定的格式写入文件。在写入文件时，我们手动添加了注释，以便保留原始的注释内容。

使用自定义的格式化器后，您可以使用相同的代码来读取、修改和写入INI文件，并保留注释。请注意，此方法仅适用于标准格式的INI文件，并且假设注释是以"#"开头的行。如果您的INI文件使用不同的注释语法，您可能需要进行适当的调整