一、conf配置文件
1.介紹
- conf配置文件和ini配置文件讀取方式一致,以下以ini為后綴的配置文件為例
- 配置文件由sections與items組成:
- sections用來(lái)區(qū)分不同的配置塊
- items是sections下面的鍵值對(duì)
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
注意:中括號(hào)中的內(nèi)容為sections,每個(gè)sections可以有多個(gè)items(鍵值對(duì))
2.使用
- 讀取或更改conf或者ini配置文件,需要導(dǎo)入configparser模塊:
from configparser import ConfigParser - 讀取或更改配置前需創(chuàng)建對(duì)象和讀取文件內(nèi)容:
config = ConfigParser()config.read(filename, encoding)
2.1 讀取配置
-
config.sections():得到所有的section,并以列表的形式返回 config.options(section):得到該section的所有option,并以列表的形式返回-
config.items(section):得到該section的所有鍵值對(duì),并以列表的形式返回 -
config[section][option]:讀取section中的option的值 config.get(section, option):得到該section中option的值,返回類型為str類型-
config.getint(section, option):得到section中的option的值,返回類型為int類型 -
config.getboolean(section, option):得到section中的option的值,返回類型為bool類型 -
config.getfloat(section, option):得到section中的option的值,返回值為float類型 -
config.has_section(section):檢查對(duì)應(yīng)的section是否存在,存在返回True,不存在返回false -
config.has_option(section, option):檢查對(duì)應(yīng)的option是否存在,存在返回True,不存在返回false
-
config.options(section)、config.get(section, option)
注意:下面的配置文件來(lái)自上方的例子
def get_config():
'''
獲取配置文件內(nèi)容
'''
CONFTEST_FILE_PATH = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) + r"/conf.ini"
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
# 獲取配置文件內(nèi)common部分的配置信息
options = conf.options('common')
options_dict = {}
for cmd in options:
default = conf.get('common', cmd)
options_dict[cmd] = default
return options_dict
- config.getint(section, option)、config.getboolean(section, option)、config.getfloat(section, option)
- 配置文件
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
- 讀取配置代碼
import os
import configparser
CONFTEST_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), r"test_ini.ini")
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
print(conf.get("common", "web-port"), type(conf.get("common", "web-port")))
print(conf.getint("common", "web-port"), type(conf.getint("common", "web-port")))
print(conf.get("common", "version"), type(conf.get("common", "version")))
print(conf.getfloat("common", "version"), type(conf.getfloat("common", "version")))
print(conf.get("log", "url-log-enable"), type(conf.get("log", "url-log-enable")))
print(conf.getboolean("log", "url-log-enable"), type(conf.getboolean("log", "url-log-enable")))
輸出結(jié)果如下:
80 <class 'str'>
80 <class 'int'>
1.0 <class 'str'>
1.0 <class 'float'>
false <class 'str'>
False <class 'bool'>
- config.sections()、config.items(section)
- 配置文件
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
- 讀取配置代碼
import os
import configparser
CONFTEST_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), r"test_ini.ini")
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
print(conf.sections())
print(conf.items("common"))
輸出結(jié)果如下:
['common', 'log']
[('web-port', '80'), ('gateway-port', '80'), ('version', '1.0')]
- config.has_section(section)、config.has_option(section, option)
- 配置文件
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
- 讀取配置代碼
import os
import configparser
CONFTEST_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), r"test_ini.ini")
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
print(conf.has_section('common'))
print(conf.has_section('envType'))
print(conf.has_option('common', 'version'))
print(conf.has_option('common', 'branch'))
輸出結(jié)果如下:
True
False
True
False
2.2 更改配置
-
config.add_section(section):添加一個(gè)新的section -
config.set(section, option, value):對(duì)section中存在的option是修改,對(duì)section中不存在的option是新增
注意:
1.如果section不存在,使用set方法就會(huì)報(bào)錯(cuò),如果要新增的option的對(duì)應(yīng)section不存在,需要先調(diào)用add_section方法,再調(diào)用set方法才不報(bào)錯(cuò)
2.使用set方法后不進(jìn)行寫(xiě)操作,再使用get方法獲取的value已經(jīng)發(fā)生變化,只是配置文件保持不變 -
config.write(open(path, "w")):將修改的內(nèi)容寫(xiě)到配置文件 -
config[section][option]=value:對(duì)section中存在的option是修改,對(duì)section中不存在的option是新增 -
config.remove_section(section):刪除section -
config.remove_option(section, option):刪除section下的option
注意:使用remove刪除section和option,再使用get方法獲取的option就會(huì)提示option不存在,但是配置文件依舊存在
- config.set(section, option, value)、config[section][option]=value、config.write(open(path, "w"))(修改已有配置并同步到配置文件)
- 配置文件
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
- 更新配置代碼
import os
import configparser
CONFTEST_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), r"test_ini.ini")
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
conf.set('log', 'console-log-level', 'debug')
print(conf.get('log', 'console-log-level'))
conf["log"]["console-log-level"] = "error"
print(conf.get('log', 'console-log-level'))
conf.write(open(CONFTEST_FILE_PATH, 'w', encoding='utf-8'))
輸出結(jié)果如下:
debug
error
輸出結(jié)果后的配置文件如下:
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
# 修改配置處
console-log-level = error
file-log-level = info
url-log-enable = false
- config.add_section(section_name)、config.write(open(path, "w"))(新增配置并同步到配置文件)
- 配置文件
[common]
web-port = 80
gateway-port = 80
version = 1.0
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
- 新增配置代碼
import os
import configparser
CONFTEST_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), r"test_ini.ini")
conf = configparser.ConfigParser()
conf.read(CONFTEST_FILE_PATH, encoding='utf-8')
conf.add_section('envType')
conf.set('envType', 'type', 'uat')
conf.set('common', 'level', 'DAILY_TEST')
conf['common']['branch'] = "master"
conf.write(open(CONFTEST_FILE_PATH, 'w', encoding='utf-8'))
輸出結(jié)果后的配置文件如下:
[common]
web-port = 80
gateway-port = 80
version = 1.0
# 新增配置處1
level = DAILY_TEST
# 新增配置處2
branch = master
[log]
console-log-level = info
file-log-level = info
url-log-enable = false
# 新增配置處3
[envType]
type = uat