python 配置文件讀寫

轉自： orientlu 的《python 配置文件讀寫》

原址：https://www.jianshu.com/p/aadd86f8d38e

前言

將代碼中的配置項抽取到配置文件中，修改配置時不需要涉及到代碼修改，避免面對一堆令人抓狂的 magic number，極大的方便後期軟件的維護。

python 本身提供標準的配置讀寫模塊 configParse（python2，python3 修改爲configparser），用於讀取 ini 格式的配置文件。

[DEFAULT]
ServerAliveInterval = 45
Compression = yes

[topsecret.server.com]
Port = 50022
ForwardX11 = no

除了標準庫提供的模塊，通過第三方模塊 pyYAML，可以讀寫 yaml[1]式的配置文件。

本文介紹 python 通過 configParser 和 pyYAML 讀寫配置文件的方法。

configParser

Note The ConfigParser module has been renamed to configparser in Python 3. The 2to3 tool will automatically adapt imports when converting your sources to Python 3.

python2 和 python3 中此模塊有些許不同，舊代碼可以通過工具進行轉換。
目前來說，python2 在項目中仍有使用，所以以下對在 python2 和 python3 下模塊的使用都進行介紹。

python2 - ConfigParser

在ConfigParser 中提供了三個類:

RawConfigParser
ConfigParser
SafeConfigParser
三個以此在前者的基礎進行擴展，接口提供額外可選參數，提供更加複雜的功能，主要差別應該體現在對 %(value_name)s進行參數替換（value_name 爲同section或者[DEFAULT]中的其他變量名才行）

這裏使用的默認配置文件 default.cfg 內容如下：

[DEFAULT]
default_name = lcd

[Section1]
an_int = 15
a_bool = true
a_float = 3.1415
baz = fun
bar = Python
foo = %(bar)s is %(baz)s!
name = s1_%(default_name)s   ; DEFAULT section's value

基本讀寫

使用 RawConfigParser 實現配置文件的基本的讀寫操作。

import ConfigParser

test_cfg = "./default.cfg"
config_raw = ConfigParser.RawConfigParser()
config_raw.read(test_cfg)

# 讀取配置文件中 [DEFAULT]
defaults = config_raw.defaults()
print defaults

# 讀取指定section下的value值
a_float = config_raw.getfloat('Section1', 'a_float')
print "-- number : %f type is : %s"%(a_float ,type(a_float))

# 設置指定section下的value值
# 此時沒有寫入文件，保存在內存實例中
a_float = 2.14159
config_raw.set('Section1', 'a_float', a_float)
a_float = config_raw.getfloat('Section1', 'a_float')
print "-- number : %f type is : %s"%(a_float ,type(a_float))

# 讀取帶有參數替換模板的變量，但是沒有替換參數
print "-- RawConfigParser just get raw value"
str_foo = config_raw.get('Section1', 'foo')
print str_foo

對應不同數據類型，除了調用get()獲取配置文件中的原始內容，還可以使用對應的接口，getint, getboolean, 其中，布爾值 True 對應的是 1、yes、true 和 on， False 對應 0、no、false 和 off。

運行結果

OrderedDict([('default_name', 'lcd')])
-- number : 3.141500 type is : <type 'float'>
-- number : 2.141590 type is : <type 'float'>
-- RawConfigParser just get raw value
%(bar)s is %(baz)s!

參數替換

相比 RawConfigParser，對於配置文件中foo = %(bar)s is %(baz)s! 這種格式的變量，在讀取的時候如果想要取得替換後的值，需要使用類 ConfigParser 或者 SafeConfigParser 。
代碼如下

config = ConfigParser.ConfigParser()
config.read(test_cfg)

print "-- ConfigParser can get interpolation"
## get 接口添加參數 raw，raw=1 時直接返回配置文件中的值，不做參數替換
## raw 默認爲0，設置爲0時，返回替換後的值
str_foo = config.get('Section1', 'foo', raw=1)
#等同 str_foo = config.get('Section1', 'foo', 1)
print str_foo
str_foo = config.get('Section1', 'foo')
print str_foo
str_foo = config.get('Section1', 'foo', 0)
print str_foo

print "-- After set a new value"
str_foo = "%(name)s is %(baz)s!"
config.set('Section1', 'foo', str_foo)
str_foo = config.get('Section1', 'foo', 1)
print str_foo
str_foo = config.get('Section1', 'foo')
print str_foo

## raw=0，返回替換後的值，替換的變量是在同 section 下或者 default section 中查找
str_foo = config.get('Section1', 'name')
print str_foo

## 接口還有另外一個可選參數 vars,
## 設置後，查詢配置 values 時，會優先從vars這個{}尋找匹配的key返回
## 沒有再去尋找配置文件中的。
print "-- use default value if pass by vars={}"
a_float = config.get('Section1', 'a_float1', vars={'a_float1':'0.01'})
print "-- number : %f type is : %s"%(float(a_float) ,type(a_float))

運行結果

-- ConfigParser can get interpolation
%(bar)s is %(baz)s!
Python is fun!
Python is fun!
-- After set a new value
%(name)s is %(baz)s!
s1_lcd is fun!
s1_lcd
-- use default value if pass by vars={}
-- number : 0.010000 type is : <type 'str'>

使用默認參數

有些配置參數有時候配置文件中並沒有設置，此時程序中應該有對應的默認值，當找配置文件中查找不到時，使用配置值。注意和上一小節設置 vars={}不同，此處是優先返回配置文件的值，沒有才返回設置的默認值，上面則相反。

如下

## 設置默認值 name : default_name
config = ConfigParser.ConfigParser({'name' : 'default_name'})
config.readfp(open('./default.cfg'))
    
# 讀取存在的配置值，返回的是配置文件中的值
str_foo = config.get('Section1', 'name')
print str_foo
print "-- use default value"
config.remove_option('Section1', 'name')
# 讀取不存在的配置值，返回設置的默認值
str_foo = config.get('Section1', 'name')
print str_foo

運行結果

s1_lcd
-- use default value
default_name

使用默認配置文件

程序配置時，可以設置多個配置文件，並按照一定的優先級使用相應的配置文件，比如系統默認有個配置文件，不同的用戶下又使用不同的配置文件，程序運行時優先使用用戶配置文件中的配置參數，如果用戶配置文件不存在或者對應參數沒有設置，再讀取系統默認配置文件中的參數值。
此處，默認配置文件是開頭提供的 default.cfg

另新加兩個配置文件:

user1.cfg

[DEFAULT]
default_name = user1

[Section1]
name = s1_%(default_name)s   ; DEFAULT section's value

user2.cfg

[DEFAULT]
default_name = user1

[Section1]
name = s1_%(default_name)s   ; DEFAULT section's value

我們希望，參數使用優先級按照 user3.cfg > uer2.cfg > user1.cfg > default.cfg 使用
實現方式如下:

config = ConfigParser.ConfigParser()
## 設置默認的配置文件
## 注意此文件不存在會raise異常
config.readfp(open('./default.cfg'))
## 設置可選配置文件，最後優先級最高，文件不存在則忽略
config.read(['./user1.cfg', './user2.cfg', './user3.cfg'])
# readfp 必須先調用後才能調用read，否則read中都打不開，會報錯
# config.read(['./user11111111.cfg', './user22222222.cfg'])

## 可選文件中找不到的參數，在default中查找
an_int = config.getint('Section1', 'an_int')
print "-- number : %f type is : %s"%(an_int ,type(an_int))

## 使用可選文件中存在的參數
str_foo = config.get('Section1', 'name')
print str_foo

運行結果

-- number : 15.000000 type is : <type 'int'>
s1_user2

默認文件需要存在，運行時加載失敗會報錯，其他可選設置文件如果找不到，直接忽略。

python3 - configparser

可能考慮兼容性，前面 python2 中實現的三個類在 python3 中依然支持。對於 python2 提供的參考上一節內容，接下面我們看看 python3 的使用。

基本讀寫

同 python2 差不多，加載配置文件後可以通過諸如 get, getint的接口讀取參數值，也可以像讀取 dict 一樣讀取配置參數。

讀取的配置文件example.ini 如下

[DEFAULT]
serveraliveinterval = 45
compression = yes
compressionlevel = 9
forwardx11 = yes

[bitbucket.org]
user = hg 
;comment
#comment 

[topsecret.server.com]
port = 50022
forwardx11 = no

使用接口讀取上述配置文件內容

import configparser

config = configparser.ConfigParser()
print("- Empty config %s"%config.sections())

print("- Load config file")
config.read("./example.ini")
## 此處返回的sections list不包括 default
print("> config sections : %s"%config.sections()) 
print('bitbucket.org' in config )  ## 判斷配置文件中是否存在該 section
print("> Load config file is :")

for section in config.keys():
    print("[{s}]".format(s=section))
    for key in config[section]:
        print("{k} = {v}".format(k=key, v=config[section][key]))

## 如訪問 dict 一樣讀取配置內容
print("\n- Get value like dict :user =  %s"%config['bitbucket.org']['user'])
conf_bitbucket = config['bitbucket.org']
print(conf_bitbucket['user'])

"""
The DEFAULT section which provides default values for all other sections"""
print("\n- DEFAULT Section")
## default 是所有section的默認設置，備胎...
for key in config['bitbucket.org']: print(key)
print("> Get default value : forwardx11 = %s\n"%config['bitbucket.org']['forwardx11'])

## 讀取不同數據類型的配置參數
print("\n- Support datatypes")
forwardx11 = config['bitbucket.org'].getboolean('forwardx11')
int_port = config.getint('topsecret.server.com', 'port')
float_port = config.getfloat('topsecret.server.com', 'port')
print("> Get int port = %d type : %s"%(int_port, type(int_port)))
print("> Get float port = %f type : %s"%(float_port, type(float_port)))

運行結果如下：

- Empty config []
- Load config file
> config sections : ['bitbucket.org', 'topsecret.server.com']
True
> Load config file is :
[DEFAULT]
serveraliveinterval = 45
compression = yes
compressionlevel = 9
forwardx11 = yes
[bitbucket.org]
user = hg
serveraliveinterval = 45
compression = yes
compressionlevel = 9
forwardx11 = yes
[topsecret.server.com]
port = 50022
forwardx11 = no
serveraliveinterval = 45
compression = yes
compressionlevel = 9

- Get value like dict :user =  hg
hg

- DEFAULT Section
user
serveraliveinterval
compression
compressionlevel
forwardx11
> Get default value : forwardx11 = yes


- Support datatypes
> Get int port = 50022 type : <class 'int'>
> Get float port = 50022.000000 type : <class 'float'>

默認返回

在讀取配置參數時，設置如果在配置文件中查找不到指定值，則默認返回的值。
在指定 section 和 default 中都找不到查找的值，就會直接返回設置的 fallback，而不是 raise 錯誤。

print("\n- Return Fallback")
print("> Get value user = %s"%(config.get('bitbucket.org', 'user')))
print("> Get value user = %s"%(config.get('bitbucket.org', 'user', fallback="fallback_name")))
print("> Get value forwardx11 = %s"%(config.getboolean('bitbucket.org', 'forwardx11', fallback=False)))
print("> Get value forwardx22 = %s"%(config.getboolean('bitbucket.org', 'forwardx22', fallback=False)))
print("> Get value user2 = %s"%(config.get('bitbucket.org', 'user2', fallback="fallback_name")))

運行結果如下：

- Return Fallback
> Get value user = hg
> Get value user = hg
> Get value forwardx11 = True
> Get value forwardx22 = False
> Get value user2 = fallback_name

參數替換

在 python2 中提到的參數替換，pyton3 中默認使用的 BasicInterpolation(), 直接支持，在上面就提到，這種替換，變量必須是同個 section（包括default），如果要使用到其他 section 的參數，就需要使用 ExtendedInterpolation()，並且，語法上會有些許不同。

如下，basic_interpolation.ini 是基礎的替換配置文件，和 python2 一樣

[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack
my_pictures: %(my_dir)s/Pictures

而以下這個，擴展到參數可以使用不同的 section, 在 extended_interpolation.ini 中，替換的參數寫法是 ${section_name: value_name}

[Common]
home_dir: /Users
library_dir: /Library
system_dir: /System
macports_dir: /opt/local

[Frameworks]
Python: 3.2
path: ${Common:system_dir}/Library/Frameworks/

[Arthur]
nickname: Two Sheds
last_name: Jackson
my_dir: ${Common:home_dir}/twosheds
my_pictures: ${my_dir}/Pictures
python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}

對以上兩個配置文件進行讀取，如下代碼

print("\n- BasicInterpolation")
#default : config = configparser.ConfigParser(interpolation=configparser.BasicInterpolation())
## 默認使用的 interpolation 就是 BasicInterpolation()
config.read("./basic_interpolation.ini")
print("> Get raw value %s"%(config.get('Paths', 'my_dir', raw = 1)))
print("> Get value %s"%(config.get('Paths', 'my_dir', raw = 0)))


print("\n- ExtendedInterpolation - other sections")
config = configparser.ConfigParser(interpolation=configparser.ExtendedInterpolation())
config.read("./extended_interpolation.ini")
print("> Get raw value %s"%(config.get('Arthur', 'python_dir', raw = 1)))
print("> Get value %s"%(config.get('Arthur', 'python_dir', raw = 0)))

運行結果：

- BasicInterpolation
> Get raw value %(home_dir)s/lumberjack
> Get value /Users/lumberjack

- ExtendedInterpolation - other sections
> Get raw value ${Frameworks:path}/Python/Versions/${Frameworks:Python}
> Get value /System/Library/Frameworks//Python/Versions/3.2

作者：orientlu
鏈接：https://www.jianshu.com/p/aadd86f8d38e
來源：簡書
簡書著作權歸作者所有，任何形式的轉載都請聯繫作者獲得授權並註明出處。

python 配置文件讀寫

前言

configParser

python2 - ConfigParser

python3 - configparser

使用c#強大的表達式樹實現對象的深克隆之解決循環引用的問題

GPT-4o 引領人機交互新風向，向量數據庫賽道沸騰了

free AI online tools All In One

痞子衡嵌入式：恩智浦i.MX RT1xxx系列MCU啓動那些事（12.A）- uSDHC eMMC啓動時間(RT1170)

基於Ubuntu-22.04安裝K8s-v1.28.2實驗（二）使用kube-vip實現集羣VIP訪問

企業大模型如何成爲自己數據的“百科全書”？

本地SSL證書過期輸入命令在IIS自動生成

.NET週刊【5月第2期 2024-05-12】

基於Ubuntu-22.04安裝K8s-v1.28.2實驗（一）部署K8s

基於Ubuntu-22.04安裝K8s-v1.28.2實驗（三）數據卷掛載NFS（網絡文件系統）

linux常用應用安裝總結

conda的配置文件

reshape(1,-1) 中的-1是什麼意思？

Ubuntu命令方式安裝中文語言包

redis 單機安裝及基本用法

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結