python

关注公众号 jb51net

关闭
首页 > 脚本专栏 > python > Python配置文件用法

一文带你梳理Python中七种配置文件的常见用法

作者：跟橙姐学代码

在写 Python 项目的时候,最让人头大的环节之一,就是配置文件,本文将带大家一起深入了解下Python中七种配置文件的常见用法,感兴趣的可以了解下

在写 Python 项目的时候，最让人头大的环节之一，就是配置文件。

你肯定遇到过：

结果就是：项目写着写着，光是管理配置文件就快把人逼疯。

更扎心的是，不同的项目，配置文件格式还五花八门——有人用 .ini，有人用 .json，有人推崇 .yaml，还有 .toml、.env、.xml，甚至直接用 .py 文件来写。

那么问题来了：到底该用哪种？它们有什么区别？在 Python 里怎么读写？

别急，这篇文章我会把 7 种常见的配置方式一次性说清楚，代码实战全给你备好，照着用就行。

一、为什么配置文件这么重要

在项目开发里，配置文件就像“遥控器”。 你不可能把所有参数写死在代码里吧？ 那样一旦换服务器、换数据库、换模型路径，改动起来简直要命。

有了配置文件，就像把遥控器交给你：

所以，配置文件的格式选择，其实决定了你的项目可维护性和扩展性。

二、常见配置格式横向对比

咱们先来个总览，心里有数：

格式可读性复杂度安全性类型支持适用场景
INI高低高基础类型简单分组配置
JSON中中高丰富跨语言、数据交换
YAML高高中丰富复杂配置，带注释
XML低高高丰富企业级规范
.env高低高字符串环境变量、敏感信息
TOML高中高丰富Python 项目常用
Python 文件中高低完全支持框架级、动态配置

一张表看下来，基本思路就出来了：

下面我们就一一拆解，看它们在 Python 里怎么用。

三、七种方式逐个过

1. INI 文件 —— 老牌选手

INI 文件最大的优点就是：简单、直观、Python 原生支持。 标准库里有 configparser，拿来就用。

import configparser

def handle_ini_file():
    # 写INI文件
    config = configparser.ConfigParser()
    config['DEFAULT'] = {
        'ServerAliveInterval': '45',
        'Compression': 'yes',
        'CompressionLevel': '9'
    }
    config['bitbucket.org'] = {}
    config['bitbucket.org']['User'] = 'hg'
    config['topsecret.server.com'] = {}
    topsecret = config['topsecret.server.com']
    topsecret['Port'] = '50022'
    topsecret['ForwardX11'] = 'no'

    # 写入文件
    with open('myconfig.ini', 'w') as f:
        config.write(f)

    # 读取INI文件
    config_read = configparser.ConfigParser()
    config_read.read('myconfig.ini')

    print("INI文件内容:")
    print(f"ServerAliveInterval: {config_read['DEFAULT']['ServerAliveInterval']}")
    print(f"bitbucket User: {config_read.get('bitbucket.org', 'User')}")
    print(f"Port: {config_read.getint('topsecret.server.com', 'Port')}")
    print(f"ForwardX11: {config_read.getboolean('topsecret.server.com', 'ForwardX11')}")

适合场景：配置比较简单，不需要嵌套。

2. JSON 文件 —— 跨语言通吃

几乎所有语言都支持 JSON，这就是它的杀手锏。 Python 里用 json 模块，一行搞定。

import json

def handle_json_file():
    data = {
        "name": "John",
        "age": 30,
        "city": "New York",
        "is_student": False,
        "hobbies": ["reading", "gaming", "hiking"],
        "address": {
            "street": "123 Main St",
            "zipcode": "10001"
        }
    }

    # 写JSON
    with open('myconfig.json', 'w') as f:
        json.dump(data, f, indent=4)

    # 读JSON
    with open('myconfig.json', 'r') as f:
        data_read = json.load(f)

    print("JSON文件内容:")
    print(f"Name: {data_read['name']}")
    print(f"Age: {data_read['age']}")
    print(f"Hobbies: {', '.join(data_read['hobbies'])}")
    print(f"Zipcode: {data_read['address']['zipcode']}")

适合场景：需要和别的语言/程序交互的数据交换。

3. YAML 文件 —— 人类最友好的配置

YAML 近几年在 Python 圈特别火，优点就是：简洁，还能写注释！ 不过要装 pyyaml，标准库没带。

import yaml

def handle_yaml_file():
    data = {
        "name": "Alice",
        "age": 25,
        "city": "London",
        "is_student": True,
        "hobbies": ["painting", "dancing"],
        "address": {
            "street": "456 Oak Ave",
            "zipcode": "SW1A 1AA"
        }
    }

    # 写YAML
    with open('myconfig.yaml', 'w') as f:
        yaml.dump(data, f, sort_keys=False)

    # 读YAML
    with open('myconfig.yaml', 'r') as f:
        data_read = yaml.safe_load(f)

    print("YAML文件内容:")
    print(f"Name: {data_read['name']}")
    print(f"Age: {data_read['age']}")
    print(f"Hobbies: {', '.join(data_read['hobbies'])}")
    print(f"Zipcode: {data_read['address']['zipcode']}")

适合场景：复杂项目，需要手动编辑、加注释。

4. TOML 文件 —— Python 官方推荐

TOML 是近年来火起来的，它的设计初衷就是做配置。 Python 官方文档里推荐用它。

import toml

# 写入TOML
data = {
    "title": "TOML config",
    "owner": {
        "name": "Tom Preston-Werner",
        "dob": "1979-05-27T07:32:00-08:00"
    },
    "database": {
        "server": "192.168.1.1",
        "ports": [8001, 8001, 8002]
    }
}

with open("config.toml", "w") as f:
    toml.dump(data, f)

# 读取TOML
with open("config.toml", "r") as f:
    config = toml.load(f)

print('toml配置信息：', config["database"]["server"])

适合场景：现代 Python 项目，结构化又简洁。

5. XML 文件 —— 老派企业最爱

XML 在 Java 生态里非常常见，Python 里用得少，主要是写法太啰嗦。

import xml.etree.ElementTree as ET

# 写XML
root = ET.Element("config")
server = ET.SubElement(root, "server")
ET.SubElement(server, "host").text = "localhost"
ET.SubElement(server, "port").text = "8080"

tree = ET.ElementTree(root)
tree.write("config.xml")

# 读XML
tree = ET.parse("config.xml")
root = tree.getroot()
host = root.find("server/host").text
port = root.find("server/port").text
print(host)
print('端口', port)

适合场景：企业级规范，或者要和 Java 系统打交道时。

6. 环境变量（.env 文件）—— 敏感信息守护者

密码、API Key、数据库 URL 这些东西，最适合放 .env。 配合 python-dotenv，特别方便。

from dotenv import load_dotenv
import os

# 加载.env
load_dotenv()

# 读取环境变量
api_key = os.getenv("API_KEY")
database_url = os.getenv("DATABASE_URL")

print('apikey:', api_key)
print('Url:', database_url)

适合场景：存储敏感配置，环境变量管理。

7. Python 文件 —— 直接上本尊

有些框架直接用 .py 做配置（Django 就是）。 灵活性最高，但也意味着安全性和维护性要小心。

# settings.py
DEBUG = True
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': 'mydatabase'
    }
}

适合场景：框架内部、动态计算配置。

四、怎么选

一句话总结：

大多数情况下，YAML + TOML + .env 足够覆盖绝大多数 Python 项目需求。

五、最后的话

别小看配置文件，它决定了你的项目是不是“优雅”。 如果配置乱七八糟，项目就会越来越臃肿，哪怕代码写得再漂亮，也会被坑到。

所以，学会正确地管理配置，其实就是在给未来的自己减负。

到此这篇关于一文带你梳理Python中七种配置文件的常见用法的文章就介绍到这了,更多相关Python配置文件用法内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文