Python 程序读取和写入配置文件的常用方法

博主：小蓝
发布时间：2024 年 12 月 18 日
160 次浏览
暂无评论
6301字数
分类： Linux 技术杂烩

### Python 程序读取和写入配置文件的常用方法 🐍📄

在**Python**开发中，**配置文件**的读取与写入是常见的需求。配置文件用于存储程序的运行参数，使得程序更加灵活和易于维护。本文将详细介绍 **Python** 读取和写入配置文件的**常用方法**，并提供实用的代码示例和详尽的解释，帮助开发者高效管理配置。

---

#### 目录

1. [使用 `configparser` 处理 INI 文件](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E4%BD%BF%E7%94%A8-configparser-%E5%A4%84%E7%90%86-ini-%E6%96%87%E4%BB%B6)
2. [使用 `json` 处理 JSON 文件](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E4%BD%BF%E7%94%A8-json-%E5%A4%84%E7%90%86-json-%E6%96%87%E4%BB%B6)
3. [使用 `yaml` 处理 YAML 文件](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E4%BD%BF%E7%94%A8-yaml-%E5%A4%84%E7%90%86-yaml-%E6%96%87%E4%BB%B6)
4. [方法对比表](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E6%96%B9%E6%B3%95%E5%AF%B9%E6%AF%94%E8%A1%A8)
5. [实用小贴士](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E5%AE%9E%E7%94%A8%E5%B0%8F%E8%B4%B4%E5%A3%AB)
6. [总结](https://chatgpt.com/c/67585324-6aa8-8011-bb2f-ee8a4922d16d#%E6%80%BB%E7%BB%93)

---

### 使用 `configparser` 处理 INI 文件 📑

**`configparser`** 是 Python 内置模块，适用于处理 **INI** 格式的配置文件。**INI** 文件具有简单的键值对结构，适合存储基础配置。

#### 示例 INI 文件 (`config.ini`)

```ini
[database]
host = localhost
port = 3306
user = root
password = secret

[logging]
level = DEBUG
file = app.log
```

#### 读取 INI 文件

```python
import configparser

# 创建配置解析器实例
config = configparser.ConfigParser()

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

# 访问配置项
db_host = config['database']['host']
db_port = config['database'].getint('port')
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

* `configparser.ConfigParser()` 创建一个解析器实例。
* `config.read('config.ini')` 读取指定的 INI 文件。
* 通过 `config[section][option]` 访问配置项。
* `getint` 方法将字符串值转换为整数。

#### 写入 INI 文件

```python
import configparser

# 创建配置解析器实例
config = configparser.ConfigParser()

# 添加配置项
config['server'] = {
    'host': '192.168.1.1',
    'port': '8080'
}

config['feature'] = {}
config['feature']['enable_feature_x'] = 'yes'

# 写入到文件
with open('new_config.ini', 'w') as configfile:
    config.write(configfile)
```

**解释：**

* 通过 `config['section']` 添加新节。
* 使用字典形式添加键值对。
* `config.write(configfile)` 将配置写入文件。

---

### 使用 `json` 处理 JSON 文件 📦

**`json`** 模块适用于处理 **JSON** 格式的配置文件，具有良好的可读性和广泛的兼容性。

#### 示例 JSON 文件 (`config.json`)

```json
{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "secret"
    },
    "logging": {
        "level": "DEBUG",
        "file": "app.log"
    }
}
```

#### 读取 JSON 文件

```python
import json

# 读取 JSON 文件
with open('config.json', 'r') as file:
    config = json.load(file)

# 访问配置项
db_host = config['database']['host']
db_port = config['database']['port']
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

* `json.load(file)` 将 JSON 文件内容转换为 Python 字典。
* 通过键访问嵌套的配置项。

#### 写入 JSON 文件

```python
import json

# 配置数据
config = {
    "server": {
        "host": "192.168.1.1",
        "port": 8080
    },
    "feature": {
        "enable_feature_x": True
    }
}

# 写入到 JSON 文件
with open('new_config.json', 'w') as file:
    json.dump(config, file, indent=4)
```

**解释：**

* 使用字典构建配置数据。
* `json.dump(config, file, indent=4)` 将字典写入文件，并格式化为易读的 JSON 格式。

---

### 使用 `yaml` 处理 YAML 文件 🌿

**`yaml`** 是一种更具可读性的配置文件格式，适用于复杂的配置结构。需要安装第三方库 `PyYAML`。

#### 安装 PyYAML

```bash
pip install pyyaml
```

#### 示例 YAML 文件 (`config.yaml`)

```yaml
database:
  host: localhost
  port: 3306
  user: root
  password: secret

logging:
  level: DEBUG
  file: app.log
```

#### 读取 YAML 文件

```python
import yaml

# 读取 YAML 文件
with open('config.yaml', 'r') as file:
    config = yaml.safe_load(file)

# 访问配置项
db_host = config['database']['host']
db_port = config['database']['port']
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

* `yaml.safe_load(file)` 将 YAML 文件内容转换为 Python 字典。
* 安全加载，避免执行任意代码。

#### 写入 YAML 文件

```python
import yaml

# 配置数据
config = {
    'server': {
        'host': '192.168.1.1',
        'port': 8080
    },
    'feature': {
        'enable_feature_x': True
    }
}

# 写入到 YAML 文件
with open('new_config.yaml', 'w') as file:
    yaml.dump(config, file, default_flow_style=False)
```

**解释：**

* 使用字典构建配置数据。
* `yaml.dump(config, file, default_flow_style=False)` 将字典写入文件，使用块样式（更具可读性）。

---

### 方法对比表 📊

| **方法**   | **适用格式** | **优点**             | **缺点**                 |
| ---------------- | ------------------ | -------------------------- | ------------------------------ |
| `configparser` | INI                | 简单易用，内置模块         | 不适合嵌套复杂结构             |
| `json`         | JSON               | 广泛支持，结构化良好       | 对注释支持有限，可读性稍差     |
| `yaml`         | YAML               | 高可读性，支持复杂嵌套结构 | 需要安装第三方库，解析速度较慢 |
| `pickle`       | Python对象         | 能序列化复杂的Python对象   | 安全性较低，不推荐用于配置文件 |

---

### 实用小贴士 💡

1. **选择合适的格式**：

* **简单配置**：使用 **INI** 格式，便于快速配置和读取。
   * **结构化数据**：使用 **JSON**，适合与前端或其他系统交互。
   * **复杂配置**：使用 **YAML**，支持更多功能和更高的可读性。
2. **安全性考虑**：

* 避免使用 **pickle** 处理配置文件，因为它可能执行任意代码，存在安全风险。
   * 使用 `yaml.safe_load` 代替 `yaml.load`，以防止执行恶意代码。
3. **注释与文档**：

* **INI** 和 **YAML** 支持注释，便于在配置文件中添加说明。
   * **JSON** 不支持注释，如需添加注释，可考虑使用其他格式或在文档中说明。
4. **错误处理**：

* 在读取配置文件时，添加异常处理，确保程序在配置错误时能够优雅地处理。

```python
   try:
       with open('config.yaml', 'r') as file:
           config = yaml.safe_load(file)
   except FileNotFoundError:
       print("配置文件未找到，请检查路径。")
   except yaml.YAMLError as e:
       print(f"YAML解析错误: {e}")
   ```
5. **动态配置**：

* 对于需要动态更新的配置，可以结合环境变量或数据库存储，实现更灵活的配置管理。

---

### 总结 📝

在**Python**程序中，读取和写入**配置文件**是实现灵活性和可维护性的关键步骤。根据不同的需求和配置复杂度，可以选择合适的方法和格式：

* **`configparser`** 适用于简单的键值对配置。
* **`json`** 提供了良好的结构化支持，适合与其他系统的数据交换。
* **`yaml`** 则在需要更高可读性和复杂结构时表现出色。

通过合理选择和使用这些方法，开发者可以高效地管理程序配置，提升开发效率和代码质量。✨

蓝易云是一家专注于香港及国内数据中心服务的提供商，提供高质量的服务器租用和云计算服务、包括免备案香港服务器、香港CN2、美国服务器、海外高防服务器、国内高防服务器、香港VPS等。致力于为用户提供稳定,快速的网络连接和优质的客户体验。

最后修改：2024 年 12 月 18 日

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

Python 程序读取和写入配置文件的常用方法

小蓝 • 2024 年 12 月 18 日

### Python 程序读取和写入配置文件的常用方法 🐍📄

---

#### 目录

---

### 使用 `configparser` 处理 INI 文件 📑

**`configparser`** 是 Python 内置模块，适用于处理 **INI** 格式的配置文件。**INI** 文件具有简单的键值对结构，适合存储基础配置。

#### 示例 INI 文件 (`config.ini`)

```ini
[database]
host = localhost
port = 3306
user = root
password = secret

[logging]
level = DEBUG
file = app.log
```

#### 读取 INI 文件

```python
import configparser

# 创建配置解析器实例
config = configparser.ConfigParser()

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

# 访问配置项
db_host = config['database']['host']
db_port = config['database'].getint('port')
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

#### 写入 INI 文件

```python
import configparser

# 创建配置解析器实例
config = configparser.ConfigParser()

# 添加配置项
config['server'] = {
    'host': '192.168.1.1',
    'port': '8080'
}

config['feature'] = {}
config['feature']['enable_feature_x'] = 'yes'

# 写入到文件
with open('new_config.ini', 'w') as configfile:
    config.write(configfile)
```

**解释：**

* 通过 `config['section']` 添加新节。
* 使用字典形式添加键值对。
* `config.write(configfile)` 将配置写入文件。

---

### 使用 `json` 处理 JSON 文件 📦

**`json`** 模块适用于处理 **JSON** 格式的配置文件，具有良好的可读性和广泛的兼容性。

#### 示例 JSON 文件 (`config.json`)

#### 读取 JSON 文件

```python
import json

# 读取 JSON 文件
with open('config.json', 'r') as file:
    config = json.load(file)

# 访问配置项
db_host = config['database']['host']
db_port = config['database']['port']
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

* `json.load(file)` 将 JSON 文件内容转换为 Python 字典。
* 通过键访问嵌套的配置项。

#### 写入 JSON 文件

```python
import json

# 配置数据
config = {
    "server": {
        "host": "192.168.1.1",
        "port": 8080
    },
    "feature": {
        "enable_feature_x": True
    }
}

# 写入到 JSON 文件
with open('new_config.json', 'w') as file:
    json.dump(config, file, indent=4)
```

**解释：**

* 使用字典构建配置数据。
* `json.dump(config, file, indent=4)` 将字典写入文件，并格式化为易读的 JSON 格式。

---

### 使用 `yaml` 处理 YAML 文件 🌿

**`yaml`** 是一种更具可读性的配置文件格式，适用于复杂的配置结构。需要安装第三方库 `PyYAML`。

#### 安装 PyYAML

```bash
pip install pyyaml
```

#### 示例 YAML 文件 (`config.yaml`)

```yaml
database:
  host: localhost
  port: 3306
  user: root
  password: secret

logging:
  level: DEBUG
  file: app.log
```

#### 读取 YAML 文件

```python
import yaml

# 读取 YAML 文件
with open('config.yaml', 'r') as file:
    config = yaml.safe_load(file)

# 访问配置项
db_host = config['database']['host']
db_port = config['database']['port']
logging_level = config['logging']['level']

print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Logging Level: {logging_level}")
```

**解释：**

* `yaml.safe_load(file)` 将 YAML 文件内容转换为 Python 字典。
* 安全加载，避免执行任意代码。

#### 写入 YAML 文件

```python
import yaml

# 配置数据
config = {
    'server': {
        'host': '192.168.1.1',
        'port': 8080
    },
    'feature': {
        'enable_feature_x': True
    }
}

# 写入到 YAML 文件
with open('new_config.yaml', 'w') as file:
    yaml.dump(config, file, default_flow_style=False)
```

**解释：**

* 使用字典构建配置数据。
* `yaml.dump(config, file, default_flow_style=False)` 将字典写入文件，使用块样式（更具可读性）。

---

### 方法对比表 📊

---

### 实用小贴士 💡

1. **选择合适的格式**：

* 在读取配置文件时，添加异常处理，确保程序在配置错误时能够优雅地处理。

* 对于需要动态更新的配置，可以结合环境变量或数据库存储，实现更灵活的配置管理。

---

### 总结 📝

在**Python**程序中，读取和写入**配置文件**是实现灵活性和可维护性的关键步骤。根据不同的需求和配置复杂度，可以选择合适的方法和格式：

通过合理选择和使用这些方法，开发者可以高效地管理程序配置，提升开发效率和代码质量。✨

Python 程序读取和写入配置文件的常用方法

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

微信视频号视频下载工具WeChatVideoDownloader

Win11系统优化工具-Windows11一键设置

YDArk - 系统内核工具

XPay-自建个人免签收款支付系统

Windows微软常用运行库合集一键安装

Python里for循环要遍历的数据很多很大怎么办？

异步编程概念与实践

Navicat备份和恢复MongoDB库的数据教程

pycharm如何查看git历史版本变更信息

在线视频服务器租用？（在线视频服务器租用多少钱） - 蓝易云

Python 程序读取和写入配置文件的常用方法

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

Python 程序读取和写入配置文件的常用方法

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款