配置文件读取与管理 v1.0

一、argparse

1.简介

argparse 模块是 Python 内置的用于命令项选项与参数解析的模块，argparse 模块可以让人轻松编写用户友好的命令行接口，能够帮助程序员为模型定义参数。

2.使用

import argparse
# 创建命令行解析器对象，[description]：对参数解析器的作用进行描述
parser = argparse.ArgumentParser(description='description')
# 添加命令行参数
parser.add_argument('--epochs', type=int, default=30, help='help description')
parser.add_argument('--batch', type=int, default=4, help='help description')
# 从命令行中结构化解析参数
args = parser.parse_args()
# 获取数值
epochs = args.epochs
batch = args.batch

3.常见参数及解释

add_argument常见参数

参数	功能
name or flags	普通参数或flag参数选项参数的名称或标签，例如 epochs 或者 -e, --epochs。Flag参数不需要指定参数值，只需要带有参数名即可
default	不指定参数时该参数的默认值
type	命令行参数应该被转换成的数据类型
required	是否为必选参数或可选参数
help	参数的帮助信息
action	命令行遇到flags参数时的动作。有两个常见的动作，store_true：设定flag参数为true；store_false：设定flag参数为False。注意：如果直接运行程序，默认不读取该变量，要使用必须要进行传参，例如：python try.py --epochs
nargs	应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数
metavar	在 usage 说明中的参数名称，对于必选参数，默认就是参数名称，对于可选参数默认是全大写的参数名称
dest	解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线
choices	参数可允许的值的一个容器
const	action 和 nargs 所需要的常量值
store_const	表示赋值为const
append	将遇到的值存储成列表，也就是如果参数重复则会保存多个值
append_const	将参数规范中定义的一个值保存到一个列表
count	存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析

二、configparser

configparser 模块用于读取和写入 INI 格式的配置文件。

import configparser

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

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

# 获取配置值
value = config.get('section_name', 'key_name')

# 获取所有节
sections = config.sections()

# 检查节是否存在
if config.has_section('section_name'):
    pass

# 获取节下的所有键值对
items = config.items('section_name')

# 写入配置文件
config['section_name'] = {'key': 'value'}
with open('config.ini', 'w') as f:
    config.write(f)

三、yaml

PyYAML 库用于读取和写入 YAML 格式的配置文件。

import yaml

# 读取YAML文件
with open('config.yaml', 'r', encoding='utf-8') as f:
    config = yaml.safe_load(f)

# 写入YAML文件
with open('config.yaml', 'w', encoding='utf-8') as f:
    yaml.dump(config, f, allow_unicode=True, default_flow_style=False)

# YAML字符串解析
yaml_str = """
name: example
version: 1.0
settings:
  debug: true
  log_level: INFO
"""
config = yaml.safe_load(yaml_str)