樹莓派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

首先是寫入默認配置參數並讀取的結果，與預期一致：

之后是修改了配置參數，寫入並讀取的結果，與預期一致：