博客

详解Python利用configparser对配置文件进行读写操作

  • Post category:Python

下面是详解Python利用configparser对配置文件进行读写操作的完整攻略。

配置文件介绍

配置文件是一种常见的文本文件，用于存储软件或系统的参数和配置信息，其通常包含了键值对、段落和注释等信息。在Python中，可以使用configparser模块来读取和写入配置文件，该模块支持INI格式的配置文件，可以轻松地读取和修改配置信息。下面是一个示例配置文件：

[DATABASE]
host=127.0.0.1
port=3306
user=root
password=123456
database=test

[SMTP]
host=smtp.example.com
port=25
user=user@example.com
password=123456

这个配置文件中包含了两个段落，分别是DATABASE和SMTP，每个段落中包含了多个键值对，用于配置数据库连接信息和SMTP邮件服务器连接信息。

读取配置文件

要读取配置文件，可以先创建一个ConfigParser实例，并使用read()方法读取配置文件。例如，以下代码可以读取上面的示例文件：

import configparser

# 创建ConfigParser实例
config = configparser.ConfigParser()

# 读取配置文件
config.read('config.ini')

# 获取配置信息
db_host = config.get('DATABASE', 'host')
db_port = config.getint('DATABASE', 'port')
db_user = config.get('DATABASE', 'user')
db_password = config.get('DATABASE', 'password')
db_database = config.get('DATABASE', 'database')
smtp_host = config.get('SMTP', 'host')
smtp_port = config.getint('SMTP', 'port')
smtp_user = config.get('SMTP', 'user')
smtp_password = config.get('SMTP', 'password')

# 输出配置信息
print('Database Host:', db_host)
print('Database Port:', db_port)
print('Database User:', db_user)
print('Database Password:', db_password)
print('Database Name:', db_database)
print('SMTP Host:', smtp_host)
print('SMTP Port:', smtp_port)
print('SMTP User:', smtp_user)
print('SMTP Password:', smtp_password)

在上面的例子中，我们先使用ConfigParser()创建一个ConfigParser实例，然后使用read()方法读取配置文件。使用get()方法可以获取指定键的值，可以使用getint()、getfloat()等方法读取整数和浮点数类型的值。读取完配置信息后，我们可以使用print()语句将其输出。

写入配置文件

要写入配置文件，可以使用set()方法设置指定键的值，并使用write()方法将其写入配置文件。例如，以下代码可以将DATABASE段落中的host键的值修改为192.168.0.1：

import configparser

# 创建ConfigParser实例
config = configparser.ConfigParser()

# 读取配置文件
config.read('config.ini')

# 修改配置信息
config.set('DATABASE', 'host', '192.168.0.1')

# 将修改后的配置信息写入文件
with open('config.ini', 'w') as f:
    config.write(f)

在上面的例子中，我们使用set()方法将DATABASE段落中的host键的值修改为192.168.0.1，然后使用open()打开配置文件，使用write()方法将其写入文件。

示例：使用配置文件配置日志模块

下面是一个示例，展示如何使用配置文件来配置Python的日志模块。在下面的例子中，我们使用配置文件来指定日志的级别、文件名、格式等信息，并将其应用于日志模块。

import configparser
import logging.config

# 读取配置文件
config = configparser.ConfigParser()
config.read('logging.ini')

# 设置日志配置信息
logging.config.fileConfig('logging.ini')

# 定义一个日志器
logger = logging.getLogger('mylogger')

# 输出不同级别的日志信息
logger.debug('this is a debug message')
logger.info('this is an info message')
logger.warning('this is a warning message')
logger.error('this is an error message')
logger.critical('this is a critical message')

在这个示例中，我们同样是先使用ConfigParser()创建一个ConfigParser实例，然后使用read()方法读取配置文件。下面是示例配置文件logging.ini的内容：

[loggers]
keys=root,mylogger

[handlers]
keys=consoleHandler,fileHandler

[formatters]
keys=detailFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler

[logger_mylogger]
level=DEBUG
handlers=fileHandler
qualname=mylogger
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=INFO
formatter=detailFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=detailFormatter
args=('test.log', 'a')

[formatter_detailFormatter]
format=[%(asctime)s] %(levelname)-8s %(message)s (%(funcName)s:%(lineno)d)
datefmt=%Y-%m-%d %H:%M:%S

在这个配置文件中，我们定义了两个日志处理器，一个用于输出到控制台，另一个用于输出到文件。我们同时也定义了一个日志格式化器，用于设置日志输出的格式。在loggers和handlers段落中，我们列出了日志器和处理器的名称，因此日志器和处理器都可以通过指定名称来引用。

在代码中，我们使用fileConfig()方法读取配置文件，并将其应用于日志模块。然后，我们使用getLogger()方法创建一个名为mylogger的日志器，它继承了根日志器的配置信息。最后，我们分别使用不同级别的日志方法输出日志信息，并观察日志信息的输出情况。

Tags: