【configparser】参数管理

最近学习了一下configparser包，做一个笔记

【configparser 是什么】
configparser 是Python标准库中用于读取配置文件的模块，它提供了方便的方法来解析配置文件并提取特定的配置项值。

【为什么需要configparser】
对于小的项目，脚本较小，通常可以将参数直接写在.py文件中，尽管将参数直接写在脚本中也是可行的，但使用配置文件有助于提高脚本的可维护性、可配置性和安全性。
对于较大、复杂的应用程序，使用配置文件管理参数通常是一种更好的实践。比如一个参数在不同脚本中都有调用，那么使用.ini文件能够更好地进行参数管理。

1. 主要的读取参数方法

configparser 模块中的 ConfigParser 类提供了许多用于获取配置文件中参数的方法，以下是一些常用的类似方法：

1. getboolean(section, option, *, raw=False, fallback=None)：获取一个布尔类型的参数值。如果指定的 option 在指定的 section 中不存在，返回 fallback 参数的值（如果提供），否则引发 NoOptionError 异常。

2. getfloat(section, option, *, raw=False, fallback=None)：获取一个浮点数类型的参数值。如果指定的 option 在指定的 section 中不存在，返回 fallback 参数的值（如果提供），否则引发 NoOptionError 异常。

3. get(section, option, *, raw=False, fallback=None, **kwargs)：获取一个字符串类型的参数值。如果指定的 option 在指定的 section 中不存在，返回 fallback 参数的值（如果提供），否则引发 NoOptionError 异常。

4. getint(section,optin,*,raw=False,fallback=None,**kwargs): 获取一个整数类型的 参数值。如果指定的option在指定的section中不存在，返回fallback的值（如果提供），否则引发NoOptionError异常。

除了这些方法之外，还有一些其他方法可以根据需要获取参数，如 getint()、getboolean()、getfloat()、get() 和 getlist() 等。

1.1 通用示例

在使用这些方法之前，请确保已经正确加载了配置文件，并在相应的 section 和 option 中存在相应的参数。以下是一个示例，展示了如何使用一些类似于 getint() 的方法：

import configparser

config = configparser.ConfigParser()
config.read('config.ini', encoding='utf-8')

# 获取布尔类型的参数值
is_enabled = config.getboolean('Section', 'is_enabled')
print(is_enabled)

# 获取浮点数类型的参数值
threshold = config.getfloat('Section', 'threshold')
print(threshold)

# 获取字符串类型的参数值
username = config.get('Section', 'username')
print(username)

在这个示例中，假设存在一个名为 config.ini 的配置文件和 Section 部分。使用 getboolean()、getfloat() 和 get() 方法分别从配置文件中获取布尔、浮点数和字符串类型的参数值。

请注意，在使用这些方法之前，需要将配置文件加载到 ConfigParser 对象中，确保所需的section和option存在，并提供了正确的参数值。

1.2 文件格式问题

当.ini文件中有中文，比如中文字符串参数或者中文注解，那么直接读取.ini文件会引起 UnicodeDecodeError: 'gbk' codec can't decode byte 0xae in position 49: illegal multibyte sequence错误。

可以通过向read函数添加参数encoding = 'utf-8'调整读取问价格式。

1.3 getint()具体示例

在configparser中，getint() 是其中一个用于获取整数类型配置项值的方法。

当你调用 getint(section, option) 的时候，它会根据传入的 section 和 option 参数在配置文件中查找对应的配置项，并将其值转换成整数类型返回。如果配置项不存在或无法成功转换为整数类型，getint() 方法会引发 ValueError 异常。

示例使用configparser读取配置文件内容的代码如下：

import configparser

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

production_consume_ratio = config.getint('main', 'production_consume_ratio')

以上代码假设存在名为 config.ini 的配置文件，其中包含以下内容：

[main]
production_consume_ratio = 5

[learner]
# 下面是replay buffer的相关配置, 样本池大小和预加载因子
replay_buffer_capacity = 100000
preload_ratio = 2

# pytorch训练间隔多少步输出model文件
dump_model_freq = 1000

[actor]
# actor预测批处理大小
predict_batch_size = 4

注意.ini文件中[]与getint(section)的对应关系。
下面给出了对应关系的示意图

在这个例子中，production_consume_ratio 的整数值 5 将会被存储在 production_consume_ratio 变量中供后续使用。

请确保在使用 getint() 或其他 configparser 方法之前，你已经正确创建了 configparser.ConfigParser 的实例，并使用 read() 方法加载了配置文件。

2. 使用configparser管理参数的好处

使用 configparser 从 .ini 文件中获取参数有以下几个优点：

1. 可配置性：将参数定义在配置文件中，可以在不修改脚本代码的情况下修改参数值。这样可以方便地进行配置调整和参数的灵活管理，而无需编辑脚本本身。这在不同环境或不同用户的使用情况下非常有用，可以根据需求轻松更改配置。

2. 分离关注点：通过将参数隔离在配置文件中，可以把配置和代码逻辑分开，使得脚本更加清晰和易于维护。脚本可以关注于实现业务逻辑，而配置文件则专注于存储配置参数。

3. 多语言共享：使用 .ini 文件作为配置格式，可以使得不同编程语言的程序共享同一份配置文件。这意味着，通过编辑配置文件，可以在不同的应用或环境中使用相同的配置参数。

4. 安全性：某些参数可能包含敏感信息（如密码），将其写在脚本中可能会带来潜在的安全风险。将这些敏感参数保存在配置文件中，并设定适当的访问权限，可以更好地保护敏感信息的安全性。