Python 使用ConfigParser操作ini配置文件

下面是关于Python使用ConfigParser操作ini配置文件的完整攻略。

什么是ini配置文件

在计算机中，ini文件是一种常见的文件格式，通常用于存储程序的配置信息。ini文件通常由多个节(section)构成，每个节分别包含一系列的键值对(key-value pairs)。

下面是一个ini配置文件的示例：

[database]
host = localhost
port = 3306
username = root
password = 123456

[redis]
host = localhost
port = 6379

ConfigParser模块简介

在Python中，我们可以使用ConfigParser模块来操作ini配置文件。ConfigParser是一个标准库模块，提供了比较简单的方式来读写ini配置文件。它可以帮助我们完成以下任务：

1. 解析ini文件
2. 获取特定节中的所有键值对
3. 修改或添加节、键、值
4. 保存修改后的ini文件

下面我们来看看ConfigParser模块的一些常用方法。

ConfigParser模块常用方法

1. 创建ConfigParser对象

我们可以使用ConfigParser类来创建一个ConfigParser对象。创建的基本语法如下：

import configparser

config = configparser.ConfigParser()

2. 读取ini配置文件

我们可以使用ConfigParser对象的read()方法来读取ini配置文件。基本语法如下：

import configparser

config = configparser.ConfigParser()
config.read('config.ini')

3. 获取指定节的键值对

我们可以使用ConfigParser对象的items()方法来获取特定节中的所有键值对。基本语法如下：

import configparser

config = configparser.ConfigParser()
config.read('config.ini')

db_config = config.items('database')
for key, value in db_config:
    print(key, value)

输出结果为：

host localhost
port 3306
username root
password 123456

4. 获取指定节中的某个键的值

我们可以使用ConfigParser对象的get()方法来获取特定节中某个键的值。基本语法如下：

import configparser

config = configparser.ConfigParser()
config.read('config.ini')

db_host = config.get('database', 'host')
print(db_host)

输出结果为：

localhost

5. 修改或添加节、键、值

我们可以使用ConfigParser对象的set()方法来修改或添加ini配置文件中的节、键、值。如果修改前的节或键不存在，则set()方法会自动创建它们，如果修改前的节或键已经存在，则会用新的值覆盖原来的值。基本语法如下：

import configparser

config = configparser.ConfigParser()
config.read('config.ini')

# 修改或添加节
config.add_section('new_section')
config.set('new_section', 'key1', 'value1')

# 修改或添加键值对
config.set('database', 'charset', 'utf8mb4')

# 保存修改后的ini文件
with open('config.ini', 'w') as f:
    config.write(f)

6. 删除节、键

我们可以使用ConfigParser对象的remove_section()方法来删除指定的节，使用remove_option()方法来删除指定的键值对。基本语法如下：

import configparser

config = configparser.ConfigParser()
config.read('config.ini')

# 删除指定的节
config.remove_section('new_section')

# 删除指定的键值对
config.remove_option('database', 'port')

# 保存修改后的ini文件
with open('config.ini', 'w') as f:
    config.write(f)

至此，我们已经了解了ConfigParser模块的一些常用方法。下面我们来看看一些实际的应用示例。

使用示例

示例一：在Flask应用中使用ini配置文件

在Flask应用中，我们可以使用ConfigParser模块来加载应用程序的配置信息，并将其传递给应用程序。下面是一个简单的示例：

import configparser
from flask import Flask

app = Flask(__name__)

# 加载配置信息
config = configparser.ConfigParser()
config.read('config.ini')

# 将配置信息传递给应用程序
app.config.update(config.items('app'))

# 定义一个路由
@app.route('/')
def hello():
    return app.config.get('greeting', 'Hello')

if __name__ == '__main__':
    app.run()

在上面的示例中，我们首先创建了一个Flask应用，并加载了配置文件；然后将配置信息传递给应用程序的config属性；最后定义了一个路由，返回应用程序中配置的greeting信息。如果配置文件的内容如下：

[app]
debug = true
greeting = Hi

则当我们在浏览器中访问http://localhost:5000时，网页上会显示Hi。

示例二：在命令行程序中使用ini配置文件

在命令行程序中，我们可以使用ConfigParser模块来加载命令行参数中指定的配置文件，并使用配置文件中的配置信息（例如数据库连接信息）来进行一系列操作。下面是一个简单的示例：

import argparse
import configparser
import pymysql

# 解析命令行参数
parser = argparse.ArgumentParser()
parser.add_argument('-c', '--config', help='config file path', required=True)
args = parser.parse_args()

# 加载配置文件
config = configparser.ConfigParser()
config.read(args.config)

# 连接数据库
conn = pymysql.connect(host=config.get('database', 'host'),
                       port=config.getint('database', 'port'),
                       user=config.get('database', 'username'),
                       password=config.get('database', 'password'),
                       db=config.get('database', 'db'),
                       charset=config.get('database', 'charset'))

# 查询数据
cursor = conn.cursor()
cursor.execute('SELECT * FROM test')
results = cursor.fetchall()
for row in results:
    print(row)

# 关闭数据库连接
conn.close()

在上面的示例中，我们使用argparse模块来获取命令行参数中的配置文件路径，然后使用ConfigParser模块加载配置文件，并获取其中的数据库连接信息；然后使用pymysql模块连接数据库并查询数据；最后将查询结果打印出来。如果配置文件的内容如下：

[database]
host = localhost
port = 3306
username = root
password = 123456
db = test
charset = utf8mb4

则在命令行中执行以下命令：

python sql.py -c config.ini

就可以查询数据库中的数据了。

以上两个示例演示了ConfigParser模块在不同场景下的应用方式，可以帮助我们快速读取并使用ini配置文件中的配置信息。