如何使用Python3读写INI文件?


117

我需要读取,写入和创建一个INI使用Python3文件。

文件文件

default_path = "/path/name/"
default_file = "file.txt"

Python档案:

#    Read file and and create if it not exists
config = iniFile( 'FILE.INI' )

#    Get "default_path"
config.default_path

#    Print (string)/path/name
print config.default_path

#    Create or Update
config.append( 'default_path', 'var/shared/' )
config.append( 'default_message', 'Hey! help me!!' )

更新的 FILE.INI

default_path    = "var/shared/"
default_file    = "file.txt"
default_message = "Hey! help me!!"



正确的ini文件需要像这样的节标题[foobar]
马丁·托马

Answers:


147

可以从以下开始:

import configparser

config = configparser.ConfigParser()
config.read('FILE.INI')
print(config['DEFAULT']['path'])     # -> "/path/name/"
config['DEFAULT']['path'] = '/var/shared/'    # update
config['DEFAULT']['default_message'] = 'Hey! help me!!'   # create

with open('FILE.INI', 'w') as configfile:    # save
    config.write(configfile)

您可以在官方configparser文档中找到更多信息


4
configparser.MissingSectionHeaderError使用提供的示例文件时,没有适当的节头。
Jaakko

81

这是一个完整的读取,更新和写入示例。

输入文件test.ini

[section_a]
string_val = hello
bool_val = false
int_val = 11
pi_val = 3.14

工作代码。

try:
    from configparser import ConfigParser
except ImportError:
    from ConfigParser import ConfigParser  # ver. < 3.0

# instantiate
config = ConfigParser()

# parse existing file
config.read('test.ini')

# read values from a section
string_val = config.get('section_a', 'string_val')
bool_val = config.getboolean('section_a', 'bool_val')
int_val = config.getint('section_a', 'int_val')
float_val = config.getfloat('section_a', 'pi_val')

# update existing value
config.set('section_a', 'string_val', 'world')

# add a new section and some values
config.add_section('section_b')
config.set('section_b', 'meal_val', 'spam')
config.set('section_b', 'not_found_val', '404')

# save to a file
with open('test_update.ini', 'w') as configfile:
    config.write(configfile)

输出文件test_update.ini

[section_a]
string_val = world
bool_val = false
int_val = 11
pi_val = 3.14

[section_b]
meal_val = spam
not_found_val = 404

原始输入文件保持不变。


在我的Python 3.7系统上,必须将“ c​​onfig.set('section_b','not_found_val',404)”行更改为“ config.set('section_b','not_found_val',str(404))”,因为“设置”的参数必须是字符串。很好的例子,谢谢!
艾德先生

看起来该read 方法现在返回已读文件/文件列表,但不返回内容列表
YTerle


5

该标准ConfigParser通常需要通过进行访问config['section_name']['key'],这很无聊。稍加修改即可实现属性访问:

class AttrDict(dict):
    def __init__(self, *args, **kwargs):
        super(AttrDict, self).__init__(*args, **kwargs)
        self.__dict__ = self

AttrDict是派生自该类的类,该类dict允许同时通过字典键和属性访问:a.x is a['x']

我们可以在以下类中使用此类ConfigParser

config = configparser.ConfigParser(dict_type=AttrDict)
config.read('application.ini')

现在我们得到application.ini

[general]
key = value

>>> config._sections.general.key
'value'

6
这是一个很好的技巧,但是使用此方法的用户应该注意,在进行config._sections.general.key = "3"此类访问时不会更改config选项的内部值,因此只能用于只读访问。如果在.read()命令之后扩展或更改了配置(添加选项,某些部分的值对,->进行插值,这可能非常重要),则不应使用此访问方法!同样,任何对它的访问config._sections["section"]["opt"]都是私有规避插值并返回原始值!
加百利

5

ConfigObj是ConfigParser的很好替代品,它提供了更多的灵活性:

  • 嵌套的节(子节),任意级别
  • 列出值
  • 多行值
  • 字符串插值(替代)
  • 与功能强大的验证系统集成,包括自动类型检查/转换重复部分并允许使用默认值
  • 写出配置文件时,ConfigObj保留所有注释以及成员和节的顺序
  • 使用配置文件的许多有用方法和选项(例如“ reload”方法)
  • 完全支持Unicode

它有一些缺点:

  • 您不能设置定界符,它必须是=…(拉取请求
  • 您不能有空值,但是可以,但是它们看起来很喜欢:fuabr =而不是fubar看起来怪异和错误的值。

1
Sardathrion是正确的,如果要将注释保留在文件中,并将节的顺序保留在原始文件中,则可以使用ConfigObj。ConfigParser只会清除您的注释,并会在某些时候对顺序进行打乱。
2016年

1

我的backup_settings.ini文件中的内容

[Settings]
year = 2020

用于阅读的python代码

import configparser
config = configparser.ConfigParser()
config.read('backup_settings.ini') #path of your .ini file
year = config.get("Settings","year") 
print(year)

用于编写或更新

from pathlib import Path
import configparser
myfile = Path('backup_settings.ini')  #Path of your .ini file
config.read(myfile)
config.set('Settings', 'year','2050') #Updating existing entry 
config.set('Settings', 'day','sunday') #Writing new entry
config.write(myfile.open("w"))

输出

[Settings]
year = 2050
day = sunday
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.