树莓派Python读写配置文件--configparser库

>> [目录] 数据远程采集 Step by Step

 

配置文件格式

---

配置文件（*.ini）的基本格式如下：

[device]
type = NULL
id = 1

[comn]
protocol = 0
lenth = 400
filter_min = 120
filter_max = 400

[wifi]
ssid = user_ssid_null
psk = user_psk_null

[device]、[comn]、[wifi] 这些叫做 sections（节），每个section下面包含多个options（参数）/items（参数对，和字典的概念类似），例如：type = NULL，这里的“type”就叫做option，而（’type’,  ‘NULL’）被称为item。参数的值均是以string格式存储的。

 

configparser库

---

使用Python的configparser库来读写配置文件，configparser官方文档：

https://docs.python.org/3/library/configparser.html#configparser.ConfigParser

搜索ConfigParser Objects，这一节有函数详细的功能介绍，下面列一部分常用的：

cf = configparser.ConfigParser()	创建configparser实例
sections()	返回sections的列表
add_section(section)	增加一个section
remove_section(section)	删除一个section
has_section(section)	返回某个section是否存在
options(section)	返回某个section下的options列表
has_option(section, option)	返回某个section下的某个option是否存在
remove_option(section, option)	删除某个section下的某个option
items()	获得所有的sections，包括默认section
items(section)	获得某个section下的所有items/参数对
read(filenames)	读取某个配置文件filenames，加载到ConfigParser实例
get(section, option)	以string格式，返回某个section下的某个option的值
getint(section, option)	以int格式，返回某个section下的某个option的值
getfloat(section, option)	以float格式，返回某个section下的某个option的值
getboolean(section, option)	以boolean格式，返回某个section下的某个option的值
set(section, option, value)	设置某个section下的某个option的值
write(fileobject)	将当前的ConfigParser实例写入到配置文件fileobject

生成配置文件

---

ConfigParser库在Python2和Python3中有点区别：

• Python3

configparser库的首字母小写

import configparser

config = configparser.ConfigParser()

创建文件test_config_create_p3.py，复制下面的内容，保存退出

pi@raspberrypi:~ $ sudo nano test_config_create_p3.py

# -*- coding:utf-8 -*-
import configparser

config = configparser.ConfigParser()

config["device"] = {
  'type'       : 'NULL',
  'id'         : '1'
}

config["comn"] = {
  'protocol'   : '0',
  'lenth'      : '400',
  'filter_min' : '50',
  'filter_max' : '400'
}

config["wifi"] = {
  'ssid'       : 'user_ssid_null',
  'psk'        : 'user_psk_null'
}

with open('config.ini', 'w') as cf:
  config.write(cf)

 

运行程序：

pi@raspberrypi:~ $ python3 test_config_create_p3.py

打开生成的配置文件config.ini：

pi@raspberrypi:~ $ sudo nano config.ini

sections和options的内容都是对的，只是section下的options的顺序与预期的不一致，不过这样也没什么问题。

 

• Python2

ConfigParser库的首字母大写

import ConfigParser

config = ConfigParser.ConfigParser()

 

python2中只能逐条添加section和option

创建文件test_config_create_p2.py，复制下面的内容，保存退出

pi@raspberrypi:~ $ sudo nano test_config_create_p2.py

# -*- coding:utf-8 -*-
import ConfigParser

config = ConfigParser.ConfigParser()

config.add_section("device")
config.set("device", "type", 'NULL')
config.set("device", "id",   '1')

config.add_section("comn")
config.set("comn", "protocol",   '0'   )
config.set("comn", "lenth",      '400')
config.set("comn", "filter_min", '50' )
config.set("comn", "filter_max", '400' )

config.add_section("wifi")
config.set("wifi", "ssid", 'user_ssid_null')
config.set("wifi", "psk",  'user_psk_null')

with open('config.ini', 'w') as cf:
  config.write(cf)

 

先删掉可能存在的config.ini文件

pi@raspberrypi:~ $ rm -f config.ini

运行程序：

pi@raspberrypi:~ $ python2 test_config_create_p2.py

打开生成的配置文件config.ini：

pi@raspberrypi:~ $ sudo nano config.ini

sections和options的内容都是对的，section下的options的顺序与预期的一致。

 

读取配置文件

---

读取配置参数时，先确认section是否存在，如果不存在就添加section，并写入默认配置参数。

这里使用的配置参数主要有两种类型：string和int，分别使用get(section, option)、getint(section, option)去读取参数。

读取完成后把所有的items都打印出来。

def GetConfig(filepath):
  global PRODUCT_TYPE
  global DEVICE_ID

  global PROTOCOL_TYPE
  global DB_PARAMS_LENGTH
  global COMN_FILTER_MIN
  global COMN_FILTER_MAX

  global WIFI_SSID
  global WIFI_PASSWORD

  is_new_section = False

  print('>> GetConfig()...')
  print(filepath)

  config = configparser.ConfigParser()
  config.read(filepath)

  if "wifi" not in config.sections():
    print('>> add config >> wifi...')
    is_new_section = True
    config.add_section("wifi")
    config.set("wifi", "ssid", WIFI_SSID)
    config.set("wifi", "psk", WIFI_PASSWORD)
  else:
    WIFI_SSID = config.get("wifi", "ssid")
    WIFI_PASSWORD = config.get("wifi", "psk")

  if "device" not in config.sections():
    print('>> add config >> device...')
    is_new_section = True
    config.add_section("device")
    config.set("device", "type", PRODUCT_TYPE)
    config.set("device", "id", str(DEVICE_ID))
  else:
    PRODUCT_TYPE = config.get("device", "type")
    DEVICE_ID    = config.getint("device", "id")

  if "comn" not in config.sections():
    print('>> add config >> comn...')
    is_new_section = True
    config.add_section("comn")
    config.set("comn", "protocol",   str(PROTOCOL_TYPE)   )
    config.set("comn", "lenth",      str(DB_PARAMS_LENGTH))
    config.set("comn", "filter_min", str(COMN_FILTER_MIN) )
    config.set("comn", "filter_max", str(COMN_FILTER_MAX) )
  else:
    PROTOCOL_TYPE    = config.get("comn", "protocol")
    DB_PARAMS_LENGTH = config.getint("comn", "lenth")
    COMN_FILTER_MIN  = config.getint("comn", "filter_min")
    COMN_FILTER_MAX  = config.getint("comn", "filter_max")

  print('>> list config items...')
  for sections in config.sections():
    for items in config.items(sections):
      print(items)

  if True == is_new_section:
    print('>> new section added, write to config file...')
    with open(filepath, 'w+') as cf:
      config.write(cf)

 

修改配置文件

---

用set(section, option, value)来设置参数值，可以把所有参数值都用str()强制转换一下。

写入之前先把所有的items都打印出来。

def SetConfig(filepath):
  global WIFI_SSID
  global WIFI_PASSWORD
  global PRODUCT_TYPE
  global DEVICE_ID
  global PROTOCOL_TYPE
  global DB_PARAMS_LENGTH
  global COMN_FILTER_MIN
  global COMN_FILTER_MAX

  print('>> SetConfig()...')
  print(filepath)

  config = configparser.ConfigParser()
  config.read(CONFIG_FILE)

  if "device" not in config.sections():
    config.add_section("device")
  if "comn" not in config.sections():
    config.add_section("comn")
  if "wifi" not in config.sections():
    config.add_section("wifi")

  config.set("wifi", "ssid", str(WIFI_SSID))
  config.set("wifi", "psk",  str(WIFI_PASSWORD))

  config.set("device", "type", str(PRODUCT_TYPE))
  config.set("device", "id",   str(DEVICE_ID))

  config.set("comn", "protocol",   str(PROTOCOL_TYPE)   )
  config.set("comn", "lenth",      str(DB_PARAMS_LENGTH))
  config.set("comn", "filter_min", str(COMN_FILTER_MIN) )
  config.set("comn", "filter_max", str(COMN_FILTER_MAX) )

  print('>> list config items...')
  for sections in config.sections():
    for items in config.items(sections):
      print(items)

  print('>> write to config file...')
  with open(CONFIG_FILE, 'w+') as cf:
    config.write(cf)

运行测试

---

使用Python3进行测试（如果用Python2，只需要把库的首字母改成大写的）

创建测试程序test_config.py。SetConfig()、GetConfig()参考上面，这里为了便于阅读省略了。
pi@raspberrypi:~ $ sudo nano test_config.py

这个测试函数里先是把默认的配置参数写入到配置文件并读取，然后再修改配置参数，重新写入到配置文件并读取。程序会打印即将写入配置文件的参数，还有从配置文件中读取到的参数。

# -*- coding:utf-8 -*-
import configparser

CONFIG_FILE         = '/home/pi/config.ini'

PRODUCT_TYPE        = 'NULL'
DEVICE_ID           = 1
PROTOCOL_TYPE       = 0
DB_PARAMS_LENGTH    = 400
COMN_FILTER_MIN     = 50
COMN_FILTER_MAX     = 400
WIFI_SSID           = 'user_ssid_null'
WIFI_PASSWORD       = 'user_psk_null'

#----
def GetConfig(filepath):
  ####

#----
def SetConfig(filepath):
  ####

#----
def main():
  global CONFIG_FILE

  global WIFI_SSID
  global WIFI_PASSWORD
  global PRODUCT_TYPE
  global DEVICE_ID
  global PROTOCOL_TYPE
  global DB_PARAMS_LENGTH
  global COMN_FILTER_MIN
  global COMN_FILTER_MAX

  SetConfig(CONFIG_FILE)
  GetConfig(CONFIG_FILE)

  PRODUCT_TYPE        = 'ANOTHER_TYPE'
  DEVICE_ID           = 2

  PROTOCOL_TYPE       = 1
  DB_PARAMS_LENGTH    = 300
  COMN_FILTER_MIN     = 100
  COMN_FILTER_MAX     = 300

  WIFI_SSID           = 'another_user_ssid_null'
  WIFI_PASSWORD       = 'another_user_psk_null'

  SetConfig(CONFIG_FILE)
  GetConfig(CONFIG_FILE)

if __name__ == '__main__':
  main()

 

用Python3运行
pi@raspberrypi:~ $ python3 test_config.py

首先是写入默认配置参数并读取的结果，与预期一致：

之后是修改了配置参数，写入并读取的结果，与预期一致：